Class: AccountUpdate

An AccountUpdate is a set of instructions for the Mina network. It includes Preconditions and a list of state updates, which need to be authorized by either a Signature or Proof.

Implements

• AccountUpdate

Table of contents

Constructors

• constructor

Properties

• account
• authorization
• body
• children
• currentSlot
• id
• isSelf
• label
• lazyAuthorization
• network
• parent
• Actions
• Layout
• check
• signingInfo
• sizeInFields
• toFields
• toInput

Accessors

• balance
• publicKey
• tokenId
• tokenSymbol
• update
• MayUseToken

Methods

• approve
• hash
• isDummy
• requireSignature
• send
• sign
• toJSON
• toPretty
• toPublicInput
• token
• assertBetween
• assertEquals
• attachToTransaction
• clone
• create
• createSigned
• defaultAccountUpdate
• defaultFeePayer
• dummy
• dummyFeePayer
• fromFields
• fromJSON
• fundNewAccount
• getNonce
• getSigningInfo
• getSigningInfoUnchecked
• setValue
• signFeePayerInPlace
• toAuxiliary
• toJSON
• unlink
• witness
• witnessChildren
• witnessTree

Constructors

constructor

• new AccountUpdate(body, authorization?)

Parameters

Name	Type
body	Body
authorization?	Object
authorization.proof?	string
authorization.signature?	string

Defined in

lib/account_update.ts:684

Properties

account

• account: Account

Defined in

lib/account_update.ts:665

---

authorization

• authorization: Object

Type declaration

Name	Type
proof?	string
signature?	string

Implementation of

Types.AccountUpdate.authorization

Defined in

lib/account_update.ts:662

---

body

• body: Body

Implementation of

Types.AccountUpdate.body

Defined in

lib/account_update.ts:661

---

children

• children: Object

Type declaration

Name	Type
accountUpdates	AccountUpdate[]
callsType	{ type: "None" } | { type: "Witness" } | { type: "Equals" ; value: Field }

Defined in

lib/account_update.ts:668

---

currentSlot

• currentSlot: CurrentSlot

Defined in

lib/account_update.ts:667

---

id

• id: number

Defined in

lib/account_update.ts:655

---

isSelf

• Private isSelf: boolean

Defined in

lib/account_update.ts:680

---

label

• label: string = ''

A human-readable label for the account update, indicating how that update was created. Can be modified by applications to add richer information.

Defined in

lib/account_update.ts:660

---

lazyAuthorization

• lazyAuthorization: undefined | LazySignature | LazyProof | LazyNone = undefined

Defined in

lib/account_update.ts:663

---

network

• network: Network

Defined in

lib/account_update.ts:666

---

parent

• parent: undefined | AccountUpdate = undefined

Defined in

lib/account_update.ts:678

---

Actions

▪ Static Actions: Object = Actions

Type declaration

Name	Type
check	(x: { data: Field[][] ; hash: Field }) => void
emptyValue	() => { data: Field[][] ; hash: Field } & () => { data: Field[][] ; hash: Field }
fromFields	(x: Field[], aux: any[]) => { data: Field[][] ; hash: Field }
fromJSON	(x: string[][]) => { data: Field[][] ; hash: Field }
toAuxiliary	(x?: { data: Field[][] ; hash: Field }) => any[]
toFields	(x: { data: Field[][] ; hash: Field }) => Field[]
toInput	(x: { data: Field[][] ; hash: Field }) => { fields?: Field[] ; packed?: [Field, number][] }
toJSON	(x: { data: Field[][] ; hash: Field }) => string[][]
empty	() => Events
emptyActionState	() => Field
fromList	(events: Event[]) => Events
hash	(events: Event[]) => Field
pushEvent	(actions: Events, event: Event) => Events
sizeInFields	() => number
updateSequenceState	(state: Field, sequenceEventsHash: Field) => Field

Defined in

lib/account_update.ts:682

---

Layout

▪ Static Layout: Object

Describes the children of an account update, which are laid out in a tree.

The tree layout is described recursively by using a combination of AccountUpdate.Layout.NoChildren, AccountUpdate.Layout.StaticChildren(...) and AccountUpdate.Layout.AnyChildren.

