SnarkyJS API Reference

a new [[Bool]] that is set to true only if this [[Bool]] and y are also true.

Defined in

snarky.d.ts:379

assertEquals

▸ assertEquals(y): void

Proves that this [[Bool]] is equal to y.

Parameters

Name	Type	Description
`y`	`boolean` \| `Bool`	a [[`Bool`]].

Parameters

Name	Type	Description
`y`	`boolean` \| `Bool`	a [[`Bool`]].

snarky.d.ts:411

toJSON

▸ toJSON(): JSONValue

Serialize the [[Bool]] to a JSON string. This operation does NOT affect the circuit and can't be used to prove anything about the string representation of the Field.

Returns

Defined in

snarky.d.ts:422

toString

▸ toString(): string

Defined in

snarky.d.ts:466

snarkyjs / Exports / Character

Class: Character

Hierarchy

CircuitValue
↳ Character

Constructors

constructor

Properties

value

Methods

assertEquals
equals
isNull
toField
toFields
toJSON
toString
check
fromJSON
fromString
ofFields
sizeInFields
toConstant
toFields
toJSON

Constructors

constructor

• new Character(value)

Parameters

Name	Type
`value`	`Field`

Overrides

Defined in

lib/string.ts:11

Properties

value

• value: Field

Defined in

lib/string.ts:9

Methods

assertEquals

▸ assertEquals(this, x): void

Parameters

Name	Type
`this`	`Character`
`x`	`Character`

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

Returns

null | T

Inherited from

Defined in

fromString

▸ Static fromString(str): Character

Parameters

Name	Type
`str`	`string`

Returns

Character

Defined in

lib/string.ts:29

ofFields

▸ Static ofFields<T>(this, xs): T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Returns

T

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

snarkyjs / Exports / Circuit

Class: Circuit

Constructors

constructor

Methods

addConstraint
array
asProver
assertEqual
equal
generateKeypair
if
inCheckedComputation
inProver
newVariable
prove
runAndCheck
toFields
verify
witness

Constructors

constructor

• new Circuit()

Methods

addConstraint

▸ Static addConstraint(this, kind, x, y, z): void

Parameters

Name	Type
`this`	`Circuit`
`kind`	`"multiply"`
`x`	`Field`
`y`	`Field`
`z`	`Field`

Returns

void

Defined in

snarky.d.ts:484

▸ Static addConstraint(this, kind, x, y, z): void

Parameters

Name	Type
`this`	`Circuit`
`kind`	`"add"`
`x`	`Field`
`y`	`Field`
`z`	`Field`

Returns

void

Defined in

snarky.d.ts:491

▸ Static addConstraint(this, kind, x, y, z): void

Parameters

Name	Type
`this`	`Circuit`
`kind`	`"equal"`
`x`	`Field`
`y`	`Field`
`z`	`Field`

Returns

void

Defined in

snarky.d.ts:498

▸ Static addConstraint(this, kind, x, y, z): void

Parameters

Name	Type
`this`	`Circuit`
`kind`	`"boolean"`
`x`	`Field`
`y`	`Field`
`z`	`Field`

Returns

void

Defined in

snarky.d.ts:505

array

▸ Static array<T>(ctor, length): AsFieldElements<T[]>

Type parameters

Name
`T`

Parameters

Name	Type
`ctor`	`AsFieldElements`<`T`>
`length`	`number`

Returns

AsFieldElements<T[]>

Defined in

snarky.d.ts:525

asProver

▸ Static asProver(f): void

Parameters

Name	Type
`f`	() => `void`

Returns

void

Defined in

snarky.d.ts:521

assertEqual

▸ Static assertEqual<T>(ctor, x, y): void

Type parameters

Name
`T`

Parameters

Name	Type
`ctor`	`Object`
`ctor.toFields`	(`x`: `T`) => `Field`[]
`x`	`T`
`y`	`T`

Returns

void

Defined in

snarky.d.ts:530

▸ Static assertEqual<T>(x, y): void

Type parameters

Name
`T`

Parameters

Name	Type
`x`	`T`
`y`	`T`

Returns

void

Defined in

snarky.d.ts:532

equal

▸ Static equal<T>(ctor, x, y): Bool

Type parameters

Name
`T`

Parameters

Name	Type
`ctor`	`Object`
`ctor.toFields`	(`x`: `T`) => `Field`[]
`x`	`T`
`y`	`T`

Returns

Defined in

snarky.d.ts:534

▸ Static equal<T>(x, y): Bool

Type parameters

Name
`T`

Parameters

Name	Type
`x`	`T`
`y`	`T`

Returns

▸ Static if<T>(b, x, y): T

Type parameters

Name
`T`

Parameters

Name	Type
`b`	`boolean` \| `Bool`
`x`	`T`
`y`	`T`

Type parameters

Name
`A`

Parameters

Name	Type
`a`	`A`

Returns

Defined in

snarky.d.ts:548

verify

▸ Static verify(publicInput, vk, pi): boolean

Parameters

Name	Type
`publicInput`	`any`[]
`vk`	`VerificationKey`
`pi`	`Proof`

Returns

boolean

Defined in

snarky.d.ts:546

witness

▸ Static witness<T, S>(ctor, f): T

Type parameters

Name	Type
`T`	`T`
`S`	extends `AsFieldElements`<`T`, `S`> = `AsFieldElements`<`T`>

Parameters

Name	Type
`ctor`	`S`
`f`	() => `T`

Returns

T

Defined in

snarky.d.ts:516

snarkyjs / Exports / CircuitString

Class: CircuitString

Hierarchy

CircuitValue
↳ CircuitString

Constructors

constructor

Properties

values
maxLength

Methods

append
assertEquals
computeLengthAndMask
equals
hash
length
lengthMask
maxLength
substring
toFields
toJSON
toString
fromJSON
fromString
ofFields
sizeInFields
toConstant
toFields
toJSON

Constructors

constructor

• new CircuitString(values)

Parameters

Name	Type
`values`	`Character`[]

Overrides

Defined in

lib/string.ts:45

Properties

values

• values: Character[]

Defined in

lib/string.ts:43

maxLength

▪ Static maxLength: number = DEFAULT_STRING_LENGTH

Defined in

lib/string.ts:42

Methods

append

▸ append(str): CircuitString

appends another string to this one, returns the result and proves that it fits within the maxLength of this string (the other string can have a different maxLength)

Parameters

Name	Type
`str`	`CircuitString`

Name	Type
`length`	`Field`
`mask`	`Bool`[]

Defined in

lib/string.ts:55

equals

▸ equals(this, x): Bool

Parameters

Name	Type
`this`	`CircuitString`
`x`	`CircuitString`

Returns

Inherited from

CircuitValue.equals

Defined in

lib/circuit_value.ts:54

hash

▸ hash(): Field

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

Returns

null | T

Inherited from

Defined in

fromString

▸ Static fromString(str): CircuitString

Parameters

Name	Type
`str`	`string`

Returns

CircuitString

Defined in

lib/string.ts:136

ofFields

▸ Static ofFields<T>(this, xs): T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Returns

T

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

snarkyjs / Exports / CircuitValue

Class: CircuitValue

Hierarchy

CircuitValue
↳ Character
↳ CircuitString
↳ PrivateKey
↳ PublicKey
↳ Signature
↳ UInt32
↳ UInt64
↳ Int64

Constructors

constructor

Methods

assertEquals
equals
toFields
toJSON
fromJSON
ofFields
sizeInFields
toConstant
toFields
toJSON

Constructors

constructor

• new CircuitValue()

Methods

assertEquals

▸ assertEquals(this, x): void

Parameters

Name	Type
`this`	`CircuitValue`
`x`	`CircuitValue`

fromJSON

▸ Static fromJSON<T>(this, value): null | T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

Returns

null | T

Defined in

ofFields

▸ Static ofFields<T>(this, xs): T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Returns

T

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Defined in

snarkyjs / Exports / EndoScalar

Class: EndoScalar

Constructors

constructor

Methods

ofFields
sizeInFields
toFields

Constructors

constructor

• new EndoScalar()

Methods

ofFields

▸ Static ofFields(fields): Scalar

Parameters

Name	Type
`fields`	`Field`[]

snarkyjs / Exports / Field

Class: Field

Constructors

constructor

Properties

ORDER
minusOne
one
zero

Methods

Constructors

constructor

• new Field(x)

Coerces anything field-like to a [[Field]].

Parameters

Name	Type
`x`	`string` \| `number` \| `bigint` \| `boolean` \| `Field`

Defined in

snarky.d.ts:31

snarky.d.ts:261

Methods

add

▸ add(y): Field

Adds this [[Field]] element to another coercible to a field.

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:59

assertBoolean

▸ assertBoolean(): void

Assert that this [[Field]] is either 0 or 1.

Field.zero.assertBoolean();

This function can only be called inside a checked computation, like a SmartContract method, and throws an error if the assertion fails.

Returns

void

Defined in

snarky.d.ts:219

assertEquals

▸ assertEquals(y): void

Assert that this [[Field]] equals another Field-like value. Throws an error if the assertion fails.

Field.one.assertEquals(1);

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

void

Defined in

snarky.d.ts:208

assertGt

▸ assertGt(y): void

Assert that this [[Field]] is greater than another Field-like value.

Field.one.assertGt(0);

This function can only be called inside a checked computation, like a SmartContract method, and causes it to fail if the assertion fails.

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

void

Defined in

snarky.d.ts:187

assertGte

▸ assertGte(y): void

Assert that this [[Field]] is greater than or equal to another Field-like value.

Field.one.assertGte(0);

This function can only be called inside a checked computation, like a SmartContract method, and causes it to fail if the assertion fails.

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

void

Defined in

snarky.d.ts:198

assertLt

▸ assertLt(y): void

Assert that this [[Field]] is lower than another Field-like value.

Field.one.assertLt(2);

