Skip to main content

@midnight/ledger v3.0.2 • Readme | API

@midnight/ledger v3.0.2 / UnprovenTransaction

Class: UnprovenTransaction

Transaction, prior to being proven

All "shielded" information in the transaction can still be extracted at this stage!

Constructors​

new UnprovenTransaction(guaranteed, fallible, calls)​

new UnprovenTransaction(
   guaranteed, 
   fallible?, 
   calls?): UnprovenTransaction

Creates the transaction from guaranteed/fallible UnprovenOffers, and a ContractCallsPrototype.

Parameters​

• guaranteed: UnprovenOffer

• fallible?: UnprovenOffer

• calls?: ContractCallsPrototype

Returns​

UnprovenTransaction

Properties​

contractCalls​

readonly contractCalls: ContractAction[];

The contract interactions contained in this transaction

fallibleCoins​

readonly fallibleCoins: undefined | UnprovenOffer;

The fallible Zswap offer

guaranteedCoins​

readonly guaranteedCoins: undefined | UnprovenOffer;

The guaranteed Zswap offer

mint​

readonly mint: undefined | UnprovenAuthorizedMint;

The mint this transaction represents, if applicable

Methods​

eraseProofs()​

eraseProofs(): ProofErasedTransaction

Erases the proofs contained in this transaction

Returns​

ProofErasedTransaction

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): UnprovenTransaction

Merges this transaction with another

Parameters​

• other: UnprovenTransaction

Returns​

UnprovenTransaction

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

deserialize()​

static deserialize(raw, netid): UnprovenTransaction

Parameters​

• raw: Uint8Array

• netid: NetworkId

Returns​

UnprovenTransaction

fromMint()​

static fromMint(mint): UnprovenTransaction

Creates a minting claim transaction, the funds claimed must have been legitimately minted previously.

Parameters​

• mint: UnprovenAuthorizedMint

Returns​

UnprovenTransaction