​
Overview

​
Authentication, rate limits, error handling, and sending to specific regions

See our JSON-RPC API overview doc for information on how to send to Tokyo - apac1 Mainnet and US-East - us1 Mainnet or Testnet. The examples below use the US-East region URL.

​
Write API

​
sui_devInspectTransactionBlock

Description
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 Important note on Node usage and billing for this request: devInspectTransactionBlock can accept a TransactionBlock as input (as opposed to a string or byte-array representation of a TransactionBlock you’ve already called .build() on). If you do this, it will call TransactionBlock.build() with the input block, which will lead to additional Node Service requests (because that’s what the build() method does). These requests count towards your access key’s rate limit and your daily request count (and thus your billing), just like when you explicitly call TransactionBlock.build() with a SuiClient using Shinami’s Node Service URL. For more information, see our TransactionBlock.build() guide Params
  • sender : String- the caller’s Sui address
  • tx_bytes : String - TransactionKind bytes, as Base-64 encoded string. This includes only the bytes of the programmable transaction block, and not the gas data or sender address. If you want to run a test including the gas object that would be used in the transaction, see sui_dryRunTransactionBlock.
  • epoch : String - (Optional) The epoch to perform the call, e.g "211". Will be set from the system state object if not provided.
  • gas_price : String- (Optional) Gas is not charged, but gas usage is still calculated. Default to use reference gas price.