This function can only be called inside a checked computation, like a SmartContract method, and causes it to fail if the assertion fails.

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

void

Defined in

snarky.d.ts:165

assertLte

▸ assertLte(y): void

Assert that this [[Field]] is lower than or equal to another Field-like value.

Field.one.assertLte(2);

This function can only be called inside a checked computation, like a SmartContract method, and causes it to fail if the assertion fails.

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

void

Defined in

snarky.d.ts:176

div

▸ div(y): Field

Divides this [[Field]] element through another coercible to a field.

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:74

equals

▸ equals(y): Bool

Check if this [[Field]] equals another [[Field]]-like value. Returns a [[Bool]].

Field(2).equals(2); // Bool(true)

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:241

gt

▸ gt(y): Bool

Check if this [[Field]] is greater than another Field-like value. Returns a [[Bool]].

Field(2).gt(1); // Bool(true)

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:143

gte

▸ gte(y): Bool

Check if this [[Field]] is greater than or equal to another Field-like value. Returns a [[Bool]].

Field(2).gte(1); // Bool(true)

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:152

inv

▸ inv(): Field

Inverts this [[Field]] element.

const invX = x.inv();
invX.assertEquals(Field.one.div(x));

Returns

Check if this [[Field]] is lower than another Field-like value. Returns a [[Bool]].

Field(2).lt(3); // Bool(true)

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:125

lte

▸ lte(y): Bool

Check if this [[Field]] is lower than or equal to another Field-like value. Returns a [[Bool]].

Field(2).lte(3); // Bool(true)

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:134

mul

▸ mul(y): Field

Multiplies this [[Field]] element with another coercible to a field.

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:69

neg

▸ neg(): Field

Negates this [[Field]]. This is equivalent to multiplying the [[Field]] by -1.

const negOne = Field.one.neg();
negOne.assertEquals(-1);

Defined in

snarky.d.ts:112

sqrt

▸ sqrt(): Field

Square roots this [[Field]] element.

x.square().sqrt().assertEquals(x);

Returns

Defined in

snarky.d.ts:93

square

▸ square(): Field

Squares this [[Field]] element.

const x2 = x.square();
x2.assertEquals(x.mul(x));

Returns

Defined in

snarky.d.ts:84

sub

▸ sub(y): Field

Subtracts another [[Field]]-like element from this one.

Parameters

Name	Type
`y`	`string` \| `number` \| `boolean` \| `Field`

Returns

Defined in

snarky.d.ts:64

toBigInt

▸ toBigInt(): bigint

Serialize the [[Field]] to a bigint. This operation does NOT affect the circuit and can't be used to prove anything about the bigint representation of the Field.

Returns

bigint

Defined in

snarky.d.ts:104

toBits

Defined in

snarky.d.ts:114

toJSON

▸ toJSON(): JSONValue

Serialize the [[Field]] to a JSON string. This operation does NOT affect the circuit and can't be used to prove anything about the string representation of the Field.

Returns

Defined in

snarky.d.ts:109

toString

▸ toString(): string

Name	Type
`x`	`string`

Returns

Defined in

snarky.d.ts:344

ofBits

▸ Static ofBits(x): Field

Converts a bit array into a field element (little endian) Fails if the field element cannot fit given too many bits.

TODO: Rename to fromBits

Parameters

Name	Type
`x`	(`boolean` \| `Bool`)[]

Returns

Defined in

snarky.d.ts:328

ofFields

▸ Static ofFields(fields): Field

Parameters

Name	Type
`fields`	`Field`[]

Returns

Defined in

snarky.d.ts:307

random

▸ Static random(): Field

snarky.d.ts:311

snarkyjs / Exports / Group

Class: Group

Constructors

constructor

Properties

x
y
generator

Methods

add
assertEquals
equals
neg
scale
sub
toJSON
add
assertEqual
equal
fromJSON
neg
ofFields
scale
sizeInFields
sub
toFields
toJSON

Constructors

constructor

• new Group(args)

Parameters

Name	Type
`args`	`Object`
`args.x`	`string` \| `number` \| `boolean` \| `Field`
`args.y`	`string` \| `number` \| `boolean` \| `Field`

Defined in

snarky.d.ts:621

• new Group(x, y)

Parameters

Name	Type
`x`	`string` \| `number` \| `boolean` \| `Field`
`y`	`string` \| `number` \| `boolean` \| `Field`

Defined in

snarky.d.ts:625

Properties

Methods

add

▸ add(y): Group

Parameters

Name	Type
`y`	`Group`

Parameters

Name	Type
`x`	`Group`

Returns

Defined in

snarky.d.ts:644

snarkyjs / Exports / Int64

Class: Int64

Hierarchy

CircuitValue
↳ Int64

Implements

BalanceChange

Constructors

constructor

Properties

magnitude
sgn

Accessors

minusOne
one
zero

Methods

Constructors

constructor

• new Int64(magnitude, sgn?)

Parameters

Name	Type	Default value
`magnitude`	`UInt64`	`undefined`
`sgn`	`Field`	`Field.one`

Overrides

Defined in

lib/int.ts:366

Properties

magnitude

• magnitude: UInt64

Implementation of

BalanceChange.magnitude

Defined in

lib/int.ts:343

sgn

• sgn: Field

Implementation of

BalanceChange.sgn

Defined in

lib/int.ts:344

lib/int.ts:427

Methods

add

▸ add(y): Int64

Parameters

Name	Type
`y`	`string` \| `number` \| `bigint` \| `UInt32` \| `UInt64` \| `Int64`

Returns

Int64

Defined in

lib/int.ts:455

assertEquals

▸ assertEquals(y): void

Parameters

Name	Type
`y`	`string` \| `number` \| `bigint` \| `UInt32` \| `UInt64` \| `Int64`

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

ofFields

▸ Static ofFields<T>(this, xs): T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Returns

T

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

snarkyjs / Exports / Keypair

Class: Keypair

Contains a proving key and [[VerificationKey]] which can be used to verify proofs.

Constructors

constructor

Methods

verificationKey

Constructors

constructor

• new Keypair()

Methods

verificationKey

▸ verificationKey(): VerificationKey

Returns

VerificationKey

Defined in

snarky.d.ts:676

snarkyjs / Exports / Ledger

Class: Ledger

Constructors

constructor

Methods

Constructors

constructor

• new Ledger()

Methods

addAccount

▸ addAccount(publicKey, balance): void

Parameters

Name	Type
`publicKey`	`Object`
`publicKey.g`	`Group`
`balance`	`string`

Returns

void

Defined in

snarky.d.ts:706

applyJsonTransaction

▸ applyJsonTransaction(txJson, accountCreationFee): Account[]

Parameters

Name	Type
`txJson`	`string`
`accountCreationFee`	`string`

Returns

Account[]

Defined in

snarky.d.ts:708

getAccount

▸ getAccount(publicKey): undefined | Account

Parameters

Name	Type
`publicKey`	`Object`
`publicKey.g`	`Group`

Returns

undefined | Account

Defined in

snarky.d.ts:710

create

▸ Static create(genesisAccounts): Ledger

Parameters

Name	Type
`genesisAccounts`	{ `balance`: `string` ; `publicKey`: { `g`: `Group` } }[]

Returns

Ledger

Defined in

snarky.d.ts:702

fieldOfBase58

▸ Static fieldOfBase58(fieldBase58): Field

Parameters

Name	Type
`fieldBase58`	`string`

Returns

Defined in

snarky.d.ts:741

fieldToBase58

▸ Static fieldToBase58(field): string

Parameters

Name	Type
`field`	`Field`

Returns

string

Defined in

snarky.d.ts:740

fieldsOfJson

▸ Static fieldsOfJson(json): Field[]

Parameters

Name	Type
`json`	`string`

Returns

Defined in

snarky.d.ts:744

hashPartyFromFields

▸ Static hashPartyFromFields(fields): Field

Parameters

Name	Type
`fields`	`Field`[]

Returns

Defined in

snarky.d.ts:745

hashTransaction

▸ Static hashTransaction(partyHash): Field

Parameters

Name	Type
`partyHash`	`Field`

Returns

Defined in

snarky.d.ts:712

hashTransactionChecked

▸ Static hashTransactionChecked(partyHash): Field

Parameters

Name	Type
`partyHash`	`Field`

Returns

Defined in

snarky.d.ts:713

memoToBase58

▸ Static memoToBase58(memoString): string

Parameters

Name	Type
`memoString`	`string`

Returns

string

Defined in

snarky.d.ts:742

privateKeyOfString

▸ Static privateKeyOfString(privateKeyBase58): Scalar

Parameters

Name	Type
`privateKeyBase58`	`string`

Returns

Defined in

snarky.d.ts:739

privateKeyToString

▸ Static privateKeyToString(privateKey): string

Parameters

Name	Type
`privateKey`	`Object`
`privateKey.s`	`Scalar`

Returns

string

Defined in

snarky.d.ts:738

publicKeyOfString

▸ Static publicKeyOfString(publicKeyBase58): Group

Parameters

Name	Type
`publicKeyBase58`	`string`

Returns

Group

Defined in

snarky.d.ts:737

publicKeyToString

▸ Static publicKeyToString(publicKey): string

Parameters

Name	Type
`publicKey`	`Object`
`publicKey.g`	`Group`

Returns

string

Defined in

snarky.d.ts:736

signFeePayer

▸ Static signFeePayer(txJson, privateKey): string

Parameters

Name	Type
`txJson`	`string`
`privateKey`	`Object`
`privateKey.s`	`Scalar`

Returns

string

Defined in

snarky.d.ts:724

signFieldElement

▸ Static signFieldElement(messageHash, privateKey): string

Parameters

Name	Type
`messageHash`	`Field`
`privateKey`	`Object`
`privateKey.s`	`Scalar`

Returns

string

Defined in

snarky.d.ts:720

signOtherParty

▸ Static signOtherParty(txJson, privateKey, i): string

