Class: Ledger

Represents the Mina ledger.

Table of contents

Constructors

• constructor

Properties

• encoding
• hashInputFromJson

Methods

• addAccount
• applyJsonTransaction
• getAccount
• checkAccountUpdateSignature
• create
• createTokenAccount
• customTokenId
• customTokenIdChecked
• dummySignature
• fieldOfBase58
• fieldToBase58
• fieldsOfJson
• hashAccountUpdateFromFields
• hashAccountUpdateFromJson
• memoHashBase58
• memoToBase58
• privateKeyOfString
• privateKeyToString
• publicKeyOfString
• publicKeyToString
• signFeePayer
• signFieldElement
• signOtherAccountUpdate
• transactionCommitments
• zkappPublicInput

Constructors

constructor

• new Ledger()

Properties

encoding

▪ Static encoding: Object

Type declaration

Name	Type
versionBytes	Record<"tokenIdKey" | "receiptChainHash" | "ledgerHash" | "epochSeed" | "stateHash" | "publicKey" | "userCommandMemo", number>
ofBase58	(base58: string, versionByte: number) => MlBytes
toBase58	(s: MlBytes, versionByte: number) => string

Defined in

snarky.d.ts:1257

---

hashInputFromJson

▪ Static hashInputFromJson: Object

Type declaration

Name	Type
accountPrecondition	(json: String) => OcamlInput
body	(json: String) => OcamlInput
networkPrecondition	(json: String) => OcamlInput
packInput	(input: OcamlInput) => Field[]
permissions	(json: String) => OcamlInput
timing	(json: String) => OcamlInput
update	(json: String) => OcamlInput

Defined in

snarky.d.ts:1246

Methods

addAccount

▸ addAccount(publicKey, balance): void

Adds an account and its balance to the ledger.

Parameters

Name	Type
publicKey	PublicKey_
balance	string

Returns

void

Defined in

snarky.d.ts:1162

---

applyJsonTransaction

▸ applyJsonTransaction(txJson, accountCreationFee, networkState): void

Applies a JSON transaction to the ledger.

Parameters

Name	Type
txJson	string
accountCreationFee	string
networkState	string

Returns

void

Defined in

snarky.d.ts:1167

---

getAccount

▸ getAccount(publicKey, tokenId): undefined | Account

Returns an account.

Parameters

Name	Type
publicKey	PublicKey_
tokenId	Field

Returns

undefined | Account

Defined in

snarky.d.ts:1176

---

checkAccountUpdateSignature

▸ Static checkAccountUpdateSignature(updateJson, commitment): boolean

Parameters

Name	Type
updateJson	string
commitment	Field

Returns

boolean

Defined in

snarky.d.ts:1237

---

create

▸ Static create(genesisAccounts): Ledger

Creates a fresh ledger.

Parameters

Name	Type
genesisAccounts	{ balance: string ; publicKey: PublicKey_ }[]

Returns

Ledger

Defined in

snarky.d.ts:1155

---

createTokenAccount

▸ Static createTokenAccount(publicKey, tokenId): string

Parameters

Name	Type
publicKey	PublicKey_
tokenId	Field

Returns

string

Defined in

snarky.d.ts:1225

---

customTokenId

▸ Static customTokenId(publicKey, tokenId): Field

Parameters

Name	Type
publicKey	PublicKey_
tokenId	Field

Returns

Field

Defined in

snarky.d.ts:1223

---

customTokenIdChecked

▸ Static customTokenIdChecked(publicKey, tokenId): Field

Parameters

Name	Type
publicKey	PublicKey_
tokenId	Field

Returns

Field

Defined in

snarky.d.ts:1224

---

dummySignature

▸ Static dummySignature(): string

Returns a dummy signature.

Returns

string

Defined in

snarky.d.ts:1207

---

fieldOfBase58

▸ Static fieldOfBase58(fieldBase58): Field

Parameters

Name	Type
fieldBase58	string

Returns

Field

Defined in

snarky.d.ts:1232

---

fieldToBase58

▸ Static fieldToBase58(field): string

Parameters

Name	Type
field	Field

Returns

string

Defined in

snarky.d.ts:1231

---

fieldsOfJson

▸ Static fieldsOfJson(json): Field[]

Parameters

Name	Type
json	string

Returns

Field[]

Defined in

snarky.d.ts:1242

---

hashAccountUpdateFromFields

▸ Static hashAccountUpdateFromFields(fields): Field

Parameters

Name	Type
fields	Field[]

Returns

Field

Defined in

snarky.d.ts:1243

---

hashAccountUpdateFromJson

▸ Static hashAccountUpdateFromJson(json): Field

Parameters

Name	Type
json	string

Returns

Field

Defined in

snarky.d.ts:1244

---

memoHashBase58

▸ Static memoHashBase58(memoBase58): Field

Parameters

Name	Type
memoBase58	string

Returns

Field

Defined in

snarky.d.ts:1235

---

memoToBase58

▸ Static memoToBase58(memoString): string

Parameters

Name	Type
memoString	string

Returns

string

Defined in

snarky.d.ts:1234

---

privateKeyOfString

▸ Static privateKeyOfString(privateKeyBase58): Scalar

Parameters

Name	Type
privateKeyBase58	string

Returns

Scalar

Defined in

snarky.d.ts:1230

---

privateKeyToString

▸ Static privateKeyToString(privateKey): string

Parameters

Name	Type
privateKey	Object
privateKey.s	Scalar

Returns

string

Defined in

snarky.d.ts:1229

---

publicKeyOfString

▸ Static publicKeyOfString(publicKeyBase58): PublicKey_

Parameters

Name	Type
publicKeyBase58	string

Returns

PublicKey_

Defined in

snarky.d.ts:1228

---

publicKeyToString

▸ Static publicKeyToString(publicKey): string

Parameters

Name	Type
publicKey	PublicKey_

Returns

string

Defined in

snarky.d.ts:1227

---

signFeePayer

▸ Static signFeePayer(txJson, privateKey): string

Signs a transaction as the fee payer.

Parameters

Name	Type
txJson	string
privateKey	Object
privateKey.s	Scalar

Returns

string

Defined in

snarky.d.ts:1212

---

signFieldElement

▸ Static signFieldElement(messageHash, privateKey, isMainnet): string

Signs a Field element.

Parameters

Name	Type
messageHash	Field
privateKey	Object
privateKey.s	Scalar
isMainnet	boolean

Returns

string

Defined in

snarky.d.ts:1198

---

signOtherAccountUpdate

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

Signs an account update.

Parameters

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

Returns

string

Defined in

snarky.d.ts:1217

---

transactionCommitments

▸ Static transactionCommitments(txJson): Object

Returns the commitment of a JSON transaction.

Parameters

Name	Type
txJson	string

Returns

Object

Name	Type
commitment	Field
feePayerHash	Field
fullCommitment	Field

Defined in

snarky.d.ts:1181

---

zkappPublicInput

▸ Static zkappPublicInput(txJson, accountUpdateIndex): Object

Returns the public input of a zkApp transaction.

Parameters

Name	Type
txJson	string
accountUpdateIndex	number

Returns

Object

Name	Type
accountUpdate	Field
calls	Field

Defined in

snarky.d.ts:1190