Skip to main content

On-Chain runtime API

@midnight-ntwrk/onchain-runtime v0.1.14 • Readme | API

Midnight Onchain Runtime TypeScript API

This API provides a TypeScript interface to Midnight's onchain runtime, including the execution of VM instructions, and the primitives required to successfully use them.

Key parts of this API are:

  • setNetworkId, required to ensure the right network is being targeted
  • ContractState, encapsulating the entirety of a smart contract's on-chain state
  • StateValue, encoding data a contract maintains on-chain
  • QueryContext, providing an annotated view into the contract state, against which on-chain VM programs can be run
  • Op, providing the TypeScript encoding of on-chain VM programs
  • AlignedValue, the "base" value type that encodes all user data stored on-chain