• NoChildren means an account update that can't have children
• AnyChildren means an account update can have an arbitrary amount of children, which means you can't access those children in your circuit (because the circuit is static).
• StaticChildren means the account update must have a certain static amount of children and expects as arguments a description of each of those children. As a shortcut, you can also pass StaticChildren a number, which means it has that amount of children but no grandchildren.

This is best understood by examples:

let { NoChildren, AnyChildren, StaticChildren } = AccounUpdate.Layout;

NoChildren                 // an account update with no children
AnyChildren                // an account update with arbitrary children
StaticChildren(NoChildren) // an account update with 1 child, which doesn't have children itself
StaticChildren(1)          // shortcut for StaticChildren(NoChildren)
StaticChildren(2)          // shortcut for StaticChildren(NoChildren, NoChildren)
StaticChildren(0)          // equivalent to NoChildren

// an update with 2 children, of which one has arbitrary children and the other has exactly 1 descendant
StaticChildren(AnyChildren, StaticChildren(1))

Type declaration

Name	Type
AnyChildren	"AnyChildren"
NoChildren	number
NoDelegation	"NoDelegation"
StaticChildren	(n: number) => AccountUpdatesLayout(...args: AccountUpdatesLayout[]) => AccountUpdatesLayout

Defined in

lib/account_update.ts:1393

---

check

▪ Static check: (value: AccountUpdate) => void = Types.AccountUpdate.check

Type declaration

▸ (value): void

Parameters

Name	Type
value	AccountUpdate

Returns

void

Defined in

lib/account_update.ts:1278

---

signingInfo

▪ Static Private signingInfo: ProvableExtended<{ isSameAsFeePayer: Bool = Bool; nonce: UInt32 = UInt32 }, { isSameAsFeePayer: boolean = Bool; nonce: string = UInt32 }>

Defined in

lib/account_update.ts:1014

---

sizeInFields

▪ Static sizeInFields: () => number = Types.AccountUpdate.sizeInFields

Type declaration

▸ (): number

Returns

number

Defined in

lib/account_update.ts:1257

---

toFields

▪ Static toFields: (value: AccountUpdate) => Field[] = Types.AccountUpdate.toFields

Type declaration

▸ (value): Field[]

Parameters

Name	Type
value	AccountUpdate

Returns

Field[]

Defined in

lib/account_update.ts:1258

---

toInput

▪ Static toInput: (value: AccountUpdate) => HashInput = Types.AccountUpdate.toInput

Type declaration

▸ (value): HashInput

Parameters

Name	Type
value	AccountUpdate

Returns

HashInput

Defined in

lib/account_update.ts:1277

Accessors

balance

• get balance(): Object

Returns

Object

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

Defined in

lib/account_update.ts:875

---

publicKey

• get publicKey(): PublicKey

Returns

PublicKey

Defined in

lib/account_update.ts:958

---

tokenId

• get tokenId(): Field

Returns

Field

Defined in

lib/account_update.ts:815

---

tokenSymbol

• get tokenSymbol(): Object

Deprecated

use this.account.tokenSymbol

Returns

Object

Name	Type
set	(tokenSymbol: string) => void

Defined in

lib/account_update.ts:822

---

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: { access: AuthRequired ; editActionState: AuthRequired ; editState: AuthRequired ; incrementNonce: AuthRequired ; receive: AuthRequired ; send: AuthRequired ; setDelegate: AuthRequired ; setPermissions: AuthRequired ; setTiming: AuthRequired ; setTokenSymbol: AuthRequired ; setVerificationKey: AuthRequired ; setVotingFor: AuthRequired ; setZkappUri: AuthRequired } }
permissions.isSome	Bool
permissions.value	{ access: AuthRequired ; editActionState: AuthRequired ; editState: AuthRequired ; incrementNonce: AuthRequired ; receive: AuthRequired ; send: AuthRequired ; setDelegate: AuthRequired ; setPermissions: AuthRequired ; setTiming: AuthRequired ; setTokenSymbol: AuthRequired ; setVerificationKey: AuthRequired ; setVotingFor: AuthRequired ; setZkappUri: AuthRequired }
permissions.value.access	AuthRequired
permissions.value.editActionState	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.setTiming	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: { field: Field ; symbol: string } }
tokenSymbol.isSome	Bool
tokenSymbol.value	{ field: Field ; symbol: string }
tokenSymbol.value.field	Field
tokenSymbol.value.symbol	string
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/account_update.ts:890

