SmartContract | snarkyjs

The main zkapp class. To write a zkapp, extend this class as such:

class YourSmartContract extends SmartContract {
  // your smart contract code here
}

Hierarchy

SmartContract

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SmartContract(address: Types.PublicKey): SmartContract

- Defined in lib/zkapp.ts:453
Parameters
- address: Types.PublicKey
Returns SmartContract

Properties

Private _executionState

_executionState: undefined | ExecutionState

address

address: Types.PublicKey

events

events: {} = {}

Type declaration

[key: string]: AsFieldElements<any>

Static Optional _maxProofsVerified

_maxProofsVerified?: 0 | 2 | 1

Static Private _methodMetadata

_methodMetadata: Record<string, { digest: string; hasReturn: boolean; rows: number; sequenceEvents: number }> = {}

Static Optional _methods

_methods?: MethodInterface[]

Static Optional _provers

_provers?: Prover[]

Static Optional _verificationKey

_verificationKey?: { data: string; hash: Field }

Type declaration

data: string
hash: Field

Accessors

account

get account(): PreconditionClassType<AccountPrecondition>

- Defined in lib/zkapp.ts:554
Returns PreconditionClassType<AccountPrecondition>

balance

get balance(): { addInPlace: any; subInPlace: any }

- Defined in lib/zkapp.ts:583
Returns { addInPlace: any; subInPlace: any }
- addInPlace:function
  - addInPlace(x: string | number | bigint | UInt32 | UInt64 | Int64): void
  - - Defined in lib/party.ts:705
    Parameters
    - x: string | number | bigint | UInt32 | UInt64 | Int64
    Returns void
- subInPlace:function
  - subInPlace(x: string | number | bigint | UInt32 | UInt64 | Int64): void
  - - Defined in lib/party.ts:709
    Parameters
    - x: string | number | bigint | UInt32 | UInt64 | Int64
    Returns void

experimental

get experimental(): { get token(): { id: Field; parentTokenId: Field; tokenOwner: Types.PublicKey; burn: any; mint: any; send: any } }

- Defined in lib/zkapp.ts:562
Returns { get token(): { id: Field; parentTokenId: Field; tokenOwner: Types.PublicKey; burn: any; mint: any; send: any } }
- get token(): { id: Field; parentTokenId: Field; tokenOwner: Types.PublicKey; burn: any; mint: any; send: any }

network

get network(): PreconditionClassType<{ blockchainLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; globalSlotSinceGenesis: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; globalSlotSinceHardFork: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; minWindowDensity: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; nextEpochData: { epochLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; ledger: { hash: { isSome: Bool; value: Field }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }; lockCheckpoint: { isSome: Bool; value: Field }; seed: { isSome: Bool; value: Field }; startCheckpoint: { isSome: Bool; value: Field } }; snarkedLedgerHash: { isSome: Bool; value: Field }; stakingEpochData: { epochLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; ledger: { hash: { isSome: Bool; value: Field }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }; lockCheckpoint: { isSome: Bool; value: Field }; seed: { isSome: Bool; value: Field }; startCheckpoint: { isSome: Bool; value: Field } }; timestamp: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }>

- Defined in lib/zkapp.ts:558
Returns PreconditionClassType<{ blockchainLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; globalSlotSinceGenesis: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; globalSlotSinceHardFork: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; minWindowDensity: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; nextEpochData: { epochLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; ledger: { hash: { isSome: Bool; value: Field }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }; lockCheckpoint: { isSome: Bool; value: Field }; seed: { isSome: Bool; value: Field }; startCheckpoint: { isSome: Bool; value: Field } }; snarkedLedgerHash: { isSome: Bool; value: Field }; stakingEpochData: { epochLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; ledger: { hash: { isSome: Bool; value: Field }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }; lockCheckpoint: { isSome: Bool; value: Field }; seed: { isSome: Bool; value: Field }; startCheckpoint: { isSome: Bool; value: Field } }; timestamp: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }>

nonce

get nonce(): UInt32

- Defined in lib/zkapp.ts:587
Returns UInt32

self

get self(): Party

- Defined in lib/zkapp.ts:550
Returns Party

tokenId

get tokenId(): Field

- Defined in lib/zkapp.ts:575
Returns Field

tokenSymbol

get tokenSymbol(): { set: any }

- Defined in lib/zkapp.ts:579
Returns { set: any }
- set:function
  - set(tokenSymbol: string): void
  - - Defined in lib/party.ts:677
    Parameters
    - tokenSymbol: string
    Returns void

Static Proof

get Proof(): typeof __class

- Defined in lib/zkapp.ts:445
Returns typeof __class

Methods

deploy

deploy(__namedParameters: { verificationKey?: { data: string; hash: string | Field }; zkappKey?: PrivateKey }): void

