Sui API Reference
Sui JSON-RPC API (V 1.3.0) for interaction with Sui Full node. Make RPC calls using https://fullnode.NETWORK.sui.io:443, where NETWORK is the network you want to use (testnet, devnet, mainnet). By default, local networks use port 9000.
sui_devInspectTransactionBlock​
Write API
Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.
Params
sender_address:<SuiAddress>-tx_bytes:<Base64>- BCS encoded TransactionKind(as opposed to TransactionData, which include gasBudget and gasPrice)gas_price:<BigInt_for_uint64>- Gas is not charged, but gas usage is still calculated. Default to use reference gas priceepoch:<BigInt_for_uint64>- The epoch to perform the call. Will be set from the system state object if not provided
Result
-
DevInspectResults:<DevInspectResults>- effects :
<[TransactionBlockEffects]>- Summary of effects that likely would be generated if the transaction is actually run. Note however, that not all dev-inspect transactions are actually usable as transactions so it might not be possible actually generate these effects from a normal transaction. - error :
<string,null>- Execution error from executing the transactions - events :
<[Event]>- Events that likely would be generated if the transaction is actually run. - results :
<[SuiExecutionResult]>- Execution results (including return values) from executing the transactions
- effects :
Example Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_devInspectTransactionBlock",
"params": [
"0xd70420418b84502e506794227f897237764dde8d79a01ab2104bf742a277a2ab",
"AAACACBnxtMcbJcOVn8D72fYEaT4Q2ZbjePygvpIs+AQO6m77QEAagYVO5/EhuEB8OnicDrIZm0GrsxN3355JqNhlwxlpbECAAAAAAAAACDoQ3EipycU+/EOvBcDPFtMkZiSbdzWAw3CwdmQCAtBWAEBAQEBAAEAAC9cVD1xauQ9RT3rOxmbva8bxwMMdoL4dwPc5DEkj+3gASxDgF0Nb1QCp60Npb3sVJx83qBrxKHTOaIlIe6pM7iJAgAAAAAAAAAgnvsgc1pPauyCE27/c+aBnHN3fSsxRAWdEJYzYFOryNAvXFQ9cWrkPUU96zsZm72vG8cDDHaC+HcD3OQxJI/t4AoAAAAAAAAAAC0xAQAAAAAA",
1000,
8888
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"effects": {
"messageVersion": "v1",
"status": {
"status": "success"
},
"executedEpoch": "0",
"gasUsed": {
"computationCost": "100",
"storageCost": "100",
"storageRebate": "10",
"nonRefundableStorageFee": "0"
},
"transactionDigest": "76gyHCk7FRrGACRqXM7Ybj5uJLtAzgEMJ5P9CeEzxZSG",
"mutated": [
{
"owner": {
"AddressOwner": "0x2f5c543d716ae43d453deb3b199bbdaf1bc7030c7682f87703dce431248fede0"
},
"reference": {
"objectId": "0x2c43805d0d6f5402a7ad0da5bdec549c7cdea06bc4a1d339a22521eea933b889",
"version": 2,
"digest": "BhbWpBeESxuRWvmvLMyb2JNUuFa6j4aG1T4WUiPgKAHm"
}
},
{
"owner": {
"AddressOwner": "0x67c6d31c6c970e567f03ef67d811a4f843665b8de3f282fa48b3e0103ba9bbed"
},
"reference": {
"objectId": "0x6a06153b9fc486e101f0e9e2703ac8666d06aecc4ddf7e7926a361970c65a5b1",
"version": 2,
"digest": "GdfET1avZReDftpJNB8LSuHJ2cKUheSbEaLMzuPVXHsM"
}
}
],
"gasObject": {
"owner": {
"ObjectOwner": "0x2f5c543d716ae43d453deb3b199bbdaf1bc7030c7682f87703dce431248fede0"
},
"reference": {
"objectId": "0x2c43805d0d6f5402a7ad0da5bdec549c7cdea06bc4a1d339a22521eea933b889",
"version": 2,
"digest": "BhbWpBeESxuRWvmvLMyb2JNUuFa6j4aG1T4WUiPgKAHm"
}
},
"eventsDigest": "6kerMphN4S5QTfd9TAhwMiFq1q9c2YwfpheBfWm85vUq"
},
"events": []
}
}
sui_dryRunTransactionBlock​
Write API
Return transaction execution effects including the gas cost summary, while the effects are not committed to the chain.
Params
tx_bytes:<Base64>-
Result
-
DryRunTransactionBlockResponse:<DryRunTransactionBlockResponse>- balanceChanges :
<[BalanceChange]> - effects :
<TransactionBlockEffects> - events :
<[Event]> - input :
<TransactionBlockData> - objectChanges :
<[ObjectChange]>
- balanceChanges :
Example Dry runs a transaction block to get back estimated gas fees and other potential effects.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_dryRunTransactionBlock",
"params": [
"AAACACB7qR3cfnF89wjJNwYPBASHNuwz+xdG2Zml5YzVxnftgAEAT4LxyFh7mNZMAL+0bDhDvYv2zPp8ZahhOGmM0f3Kw9wCAAAAAAAAACCxDABG4pPAjOwPQHg9msS/SrtNf4IGR/2F0ZGD3ufH/wEBAQEBAAEAAGH7tbTzQqQL2/h/5KlGueONGM+P/HsAALl1F1x7apV2AejYx86GPzE9o9vZKoPvJtEouI/ma/JuDg0Jza9yfR2EAgAAAAAAAAAgzMqpegLMOpgEFnDhYJ23FOmFjJbp5GmFXxzzv9+X6GVh+7W080KkC9v4f+SpRrnjjRjPj/x7AAC5dRdce2qVdgoAAAAAAAAAAC0xAQAAAAAA"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"digest": "Gm54bTY5F9KjiCw3kfKpkXPaEE3kx8ToJkYqTsuQDZ7q",
"transaction": {
"data": {
"messageVersion": "v1",
"transaction": {
"kind": "ProgrammableTransaction",
"inputs": [
{
"type": "pure",
"valueType": "address",
"value": "0x7ba91ddc7e717cf708c937060f04048736ec33fb1746d999a5e58cd5c677ed80"
},
{
"type": "object",
"objectType": "immOrOwnedObject",
"objectId": "0x4f82f1c8587b98d64c00bfb46c3843bd8bf6ccfa7c65a86138698cd1fdcac3dc",
"version": "2",
"digest": "Cv7n2YaM7Am1ssZGu4khsFkcKHnpgVhwFCSs4kLjrtLW"
}
],
"transactions": [
{
"TransferObjects": [
[
{
"Input": 1
}
],
{
"Input": 0
}
]
}
]
},
"sender": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576",
"gasData": {
"payment": [
{
"objectId": "0xe8d8c7ce863f313da3dbd92a83ef26d128b88fe66bf26e0e0d09cdaf727d1d84",
"version": 2,
"digest": "EnRQXe1hDGAJCFyF2ds2GmPHdvf9V6yxf24LisEsDkYt"
}
],
"owner": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576",
"price": "10",
"budget": "20000000"
}
},
"txSignatures": [
"AGLsaLe6fSvGG/YgrxirjhKqE21kVCcveOW9h0IiCZ1Ei/oAOmu95EnKjoBhLHcS2/2Ga2Ljw0BVnGrY6reYkwVDij1TvBYKLcfLNo8fq6GASb9yfo6uvuwNUBGkTf54wQ=="
]
},
"rawTransaction": "AQAAAAAAAgAge6kd3H5xfPcIyTcGDwQEhzbsM/sXRtmZpeWM1cZ37YABAE+C8chYe5jWTAC/tGw4Q72L9sz6fGWoYThpjNH9ysPcAgAAAAAAAAAgsQwARuKTwIzsD0B4PZrEv0q7TX+CBkf9hdGRg97nx/8BAQEBAQABAABh+7W080KkC9v4f+SpRrnjjRjPj/x7AAC5dRdce2qVdgHo2MfOhj8xPaPb2SqD7ybRKLiP5mvybg4NCc2vcn0dhAIAAAAAAAAAIMzKqXoCzDqYBBZw4WCdtxTphYyW6eRphV8c87/fl+hlYfu1tPNCpAvb+H/kqUa5440Yz4/8ewAAuXUXXHtqlXYKAAAAAAAAAAAtMQEAAAAAAAFhAGLsaLe6fSvGG/YgrxirjhKqE21kVCcveOW9h0IiCZ1Ei/oAOmu95EnKjoBhLHcS2/2Ga2Ljw0BVnGrY6reYkwVDij1TvBYKLcfLNo8fq6GASb9yfo6uvuwNUBGkTf54wQ==",
"effects": {
"messageVersion": "v1",
"status": {
"status": "success"
},
"executedEpoch": "0",
"gasUsed": {
"computationCost": "100",
"storageCost": "100",
"storageRebate": "10",
"nonRefundableStorageFee": "0"
},
"transactionDigest": "8UExPV121BEfWkbymSPDYhh23rVNh3MSWtC5juJ9JGMJ",
"mutated": [
{
"owner": {
"AddressOwner": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576"
},
"reference": {
"objectId": "0xe8d8c7ce863f313da3dbd92a83ef26d128b88fe66bf26e0e0d09cdaf727d1d84",
"version": 2,
"digest": "EnRQXe1hDGAJCFyF2ds2GmPHdvf9V6yxf24LisEsDkYt"
}
},
{
"owner": {
"AddressOwner": "0x7ba91ddc7e717cf708c937060f04048736ec33fb1746d999a5e58cd5c677ed80"
},
"reference": {
"objectId": "0x4f82f1c8587b98d64c00bfb46c3843bd8bf6ccfa7c65a86138698cd1fdcac3dc",
"version": 2,
"digest": "Cv7n2YaM7Am1ssZGu4khsFkcKHnpgVhwFCSs4kLjrtLW"
}
}
],
"gasObject": {
"owner": {
"ObjectOwner": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576"
},
"reference": {
"objectId": "0xe8d8c7ce863f313da3dbd92a83ef26d128b88fe66bf26e0e0d09cdaf727d1d84",
"version": 2,
"digest": "EnRQXe1hDGAJCFyF2ds2GmPHdvf9V6yxf24LisEsDkYt"
}
},
"eventsDigest": "55TNn3v5vpuXjQfjqamw76P9GZD522pumo4NuT7RYeFB"
},
"objectChanges": [
{
"type": "transferred",
"sender": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576",
"recipient": {
"AddressOwner": "0x7ba91ddc7e717cf708c937060f04048736ec33fb1746d999a5e58cd5c677ed80"
},
"objectType": "0x2::example::Object",
"objectId": "0x4f82f1c8587b98d64c00bfb46c3843bd8bf6ccfa7c65a86138698cd1fdcac3dc",
"version": "2",
"digest": "B3xLC8EbyvTxy5pgiwTNUzHLa6kS7uwD6sZdErKB8F8f"
}
]
}
}
sui_executeTransactionBlock​
Write API
Execute the transaction and wait for results if desired. Request types: 1. WaitForEffectsCert: waits for TransactionEffectsCert and then return to client. This mode is a proxy for transaction finality. 2. WaitForLocalExecution: waits for TransactionEffectsCert and make sure the node executed the transaction locally before returning the client. The local execution makes sure this node is aware of this transaction when client fires subsequent queries. However if the node fails to execute the transaction locally in a timely manner, a bool type in the response is set to false to indicated the case. request_type is default to be WaitForEffectsCert unless options.show_events or options.show_effects is true
Params
tx_bytes:<Base64>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.signatures:<[Base64]>- A list of signatures (flag || signature || pubkeybytes, as base-64 encoded string). Signature is committed to the intent message of the transaction data, as base-64 encoded string.options:<TransactionBlockResponseOptions>- options for specifying the content to be returnedrequest_type:<ExecuteTransactionRequestType>- The request type, derived fromSuiTransactionBlockResponseOptionsif None
Result
SuiTransactionBlockResponse:<TransactionBlockResponse>
Example Executes a transaction with serialized signatures.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_executeTransactionBlock",
"params": [
"AAACACBqEB6aOvXIBwES+Ahkizbvv43uihqC3kbZUE6WoRCKFwEAjvdvVsOZYzousxC8qRJOXy84znOeqsu2YAaIgE4HhEgCAAAAAAAAACB9w3+ufZMpihJFwxtCBojBaGy00TVtFxgN2C6TpIPFqwEBAQEBAAEAAAS0l6kWtGVmCaf6gnoJGE1vR2gdO6dM4NejbGSysfiHAZ+Q9/hmzCnfsdpjc86U+dldylpA9OF2mRjuv5+64AvTAgAAAAAAAAAgjleHL0UiRGjh/BfIFHCJ3EMY/dQA22c2TvNQyVJnbYUEtJepFrRlZgmn+oJ6CRhNb0doHTunTODXo2xksrH4hwoAAAAAAAAAAC0xAQAAAAAA",
[
"AEZc4UMAoxzWtp+i1dvyOgmy+Eeb/5ZNwO5dpHBqX5Rt36+HhYnBby8asFU4b0i7TjQZGgLahT8w3NQUfk0NUQnqvbuA0Q1Bqu4RHV3JPpqmH+C527hWJGUBOZN1j9sg8w=="
],
{
"showInput": true,
"showRawInput": true,
"showEffects": true,
"showEvents": true,
"showObjectChanges": true,
"showBalanceChanges": true
},
"WaitForLocalExecution"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"digest": "BgSFSEFYbCrVUJJtHFeoLmLJi8jDf1CpC2o8S33HjeDJ",
"transaction": {
"data": {
"messageVersion": "v1",
"transaction": {
"kind": "ProgrammableTransaction",
"inputs": [
{
"type": "pure",
"valueType": "address",
"value": "0x6a101e9a3af5c8070112f808648b36efbf8dee8a1a82de46d9504e96a1108a17"
},
{
"type": "object",
"objectType": "immOrOwnedObject",
"objectId": "0x8ef76f56c399633a2eb310bca9124e5f2f38ce739eaacbb6600688804e078448",
"version": "2",
"digest": "9Tvs1pGrMbNv7kkr1PoKLsWamyQpaFz5UWbL2AQ1ezk2"
}
],
"transactions": [
{
"TransferObjects": [
[
{
"Input": 1
}
],
{
"Input": 0
}
]
}
]
},
"sender": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887",
"gasData": {
"payment": [
{
"objectId": "0x9f90f7f866cc29dfb1da6373ce94f9d95dca5a40f4e1769918eebf9fbae00bd3",
"version": 2,
"digest": "AaeJbTYkUuyromsivxzkoxSkHt7pCESTyQG7xz6nbQ2G"
}
],
"owner": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887",
"price": "10",
"budget": "20000000"
}
},
"txSignatures": [
"AEZc4UMAoxzWtp+i1dvyOgmy+Eeb/5ZNwO5dpHBqX5Rt36+HhYnBby8asFU4b0i7TjQZGgLahT8w3NQUfk0NUQnqvbuA0Q1Bqu4RHV3JPpqmH+C527hWJGUBOZN1j9sg8w=="
]
},
"rawTransaction": "AQAAAAAAAgAgahAemjr1yAcBEvgIZIs277+N7ooagt5G2VBOlqEQihcBAI73b1bDmWM6LrMQvKkSTl8vOM5znqrLtmAGiIBOB4RIAgAAAAAAAAAgfcN/rn2TKYoSRcMbQgaIwWhstNE1bRcYDdguk6SDxasBAQEBAQABAAAEtJepFrRlZgmn+oJ6CRhNb0doHTunTODXo2xksrH4hwGfkPf4Zswp37HaY3POlPnZXcpaQPThdpkY7r+fuuAL0wIAAAAAAAAAII5Xhy9FIkRo4fwXyBRwidxDGP3UANtnNk7zUMlSZ22FBLSXqRa0ZWYJp/qCegkYTW9HaB07p0zg16NsZLKx+IcKAAAAAAAAAAAtMQEAAAAAAAFhAEZc4UMAoxzWtp+i1dvyOgmy+Eeb/5ZNwO5dpHBqX5Rt36+HhYnBby8asFU4b0i7TjQZGgLahT8w3NQUfk0NUQnqvbuA0Q1Bqu4RHV3JPpqmH+C527hWJGUBOZN1j9sg8w==",
"effects": {
"messageVersion": "v1",
"status": {
"status": "success"
},
"executedEpoch": "0",
"gasUsed": {
"computationCost": "100",
"storageCost": "100",
"storageRebate": "10",
"nonRefundableStorageFee": "0"
},
"transactionDigest": "9agZ3azEMgMqxrDVG8P4GddELfWag2HhimEkpjixHhGE",
"mutated": [
{
"owner": {
"AddressOwner": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887"
},
"reference": {
"objectId": "0x9f90f7f866cc29dfb1da6373ce94f9d95dca5a40f4e1769918eebf9fbae00bd3",
"version": 2,
"digest": "AaeJbTYkUuyromsivxzkoxSkHt7pCESTyQG7xz6nbQ2G"
}
},
{
"owner": {
"AddressOwner": "0x6a101e9a3af5c8070112f808648b36efbf8dee8a1a82de46d9504e96a1108a17"
},
"reference": {
"objectId": "0x8ef76f56c399633a2eb310bca9124e5f2f38ce739eaacbb6600688804e078448",
"version": 2,
"digest": "9Tvs1pGrMbNv7kkr1PoKLsWamyQpaFz5UWbL2AQ1ezk2"
}
}
],
"gasObject": {
"owner": {
"ObjectOwner": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887"
},
"reference": {
"objectId": "0x9f90f7f866cc29dfb1da6373ce94f9d95dca5a40f4e1769918eebf9fbae00bd3",
"version": 2,
"digest": "AaeJbTYkUuyromsivxzkoxSkHt7pCESTyQG7xz6nbQ2G"
}
},
"eventsDigest": "816hEv4WAW2reK9xkf11PeHiaZJrp7PQT9oGJZhdf9TN"
},
"objectChanges": [
{
"type": "transferred",
"sender": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887",
"recipient": {
"AddressOwner": "0x6a101e9a3af5c8070112f808648b36efbf8dee8a1a82de46d9504e96a1108a17"
},
"objectType": "0x2::example::Object",
"objectId": "0x8ef76f56c399633a2eb310bca9124e5f2f38ce739eaacbb6600688804e078448",
"version": "2",
"digest": "7PsBHpUW6yfGNov2WrbVafLjgT9nYziQ3gVDbRq6zTbF"
}
]
}
}
sui_getChainIdentifier​
Read API
Return the chain's identifier
Result
String:<string>
sui_getCheckpoint​
Read API
Return a checkpoint
Params
id:<CheckpointId>- Checkpoint identifier, can use either checkpoint digest, or checkpoint sequence number as input.
Result
-
Checkpoint:<Checkpoint>- checkpointCommitments :
<[CheckpointCommitment]>- Commitments to checkpoint state - digest :
<[CheckpointDigest]>- Checkpoint digest - endOfEpochData :
<[EndOfEpochData]>- Present only on the final checkpoint of the epoch. - epoch :
<[BigInt_for_uint64]>- Checkpoint's epoch ID - epochRollingGasCostSummary :
<[GasCostSummary]>- The running total gas costs of all transactions included in the current epoch so far until this checkpoint. - networkTotalTransactions :
<[BigInt_for_uint64]>- Total number of transactions committed since genesis, including those in this checkpoint. - previousDigest :
<[CheckpointDigest]>- Digest of the previous checkpoint - sequenceNumber :
<[BigInt_for_uint64]>- Checkpoint sequence number - timestampMs :
<[BigInt_for_uint64]>- Timestamp of the checkpoint - number of milliseconds from the Unix epoch Checkpoint timestamps are monotonic, but not strongly monotonic - subsequent checkpoints can have same timestamp if they originate from the same underlining consensus commit - transactions :
<[TransactionDigest]>- Transaction digests - validatorSignature :
<[Base64]>- Validator Signature
- checkpointCommitments :
Example Gets checkpoint information for the checkpoint ID in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getCheckpoint",
"params": [
"1000"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"epoch": "5000",
"sequenceNumber": "1000",
"digest": "G6Dtzr1ZSfHFhotGsTE3cLENa7L1ooe1BBvknAUsARbV",
"networkTotalTransactions": "792385",
"previousDigest": "6tBy8RXZKrdrB4XkMQn7J3MNG4fQCo9XcRduFFvYrL5Z",
"epochRollingGasCostSummary": {
"computationCost": "0",
"storageCost": "0",
"storageRebate": "0",
"nonRefundableStorageFee": "0"
},
"timestampMs": "1676911928",
"transactions": [
"mN8YNBgVR3wB7vfXmjVgDRF4oqxVRRjzmJ6U4mzbq77"
],
"checkpointCommitments": [],
"validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
}
sui_getCheckpoints​
Read API
Return paginated list of checkpoints
Params
cursor:<BigInt_for_uint64>- An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.limit:<uint>- Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT_CHECKPOINTS] if not specified.descending_order:<boolean>- query result ordering, default to false (ascending order), oldest record first.
Result
CheckpointPage:<Page_for_Checkpoint_and_BigInt_for_uint64>
Example Gets a paginated list in descending order of all checkpoints starting at the provided cursor. Each page of results has a maximum number of checkpoints set by the provided limit.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getCheckpoints",
"params": [
"1004",
4,
false
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": [
{
"epoch": "5000",
"sequenceNumber": "1005",
"digest": "9zA7Q9Ka1ykvYjSQGhQCdCf32FZkcWNWx7L22JczXGsk",
"networkTotalTransactions": "792385",
"previousDigest": "8BLFxLTjWZ2KqaGc3FjR1o9aL6kbyYrmhuNfJLU1ehYt",
"epochRollingGasCostSummary": {
"computationCost": "0",
"storageCost": "0",
"storageRebate": "0",
"nonRefundableStorageFee": "0"
},
"timestampMs": "1676911928",
"transactions": [
"7RudGLkQDBNJyqrptkrNU66Zd3pvq8MHVAHYz9WpBm59"
],
"checkpointCommitments": [],
"validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
},
{
"epoch": "5000",
"sequenceNumber": "1006",
"digest": "FAUWHyWacmb4Vg4QGi9a6gqeVb7ixAZiL73FaGd6WpoV",
"networkTotalTransactions": "792385",
"previousDigest": "6Pn25cieaE62AT6BwCeBoca13AGZuneucaaTGqt3gNCo",
"epochRollingGasCostSummary": {
"computationCost": "0",
"storageCost": "0",
"storageRebate": "0",
"nonRefundableStorageFee": "0"
},
"timestampMs": "1676911928",
"transactions": [
"7r7tmP5hzgrusiN6cucFwfTveqDb7K75tMJ7oNCyoDmy"
],
"checkpointCommitments": [],
"validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
},
{
"epoch": "5000",
"sequenceNumber": "1007",
"digest": "B3mzC6gy87SomUQwPsmVY7mtwkZLxfm5WwNi3kKyEb3x",
"networkTotalTransactions": "792385",
"previousDigest": "CnHTfdUJr1UUqwXkYUhbQjXeM16xR33UR62jE72toCis",
"epochRollingGasCostSummary": {
"computationCost": "0",
"storageCost": "0",
"storageRebate": "0",
"nonRefundableStorageFee": "0"
},
"timestampMs": "1676911928",
"transactions": [
"Gb1UDqhmKMzMJ5FL37kBqCcuy4TtBL2ay3qec8tEUBLj"
],
"checkpointCommitments": [],
"validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
},
{
"epoch": "5000",
"sequenceNumber": "1008",
"digest": "HunuJWKu7azBfS47rJTq9FHTMvUDNVo2SK4hQeh5brXp",
"networkTotalTransactions": "792385",
"previousDigest": "38fLUfuigyzLPEDrsmRhcQmhKtbEUohuFBP9NDcWBmFz",
"epochRollingGasCostSummary": {
"computationCost": "0",
"storageCost": "0",
"storageRebate": "0",
"nonRefundableStorageFee": "0"
},
"timestampMs": "1676911928",
"transactions": [
"GWTS9QR7mjNz9fBWGkk4JZU3mrzMXrmj74uS59Cd5und"
],
"checkpointCommitments": [],
"validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
],
"nextCursor": "1008",
"hasNextPage": true
}
}
sui_getEvents​
Read API
Return transaction events.
Params
transaction_digest:<TransactionDigest>- the event query criteria.
Result
Vec<SuiEvent>:<[Event]>
Example Returns the events the transaction in the request emits.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getEvents",
"params": [
"11a72GCQ5hGNpWGh2QhQkkusTEGS6EDqifJqxr7nSYX"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": [
{
"id": {
"txDigest": "11a72GCQ5hGNpWGh2QhQkkusTEGS6EDqifJqxr7nSYX",
"eventSeq": "0"
},
"packageId": "0xc54ab30a3d9adc07c1429c4d6bbecaf9457c9af77a91f631760853934d383634",
"transactionModule": "test_module",
"sender": "0xbcf7c32655009a61f1de0eae420a2e4ae1bb772ab2dd5d5a7dfa949c0ef06908",
"type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestEvent",
"parsedJson": {
"test": "example value"
},
"bcs": ""
}
],
"nextCursor": {
"txDigest": "11a72GCQ5hGNpWGh2QhQkkusTEGS6EDqifJqxr7nSYX",
"eventSeq": "5"
},
"hasNextPage": false
}
}
sui_getLatestCheckpointSequenceNumber​
Read API
Return the sequence number of the latest checkpoint that has been executed
Result
BigInt<u64>:<BigInt_for_uint64>
Example Gets the sequence number for the latest checkpoint.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getLatestCheckpointSequenceNumber",
"params": []
}
Response
{
"jsonrpc": "2.0",
"result": "507021"
}
sui_getLoadedChildObjects​
Read API
Params
digest:<TransactionDigest>-
Result
SuiLoadedChildObjectsResponse:<LoadedChildObjectsResponse>
Example Gets loaded child objects associated with the transaction the request provides.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getLoadedChildObjects",
"params": [
"6hpz6Qxv6t5VkNT5rcBKQS2Jootr6WHuSuRMLmmN13Jg"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"loadedChildObjects": [
{
"objectId": "0xb6a23efeb7298cf0a8d0b837b78749c2cfc711c42036cc6b76211639f3606a53",
"sequenceNumber": "2462820"
},
{
"objectId": "0xf61f3a566963b3eac49fe3bb57d304a454ed2f4859b44f4e49180047d5fa0a82",
"sequenceNumber": "2462820"
},
{
"objectId": "0xd55c32b09995a0ae1eedfee9c7b1354e805ed10ee3d0800105867da4655eca6d",
"sequenceNumber": "2164186"
},
{
"objectId": "0x258bfd1ad92af329a07781ee71e60065e00f2de961630d3505f8905a0f4d42c6",
"sequenceNumber": "3350147"
},
{
"objectId": "0xa78a6ba2b28f68a3299ec3417bbabc6717dcc95b9e341bc3aba1654bdbad707d",
"sequenceNumber": "3560717"
},
{
"objectId": "0xcd773bd6309363447ef3fe58a960de92aa9377b3482580ee8d5bdc5b824808df",
"sequenceNumber": "3560717"
}
]
}
}
sui_getMoveFunctionArgTypes​
Move Utils
Return the argument types of a Move function, based on normalized Type.
Params
package:<ObjectID>-module:<string>-function:<string>-
Result
Vec<MoveFunctionArgType>:<[MoveFunctionArgType]>
Example Returns the argument types for the package and function the request provides.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getMoveFunctionArgTypes",
"params": [
"0x007efb0f94f1e64d2e8090c619a39299d87ee8070b5f56bb10bafa0e2261d819",
"suifrens",
"mint"
]
}
Response
{
"jsonrpc": "2.0",
"result": [
{
"Object": "ByMutableReference"
},
"Pure",
"Pure",
{
"Object": "ByValue"
},
{
"Object": "ByImmutableReference"
},
{
"Object": "ByValue"
},
{
"Object": "ByMutableReference"
}
]
}
sui_getNormalizedMoveFunction​
Move Utils
Return a structured representation of Move function
Params
package:<ObjectID>-module_name:<string>-function_name:<string>-
Result
-
SuiMoveNormalizedFunction:<SuiMoveNormalizedFunction>- isEntry :
<boolean> - parameters :
<[SuiMoveNormalizedType]> - return :
<[SuiMoveNormalizedType]> - typeParameters :
<[SuiMoveAbilitySet]> - visibility :
<SuiMoveVisibility>
- isEntry :
Example Returns the structured representation of the function the request provides.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getNormalizedMoveFunction",
"params": [
"0xb2582f82ab308bf9c96dfb22ec7345db1b5f14fdb2b9538efb160d31842e3a17",
"moduleName",
"functionName"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"visibility": "Public",
"isEntry": false,
"typeParameters": [
{
"abilities": [
"Store",
"Key"
]
}
],
"parameters": [
"U64"
],
"return": [
"U64"
]
}
}
sui_getNormalizedMoveModule​
Move Utils
Return a structured representation of Move module
Params
package:<ObjectID>-module_name:<string>-
Result
-
SuiMoveNormalizedModule:<SuiMoveNormalizedModule>- address :
<string> - exposedFunctions :
<object> - fileFormatVersion :
<uint32> - friends :
<[SuiMoveModuleId]> - name :
<string> - structs :
<object>
- address :
Example Gets a structured representation of the Move module for the package in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getNormalizedMoveModule",
"params": [
"0x16dc6797cf787c839a07edc03e633842109123618df6438d21a48040e6bb568c",
"module"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"fileFormatVersion": 6,
"address": "0x43cc4c24010dafad05b12619b275649741cc9060d87664c26a3f9a509228c21b",
"name": "module",
"friends": [],
"structs": {},
"exposedFunctions": {}
}
}
sui_getNormalizedMoveModulesByPackage​
Move Utils
Return structured representations of all modules in the given package
Params
package:<ObjectID>-
Result
BTreeMap<String,SuiMoveNormalizedModule>:<object>
Example Gets structured representations of all the modules for the package in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getNormalizedMoveModulesByPackage",
"params": [
"0xece356d10d89e75f565b0934851ba8d5bc59462a46078b90f1f508a1e4fd4eed"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"fileFormatVersion": 6,
"address": "0xafc13246bd847c60448160e0358cac4a11345594d02890c986dbf328d28d21ac",
"name": "module",
"friends": [],
"structs": {},
"exposedFunctions": {}
}
}
sui_getNormalizedMoveStruct​
Move Utils
Return a structured representation of Move struct
Params
package:<ObjectID>-module_name:<string>-struct_name:<string>-
Result
-
SuiMoveNormalizedStruct:<SuiMoveNormalizedStruct>- abilities :
<SuiMoveAbilitySet> - fields :
<[SuiMoveNormalizedField]> - typeParameters :
<[SuiMoveStructTypeParameter]>
- abilities :
Example Gets a structured representation of the struct in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getNormalizedMoveStruct",
"params": [
"0x46c25c211cb35c05d801c769b78770474957b37379c527753c5c8ab783f697e7",
"module",
"StructName"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"abilities": {
"abilities": [
"Store",
"Key"
]
},
"typeParameters": [],
"fields": []
}
}
sui_getObject​
Read API
Return the object information for a specified object
Params
object_id:<ObjectID>- the ID of the queried objectoptions:<ObjectDataOptions>- options for specifying the content to be returned
Result
-
SuiObjectResponse:<SuiObjectResponse>- data :
<[ObjectData]> - error :
<[ObjectResponseError]>
- data :
Example Gets Object data for the ID in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getObject",
"params": [
"0x53e4567ccafa5f36ce84c80aa8bc9be64e0d5ae796884274aef3005ae6733809",
{
"showType": true,
"showOwner": true,
"showPreviousTransaction": true,
"showDisplay": false,
"showContent": true,
"showBcs": false,
"showStorageRebate": true
}
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": {
"objectId": "0x53e4567ccafa5f36ce84c80aa8bc9be64e0d5ae796884274aef3005ae6733809",
"version": "1",
"digest": "33K5ZXJ3RyubvYaHuEnQ1QXmmbhgtrFwp199dnEbL4n7",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0xc8ec1d5b84dd6289e193b9f88de4a994358c9f856135236c3e75a925e1c77ac3"
},
"previousTransaction": "5PLgmQye6rraDYqpV3npV6H1cUXoJZgJh1dPCyRa3WCv",
"storageRebate": "100",
"content": {
"dataType": "moveObject",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"hasPublicTransfer": true,
"fields": {
"balance": "100000000",
"id": {
"id": "0x53e4567ccafa5f36ce84c80aa8bc9be64e0d5ae796884274aef3005ae6733809"
}
}
}
}
}
}
sui_getProtocolConfig​
Read API
Return the protocol config table for the given version number. If the version number is not specified, If none is specified, the node uses the version of the latest epoch it has processed.
Params
version:<BigInt_for_uint64>- An optional protocol version specifier. If omitted, the latest protocol config table for the node will be returned.
Result
ProtocolConfigResponse:<ProtocolConfig>
Example Returns the protocol config for the given protocol version. If none is specified, the node uses the version of the latest epoch it has processed
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getProtocolConfig",
"params": [
6
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"minSupportedProtocolVersion": "1",
"maxSupportedProtocolVersion": "12",
"protocolVersion": "6",
"featureFlags": {
"advance_epoch_start_time_in_safe_mode": true,
"advance_to_highest_supported_protocol_version": false,
"ban_entry_init": false,
"commit_root_state_digest": false,
"consensus_order_end_of_epoch_last": true,
"disable_invariant_violation_check_in_swap_loc": false,
"disallow_adding_abilities_on_upgrade": false,
"disallow_change_struct_type_params_on_upgrade": false,
"loaded_child_objects_fixed": true,
"missing_type_is_compatibility_error": true,
"narwhal_versioned_metadata": false,
"no_extraneous_module_bytes": false,
"package_digest_hash_module": false,
"package_upgrades": true,
"scoring_decision_with_validity_cutoff": true,
"zklogin_auth": false
},
"attributes": {
"address_from_bytes_cost_base": {
"u64": "52"
},
"address_from_u256_cost_base": {
"u64": "52"
},
"address_to_u256_cost_base": {
"u64": "52"
},
"base_tx_cost_fixed": {
"u64": "2000"
},
"base_tx_cost_per_byte": {
"u64": "0"
},
"bls12381_bls12381_min_pk_verify_cost_base": {
"u64": "52"
},
"bls12381_bls12381_min_pk_verify_msg_cost_per_block": {
"u64": "2"
},
"bls12381_bls12381_min_pk_verify_msg_cost_per_byte": {
"u64": "2"
},
"bls12381_bls12381_min_sig_verify_cost_base": {
"u64": "52"
},
"bls12381_bls12381_min_sig_verify_msg_cost_per_block": {
"u64": "2"
},
"bls12381_bls12381_min_sig_verify_msg_cost_per_byte": {
"u64": "2"
},
"buffer_stake_for_protocol_upgrade_bps": {
"u64": "5000"
},
"crypto_invalid_arguments_cost": {
"u64": "100"
},
"dynamic_field_add_child_object_cost_base": {
"u64": "100"
},
"dynamic_field_add_child_object_struct_tag_cost_per_byte": {
"u64": "10"
},
"dynamic_field_add_child_object_type_cost_per_byte": {
"u64": "10"
},
"dynamic_field_add_child_object_value_cost_per_byte": {
"u64": "10"
},
"dynamic_field_borrow_child_object_child_ref_cost_per_byte": {
"u64": "10"
},
"dynamic_field_borrow_child_object_cost_base": {
"u64": "100"
},
"dynamic_field_borrow_child_object_type_cost_per_byte": {
"u64": "10"
},
"dynamic_field_has_child_object_cost_base": {
"u64": "100"
},
"dynamic_field_has_child_object_with_ty_cost_base": {
"u64": "100"
},
"dynamic_field_has_child_object_with_ty_type_cost_per_byte": {
"u64": "2"
},
"dynamic_field_has_child_object_with_ty_type_tag_cost_per_byte": {
"u64": "2"
},
"dynamic_field_hash_type_and_key_cost_base": {
"u64": "100"
},
"dynamic_field_hash_type_and_key_type_cost_per_byte": {
"u64": "2"
},
"dynamic_field_hash_type_and_key_type_tag_cost_per_byte": {
"u64": "2"
},
"dynamic_field_hash_type_and_key_value_cost_per_byte": {
"u64": "2"
},
"dynamic_field_remove_child_object_child_cost_per_byte": {
"u64": "2"
},
"dynamic_field_remove_child_object_cost_base": {
"u64": "100"
},
"dynamic_field_remove_child_object_type_cost_per_byte": {
"u64": "2"
},
"ecdsa_k1_decompress_pubkey_cost_base": {
"u64": "52"
},
"ecdsa_k1_ecrecover_keccak256_cost_base": {
"u64": "52"
},
"ecdsa_k1_ecrecover_keccak256_msg_cost_per_block": {
"u64": "2"
},
"ecdsa_k1_ecrecover_keccak256_msg_cost_per_byte": {
"u64": "2"
},
"ecdsa_k1_ecrecover_sha256_cost_base": {
"u64": "52"
},
"ecdsa_k1_ecrecover_sha256_msg_cost_per_block": {
"u64": "2"
},
"ecdsa_k1_ecrecover_sha256_msg_cost_per_byte": {
"u64": "2"
},
"ecdsa_k1_secp256k1_verify_keccak256_cost_base": {
"u64": "52"
},
"ecdsa_k1_secp256k1_verify_keccak256_msg_cost_per_block": {
"u64": "2"
},
"ecdsa_k1_secp256k1_verify_keccak256_msg_cost_per_byte": {
"u64": "2"
},
"ecdsa_k1_secp256k1_verify_sha256_cost_base": {
"u64": "52"
},
"ecdsa_k1_secp256k1_verify_sha256_msg_cost_per_block": {
"u64": "2"
},
"ecdsa_k1_secp256k1_verify_sha256_msg_cost_per_byte": {
"u64": "2"
},
"ecdsa_r1_ecrecover_keccak256_cost_base": {
"u64": "52"
},
"ecdsa_r1_ecrecover_keccak256_msg_cost_per_block": {
"u64": "2"
},
"ecdsa_r1_ecrecover_keccak256_msg_cost_per_byte": {
"u64": "2"
},
"ecdsa_r1_ecrecover_sha256_cost_base": {
"u64": "52"
},
"ecdsa_r1_ecrecover_sha256_msg_cost_per_block": {
"u64": "2"
},
"ecdsa_r1_ecrecover_sha256_msg_cost_per_byte": {
"u64": "2"
},
"ecdsa_r1_secp256r1_verify_keccak256_cost_base": {
"u64": "52"
},
"ecdsa_r1_secp256r1_verify_keccak256_msg_cost_per_block": {
"u64": "2"
},
"ecdsa_r1_secp256r1_verify_keccak256_msg_cost_per_byte": {
"u64": "2"
},
"ecdsa_r1_secp256r1_verify_sha256_cost_base": {
"u64": "52"
},
"ecdsa_r1_secp256r1_verify_sha256_msg_cost_per_block": {
"u64": "2"
},
"ecdsa_r1_secp256r1_verify_sha256_msg_cost_per_byte": {
"u64": "2"
},
"ecvrf_ecvrf_verify_alpha_string_cost_per_block": {
"u64": "2"
},
"ecvrf_ecvrf_verify_alpha_string_cost_per_byte": {
"u64": "2"
},
"ecvrf_ecvrf_verify_cost_base": {
"u64": "52"
},
"ed25519_ed25519_verify_cost_base": {
"u64": "52"
},
"ed25519_ed25519_verify_msg_cost_per_block": {
"u64": "2"
},
"ed25519_ed25519_verify_msg_cost_per_byte": {
"u64": "2"
},
"event_emit_cost_base": {
"u64": "52"
},
"event_emit_output_cost_per_byte": {
"u64": "10"
},
"event_emit_tag_size_derivation_cost_per_byte": {
"u64": "5"
},
"event_emit_value_size_derivation_cost_per_byte": {
"u64": "2"
},
"gas_model_version": {
"u64": "5"
},
"groth16_prepare_verifying_key_bls12381_cost_base": {
"u64": "52"
},
"groth16_prepare_verifying_key_bn254_cost_base": {
"u64": "52"
},
"groth16_verify_groth16_proof_internal_bls12381_cost_base": {
"u64": "52"
},
"groth16_verify_groth16_proof_internal_bls12381_cost_per_public_input": {
"u64": "2"
},
"groth16_verify_groth16_proof_internal_bn254_cost_base": {
"u64": "52"
},
"groth16_verify_groth16_proof_internal_bn254_cost_per_public_input": {
"u64": "2"
},
"groth16_verify_groth16_proof_internal_public_input_cost_per_byte": {
"u64": "2"
},
"hash_blake2b256_cost_base": {
"u64": "52"
},
"hash_blake2b256_data_cost_per_block": {
"u64": "2"
},
"hash_blake2b256_data_cost_per_byte": {
"u64": "2"
},
"hash_keccak256_cost_base": {
"u64": "52"
},
"hash_keccak256_data_cost_per_block": {
"u64": "2"
},
"hash_keccak256_data_cost_per_byte": {
"u64": "2"
},
"hmac_hmac_sha3_256_cost_base": {
"u64": "52"
},
"hmac_hmac_sha3_256_input_cost_per_block": {
"u64": "2"
},
"hmac_hmac_sha3_256_input_cost_per_byte": {
"u64": "2"
},
"max_arguments": {
"u32": "512"
},
"max_back_edges_per_function": {
"u64": "10000"
},
"max_back_edges_per_module": {
"u64": "10000"
},
"max_basic_blocks": {
"u64": "1024"
},
"max_checkpoint_size_bytes": {
"u64": "31457280"
},
"max_dependency_depth": {
"u64": "100"
},
"max_event_emit_size": {
"u64": "256000"
},
"max_fields_in_struct": {
"u64": "32"
},
"max_function_definitions": {
"u64": "1000"
},
"max_function_parameters": {
"u64": "128"
},
"max_gas_computation_bucket": {
"u64": "5000000"
},
"max_gas_payment_objects": {
"u32": "256"
},
"max_gas_price": {
"u64": "100000"
},
"max_generic_instantiation_length": {
"u64": "32"
},
"max_input_objects": {
"u64": "2048"
},
"max_loop_depth": {
"u64": "5"
},
"max_meter_ticks_per_module": {
"u64": "6000000"
},
"max_modules_in_publish": {
"u32": "128"
},
"max_move_identifier_len": null,
"max_move_object_size": {
"u64": "256000"
},
"max_move_package_size": {
"u64": "102400"
},
"max_move_value_depth": null,
"max_move_vector_len": {
"u64": "262144"
},
"max_num_deleted_move_object_ids": {
"u64": "2048"
},
"max_num_deleted_move_object_ids_system_tx": {
"u64": "32768"
},
"max_num_event_emit": {
"u64": "256"
},
"max_num_new_move_object_ids": {
"u64": "2048"
},
"max_num_new_move_object_ids_system_tx": {
"u64": "32768"
},
"max_num_transferred_move_object_ids": {
"u64": "2048"
},
"max_num_transferred_move_object_ids_system_tx": {
"u64": "32768"
},
"max_programmable_tx_commands": {
"u32": "1024"
},
"max_pure_argument_size": {
"u32": "16384"
},
"max_push_size": {
"u64": "10000"
},
"max_serialized_tx_effects_size_bytes": {
"u64": "524288"
},
"max_serialized_tx_effects_size_bytes_system_tx": {
"u64": "8388608"
},
"max_size_written_objects": {
"u64": "5000000"
},
"max_size_written_objects_system_tx": {
"u64": "50000000"
},
"max_struct_definitions": {
"u64": "200"
},
"max_transactions_per_checkpoint": {
"u64": "10000"
},
"max_tx_gas": {
"u64": "50000000000"
},
"max_tx_size_bytes": {
"u64": "131072"
},
"max_type_argument_depth": {
"u32": "16"
},
"max_type_arguments": {
"u32": "16"
},
"max_type_nodes": {
"u64": "256"
},
"max_value_stack_size": {
"u64": "1024"
},
"max_verifier_meter_ticks_per_function": {
"u64": "6000000"
},
"move_binary_format_version": {
"u32": "6"
},
"obj_access_cost_delete_per_byte": {
"u64": "40"
},
"obj_access_cost_mutate_per_byte": {
"u64": "40"
},
"obj_access_cost_read_per_byte": {
"u64": "15"
},
"obj_access_cost_verify_per_byte": {
"u64": "200"
},
"obj_data_cost_refundable": {
"u64": "100"
},
"obj_metadata_cost_non_refundable": {
"u64": "50"
},
"object_borrow_uid_cost_base": {
"u64": "52"
},
"object_delete_impl_cost_base": {
"u64": "52"
},
"object_record_new_uid_cost_base": {
"u64": "52"
},
"object_runtime_max_num_cached_objects": {
"u64": "1000"
},
"object_runtime_max_num_cached_objects_system_tx": {
"u64": "16000"
},
"object_runtime_max_num_store_entries": {
"u64": "1000"
},
"object_runtime_max_num_store_entries_system_tx": {
"u64": "16000"
},
"package_publish_cost_fixed": {
"u64": "1000"
},
"package_publish_cost_per_byte": {
"u64": "80"
},
"reward_slashing_rate": {
"u64": "10000"
},
"scoring_decision_cutoff_value": {
"f64": "2.5"
},
"scoring_decision_mad_divisor": {
"f64": "2.3"
},
"storage_fund_reinvest_rate": {
"u64": "500"
},
"storage_gas_price": {
"u64": "76"
},
"storage_rebate_rate": {
"u64": "9900"
},
"transfer_freeze_object_cost_base": {
"u64": "52"
},
"transfer_share_object_cost_base": {
"u64": "52"
},
"transfer_transfer_internal_cost_base": {
"u64": "52"
},
"tx_context_derive_id_cost_base": {
"u64": "52"
},
"types_is_one_time_witness_cost_base": {
"u64": "52"
},
"types_is_one_time_witness_type_cost_per_byte": {
"u64": "2"
},
"types_is_one_time_witness_type_tag_cost_per_byte": {
"u64": "2"
},
"validator_validate_metadata_cost_base": {
"u64": "52"
},
"validator_validate_metadata_data_cost_per_byte": {
"u64": "2"
}
}
}
}
sui_getTotalTransactionBlocks​
Read API
Return the total number of transactions known to the server.
Result
BigInt<u64>:<BigInt_for_uint64>
Example Gets total number of transactions on the network.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getTotalTransactionBlocks",
"params": []
}
Response
{
"jsonrpc": "2.0",
"result": "2451485"
}
sui_getTransactionBlock​
Read API
Return the transaction response object.
Params
digest:<TransactionDigest>- the digest of the queried transactionoptions:<TransactionBlockResponseOptions>- options for specifying the content to be returned
Result
SuiTransactionBlockResponse:<TransactionBlockResponse>
Example Returns the transaction response object for specified transaction digest.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_getTransactionBlock",
"params": [
"oKtFZjL99EZ2K3TLPRarpZN8gz9xReMkiNf4Tjja2no",
{
"showInput": true,
"showRawInput": false,
"showEffects": true,
"showEvents": true,
"showObjectChanges": false,
"showBalanceChanges": false
}
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"digest": "oKtFZjL99EZ2K3TLPRarpZN8gz9xReMkiNf4Tjja2no",
"transaction": {
"data": {
"messageVersion": "v1",
"transaction": {
"kind": "ProgrammableTransaction",
"inputs": [
{
"type": "pure",
"valueType": "address",
"value": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb"
},
{
"type": "object",
"objectType": "immOrOwnedObject",
"objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc",
"version": "2",
"digest": "GK4NxEKSrK88XkPNeuBqtJYPmU9yMTWMD7K9TdU4ybKN"
}
],
"transactions": [
{
"TransferObjects": [
[
{
"Input": 1
}
],
{
"Input": 0
}
]
}
]
},
"sender": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66",
"gasData": {
"payment": [
{
"objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051",
"version": 2,
"digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9"
}
],
"owner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66",
"price": "10",
"budget": "20000000"
}
},
"txSignatures": [
"ABTTP4JUSxqOQTlysdS30HzkMc3DOwJqlBJstqn2EwW0SKtvoGIoxFEbmTqIS+UYSemveVGJ+S6BijQQVS97cwxtCxWrqsEEHAdxoMDwblU5hyWJ8H3zFvk20E2fO5bzHA=="
]
},
"rawTransaction": "AQAAAAAAAgAggZbQSLem0EyO3IlXnYb9P8kMUvmhTGuBK5T+YTxbzrsBAF7rHUSeJRYWbVfXH96xVNDcns23swBX0KkyaEysNSzcAgAAAAAAAAAg43+UGkUe+CCaD7+/G1SbK7Jrjq7giJUUbfJ7w88mEMEBAQEBAQABAACCF5xX1Ylbq/tlXNYujohqUzNLXnvpvmWOt1nMNeP8ZgEaPomAKdAk7sHUTGr14vrN7YTQO1NzUU8W49ZuAAgQUQIAAAAAAAAAIGS7c6HtWLLBiwy/N3eS4gbmuA1NXupk4ucFY7FYkCbEghecV9WJW6v7ZVzWLo6IalMzS1576b5ljrdZzDXj/GYKAAAAAAAAAAAtMQEAAAAAAAFhABTTP4JUSxqOQTlysdS30HzkMc3DOwJqlBJstqn2EwW0SKtvoGIoxFEbmTqIS+UYSemveVGJ+S6BijQQVS97cwxtCxWrqsEEHAdxoMDwblU5hyWJ8H3zFvk20E2fO5bzHA==",
"effects": {
"messageVersion": "v1",
"status": {
"status": "success"
},
"executedEpoch": "0",
"gasUsed": {
"computationCost": "100",
"storageCost": "100",
"storageRebate": "10",
"nonRefundableStorageFee": "0"
},
"transactionDigest": "6AyFnAuKAKCqm1cD94EyGzBqJCDDJ716ojjmsKF2rqoi",
"mutated": [
{
"owner": {
"AddressOwner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66"
},
"reference": {
"objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051",
"version": 2,
"digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9"
}
},
{
"owner": {
"AddressOwner": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb"
},
"reference": {
"objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc",
"version": 2,
"digest": "GK4NxEKSrK88XkPNeuBqtJYPmU9yMTWMD7K9TdU4ybKN"
}
}
],
"gasObject": {
"owner": {
"ObjectOwner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66"
},
"reference": {
"objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051",
"version": 2,
"digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9"
}
},
"eventsDigest": "9BQobwxQvJ1JxSXNn8v8htZPTu8FEzJJGgcD4kgLUuMd"
},
"objectChanges": [
{
"type": "transferred",
"sender": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66",
"recipient": {
"AddressOwner": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb"
},
"objectType": "0x2::example::Object",
"objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc",
"version": "2",
"digest": "64UQ3a7m1mjWuzgyGoH8RnMyPGDN4XYTC9dS4qiSfdK4"
}
]
}
}
sui_multiGetObjects​
Read API
Return the object data for a list of objects
Params
object_ids:<[ObjectID]>- the IDs of the queried objectsoptions:<ObjectDataOptions>- options for specifying the content to be returned
Result
Vec<SuiObjectResponse>:<[SuiObjectResponse]>
Example Gets objects by IDs.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_multiGetObjects",
"params": [
[
"0xb61439368cd75ebe63d633af32ffb4a022d18b95b4eaa9fd3b22b43f6b2c8e92",
"0x6ea7bed8f6c3d80f2a595c2305e12dd6d07c3fbbd3ebef7dbcc7b02346cdf056",
"0x75da5e934f672d3da3e003d989075efaecc79b5cd5df0df2a168259b7115a41c",
"0x38554a9ff7b4f6b59f9426c321c8013afed093481dd4ef1267c67a8e9a0d074f",
"0xe74d1b250d5df2cb5170782a8a438fbf681eded4d1e0a2cd7dfb27e784493fb1"
],
{
"showType": true,
"showOwner": true,
"showPreviousTransaction": true,
"showDisplay": false,
"showContent": true,
"showBcs": false,
"showStorageRebate": true
}
]
}
Response
{
"jsonrpc": "2.0",
"result": [
{
"data": {
"objectId": "0xb61439368cd75ebe63d633af32ffb4a022d18b95b4eaa9fd3b22b43f6b2c8e92",
"version": "1",
"digest": "6D2MGzZN1DnALrbg6y9nQWwuipCa6fJERLXAwNGuGtKQ",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0x090bd6d16522a6fd4fa83ec70a5f197ad656da104dde1de9880be827a1a753e5"
},
"previousTransaction": "CQN1aMpZRYrVHByFfPFceCXzv5kT7bNM4Uzoe2jbZvM",
"storageRebate": "100",
"content": {
"dataType": "moveObject",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"hasPublicTransfer": true,
"fields": {
"balance": "100000000",
"id": {
"id": "0xb61439368cd75ebe63d633af32ffb4a022d18b95b4eaa9fd3b22b43f6b2c8e92"
}
}
}
}
},
{
"data": {
"objectId": "0x6ea7bed8f6c3d80f2a595c2305e12dd6d07c3fbbd3ebef7dbcc7b02346cdf056",
"version": "1",
"digest": "HCvnds5SSF8Tn2kANyZDeAJuKa7bY6mf1ykzD8nQY42b",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0x74452cc61f316af5d5d7c02b94b02324268500a65bf5fdccb50582333b61721e"
},
"previousTransaction": "86PvfkkGKweeE3TRmQDL9azrkyU9yqiVcRpWMNsqcWTK",
"storageRebate": "100",
"content": {
"dataType": "moveObject",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"hasPublicTransfer": true,
"fields": {
"balance": "100000000",
"id": {
"id": "0x6ea7bed8f6c3d80f2a595c2305e12dd6d07c3fbbd3ebef7dbcc7b02346cdf056"
}
}
}
}
},
{
"data": {
"objectId": "0x75da5e934f672d3da3e003d989075efaecc79b5cd5df0df2a168259b7115a41c",
"version": "1",
"digest": "7AVTCGjWUFNAZYmcxtKQvAWbyzbFVn9cbr1fMvngbs9S",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0xcc0a372b6fd0026e0c63043492ce4d0c19a63e7f360c51d035a6470f09c8d237"
},
"previousTransaction": "2YMeG7z6fPbqT6Sk7K4DQ7qqd2zBC1zAn2SuEXq4wJgY",
"storageRebate": "100",
"content": {
"dataType": "moveObject",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"hasPublicTransfer": true,
"fields": {
"balance": "100000000",
"id": {
"id": "0x75da5e934f672d3da3e003d989075efaecc79b5cd5df0df2a168259b7115a41c"
}
}
}
}
},
{
"data": {
"objectId": "0x38554a9ff7b4f6b59f9426c321c8013afed093481dd4ef1267c67a8e9a0d074f",
"version": "1",
"digest": "DumsSGokTELtJXW54HKCRLjFKBeHkaySUZ86DDo8QwvR",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0x90fddb42cd928f74b986c6f539a734f3d7c9a75a9cb227ec315724962ee4193c"
},
"previousTransaction": "ARhjuTpfA6H8EM8bpBuJ5vFGALmMrMcbSZDiTTF8nxCp",
"storageRebate": "100",
"content": {
"dataType": "moveObject",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"hasPublicTransfer": true,
"fields": {
"balance": "100000000",
"id": {
"id": "0x38554a9ff7b4f6b59f9426c321c8013afed093481dd4ef1267c67a8e9a0d074f"
}
}
}
}
},
{
"data": {
"objectId": "0xe74d1b250d5df2cb5170782a8a438fbf681eded4d1e0a2cd7dfb27e784493fb1",
"version": "1",
"digest": "94nQ4Tz4nyqcVJmbLMUShkucx3eVfhLXGTCR4d1KP6gL",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0xdccde7893a3ac5c67cd2c4e27540b52ee828096b2aa5fe50a7effd8c23976147"
},
"previousTransaction": "3rqeFGm86S2ZKWXPF2HHP8zdpRRqb7WZLDkquE2KHetA",
"storageRebate": "100",
"content": {
"dataType": "moveObject",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"hasPublicTransfer": true,
"fields": {
"balance": "100000000",
"id": {
"id": "0xe74d1b250d5df2cb5170782a8a438fbf681eded4d1e0a2cd7dfb27e784493fb1"
}
}
}
}
}
]
}
sui_multiGetTransactionBlocks​
Read API
Returns an ordered list of transaction responses The method will throw an error if the input contains any duplicate or the input size exceeds QUERY_MAX_RESULT_LIMIT
Params
digests:<[TransactionDigest]>- A list of transaction digests.options:<TransactionBlockResponseOptions>- config options to control which fields to fetch
Result
Vec<SuiTransactionBlockResponse>:<[TransactionBlockResponse]>
Example Returns the transaction data for specified digest.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_multiGetTransactionBlocks",
"params": [
[
"Gd2vRA1pRwWu8j7KQe6fzHS4mMChq1JHJpi9KGnVJMtV",
"73FjSYzymaz1UWPu4bMW191cyxSxziKXJm2MyTQMjeur",
"7TxdfBqwTPYgG4hztwiQdeQcdWgeqpZKF7EJpyjDojFd"
],
{
"showInput": true,
"showRawInput": false,
"showEffects": true,
"showEvents": true,
"showObjectChanges": false,
"showBalanceChanges": false
}
]
}
Response
{
"jsonrpc": "2.0",
"result": [
{
"digest": "Gd2vRA1pRwWu8j7KQe6fzHS4mMChq1JHJpi9KGnVJMtV",
"transaction": {
"data": {
"messageVersion": "v1",
"transaction": {
"kind": "ProgrammableTransaction",
"inputs": [
{
"type": "pure",
"valueType": "address",
"value": "0x0ad2c31e8c3681aa4f7d35488cf6bf1135d2fc8703690e085797c3e4f846a282"
},
{
"type": "object",
"objectType": "immOrOwnedObject",
"objectId": "0x754946e181e00f4341a53b5e895ef8ec3c73d2378a0a11825e232fac1a70e20e",
"version": "2",
"digest": "21hjAvY5LZAy2dc72b3nPgJTsbmtRYaTfqMn2a2sdnkB"
}
],
"transactions": [
{
"TransferObjects": [
[
{
"Input": 1
}
],
{
"Input": 0
}
]
}
]
},
"sender": "0x0a3f57ac1ee741463bc97744050f1af4d570d8b8d0f203b67d09cd82fdb21e13",
"gasData": {
"payment": [
{
"objectId": "0x146fb1303bd60eb4bea9bd453e50690b423241f0e2e9beabd601bbdabf2828ee",
"version": 2,
"digest": "BYX5uiUfQkTJrNSnH3mj8Cs8mz1ppQKWBXi4y3Xi6y8D"
}
],
"owner": "0x0a3f57ac1ee741463bc97744050f1af4d570d8b8d0f203b67d09cd82fdb21e13",
"price": "10",
"budget": "20000000"
}
},
"txSignatures": [
"ABWZkYviOekutE6mrOgoq7d2q5fx3xlmo0qWTyQSa+jDFzePlm+RPZm1zkOedq3TlQcYiMKaw+jqNYIYerHujAg34HWK6fGd/e11nJeO7UMQFVm4jiZjwDYb8XNiqcCJOQ=="
]
},
"rawTransaction": "AQAAAAAAAgAgCtLDHow2gapPfTVIjPa/ETXS/IcDaQ4IV5fD5PhGooIBAHVJRuGB4A9DQaU7Xole+Ow8c9I3igoRgl4jL6wacOIOAgAAAAAAAAAgDwm8uJB3PRHBq9cXZ7H2eoBAJneIID85dyL8J2rqpzwBAQEBAQABAAAKP1esHudBRjvJd0QFDxr01XDYuNDyA7Z9Cc2C/bIeEwEUb7EwO9YOtL6pvUU+UGkLQjJB8OLpvqvWAbvavygo7gIAAAAAAAAAIJyn5CJ6Yc/4Uf75+2oIrkRMlvmBAnXWr5c8DQItueIaCj9XrB7nQUY7yXdEBQ8a9NVw2LjQ8gO2fQnNgv2yHhMKAAAAAAAAAAAtMQEAAAAAAAFhABWZkYviOekutE6mrOgoq7d2q5fx3xlmo0qWTyQSa+jDFzePlm+RPZm1zkOedq3TlQcYiMKaw+jqNYIYerHujAg34HWK6fGd/e11nJeO7UMQFVm4jiZjwDYb8XNiqcCJOQ==",
"effects": {
"messageVersion": "v1",
"status": {
"status": "success"
},
"executedEpoch": "0",
"gasUsed": {
"computationCost": "100",
"storageCost": "100",
"storageRebate": "10",
"nonRefundableStorageFee": "0"
},
"transactionDigest": "CVLsRJgJKde8RVNLtkZCBGWxEmCninDQaBb5V4tz9sZ8",
"mutated": [
{
"owner": {
"AddressOwner": "0x0a3f57ac1ee741463bc97744050f1af4d570d8b8d0f203b67d09cd82fdb21e13"
},
"reference": {
"objectId": "0x146fb1303bd60eb4bea9bd453e50690b423241f0e2e9beabd601bbdabf2828ee",
"version": 2,
"digest": "BYX5uiUfQkTJrNSnH3mj8Cs8mz1ppQKWBXi4y3Xi6y8D"
}
},
{
"owner": {
"AddressOwner": "0x0ad2c31e8c3681aa4f7d35488cf6bf1135d2fc8703690e085797c3e4f846a282"
},
"reference": {
"objectId": "0x754946e181e00f4341a53b5e895ef8ec3c73d2378a0a11825e232fac1a70e20e",
"version": 2,
"digest": "21hjAvY5LZAy2dc72b3nPgJTsbmtRYaTfqMn2a2sdnkB"
}
}
],
"gasObject": {
"owner": {
"ObjectOwner": "0x0a3f57ac1ee741463bc97744050f1af4d570d8b8d0f203b67d09cd82fdb21e13"
},
"reference": {
"objectId": "0x146fb1303bd60eb4bea9bd453e50690b423241f0e2e9beabd601bbdabf2828ee",
"version": 2,
"digest": "BYX5uiUfQkTJrNSnH3mj8Cs8mz1ppQKWBXi4y3Xi6y8D"
}
},
"eventsDigest": "Hwdei4TM2C5h2gpRiUQfS8roKsKgTUzx883qTuy7ASdt"
},
"objectChanges": [
{
"type": "transferred",
"sender": "0x0a3f57ac1ee741463bc97744050f1af4d570d8b8d0f203b67d09cd82fdb21e13",
"recipient": {
"AddressOwner": "0x0ad2c31e8c3681aa4f7d35488cf6bf1135d2fc8703690e085797c3e4f846a282"
},
"objectType": "0x2::example::Object",
"objectId": "0x754946e181e00f4341a53b5e895ef8ec3c73d2378a0a11825e232fac1a70e20e",
"version": "2",
"digest": "zbXdxaWUbmKnKQfLLwiCVYe2nQyreC7JoKHrk8vY9aA"
}
]
},
{
"digest": "73FjSYzymaz1UWPu4bMW191cyxSxziKXJm2MyTQMjeur",
"transaction": {
"data": {
"messageVersion": "v1",
"transaction": {
"kind": "ProgrammableTransaction",
"inputs": [
{
"type": "pure",
"valueType": "address",
"value": "0x2e84e81f871c47c3149e27b12500da884afdf5c30b19c017a0d10388c28ddd59"
},
{
"type": "object",
"objectType": "immOrOwnedObject",
"objectId": "0x77a58e206acd19639c875a4fbecf3342b825c8384300ac7e3badc820a75b5742",
"version": "2",
"digest": "6ozDx8La5rgu5zSoxaMseRjcX169ZBEjSyQeD2RGoa44"
}
],
"transactions": [
{
"TransferObjects": [
[
{
"Input": 1
}
],
{
"Input": 0
}
]
}
]
},
"sender": "0x028d636e74862991ed521dcc9c6cb7ab860b449e3f4f7b8520b582325bcda4f6",
"gasData": {
"payment": [
{
"objectId": "0x24b920aa9b005093b820df24ef8b43715499f4fff4e056c0cd5cd8024b4b39a7",
"version": 2,
"digest": "J9ifwZ2hbL5Tg7fbbta3CXybtaabdaN8BmKudP7R8sBU"
}
],
"owner": "0x028d636e74862991ed521dcc9c6cb7ab860b449e3f4f7b8520b582325bcda4f6",
"price": "10",
"budget": "20000000"
}
},
"txSignatures": [
"ANFMDxz+6lExShcHA/qG/j2jZk6y9+5k65x6u8JGJP/dyxkfrihDdFxtOt3fvaoJ/OvEZ4eo123n/momyGQuFgahtxyxD8zwVSmWjSVhhtf+UKhpW2mTgOA1Wn2xxsedmg=="
]
},
"rawTransaction": "AQAAAAAAAgAgLoToH4ccR8MUniexJQDaiEr99cMLGcAXoNEDiMKN3VkBAHeljiBqzRljnIdaT77PM0K4Jcg4QwCsfjutyCCnW1dCAgAAAAAAAAAgVlPau21sld3X01pC0x86m+u7aD22booGcGhVRnLhN7UBAQEBAQABAAACjWNudIYpke1SHcycbLerhgtEnj9Pe4UgtYIyW82k9gEkuSCqmwBQk7gg3yTvi0NxVJn0//TgVsDNXNgCS0s5pwIAAAAAAAAAIP7ScTSwc9qGOEVBETllGTeeiIyDq68OYAUEeeRW/wE/Ao1jbnSGKZHtUh3MnGy3q4YLRJ4/T3uFILWCMlvNpPYKAAAAAAAAAAAtMQEAAAAAAAFhANFMDxz+6lExShcHA/qG/j2jZk6y9+5k65x6u8JGJP/dyxkfrihDdFxtOt3fvaoJ/OvEZ4eo123n/momyGQuFgahtxyxD8zwVSmWjSVhhtf+UKhpW2mTgOA1Wn2xxsedmg==",
"effects": {
"messageVersion": "v1",
"status": {
"status": "success"
},
"executedEpoch": "0",
"gasUsed": {
"computationCost": "100",
"storageCost": "100",
"storageRebate": "10",
"nonRefundableStorageFee": "0"
},
"transactionDigest": "6gAPDZyrAYmnm5zGDhc3LF3Ae2PT6ABP6xSC1dfRRoXp",
"mutated": [
{
"owner": {
"AddressOwner": "0x028d636e74862991ed521dcc9c6cb7ab860b449e3f4f7b8520b582325bcda4f6"
},
"reference": {
"objectId": "0x24b920aa9b005093b820df24ef8b43715499f4fff4e056c0cd5cd8024b4b39a7",
"version": 2,
"digest": "J9ifwZ2hbL5Tg7fbbta3CXybtaabdaN8BmKudP7R8sBU"
}
},
{
"owner": {
"AddressOwner": "0x2e84e81f871c47c3149e27b12500da884afdf5c30b19c017a0d10388c28ddd59"
},
"reference": {
"objectId": "0x77a58e206acd19639c875a4fbecf3342b825c8384300ac7e3badc820a75b5742",
"version": 2,
"digest": "6ozDx8La5rgu5zSoxaMseRjcX169ZBEjSyQeD2RGoa44"
}
}
],
"gasObject": {
"owner": {
"ObjectOwner": "0x028d636e74862991ed521dcc9c6cb7ab860b449e3f4f7b8520b582325bcda4f6"
},
"reference": {
"objectId": "0x24b920aa9b005093b820df24ef8b43715499f4fff4e056c0cd5cd8024b4b39a7",
"version": 2,
"digest": "J9ifwZ2hbL5Tg7fbbta3CXybtaabdaN8BmKudP7R8sBU"
}
},
"eventsDigest": "8ju2GtaGc2UB3vFu9Pmjwze8LcUh37izem5NsGcstgtx"
},
"objectChanges": [
{
"type": "transferred",
"sender": "0x028d636e74862991ed521dcc9c6cb7ab860b449e3f4f7b8520b582325bcda4f6",
"recipient": {
"AddressOwner": "0x2e84e81f871c47c3149e27b12500da884afdf5c30b19c017a0d10388c28ddd59"
},
"objectType": "0x2::example::Object",
"objectId": "0x77a58e206acd19639c875a4fbecf3342b825c8384300ac7e3badc820a75b5742",
"version": "2",
"digest": "kLukTF3HAHvTW17s8ZHtVKZyWf4bSJb7SjZ5HuNeELk"
}
]
},
{
"digest": "7TxdfBqwTPYgG4hztwiQdeQcdWgeqpZKF7EJpyjDojFd",
"transaction": {
"data": {
"messageVersion": "v1",
"transaction": {
"kind": "ProgrammableTransaction",
"inputs": [
{
"type": "pure",
"valueType": "address",
"value": "0xdcc85bada4a729d650f7762226432129780927838b06db0346808ffb0676099d"
},
{
"type": "object",
"objectType": "immOrOwnedObject",
"objectId": "0xe0408b31759f57b69c52e09410a66f9a23c34be9913b6697a5e83e02e2a0fc74",
"version": "2",
"digest": "GP1ZYjdAR42yCiTAvnQgqPtc5bG9i7BzetfWeAo6ewgN"
}
],
"transactions": [
{
"TransferObjects": [
[
{
"Input": 1
}
],
{
"Input": 0
}
]
}
]
},
"sender": "0xb30fdd73db52c4eb06754bdb50fec3ea0e19a7851f2383d764fcb3d6eb7f8c82",
"gasData": {
"payment": [
{
"objectId": "0x7057ba0901e4d9b1e04de75ea2699a4413215612581eba57ebe7e594b809ccce",
"version": 2,
"digest": "Gtv38WbTUCw2KoAv9S5db8oTXn8ZdgkX7gGCrfU3Zvms"
}
],
"owner": "0xb30fdd73db52c4eb06754bdb50fec3ea0e19a7851f2383d764fcb3d6eb7f8c82",
"price": "10",
"budget": "20000000"
}
},
"txSignatures": [
"AKM1jt3XaQUsZ9Pe77tb2tGgmJvI8GLE2P3kdaQ1I4oglYnu9TrBds27Zbm0KP0tayMvhoDRBQc2a3mdbfPsVA/WnfBR88qs+c/GcHXhsNtHEECK8vIjfFKQvXV+9IXwAw=="
]
},
"rawTransaction": "AQAAAAAAAgAg3MhbraSnKdZQ93YiJkMhKXgJJ4OLBtsDRoCP+wZ2CZ0BAOBAizF1n1e2nFLglBCmb5ojw0vpkTtml6XoPgLioPx0AgAAAAAAAAAg5IK3WMI5kDnbvt1dskOF6TTWgrL9ZzRGkavQ78dxlBsBAQEBAQABAACzD91z21LE6wZ1S9tQ/sPqDhmnhR8jg9dk/LPW63+MggFwV7oJAeTZseBN516iaZpEEyFWElgeulfr5+WUuAnMzgIAAAAAAAAAIOwr5NrG/2lF1Js+zAQ9BJYR9s/RC8pNUX6UUq1Uhtaesw/dc9tSxOsGdUvbUP7D6g4Zp4UfI4PXZPyz1ut/jIIKAAAAAAAAAAAtMQEAAAAAAAFhAKM1jt3XaQUsZ9Pe77tb2tGgmJvI8GLE2P3kdaQ1I4oglYnu9TrBds27Zbm0KP0tayMvhoDRBQc2a3mdbfPsVA/WnfBR88qs+c/GcHXhsNtHEECK8vIjfFKQvXV+9IXwAw==",
"effects": {
"messageVersion": "v1",
"status": {
"status": "success"
},
"executedEpoch": "0",
"gasUsed": {
"computationCost": "100",
"storageCost": "100",
"storageRebate": "10",
"nonRefundableStorageFee": "0"
},
"transactionDigest": "F2iA4tJuSYJhXArnKAhrUJVAvNdTuvA8VMj9zXj6PNDe",
"mutated": [
{
"owner": {
"AddressOwner": "0xb30fdd73db52c4eb06754bdb50fec3ea0e19a7851f2383d764fcb3d6eb7f8c82"
},
"reference": {
"objectId": "0x7057ba0901e4d9b1e04de75ea2699a4413215612581eba57ebe7e594b809ccce",
"version": 2,
"digest": "Gtv38WbTUCw2KoAv9S5db8oTXn8ZdgkX7gGCrfU3Zvms"
}
},
{
"owner": {
"AddressOwner": "0xdcc85bada4a729d650f7762226432129780927838b06db0346808ffb0676099d"
},
"reference": {
"objectId": "0xe0408b31759f57b69c52e09410a66f9a23c34be9913b6697a5e83e02e2a0fc74",
"version": 2,
"digest": "GP1ZYjdAR42yCiTAvnQgqPtc5bG9i7BzetfWeAo6ewgN"
}
}
],
"gasObject": {
"owner": {
"ObjectOwner": "0xb30fdd73db52c4eb06754bdb50fec3ea0e19a7851f2383d764fcb3d6eb7f8c82"
},
"reference": {
"objectId": "0x7057ba0901e4d9b1e04de75ea2699a4413215612581eba57ebe7e594b809ccce",
"version": 2,
"digest": "Gtv38WbTUCw2KoAv9S5db8oTXn8ZdgkX7gGCrfU3Zvms"
}
},
"eventsDigest": "HQh9RPyW3hh7X3GYRXPvAQ2k7VmYWKKrZ5cMcvPypu3v"
},
"objectChanges": [
{
"type": "transferred",
"sender": "0xb30fdd73db52c4eb06754bdb50fec3ea0e19a7851f2383d764fcb3d6eb7f8c82",
"recipient": {
"AddressOwner": "0xdcc85bada4a729d650f7762226432129780927838b06db0346808ffb0676099d"
},
"objectType": "0x2::example::Object",
"objectId": "0xe0408b31759f57b69c52e09410a66f9a23c34be9913b6697a5e83e02e2a0fc74",
"version": "2",
"digest": "Azr7oPHAo6LZ9iPfHYjguY2BoVTZ9zwVArvUEJSwXKWW"
}
]
}
]
}
sui_tryGetPastObject​
Read API
Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies. Return the object information for a specified version
Params
object_id:<ObjectID>- the ID of the queried objectversion:<SequenceNumber>- the version of the queried object. If None, default to the latest known versionoptions:<ObjectDataOptions>- options for specifying the content to be returned
Result
SuiPastObjectResponse:<ObjectRead>
Example Gets Past Object data.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "sui_tryGetPastObject",
"params": [
"0x11af4b844ff94b3fbef6e36b518da3ad4c5856fa686464524a876b463d129760",
4,
{
"showType": true,
"showOwner": true,
"showPreviousTransaction": true,
"showDisplay": false,
"showContent": true,
"showBcs": false,
"showStorageRebate": true
}
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"status": "VersionFound",
"details": {
"objectId": "0x11af4b844ff94b3fbef6e36b518da3ad4c5856fa686464524a876b463d129760",
"version": "4",
"digest": "5VPAwDXy3BL72ehFc7gSJoz27ahMd6spUg5YwYc4ibcv",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0x3568c40e814d9d5396d23087a0fd641e91e0e00df6c012cded9ef9ba5e5bf042"
},
"previousTransaction": "5jQByoouHBwaico5pQB73GdbzerC2StjTiHh5garBjiV",
"storageRebate": "100",
"content": {
"dataType": "moveObject",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"hasPublicTransfer": true,
"fields": {
"balance": "10000",
"id": {
"id": "0x11af4b844ff94b3fbef6e36b518da3ad4c5856fa686464524a876b463d129760"
}
}
}
}
}
}
sui_tryMultiGetPastObjects​
Read API
Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies. Return the object information for a specified version
Params
past_objects:<[GetPastObjectRequest]>- a vector of object and versions to be queriedoptions:<ObjectDataOptions>- options for specifying the content to be returned
Result
Vec<SuiPastObjectResponse>:<[ObjectRead]>
suix_getAllBalances​
Coin Query API
Return the total coin balance for all coin type, owned by the address owner.
Params
owner:<SuiAddress>- the owner's Sui address
Result
Vec<Balance>:<[Balance]>
Example Gets all balances for the address in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getAllBalances",
"params": [
"0x94f1a597b4e8f709a396f7f6b1482bdcd65a673d111e49286c527fab7c2d0961"
]
}
Response
{
"jsonrpc": "2.0",
"result": [
{
"coinType": "0x2::sui::SUI",
"coinObjectCount": 15,
"totalBalance": "3000000000",
"lockedBalance": {}
}
]
}
suix_getAllCoins​
Coin Query API
Return all Coin objects owned by an address.
Params
owner:<SuiAddress>- the owner's Sui addresscursor:<ObjectID>- optional paging cursorlimit:<uint>- maximum number of items per page
Result
CoinPage:<Page_for_Coin_and_ObjectID>
Example
Gets all coins for the address in the request body. Begin listing the coins that are after the provided cursor value and return only the limit amount of results per page.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getAllCoins",
"params": [
"0x41f5975e3c6bd5c95f041a8493ad7e9934be26e69152d2c2e86d8a9bdbd242b3",
"0x2564cd31a71cf9833609b111436d8f0f47b7f8b9927ec3f8975a1dcbf9b25564",
3
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": [
{
"coinType": "0x2::sui::SUI",
"coinObjectId": "0x91825debff541cf4e08b5c5f7296ff9840e6f0b185af93984cde8cf3870302c0",
"version": "103626",
"digest": "7dp5WtTmtGp83EXYYFMzjBJRFeSgR67AzqMETLrfgeFx",
"balance": "200000000",
"previousTransaction": "9WfFUVhjbbh4tWkyUse1QxzbKX952cyXScH7xJNPB2vQ"
},
{
"coinType": "0x2::sui::SUI",
"coinObjectId": "0x48a53f22e2e901ea2a5bf44fdd5bb94a1d83b6efc4dd779f0890ca3b1f6ba997",
"version": "103626",
"digest": "9xLdMXezY8d1yRA2TtN6pYjapyy2EVKHWNriGPFGCFvd",
"balance": "200000000",
"previousTransaction": "Byq9SyV7x6fvzaf88YRA9JM8vLbVLJAqUX8pESDmKcgw"
},
{
"coinType": "0x2::sui::SUI",
"coinObjectId": "0x6867fcc63161269c5c0c73b02229486bbaff319209dfb8299ced3b8609037997",
"version": "103626",
"digest": "5xexWFq6QpGHBQyC9P2cbAJXq9qm2EjzfuRM9NwS1uyG",
"balance": "200000000",
"previousTransaction": "CEjwHmo98nAiYhSMfKoSDvUMtfKJ6ge6Uj4wKotK4MPZ"
}
],
"nextCursor": "0x861c5e055605b2bb1199faf653a8771e448930bc95a0369fad43a9870a2e5878",
"hasNextPage": true
}
}
suix_getBalance​
Coin Query API
Return the total coin balance for one coin type, owned by the address owner.
Params
owner:<SuiAddress>- the owner's Sui addresscoin_type:<string>- optional type names for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC), default to 0x2::sui::SUI if not specified.
Result
-
Balance:<Balance>- coinObjectCount :
<uint> - coinType :
<string> - lockedBalance :
<object> - totalBalance :
<BigInt_for_uint128>
- coinObjectCount :
Example Gets the balance of the specified type of coin for the address in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getBalance",
"params": [
"0x51ceab2edc89f74730e683ebee65578cb3bc9237ba6fca019438a9737cf156ae",
"0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"coinType": "0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC",
"coinObjectCount": 15,
"totalBalance": "15",
"lockedBalance": {}
}
}
suix_getCoinMetadata​
Coin Query API
Return metadata(e.g., symbol, decimals) for a coin
Params
coin_type:<string>- type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC)
Result
-
SuiCoinMetadata:<SuiCoinMetadata>- decimals :
<uint8>- Number of decimal places the coin uses. - description :
<string>- Description of the token - iconUrl :
<string,null>- URL for the token logo - id :
<[ObjectID]>- Object id for the CoinMetadata object - name :
<string>- Name for the token - symbol :
<string>- Symbol for the token
- decimals :
Example Gets the metadata for the coin type in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getCoinMetadata",
"params": [
"0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"id": {
"id": "0x6d907beaa3a49db57bdfdb3557e6d405cbf01c293a53e01457d65e92b5d8dd68"
},
"decimals": 9,
"name": "Usdc",
"symbol": "USDC",
"description": "Stable coin.",
"icon_url": null
}
}
suix_getCoins​
Coin Query API
Return all Coin< coin_type > objects owned by an address.
Params
owner:<SuiAddress>- the owner's Sui addresscoin_type:<string>- optional type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC), default to 0x2::sui::SUI if not specified.cursor:<ObjectID>- optional paging cursorlimit:<uint>- maximum number of items per page
Result
CoinPage:<Page_for_Coin_and_ObjectID>
Example
Gets all SUI coins owned by the address provided. Return a paginated list of limit results per page. Similar to suix_getAllCoins , but provides a way to filter by coin type.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getCoins",
"params": [
"0xd62ca040aba24f862a763851c54908cd2a0ee7d709c11b93d4a2083747b76856",
"0x2::sui::SUI",
"0xe5c651321915b06c81838c2e370109b554a448a78d3a56220f798398dde66eab",
3
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": [
{
"coinType": "0x2::sui::SUI",
"coinObjectId": "0xa5a8e30db5a798a7354340b6ea78a66f50921841ab5359ec7a3dc01f282420ae",
"version": "103626",
"digest": "tw5DzJTfdxTn4f3rekFrhN7dQTUezBgsEhycDobTBLb",
"balance": "200000000",
"previousTransaction": "HSein75AFXgdsnbABWLQ5mvjFmPFWrBFi9CMVsNn7gJr"
},
{
"coinType": "0x2::sui::SUI",
"coinObjectId": "0x47dfa99496428c65b2054ad7db1872b87ff05b1047bb5e3adf5257cceb08ecb4",
"version": "103626",
"digest": "AfgFe7ZfjJ5dWV6VAy2LbtvBFhcABkvdvwEjLrRcFqtr",
"balance": "200000000",
"previousTransaction": "5WHnm9jUZEtDvSvsj7HBrP5BoxA3UY6R57qqumXJXboV"
},
{
"coinType": "0x2::sui::SUI",
"coinObjectId": "0xd4f062dbcfc3bf73f5861945592222ff7b090ac21c8a3cf840abdc5b743da778",
"version": "103626",
"digest": "9er6jxigfuQEKsn9gtPV2oW1zGQRcFtKNijHVe88GUJD",
"balance": "200000000",
"previousTransaction": "H3gwoKE2FSLx3BwvNTTKqCsNHmg6ARzm345icHhXUAEW"
}
],
"nextCursor": "0xd4f062dbcfc3bf73f5861945592222ff7b090ac21c8a3cf840abdc5b743da778",
"hasNextPage": true
}
}
suix_getCommitteeInfo​
Governance Read API
Return the committee information for the asked epoch .
Params
epoch:<BigInt_for_uint64>- The epoch of interest. If None, default to the latest epoch
Result
SuiCommittee:<CommitteeInfo>
Example Gets committee information for epoch 5000.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getCommitteeInfo",
"params": [
"5000"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"epoch": "5000",
"validators": [
[
"jc/20VUECmVvSBmxMRG1LFdGqGunLzlfuv4uw4R9HoFA5iSnUf32tfIFC8cgXPnTAATJCwx0Cv/TJs5nPMKyOi0k1T4q/rKG38Zo/UBgCJ1tKxe3md02+Q0zLlSnozjU",
"2500"
],
[
"mfJe9h+AMrkUY2RgmCxcxvE07x3a52ZX8sv+wev8jQlzdAgN9vzw3Li8Sw2OCvXYDrv/K0xZn1T0LWMS38MUJ2B4wcw0fru+xRmL4lhRPzhrkw0CwnSagD4jMJVevRoQ",
"2500"
],
[
"rd7vlNiYyI5A297/kcXxBfnPLHR/tvK8N+wD1ske2y4aV4z1RL6LCTHiXyQ9WbDDDZihbOO6HWzx1/UEJpkusK2zE0sFW+gUDS218l+wDYP45CIr8B/WrJOh/0152ljy",
"2500"
],
[
"s/1e+1yHJAOkrRPxGZUTYG0jNUqEUkmuoVdWTCP/PBXGyeZSty10DoysuTy8wGhrDsDMDBx2C/tCtDZRn8WoBUt2UzqXqfI5h9CX75ax8lJrsgc/oQp3GZQXcjR+8nT0",
"2500"
]
]
}
}
suix_getDynamicFieldObject​
Extended API
Return the dynamic field object information for a specified object
Params
parent_object_id:<ObjectID>- The ID of the queried parent objectname:<DynamicFieldName>- The Name of the dynamic field
Result
-
SuiObjectResponse:<SuiObjectResponse>- data :
<[ObjectData]> - error :
<[ObjectResponseError]>
- data :
Example Gets the information for the dynamic field the request provides.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getDynamicFieldObject",
"params": [
"0xc8359b6b5e3bfeab524e5edaad3a204b4053745b2d45d1f00cd8d24e5b697607",
{
"type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField",
"value": "some_value"
}
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": {
"objectId": "0xc8359b6b5e3bfeab524e5edaad3a204b4053745b2d45d1f00cd8d24e5b697607",
"version": "1",
"digest": "2VivvkBoFVwEg8oXq3tK9r3d3ybvMACtk9QwpFnkM6v2",
"type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField",
"owner": {
"AddressOwner": "0xc055d5c23e2f6c69e6aacf5b4664b570cb20d4feace07fc863a2eef286c3e95e"
},
"previousTransaction": "FJjAr8fdpuQvVZgd9VswXxz9jZcFGEAgKgdi8d6zXE3S",
"storageRebate": "100",
"content": {
"dataType": "moveObject",
"type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField",
"hasPublicTransfer": true,
"fields": {}
}
}
}
}
suix_getDynamicFields​
Extended API
Return the list of dynamic field objects owned by an object.
Params
parent_object_id:<ObjectID>- The ID of the parent objectcursor:<ObjectID>- An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.limit:<uint>- Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.
Result
DynamicFieldPage:<Page_for_DynamicFieldInfo_and_ObjectID>
Example
Gets dynamic fields for the object the request provides in a paginated list of limit dynamic field results per page. The default limit is 50.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getDynamicFields",
"params": [
"0xe15bb8de6dadd21835dfe44f4973139c15f93ddea0f8c3da994d9ead562ce76e",
"0xa9334aeacc435c70ab9635e47a277d8f8dd9d87765d1aadec2db8cc24c312542",
3
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": [
{
"name": {
"type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField",
"value": "some_value"
},
"bcsName": "2F1KQ3miNpBx1RzoRr1MVYMraK7RV",
"type": "DynamicField",
"objectType": "test",
"objectId": "0x36fdef6a382da344930c73d1298b0e9644b85ea6f7a348f4a7bd1a9ab069eb7f",
"version": 1,
"digest": "7hWCQjKfZf7oNLpSrhFJZEmYnpmSPzVLwJfFuHmMD9ct"
},
{
"name": {
"type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField",
"value": "some_value"
},
"bcsName": "2F1KQ3miNpBx1RzoRr1MVYMraK7RV",
"type": "DynamicField",
"objectType": "test",
"objectId": "0xfe41671856fd3450dc5574abd53c793c9f22d8a72d5550df8d2d64a9155d126c",
"version": 1,
"digest": "CxuC9uMcWLk8oMg7QGaJSqUE4hwP6cMUQ94ipiN53jr3"
},
{
"name": {
"type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField",
"value": "some_value"
},
"bcsName": "2F1KQ3miNpBx1RzoRr1MVYMraK7RV",
"type": "DynamicField",
"objectType": "test",
"objectId": "0x1edb2df5ea5d55c96a611371d22799d268270cd4bb4d4f520fe9bbf0cf1cebe3",
"version": 1,
"digest": "HJxTwLy4oE1Aoy3PocGfL9oHystQiyssHfmyE8YaPrw4"
}
],
"nextCursor": "0x8a25d8876ea3c60e345ac3861444136b4a1b0b37a91692359a98496738a58c17",
"hasNextPage": true
}
}
suix_getLatestSuiSystemState​
Governance Read API
Return the latest SUI system state object on-chain.
Result
-
SuiSystemStateSummary:<SuiSystemStateSummary>- activeValidators :
<[SuiValidatorSummary]>- The list of active validators in the current epoch. - atRiskValidators :
<[SuiAddress]>- Map storing the number of epochs for which each validator has been below the low stake threshold. - epoch :
<[BigInt_for_uint64]>- The current epoch ID, starting from 0. - epochDurationMs :
<[BigInt_for_uint64]>- The duration of an epoch, in milliseconds. - epochStartTimestampMs :
<[BigInt_for_uint64]>- Unix timestamp of the current epoch start - inactivePoolsId :
<[ObjectID]>- ID of the object that maps from a staking pool ID to the inactive validator that has that pool as its staking pool. - inactivePoolsSize :
<[BigInt_for_uint64]>- Number of inactive staking pools. - maxValidatorCount :
<[BigInt_for_uint64]>- Maximum number of active validators at any moment. We do not allow the number of validators in any epoch to go above this. - minValidatorJoiningStake :
<[BigInt_for_uint64]>- Lower-bound on the amount of stake required to become a validator. - pendingActiveValidatorsId :
<[ObjectID]>- ID of the object that contains the list of new validators that will join at the end of the epoch. - pendingActiveValidatorsSize :
<[BigInt_for_uint64]>- Number of new validators that will join at the end of the epoch. - pendingRemovals :
<[BigInt_for_uint64]>- Removal requests from the validators. Each element is an index pointing toactive_validators. - protocolVersion :
<[BigInt_for_uint64]>- The current protocol version, starting from 1. - referenceGasPrice :
<[BigInt_for_uint64]>- The reference gas price for the current epoch. - safeMode :
<boolean>- Whether the system is running in a downgraded safe mode due to a non-recoverable bug. This is set whenever we failed to execute advance_epoch, and ended up executing advance_epoch_safe_mode. It can be reset once we are able to successfully execute advance_epoch. - safeModeComputationRewards :
<[BigInt_for_uint64]>- Amount of computation rewards accumulated (and not yet distributed) during safe mode. - safeModeNonRefundableStorageFee :
<[BigInt_for_uint64]>- Amount of non-refundable storage fee accumulated during safe mode. - safeModeStorageRebates :
<[BigInt_for_uint64]>- Amount of storage rebates accumulated (and not yet burned) during safe mode. - safeModeStorageRewards :
<[BigInt_for_uint64]>- Amount of storage rewards accumulated (and not yet distributed) during safe mode. - stakeSubsidyBalance :
<[BigInt_for_uint64]>- Balance of SUI set aside for stake subsidies that will be drawn down over time. - stakeSubsidyCurrentDistributionAmount :
<[BigInt_for_uint64]>- The amount of stake subsidy to be drawn down per epoch. This amount decays and decreases over time. - stakeSubsidyDecreaseRate :
<uint16>- The rate at which the distribution amount decays at the end of each period. Expressed in basis points. - stakeSubsidyDistributionCounter :
<[BigInt_for_uint64]>- This counter may be different from the current epoch number if in some epochs we decide to skip the subsidy. - stakeSubsidyPeriodLength :
<[BigInt_for_uint64]>- Number of distributions to occur before the distribution amount decays. - stakeSubsidyStartEpoch :
<[BigInt_for_uint64]>- The starting epoch in which stake subsidies start being paid out - stakingPoolMappingsId :
<[ObjectID]>- ID of the object that maps from staking pool's ID to the sui address of a validator. - stakingPoolMappingsSize :
<[BigInt_for_uint64]>- Number of staking pool mappings. - storageFundNonRefundableBalance :
<[BigInt_for_uint64]>- The non-refundable portion of the storage fund coming from storage reinvestment, non-refundable storage rebates and any leftover staking rewards. - storageFundTotalObjectStorageRebates :
<[BigInt_for_uint64]>- The storage rebates of all the objects on-chain stored in the storage fund. - systemStateVersion :
<[BigInt_for_uint64]>- The current version of the system state data structure type. - totalStake :
<[BigInt_for_uint64]>- Total amount of stake from all active validators at the beginning of the epoch. - validatorCandidatesId :
<[ObjectID]>- ID of the object that stores preactive validators, mapping their addresses to theirValidatorstructs. - validatorCandidatesSize :
<[BigInt_for_uint64]>- Number of preactive validators. - validatorLowStakeGracePeriod :
<[BigInt_for_uint64]>- A validator can have stake belowvalidator_low_stake_thresholdfor this many epochs before being kicked out. - validatorLowStakeThreshold :
<[BigInt_for_uint64]>- Validators with stake amount belowvalidator_low_stake_thresholdare considered to have low stake and will be escorted out of the validator set after being below this threshold for more thanvalidator_low_stake_grace_periodnumber of epochs. - validatorReportRecords :
<[SuiAddress]>- A map storing the records of validator reporting each other. - validatorVeryLowStakeThreshold :
<[BigInt_for_uint64]>- Validators with stake belowvalidator_very_low_stake_thresholdwill be removed immediately at epoch change, no grace period.
- activeValidators :
Example Gets objects owned by the address in the request.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getLatestSuiSystemState",
"params": []
}
Response
{
"jsonrpc": "2.0",
"result": "some_system_state"
}
suix_getOwnedObjects​
Extended API
Return the list of objects owned by an address. Note that if the address owns more than QUERY_MAX_RESULT_LIMIT objects, the pagination is not accurate, because previous page may have been updated when the next page is fetched. Please use suix_queryObjects if this is a concern.
Params
address:<SuiAddress>- the owner's Sui addressquery:<ObjectResponseQuery>- the objects query criteria.cursor:<ObjectID>- An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.limit:<uint>- Max number of items returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.
Result
ObjectsPage:<Page_for_SuiObjectResponse_and_ObjectID>
Example Returns all the objects the address provided in the request owns and that match the filter. By default, only the digest value is returned, but the request returns additional information by setting the relevant keys to true. A cursor value is also provided, so the list of results begin after that value.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getOwnedObjects",
"params": [
"0xa69bb635dcee0f33643b4729ae81730d55e5e26860fac6839ce2d7ed7e6f29d2",
{
"filter": {
"MatchAll": [
{
"StructType": "0x2::coin::Coin<0x2::sui::SUI>"
},
{
"AddressOwner": "0xa69bb635dcee0f33643b4729ae81730d55e5e26860fac6839ce2d7ed7e6f29d2"
},
{
"Version": "13488"
}
]
},
"options": {
"showType": true,
"showOwner": true,
"showPreviousTransaction": true,
"showDisplay": false,
"showContent": false,
"showBcs": false,
"showStorageRebate": false
}
},
"0x76a1b4c23f2d9a9b6f0d8b2c17beace292b72aea16d6fb49b7d1ae51f33b01ed",
3
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": [
{
"data": {
"objectId": "0x3d6255ff8223c12b0fd985c49d5777a0d65ad3d707164b2a378eee639ebc2690",
"version": "13488",
"digest": "A6v9pFTLH3PkDSvEGgVjW1JhL7CtcUQKwGmgXK8SQNsc",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0xa69bb635dcee0f33643b4729ae81730d55e5e26860fac6839ce2d7ed7e6f29d2"
},
"previousTransaction": "AZiaEnge9YnawyLosmuxd8grpoiYasfpvBEjSLFUmJ8m",
"storageRebate": "100"
}
},
{
"data": {
"objectId": "0x1a6e30f43933bbf40f5f5b6ce1f44957337dcb28f32e0355326f8c7d932bd54d",
"version": "13488",
"digest": "Fn1HG7LyUcLDps6bhYQkPWXpeUXgisznxRJ2qvn7Q1JN",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0xa69bb635dcee0f33643b4729ae81730d55e5e26860fac6839ce2d7ed7e6f29d2"
},
"previousTransaction": "5EZjpdpApGGb48UZtuRgXuTRDBgkFDYaiNUtUNg7788k",
"storageRebate": "100"
}
},
{
"data": {
"objectId": "0x28628a24386298faa98850887f64da841b87279efd098d59a66a3d9adc87cce8",
"version": "13488",
"digest": "39aXGAwHaY3CiqWwLiBZ7JRaGSvnpvPbHxMSJAwAUY5i",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"owner": {
"AddressOwner": "0xa69bb635dcee0f33643b4729ae81730d55e5e26860fac6839ce2d7ed7e6f29d2"
},
"previousTransaction": "CnBDiCrxWcJCCU1LHoda6XwwRaCSRfva8HZzfmR3p8Ag",
"storageRebate": "100"
}
}
],
"nextCursor": "0x28628a24386298faa98850887f64da841b87279efd098d59a66a3d9adc87cce8",
"hasNextPage": true
}
}
suix_getReferenceGasPrice​
Governance Read API
Return the reference gas price for the network
Result
BigInt<u64>:<BigInt_for_uint64>
Example Gets reference gas price information for the network.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getReferenceGasPrice",
"params": []
}
Response
{
"jsonrpc": "2.0",
"result": 1000
}
suix_getStakes​
Governance Read API
Return all [DelegatedStake].
Params
owner:<SuiAddress>-
Result
Vec<DelegatedStake>:<[DelegatedStake]>
suix_getStakesByIds​
Governance Read API
Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.
Params
staked_sui_ids:<[ObjectID]>-
Result
Vec<DelegatedStake>:<[DelegatedStake]>
suix_getTotalSupply​
Coin Query API
Return total supply for a coin
Params
coin_type:<string>- type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC)
Result
-
Supply:<Supply>- value :
<BigInt_for_uint64>
- value :
Example Gets total supply for the type of coin provided.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getTotalSupply",
"params": [
"0x0a52124e2d53af3bef7959609efa51761ad155441a1b73bdaeecce7c56488b13::acoin::ACOIN"
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"value": "12023692"
}
}
suix_getValidatorsApy​
Governance Read API
Return the validator APY
Result
-
ValidatorApys:<ValidatorApys>- apys :
<[ValidatorApy]> - epoch :
<BigInt_for_uint64>
- apys :
Example Gets the APY for all validators.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_getValidatorsApy",
"params": []
}
Response
{
"jsonrpc": "2.0",
"result": {
"apys": [
{
"address": "0xb7d1cb695b9491893f88a5ae1b9d4f235b3c7e00acf5386662fa062483ba507b",
"apy": 0.06
},
{
"address": "0x1e9e3039750f0a270f2e12441ad7f611a5f7fd0b2c4326c56b1fec231d73038d",
"apy": 0.02
},
{
"address": "0xba0f0885b97982f5fcac3ec6f5c8cae16743671832358f25bfacde706e528df4",
"apy": 0.05
}
],
"epoch": "420"
}
}
suix_queryEvents​
Extended API
Return list of events for a specified query criteria.
Params
query:<EventFilter>- the event query criteria.cursor:<EventID>- optional paging cursorlimit:<uint>- maximum number of items per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.descending_order:<boolean>- query result ordering, default to false (ascending order), oldest record first.
Result
EventPage:<Page_for_Event_and_EventID>
Example Returns the events for a specified query criteria.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_queryEvents",
"params": [
{
"MoveModule": {
"package": "0x30651d6e8f93e0fb79b4bc65a512beb5b9f3378423de90ed03b694cecf443c72",
"module": "test"
}
},
{
"txDigest": "Nb5kW8n655ApSBA19d2K8UVFGtMnJHa1mJQRH1h5N9L",
"eventSeq": "1"
},
100,
false
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": [
{
"id": {
"txDigest": "8WecQq8Qd79MmrHRXYudNG7e6vjWC9HtGAT4XZFyyWRM",
"eventSeq": "1"
},
"packageId": "0x28f9c59f430eaba84b8bee9b43a30f9cc83fa395759ca37c6e1ffc179184e98a",
"transactionModule": "test",
"sender": "0xc5db76052ab656e5f81853d0cf701cdbc8ebf27ab513fc6ef8c344406c78da3d",
"type": "0x3::test::Test<0x3::test::Test>",
"parsedJson": "some_value",
"bcs": ""
},
{
"id": {
"txDigest": "CNLhn3qWzHhfmmLQTdinbFDd2DuXFPN9z77UUqsC4Z4A",
"eventSeq": "1"
},
"packageId": "0x28f9c59f430eaba84b8bee9b43a30f9cc83fa395759ca37c6e1ffc179184e98a",
"transactionModule": "test",
"sender": "0x5ad3a5fcc295dc8803c15989a62d33ee859014cfd5e91c13a481370240e39246",
"type": "0x3::test::Test<0x3::test::Test>",
"parsedJson": "some_value",
"bcs": ""
},
{
"id": {
"txDigest": "FEhceVx5a6mkeZH8dPxthQkEEPkWfjWN3w1e6uTB5rFm",
"eventSeq": "1"
},
"packageId": "0x28f9c59f430eaba84b8bee9b43a30f9cc83fa395759ca37c6e1ffc179184e98a",
"transactionModule": "test",
"sender": "0x4c329a203fb9f0a8158aaab9b2a90044b26e14cc7fee4100fdcabda6d15c63c4",
"type": "0x3::test::Test<0x3::test::Test>",
"parsedJson": "some_value",
"bcs": ""
},
{
"id": {
"txDigest": "Nb5kW8n655ApSBA19d2K8UVFGtMnJHa1mJQRH1h5N9L",
"eventSeq": "1"
},
"packageId": "0x28f9c59f430eaba84b8bee9b43a30f9cc83fa395759ca37c6e1ffc179184e98a",
"transactionModule": "test",
"sender": "0xb49c45ae23f2b936495cd38b1a4b04010295baa75ac72e548aeecf2ce8b4e885",
"type": "0x3::test::Test<0x3::test::Test>",
"parsedJson": "some_value",
"bcs": ""
}
],
"nextCursor": {
"txDigest": "Nb5kW8n655ApSBA19d2K8UVFGtMnJHa1mJQRH1h5N9L",
"eventSeq": "1"
},
"hasNextPage": false
}
}
suix_queryTransactionBlocks​
Extended API
Return list of transactions for a specified query criteria.
Params
query:<TransactionBlockResponseQuery>- the transaction query criteria.cursor:<TransactionDigest>- An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.limit:<uint>- Maximum item returned per page, default to QUERY_MAX_RESULT_LIMIT if not specified.descending_order:<boolean>- query result ordering, default to false (ascending order), oldest record first.
Result
TransactionBlocksPage:<Page_for_TransactionBlockResponse_and_TransactionDigest>
Example Returns the transaction digest for specified query criteria.
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "suix_queryTransactionBlocks",
"params": [
{
"filter": {
"InputObject": "0x93633829fcba6d6e0ccb13d3dbfe7614b81ea76b255e5d435032cd8595f37eb8"
},
"options": null
},
"HxidAfFfyr4kXSiWeVq1J6Tk526YUVDoSUY5PSnS4tEJ",
100,
false
]
}
Response
{
"jsonrpc": "2.0",
"result": {
"data": [
{
"digest": "GUPcK4cmRmgsTFr52ab9f6fnzNVg3Lz6hF2aXFcsRzaD"
},
{
"digest": "B2iV1SVbBjgTKfbJKPQrvTT6F3kNdekFuBwY9tQcAxV2"
},
{
"digest": "8QrPa4x9iNG5r2zQfmeH8pJoVjjtq9AGzp8rp2fxi8Sk"
},
{
"digest": "3nek86HEjXZ7K3EtrAcBG4wMrCS21gqr8BqwwC6M6P7F"
}
],
"nextCursor": "3nek86HEjXZ7K3EtrAcBG4wMrCS21gqr8BqwwC6M6P7F",
"hasNextPage": false
}
}
suix_resolveNameServiceAddress​
Extended API
Return the resolved address given resolver and name
Params
name:<string>- The name to resolve
Result
SuiAddress:<SuiAddress>
suix_resolveNameServiceNames​
Extended API
Return the resolved names given address, if multiple names are resolved, the first one is the primary name.
Params
address:<SuiAddress>- The address to resolvecursor:<ObjectID>-limit:<uint>-
Result
Page<String,ObjectID>:<Page_for_String_and_ObjectID>
suix_subscribeEvent​
Extended API, Websocket, PubSub
Subscribe to a stream of Sui event
Params
filter:<EventFilter>- the filter criteria of the event stream, see the Sui docs for detailed examples.
Result
SuiEvent:<Event>
suix_subscribeTransaction​
Extended API, Websocket, PubSub
Subscribe to a stream of Sui transaction effects
Params
filter:<TransactionFilter>-
Result
SuiTransactionBlockEffects:<TransactionBlockEffects>
unsafe_batchTransaction​
Transaction Builder API
Create an unsigned batched transaction.
Params
signer:<SuiAddress>- the transaction signer's Sui addresssingle_transaction_params:<[RPCTransactionRequestParams]>- list of transaction request parametersgas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer's possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budgettxn_builder_mode:<SuiTransactionBlockBuilderMode>- Whether this is a regular transaction or a Dev Inspect Transaction
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_mergeCoins​
Transaction Builder API
Create an unsigned transaction to merge multiple coins into one coin.
Params
signer:<SuiAddress>- the transaction signer's Sui addressprimary_coin:<ObjectID>- the coin object to merge into, this coin will remain after the transactioncoin_to_merge:<ObjectID>- the coin object to be merged, this coin will be destroyed, the balance will be added toprimary_coingas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer's possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_moveCall​
Transaction Builder API
Create an unsigned transaction to execute a Move call on the network, by calling the specified function in the module of a given package.
Params
signer:<SuiAddress>- the transaction signer's Sui addresspackage_object_id:<ObjectID>- the Move package ID, e.g.0x2module:<string>- the Move module name, e.g.payfunction:<string>- the move function name, e.g.splittype_arguments:<[TypeTag]>- the type arguments of the Move functionarguments:<[SuiJsonValue]>- the arguments to be passed into the Move function, in SuiJson formatgas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer's possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budgetexecution_mode:<SuiTransactionBlockBuilderMode>- Whether this is a Normal transaction or a Dev Inspect Transaction. Default to beSuiTransactionBlockBuilderMode::Commitwhen it's None.
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_pay​
Transaction Builder API
Send Coin<T> to a list of addresses, where T can be any coin type, following a list of amounts, The object specified in the gas field will be used to pay the gas fee for the transaction. The gas object can not appear in input_coins . If the gas object is not specified, the RPC server will auto-select one.
Params
signer:<SuiAddress>- the transaction signer's Sui addressinput_coins:<[ObjectID]>- the Sui coins to be used in this transactionrecipients:<[SuiAddress]>- the recipients' addresses, the length of this vector must be the same as amounts.amounts:<[BigInt_for_uint64]>- the amounts to be transferred to recipients, following the same ordergas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer's possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_payAllSui​
Transaction Builder API
Send all SUI coins to one recipient. This is for SUI coin only and does not require a separate gas coin object. Specifically, what pay_all_sui does are: 1. accumulate all SUI from input coins and deposit all SUI to the first input coin 2. transfer the updated first coin to the recipient and also use this first coin as gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - actual_gas_cost. 4. all other input coins other than the first are deleted.
Params
signer:<SuiAddress>- the transaction signer’s Sui addressinput_coins:<[ObjectID]>- the Sui coins to be used in this transaction, including the coin for gas payment.recipient:<SuiAddress>- the recipient address,gas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_paySui​
Transaction Builder API
Send SUI coins to a list of addresses, following a list of amounts. This is for SUI coin only and does not require a separate gas coin object. Specifically, what pay_sui does are: 1. debit each input_coin to create new coin following the order of amounts and assign it to the corresponding recipient. 2. accumulate all residual SUI from input coins left and deposit all SUI to the first input coin, then use the first input coin as the gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - sum(amounts) - actual_gas_cost 4. all other input coints other than the first one are deleted.
Params
signer:<SuiAddress>- the transaction signer’s Sui addressinput_coins:<[ObjectID]>- the Sui coins to be used in this transaction, including the coin for gas payment.recipients:<[SuiAddress]>- the recipients’ addresses, the length of this vector must be the same as amounts.amounts:<[BigInt_for_uint64]>- the amounts to be transferred to recipients, following the same ordergas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_publish​
Transaction Builder API
Create an unsigned transaction to publish a Move package.
Params
sender:<SuiAddress>- the transaction signer’s Sui addresscompiled_modules:<[Base64]>- the compiled bytes of a Move packagedependencies:<[ObjectID]>- a list of transitive dependency addresses that this set of modules depends on.gas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer’s possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_requestAddStake​
Transaction Builder API
Add stake to a validator’s staking pool using multiple coins and amount.
Params
signer:<SuiAddress>- the transaction signer’s Sui addresscoins:<[ObjectID]>- Coin object to stakeamount:<BigInt_for_uint64>- stake amountvalidator:<SuiAddress>- the validator’s Sui addressgas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer’s possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_requestWithdrawStake​
Transaction Builder API
Withdraw stake from a validator’s staking pool.
Params
signer:<SuiAddress>- the transaction signer’s Sui addressstaked_sui:<ObjectID>- StakedSui object IDgas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer’s possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_splitCoin​
Transaction Builder API
Create an unsigned transaction to split a coin object into multiple coins.
Params
signer:<SuiAddress>- the transaction signer’s Sui addresscoin_object_id:<ObjectID>- the coin object to be spiltsplit_amounts:<[BigInt_for_uint64]>- the amounts to split out from the coingas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer’s possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_splitCoinEqual​
Transaction Builder API
Create an unsigned transaction to split a coin object into multiple equal-size coins.
Params
signer:<SuiAddress>- the transaction signer’s Sui addresscoin_object_id:<ObjectID>- the coin object to be spiltsplit_count:<BigInt_for_uint64>- the number of coins to split intogas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer’s possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budget
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_transferObject​
Transaction Builder API
Create an unsigned transaction to transfer an object from one address to another. The object’s type must allow public transfers
Params
signer:<SuiAddress>- the transaction signer’s Sui addressobject_id:<ObjectID>- the ID of the object to be transferredgas:<ObjectID>- gas object to be used in this transaction, node will pick one from the signer’s possession if not providedgas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budgetrecipient:<SuiAddress>- the recipient’s Sui address
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :
unsafe_transferSui​
Transaction Builder API
Create an unsigned transaction to send SUI coin object to a Sui address. The SUI object is also used as the gas object.
Params
signer:<SuiAddress>- the transaction signer’s Sui addresssui_object_id:<ObjectID>- the Sui coin object to be used in this transactiongas_budget:<BigInt_for_uint64>- the gas budget, the transaction will fail if the gas cost exceed the budgetrecipient:<SuiAddress>- the recipient’s Sui addressamount:<BigInt_for_uint64>- the amount to be split out and transferred
Result
-
TransactionBlockBytes:<TransactionBlockBytes>- gas :
<[ObjectRef]>- the gas objects to be used - inputObjects :
<[InputObjectKind]>- objects to be used in this transaction - txBytes :
<[Base64]>- BCS serialized transaction data bytes without its type tag, as base-64 encoded string.
- gas :