Skip to main content

Midnight.js API Reference v1.0.0

Midnight.js API Reference / @midnight-ntwrk/midnight-js-types / MidnightProviders

Interface: MidnightProviders<ICK, PSI, PS>

Set of providers needed for transaction construction and submission.

Type Parameters​

ICK​

ICK extends ImpureCircuitId = ImpureCircuitId

A union of string literal types representing the callable circuits.

PSI​

PSI extends PrivateStateId = PrivateStateId

Parameter indicating the private state ID, sometimes a union of string literals.

PS​

PS = any

Parameter indicating the private state type stored, sometimes a union of private state types.

Properties​

loggerProvider?​

readonly optional loggerProvider: LoggerProvider

An optional logger that provides utilities for logging at given levels.

midnightProvider​

readonly midnightProvider: MidnightProvider

Submits proven, balanced transactions to the network.

privateStateProvider​

readonly privateStateProvider: PrivateStateProvider<PSI, PS>

Manages the private state of a contract.

proofProvider​

readonly proofProvider: ProofProvider<ICK>

Creates proven, unbalanced transactions.

publicDataProvider​

readonly publicDataProvider: PublicDataProvider

Retrieves public data from the blockchain.

walletProvider​

readonly walletProvider: WalletProvider

Creates proven, balanced transactions.

zkConfigProvider​

readonly zkConfigProvider: ZKConfigProvider<ICK>

Retrieves the ZK artifacts of a contract needed to create proofs.

Feedback