---

MayUseToken

• Static get MayUseToken(): Object

Returns

Object

Name	Type
InheritFromParent	{ inheritFromParent: Bool ; parentsOwnToken: Bool }
InheritFromParent.inheritFromParent	Bool
InheritFromParent.parentsOwnToken	Bool
No	{ inheritFromParent: Bool ; parentsOwnToken: Bool }
No.inheritFromParent	Bool
No.parentsOwnToken	Bool
ParentsOwnToken	{ inheritFromParent: Bool ; parentsOwnToken: Bool }
ParentsOwnToken.inheritFromParent	Bool
ParentsOwnToken.parentsOwnToken	Bool
type	ProvablePure<{ inheritFromParent: Bool = Bool; parentsOwnToken: Bool = Bool }> & ProvableExtension<{ inheritFromParent: Bool = Bool; parentsOwnToken: Bool = Bool }, { inheritFromParent: boolean = Bool; parentsOwnToken: boolean = Bool }>
isInheritFromParent	(a: AccountUpdate) => Bool
isNo	(__namedParameters: AccountUpdate) => Bool
isParentsOwnToken	(a: AccountUpdate) => Bool

Defined in

lib/account_update.ts:1407

Methods

approve

▸ approve(childUpdate, layout?): void

Makes an AccountUpdate a child-AccountUpdate of this and approves it.

Parameters

Name	Type	Default value
childUpdate	AccountUpdate	undefined
layout	AccountUpdatesLayout	AccountUpdate.Layout.NoChildren

Returns

void

Defined in

lib/account_update.ts:867

---

hash

▸ hash(): Field

Returns

Field

Defined in

lib/account_update.ts:1074

---

isDummy

▸ isDummy(): Bool

Returns

Bool

Defined in

lib/account_update.ts:1103

---

requireSignature

▸ requireSignature(): void

Use this command if this account update should be signed by the account owner, instead of not having any authorization.

If you use this and are not relying on a wallet to sign your transaction, then you should use the following code before sending your transaction:

let tx = Mina.transaction(...); // create transaction as usual, using `requireSignature()` somewhere
tx.sign([privateKey]); // pass the private key of this account to `sign()`!

Note that an account's Permissions determine which updates have to be (can be) authorized by a signature.

Returns

void

Defined in

lib/account_update.ts:977

---

send

▸ send(«destructured»): AccountUpdate

Parameters

Name	Type
«destructured»	Object
› amount	number | bigint | UInt64
› to	PublicKey | AccountUpdate | SmartContract

Returns

AccountUpdate

Defined in

lib/account_update.ts:832

---

sign

▸ sign(privateKey?): void

Deprecated

.sign() is deprecated in favor of .requireSignature()

Parameters

Name	Type
privateKey?	PrivateKey

Returns

void

Defined in

lib/account_update.ts:983

---

toJSON

▸ toJSON(): AccountUpdate

Returns

AccountUpdate

Defined in

lib/account_update.ts:1063

---

toPretty

▸ toPretty(): any

Returns a JSON representation of only the fields that differ from the default AccountUpdate.

Returns

any

Defined in

lib/account_update.ts:1442

---

toPublicInput

▸ toPublicInput(): ZkappPublicInput

Returns

ZkappPublicInput

Defined in

lib/account_update.ts:1091

---

token

▸ token(): Object

Returns

Object

Name	Type
id	Field
parentTokenId	Field
tokenOwner	PublicKey
burn	(__namedParameters: { address: PublicKey | AccountUpdate | SmartContract ; amount: number | bigint | UInt64 }) => AccountUpdate
mint	(__namedParameters: { address: PublicKey | AccountUpdate | SmartContract ; amount: number | bigint | UInt64 }) => AccountUpdate
send	(__namedParameters: { amount: number | bigint | UInt64 ; from: PublicKey | AccountUpdate | SmartContract ; to: PublicKey | AccountUpdate | SmartContract }) => AccountUpdate

Defined in

lib/account_update.ts:721

---

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	OrIgnore<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.from(20e9); AccountUpdate.assertBetween(this.self.body.preconditions.account.balance, lower, upper); // ... }

Returns

void

Defined in

lib/account_update.ts:918

---

assertEquals

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

Fix a property to a certain value.