- Defined in lib/zkapp.ts:504
Parameters
- __namedParameters: { verificationKey?: { data: string; hash: string | Field }; zkappKey?: PrivateKey }
  - Optional verificationKey?: { data: string; hash: string | Field }
    - data: string
    - hash: string | Field
  - Optional zkappKey?: PrivateKey
Returns void

emitEvent

emitEvent<K>(type: K, event: any): void

- Defined in lib/zkapp.ts:594
Type parameters
- K: string | number
Parameters
- type: K
- event: any
Returns void

Private executionState

executionState(): ExecutionState

- Defined in lib/zkapp.ts:525
Returns ExecutionState

fetchEvents

fetchEvents(start?: UInt32, end?: UInt32): Promise<{ event: AsFieldElements<any>; type: string }[]>

- Defined in lib/zkapp.ts:624
Parameters
- start: UInt32 = ...
- Optional end: UInt32
Returns Promise<{ event: AsFieldElements<any>; type: string }[]>

send

send(args: Omit<SendParams, "from">): void

- Defined in lib/zkapp.ts:571
Parameters
- args: Omit<SendParams, "from">
Returns void

setPermissions

setPermissions(permissions: Permissions): void

- Defined in lib/zkapp.ts:715
Parameters
- permissions: Permissions
Returns void

setValue

setValue<T>(maybeValue: SetOrKeep<T>, value: T): void

- Defined in lib/zkapp.ts:709
Type parameters
- T
Parameters
- maybeValue: SetOrKeep<T>
- value: T
Returns void

sign

sign(zkappKey?: PrivateKey, fallbackToZeroNonce?: boolean): void

- Defined in lib/zkapp.ts:521
Parameters
- Optional zkappKey: PrivateKey
- Optional fallbackToZeroNonce: boolean
Returns void

Static analyzeMethods

analyzeMethods(address: Types.PublicKey): Record<string, { digest: string; hasReturn: boolean; rows: number; sequenceEvents: number }>

- Defined in lib/zkapp.ts:675
Parameters
- address: Types.PublicKey
Returns Record<string, { digest: string; hasReturn: boolean; rows: number; sequenceEvents: number }>

Static compile

compile(address: Types.PublicKey): Promise<{ provers: Prover[]; verificationKey: { data: string; hash: string }; verify: (publicInput: PublicInput, proof: unknown) => Promise<boolean> }>

- Defined in lib/zkapp.ts:465
Parameters
- address: Types.PublicKey
Returns Promise<{ provers: Prover[]; verificationKey: { data: string; hash: string }; verify: (publicInput: PublicInput, proof: unknown) => Promise<boolean> }>

Static digest

digest(address: Types.PublicKey): string

- Defined in lib/zkapp.ts:495
Parameters
- address: Types.PublicKey
Returns string

Static runOutsideCircuit

runOutsideCircuit(run: () => void): void

- Defined in lib/zkapp.ts:668
Parameters
- run: () => void
  - - (): void
    - Returns void
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: Types.PublicKey

Returns SmartContract

Properties

Private _executionState

address

events

Type declaration

[key: string]: AsFieldElements<any>

Static Optional _maxProofsVerified

Static Private _methodMetadata

Static Optional _methods

Static Optional _provers

Static Optional _verificationKey

Type declaration

data: string

hash: Field

Accessors

account

Returns PreconditionClassType<AccountPrecondition>

balance

Returns { addInPlace: any; subInPlace: any }

addInPlace:function

Parameters

x: string | number | bigint | UInt32 | UInt64 | Int64

Returns void

subInPlace:function

Parameters

x: string | number | bigint | UInt32 | UInt64 | Int64

Returns void

experimental

Returns { get token(): { id: Field; parentTokenId: Field; tokenOwner: Types.PublicKey; burn: any; mint: any; send: any } }

get token(): { id: Field; parentTokenId: Field; tokenOwner: Types.PublicKey; burn: any; mint: any; send: any }

network

nonce

Returns UInt32

self

Returns Party

tokenId

Returns Field

tokenSymbol

Returns { set: any }

set:function

Parameters

tokenSymbol: string

Returns void

Static Proof

Returns typeof __class

Methods

deploy

Parameters

__namedParameters: { verificationKey?: { data: string; hash: string | Field }; zkappKey?: PrivateKey }

Optional verificationKey?: { data: string; hash: string | Field }

data: string

hash: string | Field

Optional zkappKey?: PrivateKey

Returns void

emitEvent

Type parameters

K: string | number

Parameters

type: K

event: any

Returns void

Private executionState

Returns ExecutionState

fetchEvents

Parameters

start: UInt32 = ...

Optional end: UInt32

Returns Promise<{ event: AsFieldElements<any>; type: string }[]>

send