Parameters

Name	Type
`txJson`	`string`
`privateKey`	`Object`
`privateKey.s`	`Scalar`
`i`	`number`

Returns

string

Defined in

snarky.d.ts:725

transactionCommitments

▸ Static transactionCommitments(txJson): Object

Parameters

Name	Type
`txJson`	`string`

Returns

Object

Name	Type
`commitment`	`Field`
`fullCommitment`	`Field`

Defined in

snarky.d.ts:715

transactionStatement

▸ Static transactionStatement(txJson, partyIndex): Statement

Parameters

Name	Type
`txJson`	`string`
`partyIndex`	`number`

Returns

Statement

Defined in

snarky.d.ts:719

verifyPartyProof

▸ Static verifyPartyProof(statement, proof, verificationKey): Promise<boolean>

Parameters

Name	Type
`statement`	`Statement`
`proof`	`string`
`verificationKey`	`string`

Returns

Promise<boolean>

Defined in

snarky.d.ts:730

snarkyjs / Exports / Party

Class: Party

Constructors

constructor

Properties

account
authorization
body
isSelf
network

Accessors

balance
publicKey
update

Methods

hash
setNoncePrecondition
sign
signInPlace
toFields
assertBetween
assertEquals
clone
createSigned
createUnsigned
defaultFeePayer
defaultParty
dummyFeePayer
fundNewAccount
getNonce
setValue
signFeePayerInPlace

Constructors

constructor

• new Party(body, authorization?)

Parameters

Name	Type
`body`	`Body`
`authorization?`	`LazyControl`

Defined in

lib/party.ts:492

Properties

Accessors

balance

• get balance(): Object

Returns

Object

Name	Type
`addInPlace`	(`x`: `string` \| `number` \| `bigint` \| `UInt32` \| `UInt64` \| `Int64`) => `void`
`subInPlace`	(`x`: `string` \| `number` \| `bigint` \| `UInt32` \| `UInt64` \| `Int64`) => `void`

Defined in

lib/party.ts:508

publicKey

• get publicKey(): PublicKey

Returns

PublicKey

Defined in

lib/party.ts:579

update

• get update(): Object

Returns

Object

Name	Type
`appState`	{ `isSome`: `Bool` ; `value`: `Field` }[]
`delegate`	{ `isSome`: `Bool` ; `value`: `PublicKey` }
`delegate.isSome`	`Bool`
`delegate.value`	`PublicKey`
`permissions`	{ `isSome`: `Bool` ; `value`: { `editSequenceState`: `AuthRequired` ; `editState`: `AuthRequired` ; `incrementNonce`: `AuthRequired` ; `receive`: `AuthRequired` ; `send`: `AuthRequired` ; `setDelegate`: `AuthRequired` ; `setPermissions`: `AuthRequired` ; `setTokenSymbol`: `AuthRequired` ; `setVerificationKey`: `AuthRequired` ; `setVotingFor`: `AuthRequired` ; `setZkappUri`: `AuthRequired` } }
`permissions.isSome`	`Bool`
`permissions.value`	{ `editSequenceState`: `AuthRequired` ; `editState`: `AuthRequired` ; `incrementNonce`: `AuthRequired` ; `receive`: `AuthRequired` ; `send`: `AuthRequired` ; `setDelegate`: `AuthRequired` ; `setPermissions`: `AuthRequired` ; `setTokenSymbol`: `AuthRequired` ; `setVerificationKey`: `AuthRequired` ; `setVotingFor`: `AuthRequired` ; `setZkappUri`: `AuthRequired` }
`permissions.value.editSequenceState`	`AuthRequired`
`permissions.value.editState`	`AuthRequired`
`permissions.value.incrementNonce`	`AuthRequired`
`permissions.value.receive`	`AuthRequired`
`permissions.value.send`	`AuthRequired`
`permissions.value.setDelegate`	`AuthRequired`
`permissions.value.setPermissions`	`AuthRequired`
`permissions.value.setTokenSymbol`	`AuthRequired`
`permissions.value.setVerificationKey`	`AuthRequired`
`permissions.value.setVotingFor`	`AuthRequired`
`permissions.value.setZkappUri`	`AuthRequired`
`timing`	{ `isSome`: `Bool` ; `value`: { `cliffAmount`: `UInt64` ; `cliffTime`: `UInt32` ; `initialMinimumBalance`: `UInt64` ; `vestingIncrement`: `UInt64` ; `vestingPeriod`: `UInt32` } }
`timing.isSome`	`Bool`
`timing.value`	{ `cliffAmount`: `UInt64` ; `cliffTime`: `UInt32` ; `initialMinimumBalance`: `UInt64` ; `vestingIncrement`: `UInt64` ; `vestingPeriod`: `UInt32` }
`timing.value.cliffAmount`	`UInt64`
`timing.value.cliffTime`	`UInt32`
`timing.value.initialMinimumBalance`	`UInt64`
`timing.value.vestingIncrement`	`UInt64`
`timing.value.vestingPeriod`	`UInt32`
`tokenSymbol`	{ `isSome`: `Bool` ; `value`: { `data`: `string` ; `hash`: `Field` } }
`tokenSymbol.isSome`	`Bool`
`tokenSymbol.value`	{ `data`: `string` ; `hash`: `Field` }
`tokenSymbol.value.data`	`string`
`tokenSymbol.value.hash`	`Field`
`verificationKey`	{ `isSome`: `Bool` ; `value`: { `data`: `string` ; `hash`: `Field` } }
`verificationKey.isSome`	`Bool`
`verificationKey.value`	{ `data`: `string` ; `hash`: `Field` }
`verificationKey.value.data`	`string`
`verificationKey.value.hash`	`Field`
`votingFor`	{ `isSome`: `Bool` ; `value`: `Field` }
`votingFor.isSome`	`Bool`
`votingFor.value`	`Field`
`zkappUri`	{ `isSome`: `Bool` ; `value`: { `data`: `string` ; `hash`: `Field` } }
`zkappUri.isSome`	`Bool`
`zkappUri.value`	{ `data`: `string` ; `hash`: `Field` }
`zkappUri.value.data`	`string`
`zkappUri.value.hash`	`Field`

Defined in

lib/party.ts:520

Methods

assertBetween

▸ Static assertBetween<T>(property, lower, upper): void

Constrain a property to lie between lower and upper bounds.

Type parameters

Name
`T`

Parameters

Name	Type	Description
`property`	`ClosedInterval`<`T`>	The property to constrain
`lower`	`T`	The lower bound
`upper`	`T`	The upper bound Example: To constrain the account balance of a SmartContract to lie between 0 and 20 MINA, you can use `ts @method onlyRunsWhenBalanceIsLow() { let lower = UInt64.zero; let upper = UInt64.fromNumber(20e9); Party.assertBetween(this.self.body.accountPrecondition.balance, lower, upper); // ... }`

Returns

void

Defined in

lib/party.ts:546

assertEquals

▸ Static assertEquals<T>(property, value): void

Fix a property to a certain value.

Type parameters

Name
`T`

Parameters

Name	Type	Description
`property`	`ClosedInterval`<`T`> \| `OrIgnore`<`T`>	The property to constrain
`value`	`T`	The value it is fixed to Example: To fix the account nonce of a SmartContract to 0, you can use `ts @method onlyRunsWhenNonceIsZero() { Party.assertEquals(this.self.body.accountPrecondition.nonce, UInt32.zero); // ... }`

Returns

void

Defined in

lib/party.ts:567

clone

▸ Static clone(party): any

Parameters

Name	Type
`party`	`Party`

Returns

any

Defined in

lib/party.ts:502

createSigned

▸ Static createSigned(signer, options?): Party

Parameters

Name	Type
`signer`	`PrivateKey`
`options?`	`Object`
`options.isSameAsFeePayer?`	`boolean` \| `Bool`
`options.nonce?`	`UInt32`

Returns

Defined in

lib/party.ts:679

createUnsigned

▸ Static createUnsigned(publicKey): Party

Parameters

Name	Type
`publicKey`	`PublicKey`

Returns

Defined in

lib/party.ts:661

defaultFeePayer

▸ Static defaultFeePayer(address, key, nonce): FeePayerUnsigned

Parameters

Name	Type
`address`	`PublicKey`
`key`	`PrivateKey`
`nonce`	`UInt32`

Returns

FeePayerUnsigned

Defined in

lib/party.ts:647

defaultParty

▸ Static defaultParty(address): Party

Parameters

Name	Type
`address`	`PublicKey`

Returns

Defined in

lib/party.ts:642

dummyFeePayer

▸ Static dummyFeePayer(): FeePayerUnsigned

Returns

FeePayerUnsigned

Defined in

lib/party.ts:656

fundNewAccount

▸ Static fundNewAccount(feePayerKey, initialBalance?): void

Use this method to pay the account creation fee for another account. Beware that you don't need to pass in the new account! Instead, the protocol will automatically identify accounts in your transaction that need funding.

If you provide an optional initialBalance, this will be subtracted from the fee-paying account as well, but you have to separately ensure that it's added to the new account's balance.

Parameters

Name	Type	Description
`feePayerKey`	`PrivateKey`	the private key of the account that pays the fee
`initialBalance`	`Object`	the initial balance of the new account (default: 0)
`initialBalance.initialBalance`	`undefined` \| `string` \| `number` \| `UInt64`	-
`initialBalance.isSameAsFeePayer`	`undefined` \| `boolean` \| `Bool`	-

Returns

void

Defined in

lib/party.ts:745

getNonce

▸ Static getNonce(party, fallbackToZero?): UInt32

Parameters

Name	Type	Default value
`party`	`Party` \| `FeePayerUnsigned`	`undefined`
`fallbackToZero`	`boolean`	`false`

Returns

Defined in

lib/party.ts:605

setValue

▸ Static setValue<T>(maybeValue, value): void

Type parameters

Name
`T`