Type parameters

Name	Type
T	extends object

Parameters

Name	Type	Description
property	OrIgnore<T | ClosedInterval<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() { AccountUpdate.assertEquals(this.self.body.preconditions.account.nonce, UInt32.zero); // ... }

Returns

void

Defined in

lib/account_update.ts:945

---

attachToTransaction

▸ Static attachToTransaction(accountUpdate): void

Attach account update to the current transaction -- if in a smart contract, to its children

Parameters

Name	Type
accountUpdate	AccountUpdate

Returns

void

Defined in

lib/account_update.ts:1147

---

clone

▸ Static clone(accountUpdate): AccountUpdate

Clones the AccountUpdate.

Parameters

Name	Type
accountUpdate	AccountUpdate

Returns

AccountUpdate

Defined in

lib/account_update.ts:702

---

create

▸ Static create(publicKey, tokenId?): AccountUpdate

Creates an account update. If this is inside a transaction, the account update becomes part of the transaction. If this is inside a smart contract method, the account update will not only become part of the transaction, but also becomes available for the smart contract to modify, in a way that becomes part of the proof.

Parameters

Name	Type
publicKey	PublicKey
tokenId?	Field

Returns

AccountUpdate

Defined in

lib/account_update.ts:1128

---

createSigned

▸ Static createSigned(signer, tokenId?): AccountUpdate

Creates an account update, like create, but also makes sure this account update will be authorized with a signature.

If you use this and are not relying on a wallet to sign your transaction, then you should use the following code before sending your transaction:

let tx = Mina.transaction(...); // create transaction as usual, using `createSigned()` somewhere
tx.sign([privateKey]); // pass the private key of this account to `sign()`!

Note that an account's Permissions determine which updates have to be (can be) authorized by a signature.

Parameters

Name	Type
signer	PublicKey
tokenId?	Field

Returns

AccountUpdate

Defined in

lib/account_update.ts:1194

▸ Static createSigned(signer, tokenId?): AccountUpdate

Deprecated

in favor of calling this function with a PublicKey as signer

Parameters

Name	Type
signer	PrivateKey
tokenId?	Field

Returns

AccountUpdate

Defined in

lib/account_update.ts:1198

---

defaultAccountUpdate

▸ Static defaultAccountUpdate(address, tokenId?): AccountUpdate

Parameters

Name	Type
address	PublicKey
tokenId?	Field

Returns

AccountUpdate

Defined in

lib/account_update.ts:1097

---

defaultFeePayer

▸ Static defaultFeePayer(address, nonce): FeePayerUnsigned

Parameters

Name	Type
address	PublicKey
nonce	UInt32

Returns

FeePayerUnsigned

Defined in

lib/account_update.ts:1107

---

dummy

▸ Static dummy(): AccountUpdate

Returns

AccountUpdate

Defined in

lib/account_update.ts:1100

---

dummyFeePayer

▸ Static dummyFeePayer(): FeePayerUnsigned

Returns

FeePayerUnsigned

Defined in

lib/account_update.ts:1116

---

fromFields

▸ Static fromFields(fields, «destructured»): AccountUpdate

Parameters

Name	Type
fields	Field[]
«destructured»	any[]

Returns

AccountUpdate

Defined in

lib/account_update.ts:1279

---

fromJSON

▸ Static fromJSON(json): AccountUpdate

Parameters

Name	Type
json	AccountUpdate

Returns

AccountUpdate

Defined in

lib/account_update.ts:1069

---

fundNewAccount

▸ Static fundNewAccount(feePayer, numberOfAccounts?): AccountUpdate

Use this method to pay the account creation fee for another account (or, multiple accounts using the optional second argument).

Beware that you don't need to specify the account that is created! Instead, the protocol will automatically identify that accounts need to be created, and require that the net balance change of the transaction covers the account creation fee.

Parameters

Name	Type	Description
feePayer	PublicKey	the address of the account that pays the fee
numberOfAccounts?	number	the number of new accounts to fund (default: 1)

Returns

AccountUpdate

they AccountUpdate for the account which pays the fee

Defined in

lib/account_update.ts:1226

▸ Static fundNewAccount(feePayer, options?): AccountUpdate

Deprecated

Call this function with a PublicKey as feePayer, and remove the initialBalance option. To send an initial balance to the new account, you can use the returned account update:

let feePayerUpdate = AccountUpdate.fundNewAccount(feePayer);
feePayerUpdate.send({ to: receiverAddress, amount: initialBalance });

Parameters

Name	Type
feePayer	PrivateKey | PublicKey
options?	number | { initialBalance: string | number | UInt64 }

Returns

AccountUpdate

Defined in

lib/account_update.ts:1238

---

getNonce

▸ Static getNonce(accountUpdate): UInt32

Parameters

Name	Type
accountUpdate	AccountUpdate | FeePayerUnsigned

Returns

UInt32

Defined in

lib/account_update.ts:1010

---

getSigningInfo

▸ Static Private getSigningInfo(accountUpdate): Object

Parameters

Name	Type
accountUpdate	AccountUpdate | FeePayerUnsigned

Returns

Object

Name	Type
isSameAsFeePayer	Bool
nonce	UInt32

Defined in

lib/account_update.ts:1019

---

getSigningInfoUnchecked

▸ Static Private getSigningInfoUnchecked(update): Object

Parameters

Name	Type
update	AccountUpdate | FeePayerUnsigned

Returns

Object

Name	Type
isSameAsFeePayer	Bool
nonce	UInt32

Defined in

lib/account_update.ts:1027

---

setValue

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

Type parameters

Name
T

Parameters

Name	Type
maybeValue	SetOrKeep<T>
value	T

Returns

void

Defined in

lib/account_update.ts:894

---

signFeePayerInPlace

▸ Static signFeePayerInPlace(feePayer, privateKey?): void

Parameters

Name	Type
feePayer	FeePayerUnsigned
privateKey?	PrivateKey

Returns

void

Defined in

lib/account_update.ts:1001

---

toAuxiliary

▸ Static toAuxiliary(a?): (any[] | { children: { accountUpdates: AccountUpdate[] ; callsType: { type: "None" } | { type: "Witness" } | { type: "Equals" ; value: Field } } ; id: number ; label: string ; lazyAuthorization: undefined | LazySignature | LazyProof | LazyNone ; parent: undefined | AccountUpdate })[]

Parameters

Name	Type
a?	AccountUpdate

Returns

(any[] | { children: { accountUpdates: AccountUpdate[] ; callsType: { type: "None" } | { type: "Witness" } | { type: "Equals" ; value: Field } } ; id: number ; label: string ; lazyAuthorization: undefined | LazySignature | LazyProof | LazyNone ; parent: undefined | AccountUpdate })[]

Defined in

lib/account_update.ts:1259

---

toJSON

▸ Static toJSON(a): AccountUpdate

Parameters

Name	Type
a	AccountUpdate

Returns

AccountUpdate

Defined in

lib/account_update.ts:1066

---

unlink

▸ Static unlink(accountUpdate): void

Disattach an account update from where it's currently located in the transaction

Parameters

Name	Type
accountUpdate	AccountUpdate

Returns

void

Defined in

lib/account_update.ts:1167

---

witness

▸ Static witness<T>(type, compute, «destructured»?): Object

Type parameters

Name
T

Parameters

Name	Type
type	FlexibleProvable<T>
compute	() => { accountUpdate: AccountUpdate ; result: T }
«destructured»	Object
› skipCheck	undefined | boolean

Returns

Object

Name	Type
accountUpdate	AccountUpdate
result	T

Defined in

lib/account_update.ts:1287

---

witnessChildren

▸ Static witnessChildren(accountUpdate, childLayout, options?): void

Parameters

Name	Type
accountUpdate	AccountUpdate
childLayout	AccountUpdatesLayout
options?	Object
options.skipCheck	boolean

Returns

void

Defined in

lib/account_update.ts:1303

---

witnessTree

▸ Static witnessTree<T>(resultType, childLayout, compute, options?): Object

Like AccountUpdate.witness, but lets you specify a layout for the accountUpdate's children, which also get witnessed

Type parameters

Name
T

Parameters

Name	Type
resultType	FlexibleProvable<T>
childLayout	AccountUpdatesLayout
compute	() => { accountUpdate: AccountUpdate ; result: T }
options?	Object
options.skipCheck	boolean

Returns

Object

Name	Type
accountUpdate	AccountUpdate
result	T

Defined in

lib/account_update.ts:1348