Encode submission

This endpoint accepts an EncodeSubmissionRequest, which internally is a UserTransactionRequestInner (and optionally secondary signers) encoded as JSON, validates the request format, and then returns that request encoded in BCS. The client can then use this to create a transaction signature to be used in a SubmitTransactionRequest, which it then passes to the /transactions POST endpoint.

To be clear, this endpoint makes it possible to submit transaction requests to the API from languages that do not have library support for BCS. If you are using an SDK that has BCS support, such as the official Rust, TypeScript, or Python SDKs, you do not need to use this endpoint.

To sign a message using the response from this endpoint:

Decode the hex encoded string in the response to bytes.
Sign the bytes to create the signature.
Use that as the signature field in something like Ed25519Signature, which you then use to build a TransactionSignature.

POST

transactions

encode_submission

curl --request POST \
  --url https://aptos-mainnet.s.chainbase.online/{api-key}/v1/transactions/encode_submission \
  --header 'Content-Type: application/json' \
  --data '{
  "sender": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
  "sequence_number": "32425224034",
  "max_gas_amount": "32425224034",
  "gas_unit_price": "32425224034",
  "expiration_timestamp_secs": "32425224034",
  "payload": {
    "type": "entry_function_payload",
    "function": "0x1::aptos_coin::transfer",
    "type_arguments": [
      "<string>"
    ],
    "arguments": [
      "<any>"
    ]
  },
  "secondary_signers": [
    "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"
  ]
}'

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

Body

application/json

Request to encode a submission

sender

string

required

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.

Example:

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

sequence_number

string

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.

Example:

"32425224034"

max_gas_amount

string

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.

Example:

"32425224034"

gas_unit_price

string

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.

Example:

"32425224034"

expiration_timestamp_secs

string

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.

Example:

"32425224034"

payload

object

required

An enum of the possible transaction payloads

payload.type

string

required

Example:

"entry_function_payload"

payload.function

string

required

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.

Example:

"0x1::aptos_coin::transfer"

payload.type_arguments

string[]

required

Type arguments of the function

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).

payload.arguments

any[]

required

Arguments of the function

secondary_signers

string[]

Secondary signer accounts of the request for Multi-agent

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.

Response

200

application/json

All bytes (Vec<u8>) data is represented as hex-encoded string prefixed with 0x and fulfilled with two hex digits per byte.

Unlike the Address type, HexEncodedBytes will not trim any zeros.

Example:

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

curl --request POST \
  --url https://aptos-mainnet.s.chainbase.online/{api-key}/v1/transactions/encode_submission \
  --header 'Content-Type: application/json' \
  --data '{
  "sender": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
  "sequence_number": "32425224034",
  "max_gas_amount": "32425224034",
  "gas_unit_price": "32425224034",
  "expiration_timestamp_secs": "32425224034",
  "payload": {
    "type": "entry_function_payload",
    "function": "0x1::aptos_coin::transfer",
    "type_arguments": [
      "<string>"
    ],
    "arguments": [
      "<any>"
    ]
  },
  "secondary_signers": [
    "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"
  ]
}'

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

API Reference

Web3 API

SQL API

Encode submission

Body

Response