Parameters

Name	Type
`maybeValue`	`SetOrKeep`<`T`>
`value`	`T`

Returns

void

Defined in

lib/party.ts:524

signFeePayerInPlace

▸ Static signFeePayerInPlace(feePayer, privateKey?, fallbackToZeroNonce?): void

Parameters

Name	Type	Default value
`feePayer`	`FeePayerUnsigned`	`undefined`
`privateKey?`	`PrivateKey`	`undefined`
`fallbackToZeroNonce`	`boolean`	`false`

Returns

void

Defined in

lib/party.ts:595

snarkyjs / Exports / PrivateKey

Class: PrivateKey

A signing key. You can generate one via random.

Hierarchy

CircuitValue
↳ PrivateKey

Constructors

constructor

Properties

Methods

assertEquals
equals
toBase58
toFields
toJSON
toPublicKey
fromBase58
fromJSON
ofBits
ofFields
random
sizeInFields
toBase58
toConstant
toFields
toJSON

Constructors

constructor

• new PrivateKey(s)

Parameters

Name	Type
`s`	`Scalar`

Overrides

Defined in

lib/signature.ts:10

Properties

s

• s: Scalar

Defined in

lib/signature.ts:8

Methods

assertEquals

▸ assertEquals(this, x): void

Parameters

Name	Type
`this`	`PrivateKey`
`x`	`PrivateKey`

Derives the associated public key.

Returns

PublicKey

a PublicKey.

Defined in

lib/signature.ts:41

fromBase58

▸ Static fromBase58(privateKeyBase58): PrivateKey

Parameters

Name	Type
`privateKeyBase58`	`string`

Returns

PrivateKey

Defined in

lib/signature.ts:45

fromJSON

▸ Static fromJSON<T>(this, value): null | T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

Returns

null | T

Inherited from

Defined in

ofBits

▸ Static ofBits(bs): PrivateKey

Deserializes a list of bits into a PrivateKey.

Parameters

Name	Type	Description
`bs`	`Bool`[]	a list of Bools.

Returns

PrivateKey

a PrivateKey.

Defined in

lib/signature.ts:32

ofFields

▸ Static ofFields<T>(this, xs): T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Returns

T

Inherited from

CircuitValue.ofFields

Defined in

lib/circuit_value.ts:62

random

▸ Static random(): PrivateKey

You can use this method to generate a private key. You can then obtain the associated public key via toPublicKey. And generate signatures via Signature.create.

Returns

PrivateKey

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

snarkyjs / Exports / Proof

Class: Proof

Proofs can be verified using a [[VerificationKey]] and the public input.

Constructors

constructor

Methods

verify

Constructors

constructor

• new Proof()

Methods

verify

▸ verify(verificationKey, publicInput): boolean

Parameters

Name	Type
`verificationKey`	`VerificationKey`
`publicInput`	`any`[]

Returns

boolean

Defined in

snarky.d.ts:683

snarkyjs / Exports / PublicKey

Class: PublicKey

Hierarchy

CircuitValue
↳ PublicKey

Constructors

constructor

Properties

Methods

assertEquals
equals
isEmpty
toBase58
toFields
toJSON
empty
fromBase58
fromJSON
fromPrivateKey
ofFields
sizeInFields
toBase58
toConstant
toFields
toJSON

Constructors

constructor

• new PublicKey(g)

Parameters

Name	Type
`g`	`Group`

Overrides

Defined in

lib/signature.ts:61

Properties

g

• g: Group

Defined in

lib/signature.ts:59

Methods

assertEquals

▸ assertEquals(this, x): void

Parameters

Name	Type
`this`	`PublicKey`
`x`	`PublicKey`

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

Returns

null | T

Inherited from

Defined in

fromPrivateKey

▸ Static fromPrivateKey(p): PublicKey

Parameters

Name	Type
`p`	`PrivateKey`

Returns

PublicKey

Defined in

lib/signature.ts:66

ofFields

▸ Static ofFields<T>(this, xs): T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`t`	`T`

Returns

T

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:76

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

snarkyjs / Exports / Scalar

Class: Scalar

Constructors

constructor

Methods

add
div
mul
neg
sub
toFields
toJSON
fromJSON
ofBits
ofFields
random
sizeInFields
toFields
toJSON

Constructors

constructor

• new Scalar()

Methods

add

▸ add(y): Scalar

Add scalar field elements. Can only be called outside of circuit execution

Parameters

Name	Type
`y`	`Scalar`

Returns

Defined in

snarky.d.ts:568

div

▸ div(y): Scalar

Divide scalar field elements. Can only be called outside of circuit execution

Parameters

Name	Type
`y`	`Scalar`

Returns

Defined in

snarky.d.ts:586

mul

▸ mul(y): Scalar

Multiply scalar field elements. Can only be called outside of circuit execution

Parameters

Name	Type
`y`	`Scalar`

Returns

Defined in

snarky.d.ts:580

neg

▸ neg(): Scalar

Negate a scalar field element. Can only be called outside of circuit execution

Returns

Defined in

snarky.d.ts:562

sub

▸ sub(y): Scalar

Subtract scalar field elements. Can only be called outside of circuit execution

Parameters

Name	Type
`y`	`Scalar`

Returns

Defined in

snarky.d.ts:574

toFields

▸ toFields(this): Field[]

Parameters

Name	Type
`this`	`Scalar`

Parameters

Name	Type
`x`	`Scalar`

Returns

Defined in

snarky.d.ts:596

snarkyjs / Exports / Signature

Class: Signature

Hierarchy

CircuitValue
↳ Signature

Constructors

constructor

Properties

Methods

assertEquals
equals
toFields
toJSON
verify
create
fromJSON
ofFields
sizeInFields
toConstant
toFields
toJSON

Constructors

constructor

• new Signature(r, s)

Parameters

Name	Type
`r`	`Field`
`s`	`Scalar`

Overrides

Defined in

lib/signature.ts:96

Properties

r

• r: Field

Defined in

lib/signature.ts:93

s

• s: Scalar

Defined in

lib/signature.ts:94

Methods

assertEquals

▸ assertEquals(this, x): void

Parameters

Name	Type
`this`	`Signature`
`x`	`Signature`

fromJSON

▸ Static fromJSON<T>(this, value): null | T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

Returns

null | T

Inherited from

Defined in

ofFields

▸ Static ofFields<T>(this, xs): T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Returns

T

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

snarkyjs / Exports / SmartContract

Class: SmartContract

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

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

Constructors

constructor

Properties

_executionState
address
_methods
_provers
_verificationKey

Accessors

account
balance
network
nonce
self

Methods

deploy
executionState
setPermissions
setValue
sign
compile

Constructors

constructor

• new SmartContract(address)

Parameters

Name	Type
`address`	`PublicKey`

Defined in

lib/zkapp.ts:213

▪ Static Optional _verificationKey: Object

Type declaration

Name	Type
`data`	`string`
`hash`	`Field`

Defined in

lib/zkapp.ts:211

Accessors

account

• get account(): PreconditionClassType<AccountPrecondition>

Returns

PreconditionClassType<AccountPrecondition>

Defined in

lib/zkapp.ts:310

balance

• get balance(): Object

Returns

Object

Name	Type
`addInPlace`	(`x`: `string` \| `number` \| `bigint` \| `UInt32` \| `UInt64` \| `Int64`) => `void`
`subInPlace`	(`x`: `string` \| `number` \| `bigint` \| `UInt32` \| `UInt64` \| `Int64`) => `void`

Defined in

lib/zkapp.ts:306

Methods

deploy

▸ deploy(__namedParameters): void

Parameters

Name	Type
`__namedParameters`	`Object`
`__namedParameters.verificationKey?`	`Object`
`__namedParameters.verificationKey.data`	`string`
`__namedParameters.verificationKey.hash`	`string` \| `Field`
`__namedParameters.zkappKey?`	`PrivateKey`

setValue

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

Type parameters

Name
`T`

Parameters

Name	Type
`maybeValue`	`SetOrKeep`<`T`>
`value`	`T`

Defined in

lib/zkapp.ts:217

snarkyjs / Exports / UInt32

Class: UInt32

Hierarchy

CircuitValue
↳ UInt32

Implements

UInt32

Constructors

constructor

Properties

_type
value
NUM_BITS

Accessors

one
zero

Methods

Constructors

constructor

• new UInt32(value)

Parameters

Name	Type
`value`	`Field`

Overrides

Defined in

lib/int.ts:185

one

• Static get one(): UInt32

Returns

Defined in

lib/int.ts:194

zero

• Static get zero(): UInt32

Returns

Defined in

lib/int.ts:190

Methods

add

▸ add(y): UInt32

Parameters

Name	Type
`y`	`number` \| `UInt32`

Returns

Defined in

lib/int.ts:292

assertEquals

▸ assertEquals(this, x): void

Parameters

Name	Type
`this`	`UInt32`
`x`	`UInt32`

Parameters

Name	Type
`y`	`string` \| `number` \| `UInt32`

Returns

Object

Name	Type
`quotient`	`UInt32`
`rest`	`UInt32`

Defined in

lib/int.ts:242

equals

▸ equals(this, x): Bool

Parameters

Name	Type
`this`	`UInt32`
`x`	`UInt32`

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Returns

T

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

snarkyjs / Exports / UInt64

Class: UInt64

Hierarchy

CircuitValue
↳ UInt64

Implements

UInt64

Constructors

constructor

Properties

_type
value
NUM_BITS

Accessors

one
zero

Methods

Constructors

constructor

• new UInt64(value)

Parameters

Name	Type
`value`	`Field`

Overrides

Defined in

lib/int.ts:11

one

• Static get one(): UInt64

Returns

Defined in

lib/int.ts:20

zero

• Static get zero(): UInt64

Returns

Defined in

lib/int.ts:16

Methods

add

▸ add(y): UInt64

Addition with overflow checking.

Parameters

