Skip to main content

ProofErasedTransaction

@midnight-ntwrk/ledger v3.0.2 β€’ Readme | API


@midnight-ntwrk/ledger v3.0.2 / ProofErasedTransaction

Class: ProofErasedTransaction

Transaction, with all proof information erased

Primarily for use in testing, or handling data known to be correct from external information

Constructors​

new ProofErasedTransaction()​

private new ProofErasedTransaction(): ProofErasedTransaction

Returns​

ProofErasedTransaction

Properties​

contractCalls​

readonly contractCalls: ContractAction[];

The contract interactions contained in this transaction


fallibleCoins​

readonly fallibleCoins: undefined | ProofErasedOffer;

The fallible Zswap offer


guaranteedCoins​

readonly guaranteedCoins: undefined | ProofErasedOffer;

The guaranteed Zswap offer


mint​

readonly mint: undefined | ProofErasedAuthorizedMint;

The mint this transaction represents, if applicable

Methods​

fees()​

fees(params): bigint

The cost of this transaction, in the atomic unit of the base token

Parameters​

β€’ params: LedgerParameters

Returns​

bigint


identifiers()​

identifiers(): string[]

Returns the set of identifiers contained within this transaction. Any of these may be used to watch for a specific transaction.

Returns​

string[]


imbalances()​

imbalances(guaranteed, fees?): Map<string, bigint>

For given fees, and a given section (guaranteed/fallible), what the surplus or deficit of this transaction in any token type is.

Parameters​

β€’ guaranteed: boolean

β€’ fees?: bigint

Returns​

Map<string, bigint>


merge()​

merge(other): ProofErasedTransaction

Merges this transaction with another

Parameters​

β€’ other: ProofErasedTransaction

Returns​

ProofErasedTransaction

Throws​

If both transactions have contract interactions, or they spend the same coins


serialize()​

serialize(netid): Uint8Array

Parameters​

β€’ netid: NetworkId

Returns​

Uint8Array


toString()​

toString(compact?): string

Parameters​

β€’ compact?: boolean

Returns​

string


wellFormed()​

wellFormed(ref_state, strictness): void

Tests well-formedness criteria, optionally including transaction balancing

For obvious reasons, doesn't check proofs

Parameters​

β€’ ref_state: LedgerState

β€’ strictness: WellFormedStrictness

Returns​

void

Throws​

If the transaction is not well-formed for any reason


deserialize()​

static deserialize(raw, netid): ProofErasedTransaction

Parameters​

β€’ raw: Uint8Array

β€’ netid: NetworkId

Returns​

ProofErasedTransaction