Skip to main content

/v1/transactions/encode_submission REST API Endpoint

Encodes a transaction submission, allowing users to prepare and structure their transactions accurately before submission.

Updated on
Oct 4, 2023

/v1/transactions/encode_submission REST API Endpoint

Query Parameters

sender
string
REQUIRED
The account from which the transaction was sent
sequence_number
string
REQUIRED
The sequence of a transaction sent by the specific sender
max_gas_amount
string
REQUIRED
The maximum amount of gas allocated for the execution of a transaction
gas_unit_price
string
REQUIRED
The cost per unit of gas, determining the transaction fee paid by the sender for each unit of computational resource consumed
expiration_timestamp_secs
string
REQUIRED
The timestamp indicating the expiration period of a transaction, specifying the time until which the transaction can be included in a block
payload
object
REQUIRED
The data that is being carried by a transaction. It contains the following fields:
type
string
The type of payload indicating the purpose of the data contained
function
string
The function associated with the payload
type_arguments
array
An array specifying the types of arguments provided to the function
arguments
array
An array containing the actual arguments passed to the function
signature
object
REQUIRED
An array with the following fields:
type
string
The type of signature used to verify the authenticity of the function
public_key
string
The public key associated with the account that generated the signature, used for verifying the signature's validity
signature
string
The actual signature generated using the private key corresponding to the public key provided

Returns

result
The encoded representation of the transaction submission, typically in a structured format such as JSON or XML
Request
1
curl --request POST \
2
--url https://docs-demo.aptos-mainnet.quiknode.pro/v1/transactions/encode_submission \
3
--header 'Accept: application/json, application/x-bcs' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
"sender": "SENDER_ADDRESS",
7
"sequence_number": "SEQUENCE_NUMBER",
8
"max_gas_amount": "MAX_GAS_AMOUNT",
9
"gas_unit_price": "GAS_UNIT_PRICE",
10
"expiration_timestamp_secs": "EXPIRATION_TIMESTAMP_SECS",
11
"payload": {
12
"type": "PAYLOAD_TYPE",
13
"function": "FUNCTION",
14
"type_arguments": [
15
"string"
16
],
17
"arguments": [
18
null
19
]
20
},
21
"secondary_signers": [
22
"SECONDARY_SIGNER_ADDRESS"
23
]
24
}'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free