Name	Type
`y`	`number` \| `UInt64`

Returns

Defined in

lib/int.ts:132

assertEquals

▸ assertEquals(this, x): void

Parameters

Name	Type
`this`	`UInt64`
`x`	`UInt64`

Integer division.

x.div(y) returns the floor of x / y, that is, the greatest z such that x * y <= x.

Parameters

Name	Type
`y`	`number` \| `UInt64`

Returns

Defined in

lib/int.ts:106

divMod

▸ divMod(y): Object

Parameters

Name	Type
`y`	`string` \| `number` \| `UInt64`

Returns

Object

Name	Type
`quotient`	`UInt64`
`rest`	`UInt64`

Defined in

lib/int.ts:63

equals

▸ equals(this, x): Bool

Parameters

Name	Type
`this`	`UInt64`
`x`	`UInt64`

mod

▸ mod(y): UInt64

Integer remainder.

x.mod(y) returns the value z such that 0 <= z < y and x - z is divisble by y.

Parameters

Name	Type
`y`	`number` \| `UInt64`

Returns

Defined in

lib/int.ts:116

mul

▸ mul(y): UInt64

Multiplication with overflow checking.

Parameters

Name	Type
`y`	`number` \| `UInt64`

Returns

Defined in

lib/int.ts:123

sub

▸ sub(y): UInt64

Subtraction with underflow checking.

Parameters

Name	Type
`y`	`number` \| `UInt64`

fromJSON

▸ Static fromJSON<T>(this, value): null | T

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`value`	`JSONValue`

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`xs`	`Field`[]

Returns

T

toFields

▸ Static toFields<T>(this, v): Field[]

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

toJSON

▸ Static toJSON<T>(this, v): JSONValue

Type parameters

Name
`T`

Parameters

Name	Type
`this`	`Constructor`<`T`>
`v`	`T`

Returns

Inherited from

Defined in

snarky/gen/js-layout.ts:4

snarkyjs / Exports / VerificationKey

Class: VerificationKey

Part of the circuit [[Keypair]]. A verification key can be used to verify a [[Proof]] when you provide the correct public input.

Constructors

constructor

Methods

verify

Constructors

constructor

• new VerificationKey()

Methods

verify

▸ verify(publicInput, proof): boolean

Parameters

Name	Type
`publicInput`	`any`[]
`proof`	`Proof`

Returns

boolean

Defined in

snarky.d.ts:669

Interfaces

snarkyjs / Exports / AsFieldElements

Interface: AsFieldElements<T>

Type parameters

Name
`T`

Methods

check
ofFields
sizeInFields
toFields

Methods

check

▸ Optional check(x): void

Parameters

Name	Type
`x`	`T`

Defined in

snarky.d.ts:471

snarkyjs / Exports / Body

Interface: Body

The body of describing how some [[Party]] should change.

TODO: We need to rename this still.

Hierarchy

PartyBody
↳ Body

Properties

balanceChange
callData
callDepth
caller
events
incrementNonce
preconditions
publicKey
sequenceEvents
tokenId
update
useFullCommitment

Properties

balanceChange

• balanceChange: Int64

Overrides

PartyBody.publicKey

Defined in

lib/party.ts:265

sequenceEvents

useFullCommitment

• useFullCommitment: Bool

Overrides

PartyBody.useFullCommitment

Defined in

lib/party.ts:295

snarkyjs / Exports / CircuitMain

Interface: CircuitMain<W, P>

Type parameters

Name
`W`
`P`

Properties

snarkyPublicTyp
snarkyWitnessTyp

Methods

snarkyMain

Properties

snarkyPublicTyp

• snarkyPublicTyp: AsFieldElements<P>

Defined in

snarky.d.ts:479

snarkyWitnessTyp

• snarkyWitnessTyp: AsFieldElements<W>

Defined in

snarky.d.ts:478

Methods

snarkyMain

▸ snarkyMain(w, p): void

Parameters

Name	Type
`w`	`W`
`p`	`P`

Returns

void

Defined in

snarky.d.ts:480

snarkyjs / Exports / Permissions

Interface: Permissions

Permissions specify how specific aspects of the zkapp account are allowed to be modified. All fields are denominated by a [[Permission]].

Hierarchy

Permissions_
↳ Permissions

Properties

editSequenceState
editState
incrementNonce
receive
send
setDelegate
setPermissions
setTokenSymbol
setVerificationKey
setVotingFor
setZkappUri

Properties

editSequenceState

• editSequenceState: AuthRequired

The [[Permission]] corresponding to the ability to change the sequence state associated with the account.

TODO: Define sequence state here as well.

Overrides

Permissions_.editSequenceState

Defined in

lib/party.ts:174

editState

• editState: AuthRequired

The [[Permission]] corresponding to the 8 state fields associated with an account.

Overrides

Permissions_.editState

Defined in

lib/party.ts:127

• setVotingFor: AuthRequired

Overrides

Permissions_.setVotingFor

Defined in

lib/party.ts:184

setZkappUri

• setZkappUri: AuthRequired

The [[Permission]] corresponding to the ability to set the zkapp uri typically pointing to the source code of the smart contract. Usually this should be changed whenever the [[Permissions.setVerificationKey]] is changed. Effectively "upgradability" of the smart contract.

Overrides

Permissions_.setZkappUri

Defined in

lib/party.ts:166

snarkyjs / Exports

Type Aliases

DeployArgs

Ƭ DeployArgs: Object

Type declaration

Name	Type
`verificationKey?`	{ `data`: `string` ; `hash`: `string` \| `Field` }
`verificationKey.data`	`string`
`verificationKey.hash`	`string` \| `Field`
`zkappKey?`	`PrivateKey`

Defined in

lib/zkapp.ts:349

FeePayerUnsigned

Ƭ FeePayerUnsigned: Object

Type declaration

Name	Type
`authorization`	`UnfinishedSignature` \| `string`
`body`	`FeePayerBody`

One specific permission value.

A [[Permission]] tells one specific permission for our zkapp how it should behave when presented with requested modifications.

Use static factory methods on this class to use a specific behavior. See documentation on those methods to learn more.

Defined in

lib/party.ts:67

Preconditions

Ƭ Preconditions: PartyBody["preconditions"]

Preconditions for the network and accounts

Defined in

lib/party.ts:39

SetOrKeep

Ƭ SetOrKeep<T>: Object

Either set a value or keep it the same.

Type parameters

Name
`T`

Type declaration

Name	Type
`isSome`	`Bool`
`value`	`T`

Defined in

lib/party.ts:49

State

Ƭ State<A>: Object

Gettable and settable state that can be checked for equality.

Type parameters

Name
`A`

Type declaration

Name	Type
`assertEquals`	(`a`: `A`) => `void`
`fetch`	() => `Promise`<`undefined` \| `A`>
`get`	() => `A`
`set`	(`a`: `A`) => `void`

Defined in

lib/state.ts:14

Variables

Body

• Body: Object

Type declaration

Name	Type
`dummy`	() => `Body`
`keepAll`	(`publicKey`: `PublicKey`) => `Body`
`noUpdate`	() => { `appState`: { `isSome`: `Bool` ; `value`: `Field` }[] ; `delegate`: { `isSome`: `Bool` ; `value`: `PublicKey` } ; `permissions`: { `isSome`: `Bool` ; `value`: { `editSequenceState`: `AuthRequired` ; `editState`: `AuthRequired` ; `incrementNonce`: `AuthRequired` ; `receive`: `AuthRequired` ; `send`: `AuthRequired` ; `setDelegate`: `AuthRequired` ; `setPermissions`: `AuthRequired` ; `setTokenSymbol`: `AuthRequired` ; `setVerificationKey`: `AuthRequired` ; `setVotingFor`: `AuthRequired` ; `setZkappUri`: `AuthRequired` } } ; `timing`: { `isSome`: `Bool` ; `value`: { `cliffAmount`: `UInt64` ; `cliffTime`: `UInt32` ; `initialMinimumBalance`: `UInt64` ; `vestingIncrement`: `UInt64` ; `vestingPeriod`: `UInt32` } } ; `tokenSymbol`: { `isSome`: `Bool` ; `value`: { `data`: `string` ; `hash`: `Field` } } ; `verificationKey`: { `isSome`: `Bool` ; `value`: { `data`: `string` ; `hash`: `Field` } } ; `votingFor`: { `isSome`: `Bool` ; `value`: `Field` } ; `zkappUri`: { `isSome`: `Bool` ; `value`: { `data`: `string` ; `hash`: `Field` } } }

Defined in

lib/party.ts:298

Permission

• Permission: Object

Type declaration

Name	Type
`impossible`	() => `AuthRequired`
`none`	() => `AuthRequired`
`proof`	() => `AuthRequired`
`proofOrSignature`	() => `AuthRequired`
`signature`	() => `AuthRequired`

Defined in

lib/party.ts:68

Permissions

• Permissions: Object

Type declaration

Name	Type
`default`	() => `Permissions`
`impossible`	() => `AuthRequired`
`initial`	() => `Permissions`
`none`	() => `AuthRequired`
`proof`	() => `AuthRequired`
`proofOrSignature`	() => `AuthRequired`
`signature`	() => `AuthRequired`

Defined in

lib/party.ts:186

Pickles

• Const Pickles: Object

Type declaration

Name	Type
`compile`	(`rules`: [`0`, `string`, (`statement`: `Statement`) => `void`][]) => { `provers`: (`statement`: `Statement`) => `Promise`<`unknown`>[] ; `getVerificationKeyArtifact`: () => { `data`: `string` ; `hash`: `string` } ; `verify`: (`statement`: `Statement`, `proof`: `unknown`) => `Promise`<`boolean`> }
`proofToString`	(`proof`: `unknown`) => `string`

Defined in

snarky.d.ts:762

Poseidon

• Const Poseidon: Object

Type declaration

