Supra RPC Node API
Public, keyless REST + JSON API served by every Supra RPC node. Covers accounts (resources, modules, coin and fungible-asset statements), transaction submission and simulation, gas price estimation, blocks and consensus blocks, events, Move view function execution, table item lookup, committee authorizations and event-emission / transaction-inclusion proofs, across four coexisting path versions (v1 through v4). Also exposes a JSON-RPC WebSocket upgrade at /rpc/v4/ws for newBlocks and newBlockHeaders subscriptions. Described by an OpenAPI 3.1.0 document the node itself serves at /docs/api.json.
The identity and technical contract details declared by the specification.
AccountAddress
string
Hex encoded account address.
AccountCoinStatementV1
object
2 properties
2 required
AccountCoinStatementV2
object
2 properties
2 required
AccountData
object
Datatype that holds the sequence number and account authentication key.
2 properties
2 required
AccountStatementV1
object
1 property
1 required
AccountStatementV2
object
1 property
1 required
AccountStatementV3
array
Account transactions of [TransactionV3] type.
AccumulatorProof
object
A proof that can be used authenticate an element in an accumulator given trusted root hash. For example, both TransactionInclusionProof and EventEmissionProof…
1 property
1 required
Address
The address of an account This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
AuthorizedCommittee
A versioned authorized committee, wrapping either V0 or V1.
AuthorizedCommitteeV0
object
A V0 authorized committee.
2 properties
2 required
AuthorizedCommitteeV1
object
A V1 authorized committee.
2 properties
2 required
BatchHeader
object
Batch metadata.
5 properties
5 required
BinaryData
A type reserved for internal use to represent [HttpResponse] with binary data.
Block
object
The API representation of a Supra block.
2 properties
1 required
BlockHeader
object
5 properties
5 required
BlockHeaderInfo
object
Metadata about a Supra block.
6 properties
6 required
BlockInfo
object
Metadata of a block including its digest.
2 properties
2 required
BlockMetadataInfoV3
object
Details of block metadata transaction execution
4 properties
3 required
BlockMetadataInfoV4
object
Details of block metadata transaction execution
5 properties
3 required
BlockV3
object
The API representation of a Supra block.
3 properties
1 required
BlockV4
object
The API representation of a Supra block.
3 properties
1 required
BlockVoteInfo
object
Metadata of a Moonshot consensus vote.
2 properties
2 required
CertificateThresholdType
string
Certificate_BlockVoteInfo
object
5 properties
5 required
Certificate_CommitteeInfo
object
5 properties
5 required
Certificate_TransactionsInclusionCertificationData
object
5 properties
5 required
CertifiedBlock
object
An [SmrBlock] certified by an [SmrQC].
2 properties
2 required
CommitteeAuthorization
object
A certificate indicating that the Committee with the hash digest contained in the related committee info is authorized to govern the related epoch.
1 property
1 required
CommitteeInfo
object
Metadata about a Committee required to construct a committee authorization.
2 properties
2 required
CommitteeV0
object
A committee of validators operating as a subset of the Supra blockchain network. Each Committee is assigned to perform a task for the duration of its associate…
3 properties
2 required
CommitteeV1
object
A V1 committee of validators operating as a subset of the Supra blockchain network. Each Committee is assigned to perform a task for the duration of its associ…
3 properties
3 required
ConsensusBlock
object
The API representation of a Supra Certified Consensus block.
2 properties
2 required
EpochId
object
2 properties
2 required
EpochInfo
object
Metadata about an epoch.
3 properties
3 required
ErrResp
object
1 property
1 required
EventEmissionProof
object
Proof of an event's emission within a transaction's events tree.
4 properties
4 required
EventEmissionProofEntry
object
A single matched event's emission proof plus the metadata needed to correlate it back to the caller's request.
4 properties
4 required
EventEmissionProofsBatchItem
object
Per-transaction selector. Both Move and EVM transactions are supported; the format of each entry in eventtypes is dispatched off the transaction's VM.
2 properties
2 required
EventEmissionProofsBatchItemResponse
object
Per-transaction proof bundle. A single transactioninclusionproof is shared across all matched events in the same transaction.
4 properties
4 required
EventEmissionProofsBatchRequest
object
Request body for POST /rpc/v4/proofs/event-emissions.
1 property
1 required
EventEmissionProofsBatchResponse
object
Response body for POST /rpc/v4/proofs/event-emissions. All proofs in the response are anchored to a single inclusion certificate at blockheight. A cross-chain…
3 properties
3 required
EventV1
object
On-chain event.
4 properties
4 required
EventV2
object
On-chain event v2.
5 properties
5 required
EventWithContextV3
object
Event wrapper with block height and transaction hash
3 properties
3 required
EventWithContextV4
object
Event wrapper with block height and transaction hash
4 properties
3 required
EventsV1
object
1 property
1 required
EventsV3
object
Events structure for v3 API
1 property
1 required
EventsV4
object
Events structure for v4 API
1 property
1 required
EvmTransactionOutput
API representation of the execution output of an Evm transaction.
EvmTransferOperation
object
This is a convenience structure wrapping [TransferOperation] to implement (de)serialization logic.
4 properties
4 required
ExecutedBlockInfo
object
Block metadata and existing statistics collected on executed block output.
2 properties
1 required
ExecutedBlockStats
object
Executed block statistics collected based on execution results.
8 properties
GasPriceRes
object
2 properties
2 required
GasPriceResV2
object
3 properties
3 required
GasPriceResV3
object
4 properties
4 required
Guid
object
A globally unique identifier derived from the sender's address and a counter
2 properties
2 required
Hash
string
Hex encoded hash
Identity
string
Hex encoded identity.
MoveModule
object
A Move module.
5 properties
5 required
MoveModuleBytecode
object
2 properties
2 required
MoveModuleList
object
2 properties
1 required
MoveModuleListV2
object
2 properties
1 required
MoveResource
object
A Move Resource.
2 properties
2 required
MoveResourceList
object
2 properties
1 required
MoveResourcesResponse
object
2 properties
2 required
MoveTransactionOutputV1
object
The execution output of a Move transaction.
3 properties
3 required
MoveTransactionOutputV4
object
The execution output of a Move transaction.
3 properties
3 required
MoveValue
An enum of the possible Move value types.
MoveValueResponseV1
object
Datatype for representing the MoveValue This struct is deprecated. Use the [super::v2::MoveValueResponse] struct instead.
1 property
1 required
MoveValueResponseV2
object
Datatype for representing the MoveValue
1 property
1 required
SignedSmrTransaction
object
Defines internal transactions (DKG and Oracle) coupled with signer data.
2 properties
2 required
SignedTransaction
object
Defines internal transactions(DKG and Oracle) coupled with signer data.
2 properties
2 required
SignerData
object
Signer information of the [crate::delegates::UnsignedSmrTransaction].
2 properties
2 required
SmrBlock
object
A Supra Moonshot block.
3 properties
3 required
SmrDkgCommitteeType
Defines supported committee types for which distributed key generation can be conducted.
SmrQC
object
1 property
1 required
SmrTimestamp
object
1 property
1 required
SmrTransactionHeader
object
6 properties
6 required
StructTag
object
4 properties
4 required
SupraTransaction
Transaction variants supported by Supra.
TableItemRequest
object
Describes body of the Table item request by item key.
3 properties
3 required
TransactionBlockInfo
object
Metadata about the block that finalized a particular [SmrTransaction].
3 properties
3 required
TransactionInclusionAndEventEmissionProof
object
Container for an event emission proof along with its corresponding transaction inclusion proof. This structure bundles the proofs required to verify that a spe…
2 properties
2 required
TransactionInclusionProof
object
Proof of a transaction's inclusion in the merkle accumulator tree.
7 properties
5 required
TransactionInfoV1
object
Information about a Supra transaction.
7 properties
5 required
TransactionInfoV2
object
Information about a Supra transaction.
7 properties
5 required
TransactionInfoV4
object
Information about a Supra transaction.
8 properties
5 required
TransactionOutputV1
[crate::v1::TransactionOutputV1] with all fields in human-readable format.
TransactionOutputV4
[crate::v4::TransactionOutputV4] with all fields in human-readable format.
TransactionParameters
object
1 property
1 required
TransactionsInclusionCertificates
object
A collection of transaction inclusion certificates for a given range of block heights. The entires are ordered by block height, with an entry being null if the…
1 property
1 required
TransactionsInclusionCertificationData
object
Data payload for transaction inclusion certificate. Certified by the transaction inclusion certifier to prove the both MoveVM and EVM merkle accumulator of a s…
4 properties
4 required
UnsignedSmrTransaction
object
Defines unsigned transaction enclosing only header and payload information.
2 properties
2 required
VMStatus
A VMStatus is represented as either - Executed indicating successful execution. - Error indicating an error from the VM itself. - MoveAbort indicating an abort…
ValidatorPublicKeys
object
The public keys held by a Supra validator. Intended to be stored in an unencrypted JSON file as a part of the validator's public identity for easy access by th…
2 properties
2 required
ValidatorV0
object
Information about a validator participating in a Committee.
4 properties
2 required
ValidatorV1
object
Information about a validator participating in a V1 Committee.
4 properties
3 required
VersionInfo
object
JSON payload returned by /rpc/v3/version
5 properties
5 required
View
object
2 properties
2 required
ViewRequest
object
View request for the Move View Function API.
3 properties
3 required
Vm
string
VM that produced a given transaction and its events. Determines which accumulator root in the shared inclusioncertificate a per-item transactioninclusionproof…
VoteType
string
The different types of valid vote messages in Moonshot.
The full machine-readable OpenAPI contract behind this narrative.