Skip to main content

DustLocalState

For the complete documentation index, see llms.txt

@midnight/ledger v8.1.3

@midnight/ledger / DustLocalState

Class: DustLocalState

Constructors​

Constructor​

new DustLocalState(params): DustLocalState;

Parameters​

params​

DustParameters

Returns​

DustLocalState

Properties​

params​

readonly params: DustParameters;

syncTime​

readonly syncTime: Date;

utxos​

readonly utxos: QualifiedDustOutput[];

Methods​

addUtxo()​

addUtxo(
   nullifier, 
   utxo, 
   pendingUntil?): DustLocalState;

Parameters​

nullifier​

bigint

utxo​

QualifiedDustOutput

pendingUntil?​

Date

Returns​

DustLocalState

applyCommitmentCollapsedUpdate()​

applyCommitmentCollapsedUpdate(update): DustLocalState;

Parameters​

update​

DustStateMerkleTreeCollapsedUpdate

Returns​

DustLocalState

applyGenerationCollapsedUpdate()​

applyGenerationCollapsedUpdate(update): DustLocalState;

Parameters​

update​

DustStateMerkleTreeCollapsedUpdate

Returns​

DustLocalState

collapseCommitmentTree()​

collapseCommitmentTree(commitmentIndexStart, commitmentIndexEnd): DustLocalState;

Parameters​

commitmentIndexStart​

bigint

commitmentIndexEnd​

bigint

Returns​

DustLocalState

collapseGenerationTree()​

collapseGenerationTree(generationIndexStart, generationIndexEnd): DustLocalState;

Parameters​

generationIndexStart​

bigint

generationIndexEnd​

bigint

Returns​

DustLocalState

commitmentTreeRoot()​

commitmentTreeRoot(): bigint | undefined;

Returns​

bigint | undefined

findUtxoByNullifier()​

findUtxoByNullifier(nullifier): 
  | QualifiedDustOutput
  | undefined;

Parameters​

nullifier​

bigint

Returns​

| QualifiedDustOutput | undefined

generatingTreeRoot()​

generatingTreeRoot(): bigint | undefined;

Returns​

bigint | undefined

generationInfo()​

generationInfo(qdo): 
  | DustGenerationInfo
  | undefined;

Parameters​

qdo​

QualifiedDustOutput

Returns​

| DustGenerationInfo | undefined

insertCommitment()​

insertCommitment(
   commitmentIndex, 
   qdo, 
   own_qdo): DustLocalState;

Parameters​

commitmentIndex​

bigint

qdo​

QualifiedDustOutput

own_qdo​

boolean

Returns​

DustLocalState

insertGenerationInfo()​

insertGenerationInfo(
   generationIndex, 
   generation, 
   initialNonce?): DustLocalState;

Parameters​

generationIndex​

bigint

generation​

DustGenerationInfo

initialNonce?​

string

Returns​

DustLocalState

processTtls()​

processTtls(time): DustLocalState;

Parameters​

time​

Date

Returns​

DustLocalState

removeCommitment()​

removeCommitment(commitmentIndex): DustLocalState;

Parameters​

commitmentIndex​

bigint

Returns​

DustLocalState

removeGenerationInfo()​

removeGenerationInfo(generationIndex, generation): DustLocalState;

Parameters​

generationIndex​

bigint

generation​

DustGenerationInfo

Returns​

DustLocalState

removeUtxo()​

removeUtxo(nullifier): DustLocalState;

Parameters​

nullifier​

bigint

Returns​

DustLocalState

replayEvents()​

replayEvents(sk, events): DustLocalState;

Parameters​

sk​

DustSecretKey

events​

Event[]

Returns​

DustLocalState

replayEventsWithChanges()​

replayEventsWithChanges(sk, events): DustLocalStateWithChanges;

Parameters​

sk​

DustSecretKey

events​

Event[]

Returns​

DustLocalStateWithChanges

replayRawEvents()​

replayRawEvents(sk, rawEvents): DustLocalStateWithChanges;

Replays a direct concatenation of serialized ledger events. Otherwise acts as replayEventsWithChanges.

Parameters​

sk​

DustSecretKey

rawEvents​

Uint8Array

Returns​

DustLocalStateWithChanges

serialize()​

serialize(): Uint8Array;

Returns​

Uint8Array

spend()​

spend(
   sk, 
   utxo, 
   vFee, 
   ctime): [DustLocalState, DustSpend<PreProof>];

Parameters​

sk​

DustSecretKey

utxo​

QualifiedDustOutput

vFee​

bigint

ctime​

Date

Returns​

[DustLocalState, DustSpend<PreProof>]

successorUtxo()​

successorUtxo(
   qdo, 
   now, 
   subtract_fee, 
   new_commitment_index, 
   sk): QualifiedDustOutput;

Returns a new UTXO with a reduced value and the sequential nonce

Parameters​

qdo​

QualifiedDustOutput

now​

Date

subtract_fee​

bigint

new_commitment_index​

bigint

sk​

DustSecretKey

Returns​

QualifiedDustOutput

toString()​

toString(compact?): string;

Parameters​

compact?​

boolean

Returns​

string

walletBalance()​

walletBalance(time): bigint;

Parameters​

time​

Date

Returns​

bigint

deserialize()​

static deserialize(raw): DustLocalState;

Parameters​

raw​

Uint8Array

Returns​

DustLocalState