Name	Type
`Sponge`	typeof `Sponge`
`hash`	(`xs`: `Field`[]) => `Field`

Defined in

snarky.d.ts:660

Preconditions

• Preconditions: Object

Type declaration

Name Type

ignoreAll () => { account: { balance: { lower: UInt64 ; upper: UInt64 } ; delegate: { isSome: Bool ; value: PublicKey } ; nonce: { lower: UInt32 ; upper: UInt32 } ; provedState: { isSome: Bool ; value: Bool } ; receiptChainHash: { isSome: Bool ; value: Field } ; sequenceState: Field ; state: { isSome: Bool ; value: Field }[] } ; network: { blockchainLength: { lower: UInt32 ; upper: UInt32 } ; globalSlotSinceGenesis: { lower: UInt32 ; upper: UInt32 } ; globalSlotSinceHardFork: { lower: UInt32 ; upper: UInt32 } ; minWindowDensity: { lower: UInt32 ; upper: UInt32 } ; nextEpochData: { epochLength: { lower: UInt32 ; upper: UInt32 } ; ledger: { hash: { isSome: Bool ; value: Field } ; totalCurrency: { 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: { lower: UInt32 ; upper: UInt32 } ; ledger: { hash: { isSome: Bool ; value: Field } ; totalCurrency: { lower: UInt64 ; upper: UInt64 } } ; lockCheckpoint: { isSome: Bool ; value: Field } ; seed: { isSome: Bool ; value: Field } ; startCheckpoint: { isSome: Bool ; value: Field } } ; timestamp: { lower: UInt64 ; upper: UInt64 } ; totalCurrency: { lower: UInt64 ; upper: UInt64 } } }

Defined in

lib/party.ts:461

ZkappStateLength

• Const ZkappStateLength: 8

Defined in

lib/party.ts:31

isReady

• isReady: Promise<undefined>

A Promise that resolves when SnarkyJS is ready to be used

Defined in

snarky.d.ts:758

jsLayout

• jsLayout: Object

Type declaration

Name	Type
`Parties`	{ `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'feePayer'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'body'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'publicKey'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'PublicKey' } } \| { `docs`: `null` = null; `key`: `string` = 'update'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'appState'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'delegate'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'PublicKey' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'verificationKey'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'VerificationKeyWithHash'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'zkappUri'; `value`: { `inner`: { `checkedType`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'StringWithHash'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'string' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'PartyUpdate'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'events'; `value`: { `checkedType`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: `undefined` ; `type`: `string` = 'Field' } })[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'Events'; `docs`: `undefined` = null; `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'networkPrecondition'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'snarkedLedgerHash'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'timestamp'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BlockTimeInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'stakingEpochData'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'ledger'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'totalCurrency'; `value`: { `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'CurrencyAmountInterval'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochLedgerPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'seed'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'epochLength'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt32' } }[] ; `name`: `string` = 'LengthInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochDataPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'NetworkPrecondition'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'FeePayerPartyBody'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'authorization'; `value`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'string' } })[] ; `name`: `string` = 'ZkappPartyFeePayer'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'otherParties'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `string` = 'A party to a zkApp transaction'; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'body'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'publicKey'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'PublicKey' } } \| { `docs`: `null` = null; `key`: `string` = 'update'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'appState'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'delegate'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'PublicKey' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'verificationKey'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'VerificationKeyWithHash'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'zkappUri'; `value`: { `inner`: { `checkedType`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'StringWithHash'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'string' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'PartyUpdate'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'balanceChange'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'magnitude'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BalanceChange'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'events'; `value`: { `checkedType`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: `undefined` ; `type`: `string` = 'Field' } })[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'Events'; `docs`: `undefined` = null; `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'preconditions'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'network'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'snarkedLedgerHash'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'timestamp'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BlockTimeInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'stakingEpochData'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'ledger'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'totalCurrency'; `value`: { `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'CurrencyAmountInterval'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochLedgerPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'seed'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'epochLength'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt32' } }[] ; `name`: `string` = 'LengthInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochDataPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'NetworkPrecondition'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'account'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'balance'; `value`: { `inner`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BalanceInterval'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'receiptChainHash'; `value`: { `inner`: { `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'state'; `value`: { `inner`: { `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } })[] ; `name`: `string` = 'AccountPrecondition'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'Preconditions'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'PartyBody'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'authorization'; `value`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'proof'; `value`: { `inner`: { `type`: `string` = 'string' } ; `optionType`: `string` = 'orUndefined'; `type`: `string` = 'option' } }[] ; `name`: `string` = 'Control'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'ZkappParty'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'memo'; `value`: { `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'string' } })[] ; `name`: `string` = 'Parties'; `type`: `string` = 'object' }
`Parties.docs`	`null`
`Parties.layout`	({ `docs`: `null` = null; `key`: `string` = 'feePayer'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'body'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'publicKey'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'PublicKey' } } \| { `docs`: `null` = null; `key`: `string` = 'update'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'appState'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'delegate'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'PublicKey' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'verificationKey'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'VerificationKeyWithHash'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'zkappUri'; `value`: { `inner`: { `checkedType`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'StringWithHash'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'string' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'PartyUpdate'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'events'; `value`: { `checkedType`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: `undefined` ; `type`: `string` = 'Field' } })[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'Events'; `docs`: `undefined` = null; `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'networkPrecondition'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'snarkedLedgerHash'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'timestamp'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BlockTimeInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'stakingEpochData'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'ledger'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'totalCurrency'; `value`: { `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'CurrencyAmountInterval'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochLedgerPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'seed'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'epochLength'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt32' } }[] ; `name`: `string` = 'LengthInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochDataPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'NetworkPrecondition'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'FeePayerPartyBody'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'authorization'; `value`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'string' } })[] ; `name`: `string` = 'ZkappPartyFeePayer'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'otherParties'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `string` = 'A party to a zkApp transaction'; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'body'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'publicKey'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'PublicKey' } } \| { `docs`: `null` = null; `key`: `string` = 'update'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'appState'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'delegate'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'PublicKey' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'verificationKey'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'VerificationKeyWithHash'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'zkappUri'; `value`: { `inner`: { `checkedType`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'StringWithHash'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'string' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'PartyUpdate'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'balanceChange'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'magnitude'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BalanceChange'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'events'; `value`: { `checkedType`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: `undefined` ; `type`: `string` = 'Field' } })[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'Events'; `docs`: `undefined` = null; `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'preconditions'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'network'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'snarkedLedgerHash'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'timestamp'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BlockTimeInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'stakingEpochData'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'ledger'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'totalCurrency'; `value`: { `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'CurrencyAmountInterval'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochLedgerPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'seed'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'epochLength'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt32' } }[] ; `name`: `string` = 'LengthInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochDataPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'NetworkPrecondition'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'account'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'balance'; `value`: { `inner`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BalanceInterval'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'receiptChainHash'; `value`: { `inner`: { `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'state'; `value`: { `inner`: { `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } })[] ; `name`: `string` = 'AccountPrecondition'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'Preconditions'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'PartyBody'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'authorization'; `value`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'proof'; `value`: { `inner`: { `type`: `string` = 'string' } ; `optionType`: `string` = 'orUndefined'; `type`: `string` = 'option' } }[] ; `name`: `string` = 'Control'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'ZkappParty'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'memo'; `value`: { `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'string' } })[]
`Parties.name`	`string`
`Parties.type`	`string`
`Party`	{ `docs`: `string` = 'A party to a zkApp transaction'; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'body'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'publicKey'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'PublicKey' } } \| { `docs`: `null` = null; `key`: `string` = 'update'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'appState'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'delegate'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'PublicKey' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'verificationKey'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'VerificationKeyWithHash'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'zkappUri'; `value`: { `inner`: { `checkedType`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'StringWithHash'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'string' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'PartyUpdate'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'balanceChange'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'magnitude'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BalanceChange'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'events'; `value`: { `checkedType`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: `undefined` ; `type`: `string` = 'Field' } })[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'Events'; `docs`: `undefined` = null; `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'preconditions'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'network'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'snarkedLedgerHash'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'timestamp'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BlockTimeInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'stakingEpochData'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'ledger'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'totalCurrency'; `value`: { `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'CurrencyAmountInterval'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochLedgerPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'seed'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'epochLength'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt32' } }[] ; `name`: `string` = 'LengthInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochDataPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'NetworkPrecondition'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'account'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'balance'; `value`: { `inner`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BalanceInterval'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'receiptChainHash'; `value`: { `inner`: { `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'state'; `value`: { `inner`: { `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } })[] ; `name`: `string` = 'AccountPrecondition'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'Preconditions'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'PartyBody'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'authorization'; `value`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'proof'; `value`: { `inner`: { `type`: `string` = 'string' } ; `optionType`: `string` = 'orUndefined'; `type`: `string` = 'option' } }[] ; `name`: `string` = 'Control'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'ZkappParty'; `type`: `string` = 'object' }
`Party.docs`	`string`
`Party.layout`	({ `docs`: `null` = null; `key`: `string` = 'body'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'publicKey'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'PublicKey' } } \| { `docs`: `null` = null; `key`: `string` = 'update'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'appState'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'delegate'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'PublicKey' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'verificationKey'; `value`: { `inner`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'VerificationKeyWithHash'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'zkappUri'; `value`: { `inner`: { `checkedType`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `type`: `string` = 'string' } }[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'StringWithHash'; `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'string' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'PartyUpdate'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'balanceChange'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'magnitude'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BalanceChange'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'events'; `value`: { `checkedType`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'data'; `value`: { `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: `undefined` ; `type`: `string` = 'Field' } })[] ; `name`: `string` = 'Events'; `type`: `string` = 'object' } ; `checkedTypeName`: `string` = 'Events'; `docs`: `undefined` = null; `inner`: { `inner`: { `type`: `string` = 'Field' } ; `type`: `string` = 'array' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'array' } } \| { `docs`: `null` = null; `key`: `string` = 'preconditions'; `value`: { `checkedType`: `undefined` ; `checkedTypeName`: `undefined` = 'Events'; `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'network'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'snarkedLedgerHash'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'timestamp'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BlockTimeInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'stakingEpochData'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'ledger'; `value`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'hash'; `value`: { `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'totalCurrency'; `value`: { `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'CurrencyAmountInterval'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochLedgerPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'seed'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `undefined` = null; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'epochLength'; `value`: { `docs`: `undefined` = null; `inner`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt32' } }[] ; `name`: `string` = 'LengthInterval'; `type`: `string` = 'object' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } })[] ; `name`: `string` = 'EpochDataPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'NetworkPrecondition'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'account'; `value`: { `docs`: `null` = null; `layout`: ({ `docs`: `null` = null; `key`: `string` = 'balance'; `value`: { `inner`: { `docs`: `null` = null; `inner`: `undefined` ; `layout`: { `docs`: `null` = null; `key`: `string` = 'lower'; `value`: { `type`: `string` = 'UInt64' } }[] ; `name`: `string` = 'BalanceInterval'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'object' } ; `optionType`: `string` = 'implicit'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'receiptChainHash'; `value`: { `inner`: { `docs`: `undefined` = null; `inner`: `undefined` ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'Field' } ; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } } \| { `docs`: `null` = null; `key`: `string` = 'state'; `value`: { `inner`: { `docs`: `undefined` = null; `inner`: { `type`: `string` = 'Field' } ; `layout`: `undefined` ; `name`: `undefined` = 'NetworkPrecondition'; `optionType`: `string` = 'flaggedOption'; `type`: `string` = 'option' } ; `optionType`: `undefined` = 'flaggedOption'; `type`: `string` = 'array' } })[] ; `name`: `string` = 'AccountPrecondition'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'Preconditions'; `type`: `string` = 'object' } })[] ; `name`: `string` = 'PartyBody'; `type`: `string` = 'object' } } \| { `docs`: `null` = null; `key`: `string` = 'authorization'; `value`: { `docs`: `null` = null; `layout`: { `docs`: `null` = null; `key`: `string` = 'proof'; `value`: { `inner`: { `type`: `string` = 'string' } ; `optionType`: `string` = 'orUndefined'; `type`: `string` = 'option' } }[] ; `name`: `string` = 'Control'; `type`: `string` = 'object' } })[]
`Party.name`	`string`
`Party.type`	`string`

