Wait for transaction by hash
GET/transactions/wait_by_hash/:txn_hash
Same as /transactions/by_hash, but will wait for a pending transaction to be committed. To be used as a long poll optimization by clients, to reduce latency caused by polling. The "long" poll is generally a second or less but dictated by the server; the client must deal with the result as if the request was a normal /transactions/by_hash request, e.g., by retrying if the transaction is pending.
Request
Path Parameters
Hash of transaction to retrieve
Responses
- 200
- 400
- 403
- 404
- 410
- 500
- 503
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
X-APTOS-CURSOR
string
Cursor to be used for endpoints that support cursor-based pagination. Pass this to the
startfield of the endpoint on the next call to get the next page of results.
- application/json
- application/x-bcs
- Schema
Schema
- Transaction_PendingTransaction
- Transaction_UserTransaction
- Transaction_GenesisTransaction
- Transaction_BlockMetadataTransaction
- Transaction_StateCheckpointTransaction
- Transaction_BlockEpilogueTransaction
- Transaction_ValidatorTransaction
- TransactionPayload_EntryFunctionPayload
- TransactionPayload_ScriptPayload
- TransactionPayload_DeprecatedModuleBundlePayload
- TransactionPayload_MultisigPayload
Array [
]
- MultisigTransactionPayload_EntryFunctionPayload
- TransactionSignature_Ed25519Signature
- TransactionSignature_MultiEd25519Signature
- TransactionSignature_MultiAgentSignature
- TransactionSignature_FeePayerSignature
- TransactionSignature_AccountSignature
-
A single Ed25519 key account, one private key
-
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
-
A single Secp256k1Ecdsa key account, one private key
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
Array [
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
]
-
A single Ed25519 key account, one private key
-
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
-
A single Secp256k1Ecdsa key account, one private key
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
Array [
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
]
-
A single Ed25519 key account, one private key
-
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
-
A single Secp256k1Ecdsa key account, one private key
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
-
A single Ed25519 key account, one private key
-
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
-
A single Secp256k1Ecdsa key account, one private key
- ed25519_signature
- multi_ed25519_signature
- single_key_signature
- multi_key_signature
- no_account_signature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
Array [
- WriteSetChange_DeleteModule
- WriteSetChange_DeleteResource
- WriteSetChange_DeleteTableItem
- WriteSetChange_WriteModule
- WriteSetChange_WriteResource
- WriteSetChange_WriteTableItem
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
0x10x1668f6be25668c1a17cd8caf6b8d2f25vector<u64>{255, 255}=>["255", "255"]vector<u8>{255, 255}=>0xffff- 0x1::string::String
is serialized into
string. For example, struct value0x1::string::String{bytes: b"Hello World!"}is serialized as"Hello World!"in JSON. ]
- TransactionPayload_EntryFunctionPayload
- TransactionPayload_ScriptPayload
- TransactionPayload_DeprecatedModuleBundlePayload
- TransactionPayload_MultisigPayload
Array [
]
- MultisigTransactionPayload_EntryFunctionPayload
- TransactionSignature_Ed25519Signature
- TransactionSignature_MultiEd25519Signature
- TransactionSignature_MultiAgentSignature
- TransactionSignature_FeePayerSignature
- TransactionSignature_AccountSignature
-
A single Ed25519 key account, one private key
-
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
-
A single Secp256k1Ecdsa key account, one private key
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
Array [
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
]
-
A single Ed25519 key account, one private key
-
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
-
A single Secp256k1Ecdsa key account, one private key
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
Array [
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
]
-
A single Ed25519 key account, one private key
-
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
-
A single Secp256k1Ecdsa key account, one private key
- AccountSignature_Ed25519Signature
- AccountSignature_MultiEd25519Signature
- AccountSignature_SingleKeySignature
- AccountSignature_MultiKeySignature
- AccountSignature_NoAccountSignature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
-
A single Ed25519 key account, one private key
-
A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.
-
A single Secp256k1Ecdsa key account, one private key
- ed25519_signature
- multi_ed25519_signature
- single_key_signature
- multi_key_signature
- no_account_signature
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
Array [
- PublicKey_Ed25519
- PublicKey_Secp256k1Ecdsa
- PublicKey_Secp256r1Ecdsa
- PublicKey_Keyless
- PublicKey_FederatedKeyless
]
Array [
- Signature_Ed25519
- Signature_Secp256k1Ecdsa
- Signature_WebAuthn
- Signature_Keyless
]
Array [
]
Array [
- WriteSetChange_DeleteModule
- WriteSetChange_DeleteResource
- WriteSetChange_DeleteTableItem
- WriteSetChange_WriteModule
- WriteSetChange_WriteResource
- WriteSetChange_WriteTableItem
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
0x10x1668f6be25668c1a17cd8caf6b8d2f25vector<u64>{255, 255}=>["255", "255"]vector<u8>{255, 255}=>0xffff- 0x1::string::String
is serialized into
string. For example, struct value0x1::string::String{bytes: b"Hello World!"}is serialized as"Hello World!"in JSON. ]
- GenesisPayload_WriteSetPayload
- WriteSet_ScriptWriteSet
- WriteSet_DirectWriteSet
Array [
]
Array [
- WriteSetChange_DeleteModule
- WriteSetChange_DeleteResource
- WriteSetChange_DeleteTableItem
- WriteSetChange_WriteModule
- WriteSetChange_WriteResource
- WriteSetChange_WriteTableItem
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
0x10x1668f6be25668c1a17cd8caf6b8d2f25vector<u64>{255, 255}=>["255", "255"]vector<u8>{255, 255}=>0xffff- 0x1::string::String
is serialized into
string. For example, struct value0x1::string::String{bytes: b"Hello World!"}is serialized as"Hello World!"in JSON. ]
Array [
]
Array [
]
Array [
- WriteSetChange_DeleteModule
- WriteSetChange_DeleteResource
- WriteSetChange_DeleteTableItem
- WriteSetChange_WriteModule
- WriteSetChange_WriteResource
- WriteSetChange_WriteTableItem
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
0x10x1668f6be25668c1a17cd8caf6b8d2f25vector<u64>{255, 255}=>["255", "255"]vector<u8>{255, 255}=>0xffff- 0x1::string::String
is serialized into
string. For example, struct value0x1::string::String{bytes: b"Hello World!"}is serialized as"Hello World!"in JSON. ]
Array [
]
Array [
- WriteSetChange_DeleteModule
- WriteSetChange_DeleteResource
- WriteSetChange_DeleteTableItem
- WriteSetChange_WriteModule
- WriteSetChange_WriteResource
- WriteSetChange_WriteTableItem
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
0x10x1668f6be25668c1a17cd8caf6b8d2f25vector<u64>{255, 255}=>["255", "255"]vector<u8>{255, 255}=>0xffff- 0x1::string::String
is serialized into
string. For example, struct value0x1::string::String{bytes: b"Hello World!"}is serialized as"Hello World!"in JSON. ]
Array [
- WriteSetChange_DeleteModule
- WriteSetChange_DeleteResource
- WriteSetChange_DeleteTableItem
- WriteSetChange_WriteModule
- WriteSetChange_WriteResource
- WriteSetChange_WriteTableItem
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
0x10x1668f6be25668c1a17cd8caf6b8d2f25vector<u64>{255, 255}=>["255", "255"]vector<u8>{255, 255}=>0xffff- 0x1::string::String
is serialized into
string. For example, struct value0x1::string::String{bytes: b"Hello World!"}is serialized as"Hello World!"in JSON. ]
- ValidatorTransaction_JWKUpdateTransaction
- ValidatorTransaction_DKGResultTransaction
Array [
- WriteSetChange_DeleteModule
- WriteSetChange_DeleteResource
- WriteSetChange_DeleteTableItem
- WriteSetChange_WriteModule
- WriteSetChange_WriteResource
- WriteSetChange_WriteTableItem
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
0x10x1668f6be25668c1a17cd8caf6b8d2f25vector<u64>{255, 255}=>["255", "255"]vector<u8>{255, 255}=>0xffff- 0x1::string::String
is serialized into
string. For example, struct value0x1::string::String{bytes: b"Hello World!"}is serialized as"Hello World!"in JSON. ]
Array [
]
Array [
- RSA_JWK
- UnsupportedJWK
]
Array [
- WriteSetChange_DeleteModule
- WriteSetChange_DeleteResource
- WriteSetChange_DeleteTableItem
- WriteSetChange_WriteModule
- WriteSetChange_WriteResource
- WriteSetChange_WriteTableItem
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Array [
Array [
]
]
Array [
Array [
]
Array [
]
]
move_module_address,module_nameandstruct_name, all joined by::struct generic type parametersjoined by,0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>0x1::account::Account- Empty chars should be ignored when comparing 2 struct tag ids.
- When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
0x10x1668f6be25668c1a17cd8caf6b8d2f25vector<u64>{255, 255}=>["255", "255"]vector<u8>{255, 255}=>0xffff- 0x1::string::String
is serialized into
string. For example, struct value0x1::string::String{bytes: b"Hello World!"}is serialized as"Hello World!"in JSON. ]
Array [
]
oneOf
Possible values: [pending_transaction]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
payload
object
required
An enum of the possible transaction payloads
oneOf
Payload which runs a single entry function
Possible values: [entry_function_payload]
Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Type arguments of the function
Arguments of the function
Payload which runs a script that can run multiple functions
Possible values: [script_payload]
code
object
required
Move script bytecode
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
Move function
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Type arguments of the function
Arguments of the function
Possible values: [module_bundle_payload]
A multisig transaction that allows an owner of a multisig account to execute a pre-approved transaction as the multisig account.
Possible values: [multisig_payload]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
transaction_payload
object
oneOf
Payload which runs a single entry function
Possible values: [entry_function_payload]
Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Type arguments of the function
Arguments of the function
signature
object
An enum representing the different transaction signatures available
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Multi agent signature for multi agent transactions
This allows you to have transactions across multiple accounts
Possible values: [multi_agent_signature]
sender
object
required
Account signature scheme
The account signature scheme allows you to have two types of accounts:
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
The other involved parties' addresses
secondary_signers
object[]
required
The associated signatures, in the same order as the secondary addresses
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
Fee payer signature for fee payer transactions
This allows you to have transactions across multiple accounts and with a fee payer
Possible values: [fee_payer_signature]
sender
object
required
Account signature scheme
The account signature scheme allows you to have two types of accounts:
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
The other involved parties' addresses
secondary_signers
object[]
required
The associated signatures, in the same order as the secondary addresses
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
fee_payer_signer
object
required
Account signature scheme
The account signature scheme allows you to have two types of accounts:
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
Account signature scheme
The account signature scheme allows you to have two types of accounts:
type
string
required
Possible values: [ed25519_signature, multi_ed25519_signature, single_key_signature, multi_key_signature, no_account_signature]
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [no_account_signature]
Possible values: [user_transaction]
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Whether the transaction was successful
The VM status of the transaction, can tell useful information in a failure
changes
object[]
required
Final state of resources changed by the transaction
oneOf
Delete a module
Possible values: [delete_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Move module id is a string representation of Move module.
Format: {address}::{module name}
address should be hex-encoded 32 byte account address that is prefixed with 0x.
Module name is case-sensitive.
Delete a resource
Possible values: [delete_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
Delete a table item
Possible values: [delete_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Deleted table data
Deleted key
Deleted key type
Write a new module or update an existing one
Possible values: [write_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
Move module bytecode along with it's ABI
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
A Move module
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Write a resource or update an existing one
Possible values: [write_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
A parsed Move resource
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.
To clarify, you might query for 0x1::account::Account and see the example data.
Move bool type value is serialized into boolean.
Move u8, u16 and u32 type value is serialized into integer.
Move u64, u128 and u256 type value is serialized into string.
Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.
For example:
Move vector type value is serialized into array, except vector<u8> which is serialized into a
HexEncodedBytes string with 0x prefix.
For example:
Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):
{
field1_name: field1_value,
field2_name: field2_value,
......
}
For example:
{ "created": "0xa550c18", "role_id": "0" }
Special serialization for Move stdlib types:
Change set to write a table item
Possible values: [write_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Decoded table data
Key of table in JSON
Type of key
Value of table in JSON
Type of value
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
payload
object
required
An enum of the possible transaction payloads
oneOf
Payload which runs a single entry function
Possible values: [entry_function_payload]
Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Type arguments of the function
Arguments of the function
Payload which runs a script that can run multiple functions
Possible values: [script_payload]
code
object
required
Move script bytecode
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
Move function
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Type arguments of the function
Arguments of the function
Possible values: [module_bundle_payload]
A multisig transaction that allows an owner of a multisig account to execute a pre-approved transaction as the multisig account.
Possible values: [multisig_payload]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
transaction_payload
object
oneOf
Payload which runs a single entry function
Possible values: [entry_function_payload]
Entry function id is string representation of a entry function defined on-chain.
Format: {address}::{module name}::{function name}
Both module name and function name are case-sensitive.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Type arguments of the function
Arguments of the function
signature
object
An enum representing the different transaction signatures available
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Multi agent signature for multi agent transactions
This allows you to have transactions across multiple accounts
Possible values: [multi_agent_signature]
sender
object
required
Account signature scheme
The account signature scheme allows you to have two types of accounts:
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
The other involved parties' addresses
secondary_signers
object[]
required
The associated signatures, in the same order as the secondary addresses
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
Fee payer signature for fee payer transactions
This allows you to have transactions across multiple accounts and with a fee payer
Possible values: [fee_payer_signature]
sender
object
required
Account signature scheme
The account signature scheme allows you to have two types of accounts:
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
The other involved parties' addresses
secondary_signers
object[]
required
The associated signatures, in the same order as the secondary addresses
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
fee_payer_signer
object
required
Account signature scheme
The account signature scheme allows you to have two types of accounts:
oneOf
A single Ed25519 signature
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A Ed25519 multi-sig signature
This allows k-of-n signing for a transaction
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A single key signature
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A multi key signature
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
A placeholder to represent the absence of account signature
Possible values: [no_account_signature]
Account signature scheme
The account signature scheme allows you to have two types of accounts:
type
string
required
Possible values: [ed25519_signature, multi_ed25519_signature, single_key_signature, multi_key_signature, no_account_signature]
Possible values: [ed25519_signature]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [multi_ed25519_signature]
The public keys for the Ed25519 signature
Signature associated with the public keys in the same order
The number of signatures required for a successful transaction
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [single_key_signature]
public_key
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [multi_key_signature]
public_keys
object[]
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256r1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [federated_keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
signatures
object[]
required
signature
object
required
oneOf
Possible values: [ed25519]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [secp256k1_ecdsa]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [web_authn]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [keyless]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [no_account_signature]
events
object[]
required
Events generated by the transaction
guid
object
required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
The JSON representation of the event
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: [genesis_transaction]
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Whether the transaction was successful
The VM status of the transaction, can tell useful information in a failure
changes
object[]
required
Final state of resources changed by the transaction
oneOf
Delete a module
Possible values: [delete_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Move module id is a string representation of Move module.
Format: {address}::{module name}
address should be hex-encoded 32 byte account address that is prefixed with 0x.
Module name is case-sensitive.
Delete a resource
Possible values: [delete_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
Delete a table item
Possible values: [delete_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Deleted table data
Deleted key
Deleted key type
Write a new module or update an existing one
Possible values: [write_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
Move module bytecode along with it's ABI
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
A Move module
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Write a resource or update an existing one
Possible values: [write_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
A parsed Move resource
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.
To clarify, you might query for 0x1::account::Account and see the example data.
Move bool type value is serialized into boolean.
Move u8, u16 and u32 type value is serialized into integer.
Move u64, u128 and u256 type value is serialized into string.
Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.
For example:
Move vector type value is serialized into array, except vector<u8> which is serialized into a
HexEncodedBytes string with 0x prefix.
For example:
Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):
{
field1_name: field1_value,
field2_name: field2_value,
......
}
For example:
{ "created": "0xa550c18", "role_id": "0" }
Special serialization for Move stdlib types:
Change set to write a table item
Possible values: [write_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Decoded table data
Key of table in JSON
Type of key
Value of table in JSON
Type of value
payload
object
required
The writeset payload of the Genesis transaction
oneOf
A writeset payload, used only for genesis
Possible values: [write_set_payload]
write_set
object
required
The associated writeset with a payload
oneOf
Possible values: [script_write_set]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
script
object
required
Payload which runs a script that can run multiple functions
code
object
required
Move script bytecode
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
Move function
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Type arguments of the function
Arguments of the function
Possible values: [direct_write_set]
changes
object[]
required
oneOf
Delete a module
Possible values: [delete_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Move module id is a string representation of Move module.
Format: {address}::{module name}
address should be hex-encoded 32 byte account address that is prefixed with 0x.
Module name is case-sensitive.
Delete a resource
Possible values: [delete_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
Delete a table item
Possible values: [delete_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Deleted table data
Deleted key
Deleted key type
Write a new module or update an existing one
Possible values: [write_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
Move module bytecode along with it's ABI
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
A Move module
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Write a resource or update an existing one
Possible values: [write_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
A parsed Move resource
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.
To clarify, you might query for 0x1::account::Account and see the example data.
Move bool type value is serialized into boolean.
Move u8, u16 and u32 type value is serialized into integer.
Move u64, u128 and u256 type value is serialized into string.
Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.
For example:
Move vector type value is serialized into array, except vector<u8> which is serialized into a
HexEncodedBytes string with 0x prefix.
For example:
Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):
{
field1_name: field1_value,
field2_name: field2_value,
......
}
For example:
{ "created": "0xa550c18", "role_id": "0" }
Special serialization for Move stdlib types:
Change set to write a table item
Possible values: [write_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Decoded table data
Key of table in JSON
Type of key
Value of table in JSON
Type of value
events
object[]
required
guid
object
required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
The JSON representation of the event
events
object[]
required
Events emitted during genesis
guid
object
required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
The JSON representation of the event
Possible values: [block_metadata_transaction]
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Whether the transaction was successful
The VM status of the transaction, can tell useful information in a failure
changes
object[]
required
Final state of resources changed by the transaction
oneOf
Delete a module
Possible values: [delete_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Move module id is a string representation of Move module.
Format: {address}::{module name}
address should be hex-encoded 32 byte account address that is prefixed with 0x.
Module name is case-sensitive.
Delete a resource
Possible values: [delete_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
Delete a table item
Possible values: [delete_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Deleted table data
Deleted key
Deleted key type
Write a new module or update an existing one
Possible values: [write_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
Move module bytecode along with it's ABI
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
A Move module
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Write a resource or update an existing one
Possible values: [write_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
A parsed Move resource
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.
To clarify, you might query for 0x1::account::Account and see the example data.
Move bool type value is serialized into boolean.
Move u8, u16 and u32 type value is serialized into integer.
Move u64, u128 and u256 type value is serialized into string.
Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.
For example:
Move vector type value is serialized into array, except vector<u8> which is serialized into a
HexEncodedBytes string with 0x prefix.
For example:
Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):
{
field1_name: field1_value,
field2_name: field2_value,
......
}
For example:
{ "created": "0xa550c18", "role_id": "0" }
Special serialization for Move stdlib types:
Change set to write a table item
Possible values: [write_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Decoded table data
Key of table in JSON
Type of key
Value of table in JSON
Type of value
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
events
object[]
required
The events emitted at the block creation
guid
object
required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
The JSON representation of the event
Previous block votes
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
The indices of the proposers who failed to propose
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: [state_checkpoint_transaction]
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Whether the transaction was successful
The VM status of the transaction, can tell useful information in a failure
changes
object[]
required
Final state of resources changed by the transaction
oneOf
Delete a module
Possible values: [delete_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Move module id is a string representation of Move module.
Format: {address}::{module name}
address should be hex-encoded 32 byte account address that is prefixed with 0x.
Module name is case-sensitive.
Delete a resource
Possible values: [delete_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
Delete a table item
Possible values: [delete_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Deleted table data
Deleted key
Deleted key type
Write a new module or update an existing one
Possible values: [write_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
Move module bytecode along with it's ABI
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
A Move module
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Write a resource or update an existing one
Possible values: [write_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
A parsed Move resource
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.
To clarify, you might query for 0x1::account::Account and see the example data.
Move bool type value is serialized into boolean.
Move u8, u16 and u32 type value is serialized into integer.
Move u64, u128 and u256 type value is serialized into string.
Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.
For example:
Move vector type value is serialized into array, except vector<u8> which is serialized into a
HexEncodedBytes string with 0x prefix.
For example:
Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):
{
field1_name: field1_value,
field2_name: field2_value,
......
}
For example:
{ "created": "0xa550c18", "role_id": "0" }
Special serialization for Move stdlib types:
Change set to write a table item
Possible values: [write_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Decoded table data
Key of table in JSON
Type of key
Value of table in JSON
Type of value
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: [block_epilogue_transaction]
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Whether the transaction was successful
The VM status of the transaction, can tell useful information in a failure
changes
object[]
required
Final state of resources changed by the transaction
oneOf
Delete a module
Possible values: [delete_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Move module id is a string representation of Move module.
Format: {address}::{module name}
address should be hex-encoded 32 byte account address that is prefixed with 0x.
Module name is case-sensitive.
Delete a resource
Possible values: [delete_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
Delete a table item
Possible values: [delete_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Deleted table data
Deleted key
Deleted key type
Write a new module or update an existing one
Possible values: [write_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
Move module bytecode along with it's ABI
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
A Move module
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Write a resource or update an existing one
Possible values: [write_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
A parsed Move resource
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.
To clarify, you might query for 0x1::account::Account and see the example data.
Move bool type value is serialized into boolean.
Move u8, u16 and u32 type value is serialized into integer.
Move u64, u128 and u256 type value is serialized into string.
Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.
For example:
Move vector type value is serialized into array, except vector<u8> which is serialized into a
HexEncodedBytes string with 0x prefix.
For example:
Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):
{
field1_name: field1_value,
field2_name: field2_value,
......
}
For example:
{ "created": "0xa550c18", "role_id": "0" }
Special serialization for Move stdlib types:
Change set to write a table item
Possible values: [write_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Decoded table data
Key of table in JSON
Type of key
Value of table in JSON
Type of value
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
block_end_info
object
oneOf
Possible values: [observed_jwk_update]
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Whether the transaction was successful
The VM status of the transaction, can tell useful information in a failure
changes
object[]
required
Final state of resources changed by the transaction
oneOf
Delete a module
Possible values: [delete_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Move module id is a string representation of Move module.
Format: {address}::{module name}
address should be hex-encoded 32 byte account address that is prefixed with 0x.
Module name is case-sensitive.
Delete a resource
Possible values: [delete_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
Delete a table item
Possible values: [delete_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Deleted table data
Deleted key
Deleted key type
Write a new module or update an existing one
Possible values: [write_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
Move module bytecode along with it's ABI
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
A Move module
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Write a resource or update an existing one
Possible values: [write_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
A parsed Move resource
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.
To clarify, you might query for 0x1::account::Account and see the example data.
Move bool type value is serialized into boolean.
Move u8, u16 and u32 type value is serialized into integer.
Move u64, u128 and u256 type value is serialized into string.
Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.
For example:
Move vector type value is serialized into array, except vector<u8> which is serialized into a
HexEncodedBytes string with 0x prefix.
For example:
Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):
{
field1_name: field1_value,
field2_name: field2_value,
......
}
For example:
{ "created": "0xa550c18", "role_id": "0" }
Special serialization for Move stdlib types:
Change set to write a table item
Possible values: [write_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Decoded table data
Key of table in JSON
Type of key
Value of table in JSON
Type of value
events
object[]
required
guid
object
required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
The JSON representation of the event
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
quorum_certified_update
object
required
A more API-friendly representation of the on-chain aptos_types::jwks::QuorumCertifiedUpdate.
update
object
required
A more API-friendly representation of the on-chain aptos_types::jwks::ProviderJWKs.
jwks
object[]
required
anyOf
Move type 0x1::jwks::RSA_JWK in rust.
See its doc in Move for more details.
Move type 0x1::jwks::UnsupportedJWK in rust.
See its doc in Move for more details.
multi_sig
object
required
A more API-friendly representation of the on-chain aptos_types::aggregate_signature::AggregateSignature.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [dkg_result]
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Whether the transaction was successful
The VM status of the transaction, can tell useful information in a failure
changes
object[]
required
Final state of resources changed by the transaction
oneOf
Delete a module
Possible values: [delete_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Move module id is a string representation of Move module.
Format: {address}::{module name}
address should be hex-encoded 32 byte account address that is prefixed with 0x.
Module name is case-sensitive.
Delete a resource
Possible values: [delete_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
Delete a table item
Possible values: [delete_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Deleted table data
Deleted key
Deleted key type
Write a new module or update an existing one
Possible values: [write_module]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
Move module bytecode along with it's ABI
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
abi
object
A Move module
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
Friends of the module
exposed_functions
object[]
required
Public functions of the module
Possible values: [private, public, friend]
Move function visibility
Whether the function can be called as an entry function directly in a transaction
Whether the function is a view function or not
generic_type_params
object[]
required
Generic type params associated with the Move function
Move abilities tied to the generic type param and associated with the function that uses it
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Parameters associated with the move function
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
Return type of the function
structs
object[]
required
Structs of the module
Whether the struct is a native struct of Move
Whether the struct is marked with the #[event] annotation
Abilities associated with the struct
generic_type_params
object[]
required
Generic types associated with the struct
Move abilities tied to the generic type param and associated with the type that uses it
fields
object[]
required
Fields associated with the struct
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
Write a resource or update an existing one
Possible values: [write_resource]
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
State key hash
data
object
required
A parsed Move resource
Possible values: Value must match regular expression ^0x[0-9a-zA-Z:_<>]+$
String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
It is a combination of:
Examples:
Note:
See doc for more details.
This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource.
To clarify, you might query for 0x1::account::Account and see the example data.
Move bool type value is serialized into boolean.
Move u8, u16 and u32 type value is serialized into integer.
Move u64, u128 and u256 type value is serialized into string.
Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.
For example:
Move vector type value is serialized into array, except vector<u8> which is serialized into a
HexEncodedBytes string with 0x prefix.
For example:
Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):
{
field1_name: field1_value,
field2_name: field2_value,
......
}
For example:
{ "created": "0xa550c18", "role_id": "0" }
Special serialization for Move stdlib types:
Change set to write a table item
Possible values: [write_table_item]
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
data
object
Decoded table data
Key of table in JSON
Type of key
Value of table in JSON
Type of value
events
object[]
required
guid
object
required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
Possible values: Value must match regular expression ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$
String representation of an on-chain Move type tag that is exposed in transaction payload.
Values:
- bool
- u8
- u16
- u32
- u64
- u128
- u256
- address
- signer
- vector: vector<{non-reference MoveTypeId}>
- struct: {address}::{module_name}::{struct_name}::<{generic types}>
Vector type value examples:
- `vector<u8>`
- `vector<vector<u64>>`
- `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`
Struct type value examples:
- `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
- `0x1::account::Account`
Note:
1. Empty chars should be ignored when comparing 2 struct tag ids.
2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
The JSON representation of the event
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
dkg_transcript
object
required
A string containing a 64-bit unsigned integer.
We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.
A hex encoded 32 byte Aptos account address.
This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.
For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.
All bytes (Vec0x and fulfilled with
two hex digits per byte.
Unlike the Address type, HexEncodedBytes will not trim any zeros.
Possible values: [validator_transaction]
- Schema
- Example (from schema)
Schema
Array [
]
integer
[
0
]
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]
These codes provide more granular error information beyond just the HTTP status code of the response.
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]
These codes provide more granular error information beyond just the HTTP status code of the response.
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]
These codes provide more granular error information beyond just the HTTP status code of the response.
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]
These codes provide more granular error information beyond just the HTTP status code of the response.
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]
These codes provide more granular error information beyond just the HTTP status code of the response.
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}
Response Headers
X-APTOS-CHAIN-ID
integer
Chain ID of the current chain
X-APTOS-LEDGER-VERSION
integer
Current ledger version of the chain
X-APTOS-LEDGER-OLDEST-VERSION
integer
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC
integer
Current timestamp of the chain
X-APTOS-EPOCH
integer
Current epoch of the chain
X-APTOS-BLOCK-HEIGHT
integer
Current block height of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT
integer
Oldest non-pruned block height of the chain
X-APTOS-GAS-USED
integer
The cost of the call in terms of gas
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
Possible values: [account_not_found, resource_not_found, module_not_found, struct_field_not_found, version_not_found, transaction_not_found, table_item_not_found, block_not_found, state_value_not_found, version_pruned, block_pruned, invalid_input, invalid_transaction_update, sequence_number_too_old, vm_error, health_check_failed, mempool_is_full, internal_error, web_framework_error, bcs_not_supported, api_disabled]
These codes provide more granular error information beyond just the HTTP status code of the response.
A code providing VM error details when submitting transactions to the VM
{
"message": "string",
"error_code": "account_not_found",
"vm_error_code": 0
}