withContractScopedTransaction

Midnight.js API Reference v3.1.0

---

Midnight.js API Reference / @midnight-ntwrk/midnight-js-contracts / withContractScopedTransaction

Variable: withContractScopedTransaction()

const withContractScopedTransaction: <C, ICK>(providers, fn, options?) => Promise<FinalizedCallTxData<C, ICK>>

Executes a function within the context of a contract-scoped transaction.

Type Parameters

C

C extends Contract.Any

ICK

ICK extends Contract.ImpureCircuitId<C> = Contract.ImpureCircuitId<C>

Parameters

providers

ContractProviders<C, ICK>

The contract providers to use within the transaction.

fn

(txCtx) => Promise<void>

The function to execute within the transaction context.

options?

ScopedTransactionOptions

Optional transaction scope options.

Returns

Promise<FinalizedCallTxData<C, ICK>>

A Promise that resolves with the finalized transaction data of the single transaction created for all circuit calls made within fn.

Remarks

Where fn make circuit calls, these are batched together and submitted as a single transaction when the function completes successfully. If fn throws an error, any unsubmitted circuit calls are discarded.