Defined in

Functions

State

▸ State<A>(): State<A>

Type parameters

Name
`A`

Type parameters

Name
`T`

Parameters

Name	Type
`elementType`	`AsFieldElements`<`T`>
`length`	`number`

Returns

fn

▸ (target, key): void

Parameters

Name	Type
`target`	`any`
`key`	`string`

Returns

void

Defined in

lib/circuit_value.ts:178

asFieldElementsToConstant

▸ asFieldElementsToConstant<T>(typ, t): T

Type parameters

Name
`T`

Parameters

Name	Type
`typ`	`AsFieldElements`<`T`>
`t`	`T`

Returns

T

Defined in

lib/circuit_value.ts:18

circuitMain

▸ circuitMain(target, propertyName, _descriptor?): any

Parameters

Name	Type
`target`	`any`
`propertyName`	`string`
`_descriptor?`	`PropertyDescriptor`

Returns

any

Defined in

lib/circuit_value.ts:243

circuitValueEquals

▸ circuitValueEquals<T>(a, b): boolean

Type parameters

Name
`T`

Parameters

Name	Type
`a`	`T`
`b`	`T`

Returns

boolean

Defined in

lib/circuit_value.ts:312

cloneCircuitValue

▸ cloneCircuitValue<T>(obj): T

Type parameters

Name
`T`

Parameters

Name	Type
`obj`	`T`

Returns

T

Defined in

lib/circuit_value.ts:282

declareMethods

▸ declareMethods<T>(SmartContract, methodArguments): void

declareMethods can be used in place of the @method decorator to declare SmartContract methods along with their list of arguments. It should be placed after the class declaration. Here is an example of declaring a method update, which takes a single argument of type Field:

class MyContract extends SmartContract {
  // ...
  update(x: Field) {
    // ...
  }
}
declareMethods(MyContract, { update: [Field] }); // `[Field]` is the list of arguments!

Note that a method of the same name must still be defined on the class, just without the decorator.

Type parameters

Name	Type
`T`	extends typeof `SmartContract`

Parameters

Name	Type
`SmartContract`	`T`
`methodArguments`	`Record`<`string`, `AsFieldElements`<`unknown`>[]>

Returns

void

Defined in

lib/zkapp.ts:500

declareState

▸ declareState<T>(SmartContract, states): void

declareState can be used in place of the @state decorator to declare on-chain state on a SmartContract. It should be placed after the class declaration. Here is an example of declaring a state property x of type Field.

class MyContract extends SmartContract {
  x = State<Field>();
  // ...
}
declareState(MyContract, { x: Field });

If you're using pure JS, it's not possible to use the built-in class field syntax, i.e. the following will not work:

// THIS IS WRONG IN JS!
class MyContract extends SmartContract {
  x = State();
}
declareState(MyContract, { x: Field });

Instead, add a constructor where you assign the property:

class MyContract extends SmartContract {
  constructor(x) {
    super();
    this.x = State();
  }
}
declareState(MyContract, { x: Field });

Type parameters

Name	Type
`T`	extends typeof `SmartContract`

Parameters

Name	Type
`SmartContract`	`T`
`states`	`Record`<`string`, `AsFieldElements`<`unknown`>>

Returns

void

Defined in

lib/state.ts:107

deploy

▸ deploy<S>(SmartContract, __namedParameters): Promise<string>

Type parameters

Name	Type
`S`	extends typeof `SmartContract`

Parameters

Name	Type
`SmartContract`	`S`
`__namedParameters`	`Object`
`__namedParameters.feePayerKey?`	`PrivateKey`
`__namedParameters.feePayerNonce?`	`string` \| `number`
`__namedParameters.initialBalance?`	`string` \| `number`
`__namedParameters.memo?`	`string`
`__namedParameters.shouldSignFeePayer?`	`boolean`
`__namedParameters.transactionFee?`	`string` \| `number`
`__namedParameters.verificationKey`	`Object`
`__namedParameters.verificationKey.data`	`string`
`__namedParameters.verificationKey.hash`	`string` \| `Field`
`__namedParameters.zkappKey`	`PrivateKey`

Returns

Promise<string>

Defined in

lib/zkapp.ts:363

fetchAccount

▸ fetchAccount(publicKey, graphqlEndpoint?, config?): Promise<{ account: Account ; error: undefined } | { account: undefined ; error: FetchError }>

Gets account information on the specified publicKey by performing a GraphQL query to the specified endpoint. This will call the 'GetAccountInfo' query which fetches zkapp related account information.

If an error is returned by the specified endpoint, an error is thrown. Otherwise, the data is returned.

Parameters

Name	Type	Default value	Description
`publicKey`	`string` \| `PublicKey`	`undefined`	The specified account to get account information on
`graphqlEndpoint`	`string`	`defaultGraphqlEndpoint`	The graphql endpoint to fetch from
`config`	`Object`	`{}`	An object that exposes an additional timeout option
`config.timeout`	`undefined` \| `number`	`undefined`	-

Returns

Promise<{ account: Account ; error: undefined } | { account: undefined ; error: FetchError }>

zkapp information on the specified account or an error is thrown

Defined in

lib/fetch.ts:43

fetchLastBlock