Example Request Template This example uses our US East - us1 region URL since it is currently the only region where we offer Testnet. To send to another region, see our our Node Service API Overview. The TypeScript example uses the Shinami Clients SDK, which you can install with:
Shell
npm install @shinami/clients
Replace all instances of{{name}} with the actual value for that name 
curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: {{nodeAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{
        "jsonrpc":"2.0",
        "method":"sui_devInspectTransactionBlock",
        "params":[
            "{{sender}}",
            "{{tx_bytes}}",
            "{{epoch}}",
            "{{gas_price}}"
        ],
        "id":1
    }'
Example Response 
{
    "jsonrpc": "2.0",
    "result": {
        "effects": {
            "messageVersion": "v1",
            "status": {
                "status": "success"
            },
            "executedEpoch": "183",
            "gasUsed": {
                "computationCost": "1000000",
                "storageCost": "988000",
                "storageRebate": "0",
                "nonRefundableStorageFee": "0"
            },
            "modifiedAtVersions": [{
                "objectId": "0x6b58be0179322a2f5a3e4631d72e629fafbb16a10bf5947042b7a17d0a8baaed",
                "sequenceNumber": "0"
            }],
            "sharedObjects": [{
                "objectId": "0x0000000000000000000000000000000000000000000000000000000000000006",
                "version": 15651690,
                "digest": "6F14i8UWjTBjNFhJ1oZjSSTrDi14dvETnRQKkcvA4asU"
            }],
            "transactionDigest": "2ZVDw6Qv2GT7chaBw3C43ECxEvAQBq3VJQMspJg5FMFx",
            "mutated": [{
                "owner": {
                    "AddressOwner": "0xa39edfb89e6a21e89570711845c6c8f412d86bb208e571faf6ea1fc6470172d7"
                },
                "reference": {
                    "objectId": "0x6b58be0179322a2f5a3e4631d72e629fafbb16a10bf5947042b7a17d0a8baaed",
                    "version": 15651691,
                    "digest": "GcFc68NaJ7rghiFfDkxC7PzYzsRMUkgdBxE83uyTBcCu"
                }
            }],
            "gasObject": {
                "owner": {
                    "AddressOwner": "0xa39edfb89e6a21e89570711845c6c8f412d86bb208e571faf6ea1fc6470172d7"
                },
                "reference": {
                    "objectId": "0x6b58be0179322a2f5a3e4631d72e629fafbb16a10bf5947042b7a17d0a8baaed",
                    "version": 15651691,
                    "digest": "GcFc68NaJ7rghiFfDkxC7PzYzsRMUkgdBxE83uyTBcCu"
                }
            },
            "eventsDigest": "8UF45LDvvpgoD5oaBUKiYgzYHxAsFV2vsEZcWoSBhb2r",
            "dependencies": ["4ERSh51TeTSW8PCPqwKfthcJSjfhWCxbCbCHrfG9ZVLG", "58e6vN5EwfU19H3LfNYdDdPySLFTqEqeQSj9RDrkwUrg"]
        },
        "events": [{
            "id": {
                "txDigest": "2ZVDw6Qv2GT7chaBw3C43ECxEvAQBq3VJQMspJg5FMFx",
                "eventSeq": "0"
            },
            "packageId": "0xfa0e78030bd16672174c2d6cc4cd5d1d1423d03c28a74909b2a148eda8bcca16",
            "transactionModule": "clock",
            "sender": "0xa39edfb89e6a21e89570711845c6c8f412d86bb208e571faf6ea1fc6470172d7",
            "type": "0xfa0e78030bd16672174c2d6cc4cd5d1d1423d03c28a74909b2a148eda8bcca16::clock::TimeEvent",
            "parsedJson": {
                "timestamp_ms": "1699575964204"
            },
            "bcs": "8PAhUzTvoZ1"
        }],
        "results": [{}]
    },
    "id": 1
}
Response Data
  • DevInspectResults containing:
    • effects : TransactionEffects - 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 transaction commands
    • events : SuiEvent[] - Events that likely would be generated if the transaction is actually run.
    • results ?: SuiExecutionResult[] | null - Execution results (including return values) from executing the transaction commands

​
sui_dryRunTransactionBlock

Description
Test runs a transaction but does not execute it. Reports what the effects of executing the transaction would have been, including the gas cost summary. Params
  • tx_bytes : TranasactionData bytes, as Base-64 encoded string. This includes everything needed to actually run a transaction, including the sender address and a gas object. If you want to perform a test on a transaction without a gas object attached, see sui_devInspectTransactionBlock.
Example Request Template This example uses our US East - us1 region URL since it is currently the only region where we offer Testnet. To send to another region, see our our Node Service API Overview. The TypeScript example uses the Shinami Clients SDK, which you can install with:
Shell
npm install @shinami/clients
Replace all instances of{{name}} with the actual value for that name 
curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: {{nodeAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{
        "jsonrpc":"2.0",
        "method":"sui_dryRunTransactionBlock",
        "params":[
            "{{transactionDataBytes}}"
        ],
        "id":1
    }'
Example Response 
{
    "jsonrpc": "2.0",
    "result": {
        "effects": {
            "messageVersion": "v1",
            "status": {
                "status": "success"
            },
            "executedEpoch": "183",
            "gasUsed": {
                "computationCost": "1000000",
                "storageCost": "988000",
                "storageRebate": "978120",
                "nonRefundableStorageFee": "9880"
            },
            "modifiedAtVersions": [{
                "objectId": "0xb22075c570676e78a40ccf7c2e00098b56a4154f89a3cfc6b4a99afcaa340677",
                "sequenceNumber": "15450963"
            }],
            "sharedObjects": [{
                "objectId": "0x0000000000000000000000000000000000000000000000000000000000000006",
                "version": 15651033,
                "digest": "ADEFJbvcsGUQF4joyV6h24PyKLe2txsbR2n2T8za6abv"
            }],
            "transactionDigest": "CxXNehhL6xWKeCcKeWGWoTq9QmphyZEPaGjFnFkDhjYA",
            "mutated": [{
                "owner": {
                    "AddressOwner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e"
                },
                "reference": {
                    "objectId": "0xb22075c570676e78a40ccf7c2e00098b56a4154f89a3cfc6b4a99afcaa340677",
                    "version": 15651034,
                    "digest": "4MtrjpWDp48LRgsqc7np6CHAbnXStKZi9v8PLj5BqDUM"
                }
            }],
            "gasObject": {
                "owner": {
                    "AddressOwner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e"
                },
                "reference": {
                    "objectId": "0xb22075c570676e78a40ccf7c2e00098b56a4154f89a3cfc6b4a99afcaa340677",
                    "version": 15651034,
                    "digest": "4MtrjpWDp48LRgsqc7np6CHAbnXStKZi9v8PLj5BqDUM"
                }
            },
            "eventsDigest": "FJKpbGq9fn1nu3pcuap86mEQ4zY7URiffcmDbmrFccXJ",
            "dependencies": ["58e6vN5EwfU19H3LfNYdDdPySLFTqEqeQSj9RDrkwUrg", "DcivKVaUtnv8oZXx6pfevALuLWJxENmDerDPoZXY3yNf", "Ec9K2VEpQHLSXZ2AkbxsD2jigVL5Vpu13L6En72QDhu1"]
        },
        "events": [{
            "id": {
                "txDigest": "CxXNehhL6xWKeCcKeWGWoTq9QmphyZEPaGjFnFkDhjYA",
                "eventSeq": "0"
            },
            "packageId": "0xfa0e78030bd16672174c2d6cc4cd5d1d1423d03c28a74909b2a148eda8bcca16",
            "transactionModule": "clock",
            "sender": "0xa39edfb89e6a21e89570711845c6c8f412d86bb208e571faf6ea1fc6470172d7",
            "type": "0xfa0e78030bd16672174c2d6cc4cd5d1d1423d03c28a74909b2a148eda8bcca16::clock::TimeEvent",
            "parsedJson": {
                "timestamp_ms": "1699575309828"
            },
            "bcs": "hGVsMtjEBh"
        }],
        "objectChanges": [{
            "type": "mutated",
            "sender": "0xa39edfb89e6a21e89570711845c6c8f412d86bb208e571faf6ea1fc6470172d7",
            "owner": {
                "AddressOwner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e"
            },
            "objectType": "0x2::coin::Coin<0x2::sui::SUI>",
            "objectId": "0xb22075c570676e78a40ccf7c2e00098b56a4154f89a3cfc6b4a99afcaa340677",
            "version": "15651034",
            "previousVersion": "15450963",
            "digest": "4MtrjpWDp48LRgsqc7np6CHAbnXStKZi9v8PLj5BqDUM"
        }],
        "balanceChanges": [{
            "owner": {
                "AddressOwner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e"
            },
            "coinType": "0x2::sui::SUI",
            "amount": "-1009880"
        }],
        "input": {
            "messageVersion": "v1",
            "transaction": {
                "kind": "ProgrammableTransaction",
                "inputs": [{
                    "type": "object",
                    "objectType": "sharedObject",
                    "objectId": "0x0000000000000000000000000000000000000000000000000000000000000006",
                    "initialSharedVersion": "1",
                    "mutable": false
                }],
                "transactions": [{
                    "MoveCall": {
                        "package": "0xfa0e78030bd16672174c2d6cc4cd5d1d1423d03c28a74909b2a148eda8bcca16",
                        "module": "clock",
                        "function": "access",
                        "arguments": [{
                            "Input": 0
                        }]
                    }
                }]
            },
            "sender": "0xa39edfb89e6a21e89570711845c6c8f412d86bb208e571faf6ea1fc6470172d7",
            "gasData": {
                "payment": [{
                    "objectId": "0xb22075c570676e78a40ccf7c2e00098b56a4154f89a3cfc6b4a99afcaa340677",
                    "version": 15450963,
                    "digest": "7PmeCXEAwhetHHNk96gmLEMLX51adCYiomPCKe9G43Z5"
                }],
                "owner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e",
                "price": "1000",
                "budget": "5000000"
            }
        }
    },
    "id": 1
}
Response Data

​
sui_executeTransactionBlock

Description
Execute a transaction using the transaction data and signature(s).
Note that building a transaction block ahead of executing it leads to additional Node Service requests that you’ll see in your Shinami dashboard.
Params
  • tx_bytes : BCS serialized transaction data bytes without its type tag, as base-64 encoded string
  • signatures : list of signatures (flag || signature || pubkey bytes, as base-64 encoded string). Signature is committed to the intent message of the transaction data
  • options : SuiTransactionBlockResponseOptions - Optional. Sui options for specifying the transaction content to be returned. Values default to false if not provided.
  • request_type : Deprecated (see Appendix) ExecuteTransactionRequestType - Optional.
Example Request Template This example uses our US East - us1 region URL since it is currently the only region where we offer Testnet. To send to another region, see our our Node Service API Overview. The TypeScript example uses the Shinami Clients SDK, which you can install with:
Shell
npm install @shinami/clients
Replace all instances of{{name}} with the actual value for that name 
## The below has two signatures - for the sender and the sponsor -
##  as it represents a transaction sponsored with Shinami's Gas Station.
##  A non-sponsored transaction would just have the sender's signature.

curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: {{nodeAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{ "jsonrpc":"2.0",
      "method":"sui_executeTransactionBlock",
      "params":
      [
            "{{tx_bytes}}",
            ["{{senderSignature}}","{{sponsorSignature}}"],
            {
                "showInput": true,
                "showRawInput": true,
                "showEffects": true,
                "showEvents": true,
                "showObjectChanges": true,
                "showBalanceChanges": true
            },
            "{{request_type}}"
      ],
      "id":1
  }'
Example Response 
{
    "jsonrpc": "2.0",
    "result": {
        "digest": "6VX1oTmvkB9bkebDX1byYeeGaBefLyD3K6uR8hHopLq8",
        "transaction": {
            "data": {
                "messageVersion": "v1",
                "transaction": {
                    "kind": "ProgrammableTransaction",
                    "inputs": [{
                        "type": "object",
                        "objectType": "sharedObject",
                        "objectId": "0x0000000000000000000000000000000000000000000000000000000000000006",
                        "initialSharedVersion": "1",
                        "mutable": false
                    }],
                    "transactions": [{
                        "MoveCall": {
                            "package": "0xfa0e78030bd16672174c2d6cc4cd5d1d1423d03c28a74909b2a148eda8bcca16",
                            "module": "clock",
                            "function": "access",
                            "arguments": [{
                                "Input": 0
                            }]
                        }
                    }]
                },
                "sender": "0xeb583665fb5a35f488234bd8715be86bab0f8ba5311d95ee5a8f67b6088ca2b0",
                "gasData": {
                    "payment": [{
                        "objectId": "0xc2e47b0a2822c04a3ac5212e18fc3b904a22eaeeed63577151c04709d90dc5fc",
                        "version": 15450970,
                        "digest": "FMdVQsuY4YWFythBRsuQPovapJ7TpvR7j24Sz4neoeiS"
                    }],
                    "owner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e",
                    "price": "1000",
                    "budget": "5000000"
                }
            },
            "txSignatures": ["AJAGc5YF8pRcN0FpfZsaqOxJVunA9OMPCGQ6a8ue69QmD84SC0eKeukphVQ2bIyy7Mv9jwXTr8JgXzhDS9McwQh51Goyfzm4soRhJY9gDmt/wDZYCm81bkCP87eBm1T+Xw==", "AAkroyRVP1HdLsj5S0aBgZS5RwMlDGATo17reTgYxviYAP2jrjGScr3DoTZZwSCmHnrEilewuOLM+W4Y6/fSVgO5rDp1CB4nXagWW48gUU79IRg3kJf+6erjnVYdenXh+A=="]
        },
        "rawTransaction": "AQAAAAAAAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYBAAAAAAAAAAABAPoOeAML0WZyF0wtbMTNXR0UI9A8KKdJCbKhSO2ovMoWBWNsb2NrBmFjY2VzcwABAQAA61g2ZftaNfSII0vYcVvoa6sPi6UxHZXuWo9ntgiMorABwuR7CigiwEo6xSEuGPw7kEoi6u7tY1dxUcBHCdkNxfxaw+sAAAAAACDVTH4Lff2aeF5vXdXyB7y3uglt9idRAmFFgvrtzsg3dx1jLUb/cEkQM/78TmOY3OqklD3PYlErTVc3i1q3A7xe6AMAAAAAAABAS0wAAAAAAAACYQCQBnOWBfKUXDdBaX2bGqjsSVbpwPTjDwhkOmvLnuvUJg/OEgtHinrpKYVUNmyMsuzL/Y8F06/CYF84Q0vTHMEIedRqMn85uLKEYSWPYA5rf8A2WApvNW5Aj/O3gZtU/l9hAAkroyRVP1HdLsj5S0aBgZS5RwMlDGATo17reTgYxviYAP2jrjGScr3DoTZZwSCmHnrEilewuOLM+W4Y6/fSVgO5rDp1CB4nXagWW48gUU79IRg3kJf+6erjnVYdenXh+A==",
        "effects": {
            "messageVersion": "v1",
            "status": {
                "status": "success"
            },
            "executedEpoch": "187",
            "gasUsed": {
                "computationCost": "1000000",
                "storageCost": "988000",
                "storageRebate": "978120",
                "nonRefundableStorageFee": "9880"
            },
            "modifiedAtVersions": [{
                "objectId": "0xc2e47b0a2822c04a3ac5212e18fc3b904a22eaeeed63577151c04709d90dc5fc",
                "sequenceNumber": "15450970"
            }],
            "sharedObjects": [{
                "objectId": "0x0000000000000000000000000000000000000000000000000000000000000006",
                "version": 15993926,
                "digest": "HEkEnhJMPwieu5Z6kRjnWsKomaxeoYZfwcP5HwgLFKjb"
            }],
            "transactionDigest": "6VX1oTmvkB9bkebDX1byYeeGaBefLyD3K6uR8hHopLq8",
            "mutated": [{
                "owner": {
                    "AddressOwner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e"
                },
                "reference": {
                    "objectId": "0xc2e47b0a2822c04a3ac5212e18fc3b904a22eaeeed63577151c04709d90dc5fc",
                    "version": 15993927,
                    "digest": "EeZ7EZmcunjVBDc8iMdcCR5cQo7KikYB6ywvLHKKbdSW"
                }
            }],
            "gasObject": {
                "owner": {
                    "AddressOwner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e"
                },
                "reference": {
                    "objectId": "0xc2e47b0a2822c04a3ac5212e18fc3b904a22eaeeed63577151c04709d90dc5fc",
                    "version": 15993927,
                    "digest": "EeZ7EZmcunjVBDc8iMdcCR5cQo7KikYB6ywvLHKKbdSW"
                }
            },
            "eventsDigest": "HwAfMjJypQoC1dpzThWXEKHUy6Vq3CqF9jZDMT4azuhf",
            "dependencies": ["58e6vN5EwfU19H3LfNYdDdPySLFTqEqeQSj9RDrkwUrg", "DdoUFyuV3NyJ6WrngEMsqPywax14tizehvrz6SBkyPSw", "Fdhmr6PeHSeWP4YuSHNrgBSKQTk6aT3bz35fQJrKtfdu"]
        },
        "events": [{
            "id": {
                "txDigest": "6VX1oTmvkB9bkebDX1byYeeGaBefLyD3K6uR8hHopLq8",
                "eventSeq": "0"
            },
            "packageId": "0xfa0e78030bd16672174c2d6cc4cd5d1d1423d03c28a74909b2a148eda8bcca16",
            "transactionModule": "clock",
            "sender": "0xeb583665fb5a35f488234bd8715be86bab0f8ba5311d95ee5a8f67b6088ca2b0",
            "type": "0xfa0e78030bd16672174c2d6cc4cd5d1d1423d03c28a74909b2a148eda8bcca16::clock::TimeEvent",
            "parsedJson": {
                "timestamp_ms": "1699916824477"
            },
            "bcs": "TJX9NArXXrF"
        }],
        "objectChanges": [{
            "type": "mutated",
            "sender": "0xeb583665fb5a35f488234bd8715be86bab0f8ba5311d95ee5a8f67b6088ca2b0",
            "owner": {
                "AddressOwner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e"
            },
            "objectType": "0x2::coin::Coin<0x2::sui::SUI>",
            "objectId": "0xc2e47b0a2822c04a3ac5212e18fc3b904a22eaeeed63577151c04709d90dc5fc",
            "version": "15993927",
            "previousVersion": "15450970",
            "digest": "EeZ7EZmcunjVBDc8iMdcCR5cQo7KikYB6ywvLHKKbdSW"
        }],
        "balanceChanges": [{
            "owner": {
                "AddressOwner": "0x1d632d46ff70491033fefc4e6398dceaa4943dcf62512b4d57378b5ab703bc5e"
            },
            "coinType": "0x2::sui::SUI",
            "amount": "-1009880"
        }],
        "confirmedLocalExecution": true
    },
    "id": 1
}
Response Data SuiTransactionBlockResponse : SuiTransactionBlockResponse

​
Appendix

​
sui_executeTransactionBlock request_type deprecation

From Mysten: “In [Sui] version 1.33 (scheduled to be released on September 18th, 2024), JSON RPC will ignore the requestType: ‘WaitForLocalExecution’ option, and the JSON RPC API has been updated to support returning object and balance changes without the need for local execution. Many dapps have also used WaitForLocalExecution to ensure read-after-write consistency, which will no longer be possible through JSON RPC. To make this migration as painless as possible, we have updated the Typescript SDK to detect the requestType: ‘WaitForLocalExecution’ option, and automatically use client.waitForTransaction to ensure that the transaction has been indexed after execution. This means that ensuring read-after-write consistency with the TypeScript SDK is as simple as updating the SDK to version @mysten/sui@1.6.0 or later, and setting requestType to WaitForLocalExecution. This option is marked as deprecated, and will be removed in the next major release, but we don’t anticipate a major release of the typescript SDK any time soon. Going forward, dapps should use client.waitForTransaction({ digest }) to ensure a transaction has been indexed when they need read-after-write consistency. This will allow dapps to opt in to the latency costs associated with this, while allowing more efficient execution for dapps and wallets that do not have those constraints.” Request types (pre-behavior change): 1. 'WaitForEffectsCert': waits for TransactionEffectsCert and then return to client. This mode is a proxy for transaction finality. 2. 'WaitForLocalExecution': waits for TransactionEffectsCert and also makes 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 (for read-after-write consistency). 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 indicate the case. request_type defaults to 'WaitForEffectsCert' unless options.show_events or options.show_effects is true.