Skip to main content

@midnight/ledger v3.0.2 • Readme | API

@midnight/ledger v3.0.2 / StateValue

Class: StateValue

Represents the core of a contract's state, and recursively represents each of its components.

There are different classes of state values:

State values are immutable, any operations that mutate states will return a new state instead.

Constructors​

new StateValue()​

private new StateValue(): StateValue

Returns​

StateValue

Methods​

arrayPush()​

arrayPush(value): StateValue

Parameters​

• value: StateValue

Returns​

StateValue

asArray()​

asArray(): undefined | StateValue[]

Returns​

undefined | StateValue[]

asBoundedMerkleTree()​

asBoundedMerkleTree(): undefined | StateBoundedMerkleTree

Returns​

undefined | StateBoundedMerkleTree

asCell()​

asCell(): AlignedValue

Returns​

AlignedValue

asMap()​

asMap(): undefined | StateMap

Returns​

undefined | StateMap

encode()​

Internal

encode(): EncodedStateValue

Returns​

EncodedStateValue

logSize()​

logSize(): number

Returns​

number

toString()​

toString(compact?): string

Parameters​

• compact?: boolean

Returns​

string

type()​

type(): 
  | "map"
  | "null"
  | "cell"
  | "array"
  | "boundedMerkleTree"

Returns​

| "map" | "null" | "cell" | "array" | "boundedMerkleTree"

decode()​

Internal

static decode(value): StateValue

Parameters​

• value: EncodedStateValue

Returns​

StateValue

newArray()​

static newArray(): StateValue

Returns​

StateValue

newBoundedMerkleTree()​

static newBoundedMerkleTree(tree): StateValue

Parameters​

• tree: StateBoundedMerkleTree

Returns​

StateValue

newCell()​

static newCell(value): StateValue

Parameters​

• value: AlignedValue

Returns​

StateValue

newMap()​

static newMap(map): StateValue

Parameters​

• map: StateMap

Returns​

StateValue

newNull()​

static newNull(): StateValue

Returns​

StateValue