▸ fetchLastBlock(graphqlEndpoint?): Promise<PreconditionBaseTypes<{ blockchainLength: { lower: UInt32 ; upper: UInt32 } ; globalSlotSinceGenesis: { lower: UInt32 ; upper: UInt32 } ; globalSlotSinceHardFork: { lower: UInt32 ; upper: UInt32 } ; minWindowDensity: { lower: UInt32 ; upper: UInt32 } ; nextEpochData: { epochLength: { lower: UInt32 ; upper: UInt32 } ; ledger: { hash: { isSome: Bool ; value: Field } ; totalCurrency: { 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: { lower: UInt32 ; upper: UInt32 } ; ledger: { hash: { isSome: Bool ; value: Field } ; totalCurrency: { lower: UInt64 ; upper: UInt64 } } ; lockCheckpoint: { isSome: Bool ; value: Field } ; seed: { isSome: Bool ; value: Field } ; startCheckpoint: { isSome: Bool ; value: Field } } ; timestamp: { lower: UInt64 ; upper: UInt64 } ; totalCurrency: { lower: UInt64 ; upper: UInt64 } }>>

Parameters

Name	Type	Default value
`graphqlEndpoint`	`string`	`defaultGraphqlEndpoint`

Returns

Promise<PreconditionBaseTypes<{ blockchainLength: { lower: UInt32 ; upper: UInt32 } ; globalSlotSinceGenesis: { lower: UInt32 ; upper: UInt32 } ; globalSlotSinceHardFork: { lower: UInt32 ; upper: UInt32 } ; minWindowDensity: { lower: UInt32 ; upper: UInt32 } ; nextEpochData: { epochLength: { lower: UInt32 ; upper: UInt32 } ; ledger: { hash: { isSome: Bool ; value: Field } ; totalCurrency: { 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: { lower: UInt32 ; upper: UInt32 } ; ledger: { hash: { isSome: Bool ; value: Field } ; totalCurrency: { lower: UInt64 ; upper: UInt64 } } ; lockCheckpoint: { isSome: Bool ; value: Field } ; seed: { isSome: Bool ; value: Field } ; startCheckpoint: { isSome: Bool ; value: Field } } ; timestamp: { lower: UInt64 ; upper: UInt64 } ; totalCurrency: { lower: UInt64 ; upper: UInt64 } }>>

Defined in

lib/fetch.ts:349

getSrs

▸ getSrs(keypair): typeof WasmFpSrs

Parameters

Name	Type	Description
`keypair`	`Keypair`	SNARK keypair, as returned by Circuit.generateKeypair

Returns

typeof WasmFpSrs

The SRS (structured reference string), needed to reconstruct the keypair later

Defined in

snarky/addons.js:18

matrixProp

▸ matrixProp<T>(elementType, nRows, nColumns): (target: any, key: string) => void

Type parameters

Name
`T`

Parameters

Name	Type
`elementType`	`AsFieldElements`<`T`>
`nRows`	`number`
`nColumns`	`number`

Returns

fn

▸ (target, key): void

Parameters

Name	Type
`target`	`any`
`key`	`string`

Returns

void

Defined in

lib/circuit_value.ts:187

method

▸ method<T>(target, methodName, descriptor): void

A decorator to use in a zkapp to mark a method as callable by anyone. You can use inside your zkapp class as:

@method myMethod(someArg: Field) {
 // your code here
}

Type parameters

Name	Type
`T`	extends `SmartContract`<`T`>

Parameters

Name	Type
`target`	`T` & { `constructor`: `any` }
`methodName`	keyof `T` & `string`
`descriptor`	`PropertyDescriptor`

Returns

void

Defined in

lib/zkapp.ts:46

parseFetchedAccount

▸ parseFetchedAccount(account): Account

Parameters

Name	Type
`account`	`FetchedAccount`

Returns

Account

Defined in

lib/fetch.ts:196

▸ parseFetchedAccount(account): Partial<Account>

Parameters

Name	Type
`account`	`Partial`<`FetchedAccount`>

Parameters

Name	Type	Description
`srs`	typeof `WasmFpSrs`	the "structured reference string", a set of precomputed values needed for verifying proofs
`serializedVk`	`string`	string representation of a Circuit verification key

Returns

VerificationKey

the recovered verification key

Defined in

snarky/addons.js:49

sendZkapp

▸ sendZkapp(json, graphqlEndpoint?, __namedParameters?): Promise<[FetchResponse, undefined] | [undefined, FetchError]>

Parameters

Name	Type	Default value
`json`	`string`	`undefined`
`graphqlEndpoint`	`string`	`defaultGraphqlEndpoint`
`__namedParameters`	`Object`	`{}`
`__namedParameters.timeout`	`undefined` \| `number`	`undefined`

Returns

Promise<[FetchResponse, undefined] | [undefined, FetchError]>

Defined in

lib/fetch.ts:493

sendZkappQuery

▸ sendZkappQuery(json): string

Parameters

Name	Type
`json`	`string`

Returns

string

Defined in

lib/fetch.ts:504

serializeVerificationKey

▸ serializeVerificationKey(verificationKey): string

Parameters

Name	Type	Description
`verificationKey`	`VerificationKey`	the verification key of a Circuit

Returns

string

string representation of the verification key

Defined in

snarky/addons.js:27

setGraphqlEndpoint

▸ setGraphqlEndpoint(graphqlEndpoint): void

Parameters

Name	Type
`graphqlEndpoint`	`string`

Returns

void

Defined in

lib/fetch.ts:26

shutdown

▸ shutdown(): Promise<undefined>

This function must be called at the end of a nodejs program, otherwise the worker threads will continue running and the program will never terminate. From web applications, this function is a no-op.

Returns

Promise<undefined>

Defined in

snarky.d.ts:753

signFeePayer

▸ signFeePayer(transactionJson, feePayerKey, __namedParameters): string

Parameters

Name	Type
`transactionJson`	`string`
`feePayerKey`	`string` \| `PrivateKey`
`__namedParameters`	`Object`

Returns

string

Defined in

lib/zkapp.ts:458

signJsonTransaction

▸ signJsonTransaction(transactionJson, privateKey): string

Sign all parties of a transaction which belong to the account determined by [[privateKey]].

Parameters

Name	Type
`transactionJson`	`string`
`privateKey`	`string` \| `PrivateKey`

Returns

string

the modified transaction JSON

Defined in

lib/party.ts:930

state

▸ state<A>(stateType): (target: SmartContract & { constructor: any }, key: string, _descriptor?: PropertyDescriptor) => void

A decorator to use within a zkapp to indicate what will be stored on-chain. For example, if you want to store a field element some_state in a zkapp, you can use the following in the declaration of your zkapp:

@state(Field) some_state = State<Field>();

Type parameters

Name
`A`

Parameters

Name	Type
`stateType`	`AsFieldElements`<`A`>

Returns

fn

▸ (target, key, _descriptor?): void

Parameters

Name	Type
`target`	`SmartContract` & { `constructor`: `any` }
`key`	`string`
`_descriptor?`	`PropertyDescriptor`

Returns

void

Defined in

lib/state.ts:34

toPartiesUnsafe

▸ toPartiesUnsafe(__namedParameters): Parties

Parameters

Name	Type
`__namedParameters`	`Object`
`__namedParameters.feePayer`	`FeePayerUnsigned`
`__namedParameters.memo`	`string`
`__namedParameters.otherParties`	`Party`[]

Returns

Parties

Defined in

lib/party.ts:790

toPartyUnsafe

▸ toPartyUnsafe(__namedParameters): Party

Parameters

Name	Type
`__namedParameters`	`Party`

Returns

Defined in

lib/party.ts:784

Modules

snarkyjs / Exports / Encoding

Namespace: Encoding

Variables

Bijective

Functions

bytesFromFields
bytesToFields
stringFromFields
stringToFields

Variables

Bijective

• Const Bijective: Object

Type declaration

Name	Type
`Fp`	{ `fromBytes`: (`bytes`: `Uint8Array`) => `Field`[] ; `toBytes`: (`fields`: `Field`[]) => `Uint8Array` ; `fromString`: (`message`: `string`) => `Field`[] ; `toString`: (`fields`: `Field`[]) => `string` }
`Fp.fromBytes`	(`bytes`: `Uint8Array`) => `Field`[]
`Fp.toBytes`	(`fields`: `Field`[]) => `Uint8Array`
`Fp.fromString`	[object Object]
`Fp.toString`	[object Object]
`Fq`	{ `fromBytes`: (`bytes`: `Uint8Array`) => `Field`[] ; `toBytes`: (`fields`: `Field`[]) => `Uint8Array` ; `fromString`: (`message`: `string`) => `Field`[] ; `toString`: (`fields`: `Field`[]) => `string` }
`Fq.fromBytes`	(`bytes`: `Uint8Array`) => `Field`[]
`Fq.toBytes`	(`fields`: `Field`[]) => `Uint8Array`
`Fq.fromString`	[object Object]
`Fq.toString`	[object Object]

Defined in

lib/encoding.ts:83

Functions

bytesFromFields

▸ bytesFromFields(fields): Uint8Array

Parameters

Name	Type
`fields`	`Field`[]

Returns

Uint8Array

Defined in

lib/encoding.ts:52

bytesToFields

▸ bytesToFields(bytes): Field[]

Parameters

Name	Type
`bytes`	`Uint8Array`

Returns

Defined in

lib/encoding.ts:32

stringFromFields

▸ stringFromFields(fields): string

Parameters

Name	Type
`fields`	`Field`[]

Returns

string

Defined in

lib/encoding.ts:25

stringToFields

▸ stringToFields(message): Field[]

Parameters

Name	Type
`message`	`string`

Returns

Defined in

lib/encoding.ts:20

snarkyjs / Exports / Encryption

Namespace: Encryption

Functions

decrypt
encrypt

Functions

decrypt

▸ decrypt(__namedParameters, privateKey): Field[]

Parameters

Name	Type
`__namedParameters`	`CipherText`
`privateKey`	`PrivateKey`

Returns

Defined in

lib/encryption.ts:58

encrypt

▸ encrypt(message, otherPublicKey): Object

Parameters

Name	Type
`message`	`Field`[]
`otherPublicKey`	`PublicKey`

Returns

Object

Name	Type
`cipherText`	`Field`[]
`publicKey`	`Group`

Defined in

lib/encryption.ts:30

snarkyjs / Exports / Mina

Namespace: Mina

Type Aliases

CurrentTransaction

Variables

currentTransaction
nextTransactionId

Functions

BerkeleyQANet
LocalBlockchain
accountCreationFee
createTransaction
createUnsignedTransaction
currentSlot
getAccount
getBalance
getNetworkState
sendTransaction
setActiveInstance
setCurrentTransaction
transaction

Type Aliases

CurrentTransaction

Ƭ CurrentTransaction: undefined | { fetchMode: FetchMode ; nextPartyIndex: number ; parties: Party[] ; sender?: PrivateKey }

Defined in

lib/mina.ts:55

Variables

currentTransaction

• currentTransaction: CurrentTransaction = undefined

Defined in

lib/mina.ts:64

nextTransactionId

• nextTransactionId: Object

Type declaration

Name	Type
`value`	`number`

Defined in

lib/mina.ts:52

Functions

BerkeleyQANet

▸ BerkeleyQANet(graphqlEndpoint): Mina

Parameters

Name	Type
`graphqlEndpoint`	`string`

Returns

Mina

Defined in

lib/mina.ts:340

LocalBlockchain

▸ LocalBlockchain(__namedParameters?): MockMina

A mock Mina blockchain running locally and useful for testing.

Parameters

Name	Type
`__namedParameters`	`Object`
`__namedParameters.accountCreationFee`	`undefined` \| `string` \| `number`

The current slot number, according to the active Mina instance.

Defined in

lib/mina.ts:422

getAccount

▸ getAccount(pubkey): Account

Parameters

Name	Type
`pubkey`	`PublicKey`

Returns

Account

The account data associated to the given public key.

Defined in

lib/mina.ts:429

getBalance

▸ getBalance(pubkey): UInt64

Parameters

Name	Type
`pubkey`	`PublicKey`

Returns