Sui JSON-RPC (V 0.6.1)

Sui JSON-RPC API for interaction with the Sui network gateway.

sui_batchTransaction#

Transaction Builder API

Create an unsigned batched transaction.

Params
  • signer : <SuiAddress> - the transaction signer's Sui address
  • single_transaction_params : <[RPCTransactionRequestParams]> - list of transaction request parameters
  • gas : <ObjectID> - gas object to be used in this transaction, the gateway will pick one from the signer's possession if not provided
  • gas_budget : <uint64> - the gas budget, the transaction will fail if the gas cost exceed the budget
Result
  • TransactionBytes : <TransactionBytes>

Example
Create unsigned batch transaction data.

Request
[
  {
    "name": "signer",
    "value": "0x76a04053bda0a88bda5177b86a15c3b29f559873"
  },
  {
    "name": "single_transaction_params",
    "value": [
      {
        "moveCallRequestParams": {
          "arguments": [
            "Example NFT",
            "An NFT created by the Sui Command Line Tool",
            "ipfs://bafkreibngqhl3gaa7daob4i2vccziay2jjlp435cf66vhono7nrvww53ty"
          ],
          "function": "mint",
          "module": "devnet_nft",
          "packageObjectId": "0x0000000000000000000000000000000000000002",
          "typeArguments": []
        }
      },
      {
        "transferObjectRequestParams": {
          "objectId": "0x1f6de831e52bfb76e51cca8b4e9016838657edfa",
          "recipient": "0xcb481232299cd5743151ac4b2d63ae198e7bb0a9"
        }
      }
    ]
  },
  {
    "name": "gas",
    "value": "0x011f28e473c95f4013d7d53ec5fbc3b42df8ed10"
  },
  {
    "name": "gas_budget",
    "value": 1000
  }
]
Response
{
  "name": "Result",
  "value": {
    "gas": {
      "digest": "Ge17DLulcl4D5fC34w2za234KsFR9mj1+ApeKpysfGQ=",
      "objectId": "0x011f28e473c95f4013d7d53ec5fbc3b42df8ed10",
      "version": 1
    },
    "inputObjects": [
      {
        "MovePackage": "0x0000000000000000000000000000000000000002"
      },
      {
        "ImmOrOwnedMoveObject": {
          "digest": "7aFVmctds9uHC+pa7PNTFhw8tSiwxdmAUMRXC/yULYs=",
          "objectId": "0x1f6de831e52bfb76e51cca8b4e9016838657edfa",
          "version": 1
        }
      },
      {
        "ImmOrOwnedMoveObject": {
          "digest": "Ge17DLulcl4D5fC34w2za234KsFR9mj1+ApeKpysfGQ=",
          "objectId": "0x011f28e473c95f4013d7d53ec5fbc3b42df8ed10",
          "version": 1
        }
      }
    ],
    "txBytes": "VHJhbnNhY3Rpb25EYXRhOjoBAgIAAAAAAAAAAAAAAAAAAAAAAAAAAgEAAAAAAAAAIOCcuaceshkCXEyHpnxKqobyCsCqeSvBIe5C4sMmEnBhCmRldm5ldF9uZnQEbWludAADAAtFeGFtcGxlIE5GVAArQW4gTkZUIGNyZWF0ZWQgYnkgdGhlIFN1aSBDb21tYW5kIExpbmUgVG9vbABCaXBmczovL2JhZmtyZWlibmdxaGwzZ2FhN2Rhb2I0aTJ2Y2N6aWF5MmpqbHA0MzVjZjY2dmhvbm83bnJ2d3c1M3R5AMtIEjIpnNV0MVGsSy1jrhmOe7CpH23oMeUr+3blHMqLTpAWg4ZX7foBAAAAAAAAACDtoVWZy12z24cL6lrs81MWHDy1KLDF2YBQxFcL/JQti3agQFO9oKiL2lF3uGoVw7KfVZhzAR8o5HPJX0AT19U+xfvDtC347RABAAAAAAAAACAZ7XsMu6VyXgPl8LfjDbNrbfgqwVH2aPX4Cl4qnKx8ZAEAAAAAAAAA6AMAAAAAAAA="
  }
}

sui_executeTransaction#

Gateway Transaction Execution API

Execute the transaction using the transaction data, signature and public key.

Params
  • tx_bytes : <Base64> - transaction data bytes, as base-64 encoded string
  • sig_scheme : <SignatureScheme> - Flag of the signature scheme that is used.
  • signature : <Base64> - transaction signature, as base-64 encoded string
  • pub_key : <Base64> - signer's public key, as base-64 encoded string
Result
  • TransactionResponse : <TransactionResponse>

Example
Execute an object transfer transaction

Request
[
  {
    "name": "tx_bytes",
    "value": "VHJhbnNhY3Rpb25EYXRhOjoAABdY7bkmDSqGyDbvwF8X5cWVJeQExGwtZKelsdk7LYZGgF2NKhIvzNsCAAAAAAAAACA7x9yXWrdfyGV5NTb2bmQYkFA2D2I9yIq7gwAYDN0Kj9BnwzQmQaTOqrLB29rQESsuPkj4xqk9BRZR/i5O764oE0klaDiQqUICAAAAAAAAACD2POST9RLwss+3xCoHzpEwy20FmjiNiGFTbLnFuBqajQEAAAAAAAAA6AMAAAAAAAA="
  },
  {
    "name": "sig_scheme",
    "value": "ED25519"
  },
  {
    "name": "signature",
    "value": "ToDZxUmWfPg6oBlS+ZwhYfOlWzwYkymaQ15TANLjNmkWViWdxJF9lAsj7LflLslRYGN4mNCU4o/tUowJy7b+Aw=="
  },
  {
    "name": "pub_key",
    "value": "qmWfSqQCF9fGPsDsTjVFDrwGYEcuh21OWNSzokiS75E="
  }
]
Response
{
  "name": "Result",
  "value": {
    "EffectResponse": {
      "certificate": {
        "authSignInfo": {
          "epoch": 0,
          "signature": [],
          "signers_map": [
            58,
            48,
            0,
            0,
            0,
            0,
            0,
            0
          ]
        },
        "data": {
          "gasBudget": 1000,
          "gasPayment": {
            "digest": "9jzkk/US8LLPt8QqB86RMMttBZo4jYhhU2y5xbgamo0=",
            "objectId": "0xc6a93d051651fe2e4eefae28134925683890a942",
            "version": 2
          },
          "sender": "0xd067c3342641a4ceaab2c1dbdad0112b2e3e48f8",
          "transactions": [
            {
              "TransferObject": {
                "objectRef": {
                  "digest": "O8fcl1q3X8hleTU29m5kGJBQNg9iPciKu4MAGAzdCo8=",
                  "objectId": "0xc46c2d64a7a5b1d93b2d8646805d8d2a122fccdb",
                  "version": 2
                },
                "recipient": "0x1758edb9260d2a86c836efc05f17e5c59525e404"
              }
            }
          ]
        },
        "transactionDigest": "M9fSFZs98pa0bdZL7Fdgmj8vtK2LRuL9TJ8l1EMo3VA=",
        "txSignature": "AE6A2cVJlnz4OqAZUvmcIWHzpVs8GJMpmkNeUwDS4zZpFlYlncSRfZQLI+y35S7JUWBjeJjQlOKP7VKMCcu2/gOqZZ9KpAIX18Y+wOxONUUOvAZgRy6HbU5Y1LOiSJLvkQ=="
      },
      "effects": {
        "gasObject": {
          "owner": {
            "ObjectOwner": "0xd067c3342641a4ceaab2c1dbdad0112b2e3e48f8"
          },
          "reference": {
            "digest": "9jzkk/US8LLPt8QqB86RMMttBZo4jYhhU2y5xbgamo0=",
            "objectId": "0xc6a93d051651fe2e4eefae28134925683890a942",
            "version": 2
          }
        },
        "gasUsed": {
          "computationCost": 100,
          "storageCost": 100,
          "storageRebate": 10
        },
        "mutated": [
          {
            "owner": {
              "AddressOwner": "0xd067c3342641a4ceaab2c1dbdad0112b2e3e48f8"
            },
            "reference": {
              "digest": "9jzkk/US8LLPt8QqB86RMMttBZo4jYhhU2y5xbgamo0=",
              "objectId": "0xc6a93d051651fe2e4eefae28134925683890a942",
              "version": 2
            }
          },
          {
            "owner": {
              "AddressOwner": "0x1758edb9260d2a86c836efc05f17e5c59525e404"
            },
            "reference": {
              "digest": "O8fcl1q3X8hleTU29m5kGJBQNg9iPciKu4MAGAzdCo8=",
              "objectId": "0xc46c2d64a7a5b1d93b2d8646805d8d2a122fccdb",
              "version": 2
            }
          }
        ],
        "status": {
          "status": "success"
        },
        "transactionDigest": "zlFNt7v1DvUYwZWnBTdj0Kjf2ra5Ru6fOVRUkxmsfcY="
      },
      "timestamp_ms": null
    }
  }
}

sui_getMoveFunctionArgTypes#

Full Node API

Return the argument types of a Move function, based on normalized Type.

Params
  • object_id : <ObjectID> -
  • module : <string> -
  • function : <string> -
Result
  • Vec<MoveFunctionArgType> : <[MoveFunctionArgType]>

sui_getObject#

Read API

Return the object information for a specified object

Params
  • object_id : <ObjectID> - the ID of the queried object
Result
  • GetObjectDataResponse : <ObjectRead>

Example
Get Object data

Request
[
  {
    "name": "object_id",
    "value": "0xbac203232876b27b541433fb2f1438289799049b"
  }
]
Response
{
  "name": "Result",
  "value": {
    "details": {
      "data": {
        "dataType": "moveObject",
        "fields": {
          "balance": 10000,
          "id": {
            "id": "0xbac203232876b27b541433fb2f1438289799049b"
          }
        },
        "has_public_transfer": true,
        "type": "0x2::coin::Coin<0x2::coin::Coin<0x2::sui::SUI>>"
      },
      "owner": {
        "AddressOwner": "0x349f7a2c205d3a97f66ef42800baa3cb78fb3313"
      },
      "previousTransaction": "AYF3X7JqYmMCNr2LxkSjZWSJ0TW6GLEYRgKakYPUNFk=",
      "reference": {
        "digest": "PLvB4DpPjbpAz2z6B7oEPIP2pIiHNkwjMZGkuZr/Hps=",
        "objectId": "0xbac203232876b27b541433fb2f1438289799049b",
        "version": 1
      },
      "storageRebate": 100
    },
    "status": "Exists"
  }
}

sui_getObjectsOwnedByAddress#

Read API

Return the list of objects owned by an address.

Params
  • address : <SuiAddress> - the owner's Sui address
Result
  • Vec<SuiObjectInfo> : <[ObjectInfo]>

Example
Get objects owned by an address

Request
[
  {
    "name": "address",
    "value": "0x8ab2aba54ecc61a6a8d2a50043e8948be1e76a43"
  }
]
Response
{
  "name": "Result",
  "value": [
    {
      "digest": "hAUX3IoL5ldXEQRx3y4Mg2RATmMPGKaIKWdw1ullPXA=",
      "object_id": "0x7d348990b99e55fee2a4bc79b29b27f2f9720e96",
      "owner": {
        "AddressOwner": "0x8ab2aba54ecc61a6a8d2a50043e8948be1e76a43"
      },
      "previous_transaction": "k3TpQ4yaBB9zYnjbZVnLfx3gQ4HYIljcgPqeEo2eRLw=",
      "type_": "0x2::coin::Coin<0x2::sui::SUI>",
      "version": 0
    },
    {
      "digest": "f4n4BIxgceZGB5K5L/4HgkenfnOrxSl8Q25nFk7I6gM=",
      "object_id": "0x4748768277b694cee503ea339ebb53fc221a6fc0",
      "owner": {
        "AddressOwner": "0x8ab2aba54ecc61a6a8d2a50043e8948be1e76a43"
      },
      "previous_transaction": "Pdy2w4InAYTLHA5wRLJyugsjgtIbBpZt1f8A9fo22+8=",
      "type_": "0x2::coin::Coin<0x2::sui::SUI>",
      "version": 0
    },
    {
      "digest": "RlRT5wnT1G2KroN2EHgVFK4bDuZ321+lAV1pYdLQAQc=",
      "object_id": "0x1abe62cb97d5716d5d05da6e72c49bf2791775d0",
      "owner": {
        "AddressOwner": "0x8ab2aba54ecc61a6a8d2a50043e8948be1e76a43"
      },
      "previous_transaction": "0vCxMjueJyE/iwA/eKXN0IEAe9EfCbfm+iMrCj3Od0c=",
      "type_": "0x2::coin::Coin<0x2::sui::SUI>",
      "version": 0
    },
    {
      "digest": "3ITAbnlT5fHHae+Kk9y+s5BG0FWAgrZ/FCwx4Iv8pSU=",
      "object_id": "0xa12ad1e8a8d6521a26daafda96dacf7f582cb1db",
      "owner": {
        "AddressOwner": "0x8ab2aba54ecc61a6a8d2a50043e8948be1e76a43"
      },
      "previous_transaction": "w0+opZ68swDnJYYiXWE+sK8yzoCw6VKfxKyiroCjk1A=",
      "type_": "0x2::coin::Coin<0x2::sui::SUI>",
      "version": 0
    }
  ]
}

sui_getObjectsOwnedByObject#

Read API

Return the list of objects owned by an object.

Params
  • object_id : <ObjectID> - the ID of the owner object
Result
  • Vec<SuiObjectInfo> : <[ObjectInfo]>

Example
Get objects owned by an object

Request
[
  {
    "name": "object_id",
    "value": "0xf6ce4988f3b078f37f863539358646c46f14aa24"
  }
]
Response
{
  "name": "Result",
  "value": [
    {
      "digest": "tjCDXhEw83BsmaFbfslselUwTP3qUzI/5dWw6WKxjNg=",
      "object_id": "0xcaa8745bf26f63f76d85fdbda2f013ef4f4b3f87",
      "owner": {
        "ObjectOwner": "0xf6ce4988f3b078f37f863539358646c46f14aa24"
      },
      "previous_transaction": "Omcr9khIrYBZLNP37nITnzE5gaKzYx7SoUI0SK+U+5o=",
      "type_": "0x2::coin::Coin<0x2::sui::SUI>",
      "version": 0
    },
    {
      "digest": "trAgCjBvWEynl0tq1RjvAGd0QyLLmaRUU0pDPVwVaQo=",
      "object_id": "0x6f946b81f4f20727c6aee702e34fc518e58163d5",
      "owner": {
        "ObjectOwner": "0xf6ce4988f3b078f37f863539358646c46f14aa24"
      },
      "previous_transaction": "YftWgAsyn3nIUfh8DaHt1urQRJj7t2cpB6qiye4le30=",
      "type_": "0x2::coin::Coin<0x2::sui::SUI>",
      "version": 0
    },
    {
      "digest": "/FEPllo2tcrafzR6KqDBTk0vaw4oG3vS3B6IzjkcPXk=",
      "object_id": "0x568f49d11ca3392df7c1295dfa8b9524f161e029",
      "owner": {
        "ObjectOwner": "0xf6ce4988f3b078f37f863539358646c46f14aa24"
      },
      "previous_transaction": "QNs5Mg+u5GuSM0M4FHEQ4I/2eporEIgo1T8B0nV0aLY=",
      "type_": "0x2::coin::Coin<0x2::sui::SUI>",
      "version": 0
    },
    {
      "digest": "bWjEqSGAqDqp8hsYOFijZX0PaL9zM0XS7p++X0L9w3c=",
      "object_id": "0xcf766399c27532f0bec382d9ce78e399307fef50",
      "owner": {
        "ObjectOwner": "0xf6ce4988f3b078f37f863539358646c46f14aa24"
      },
      "previous_transaction": "zTfS+es09CXcFhSRhS8zFa1n53hWybFt1Qviz37dex4=",
      "type_": "0x2::coin::Coin<0x2::sui::SUI>",
      "version": 0
    }
  ]
}

sui_getRawObject#

BCS API

Return the raw BCS serialized move object bytes for a specified object.

Params
  • object_id : <ObjectID> - the id of the object
Result
  • GetRawObjectDataResponse : <ObjectRead>

Example
Get Raw Object data

Request
[
  {
    "name": "object_id",
    "value": "0xcbabe979c8e2e7f25b1e7d1ac222203afdafb9b4"
  }
]
Response
{
  "name": "Result",
  "value": {
    "details": {
      "data": {
        "bcs_bytes": "y6vpecji5/JbHn0awiIgOv2vubQQJwAAAAAAAA==",
        "dataType": "moveObject",
        "has_public_transfer": true,
        "type": "0x2::coin::Coin<0x2::sui::SUI>"
      },
      "owner": {
        "AddressOwner": "0x4db1ad9cd2e822480f3008903f1bd4ba2f27a12a"
      },
      "previousTransaction": "i3DGJIxgANNos2vY78x8/y+ExKZMjes7AZ3EAkPovBk=",
      "reference": {
        "digest": "q/ujAPWMzM2f+TP+CFMAs4YToKwdXl9husJSY66idWo=",
        "objectId": "0xcbabe979c8e2e7f25b1e7d1ac222203afdafb9b4",
        "version": 1
      },
      "storageRebate": 100
    },
    "status": "Exists"
  }
}

sui_getRecentTransactions#

Read API

Return list of recent transaction digest.

Params
  • count : <uint64> - maximum size of the result
Result
  • Vec<(GatewayTxSeqNumber,TransactionDigest)> : <[TransactionDigest]>

Example
Get recent transactions

Request
[
  {
    "name": "count",
    "value": 5
  }
]
Response
{
  "name": "Result",
  "value": [
    [
      5,
      "ml8yQ95VLSjKu+j4LWY0p9W0SZrWL2dP+m5PKMVvf0Q="
    ],
    [
      6,
      "JoJ34ak/I2H3IRf20UHi+4T1GCbiW6TadV2GNV2mCW0="
    ],
    [
      7,
      "gBI0+nhg3mjKlh8Hm7Q2enGbWc+gHpEwF/kLaLyrj2o="
    ],
    [
      8,
      "1GWc2fNBxA0beKMBs5QQee3ylVIb+O7PT9JK0t6itFM="
    ],
    [
      9,
      "vBCK0fCf63aJE5r2gZDoRQauXbwGHRIeTSYB84M/hao="
    ]
  ]
}

sui_getTotalTransactionNumber#

Read API

Return the total number of transactions known to the server.

Params
    Result
    • u64 : <uint64>

    Example
    Get total number of transactions

    Request
    []
    Response
    {
      "name": "Result",
      "value": 100
    }

    sui_getTransaction#

    Read API

    Return the transaction response object.

    Params
    • digest : <TransactionDigest> - the digest of the queried transaction
    Result
    • TransactionEffectsResponse : <TransactionEffectsResponse>

    Example
    Return the transaction response object for specified transaction digest

    Request
    [
      {
        "name": "digest",
        "value": "C5nUvmgabpdPdv22Zpl9VO1Pp30d73kv9PpXyNJeO/M="
      }
    ]
    Response
    {
      "name": "Result",
      "value": {
        "certificate": {
          "authSignInfo": {
            "epoch": 0,
            "signature": [],
            "signers_map": [
              58,
              48,
              0,
              0,
              0,
              0,
              0,
              0
            ]
          },
          "data": {
            "gasBudget": 1000,
            "gasPayment": {
              "digest": "W3cZCN9mn/bQDjJxoDrteleSSrfrZu1eJFcI+lFwEsk=",
              "objectId": "0xdfd332b8c6bbb96dcc32fa41910261a36e879305",
              "version": 2
            },
            "sender": "0xdd8a214f9b707fc2a7f4aaa87f78422177ce96f7",
            "transactions": [
              {
                "TransferObject": {
                  "objectRef": {
                    "digest": "r1WERqvHOe8ncW+9p5Z4R21pK/ViMk/OsaZItir+Xgg=",
                    "objectId": "0xca1285f78f31e031b0eb8e7b3c7b7c7c14d79cbf",
                    "version": 2
                  },
                  "recipient": "0x6bc520f045fffaeb71cdbabf9c5a259793a28a38"
                }
              }
            ]
          },
          "transactionDigest": "C5nUvmgabpdPdv22Zpl9VO1Pp30d73kv9PpXyNJeO/M=",
          "txSignature": "AH++/2C3nybBNiQOwHipCbrnKpwXF/wAl5REok6aXkZCuJSY6psJP10mTw+RfnmxVipBoe21Fc2b/AHOsRAL1w2fn92fPKLsKErr4E7Bl70ydFbV87ZjPT2D/HGLI9ACkA=="
        },
        "effects": {
          "gasObject": {
            "owner": {
              "ObjectOwner": "0xdd8a214f9b707fc2a7f4aaa87f78422177ce96f7"
            },
            "reference": {
              "digest": "W3cZCN9mn/bQDjJxoDrteleSSrfrZu1eJFcI+lFwEsk=",
              "objectId": "0xdfd332b8c6bbb96dcc32fa41910261a36e879305",
              "version": 2
            }
          },
          "gasUsed": {
            "computationCost": 100,
            "storageCost": 100,
            "storageRebate": 10
          },
          "mutated": [
            {
              "owner": {
                "AddressOwner": "0xdd8a214f9b707fc2a7f4aaa87f78422177ce96f7"
              },
              "reference": {
                "digest": "W3cZCN9mn/bQDjJxoDrteleSSrfrZu1eJFcI+lFwEsk=",
                "objectId": "0xdfd332b8c6bbb96dcc32fa41910261a36e879305",
                "version": 2
              }
            },
            {
              "owner": {
                "AddressOwner": "0x6bc520f045fffaeb71cdbabf9c5a259793a28a38"
              },
              "reference": {
                "digest": "r1WERqvHOe8ncW+9p5Z4R21pK/ViMk/OsaZItir+Xgg=",
                "objectId": "0xca1285f78f31e031b0eb8e7b3c7b7c7c14d79cbf",
                "version": 2
              }
            }
          ],
          "status": {
            "status": "success"
          },
          "transactionDigest": "4hHt3vKRUjeo3H2ov5NMtbVfKgDly95kSmeJK2Do/3s="
        },
        "timestamp_ms": null
      }
    }

    sui_getTransactionsByInputObject#

    Full Node API

    Return list of transactions for a specified input object.

    Params
    • object : <ObjectID> - the ID of the input object
    Result
    • Vec<(GatewayTxSeqNumber,TransactionDigest)> : <[TransactionDigest]>

    Example
    Return the transaction digest for specified input object

    Request
    [
      {
        "name": "object",
        "value": "0x450f652899990773759ec45baa3729cdd47730ad"
      }
    ]
    Response
    {
      "name": "Result",
      "value": [
        [
          5,
          "yr/KXW8phvecGJfoUjpUahrq5QnXF2RDzTmizNBl6xo="
        ],
        [
          6,
          "QoVeKuyESxvrFHHr8kGw3NZUsXjLOq/G1BcI9P+UOHk="
        ],
        [
          7,
          "rIzmlgDYTDWxkqyU3snU/YODzGBxnC6k/2sbU2ptIu0="
        ]
      ]
    }

    sui_getTransactionsByMoveFunction#

    Full Node API

    Return list of transactions for a specified move function.

    Params
    • package : <ObjectID> - the Move package ID, e.g. `0x2`
    • module : <string> - the Move module name, e.g. `devnet_nft`
    • function : <string> - the move function name, e.g. `mint`
    Result
    • Vec<(GatewayTxSeqNumber,TransactionDigest)> : <[TransactionDigest]>

    Example
    Return the transaction digest for specified input object

    Request
    [
      {
        "name": "package",
        "value": "0x0000000000000000000000000000000000000002"
      },
      {
        "name": "module",
        "value": "devnet_nft"
      },
      {
        "name": "function",
        "value": "function"
      }
    ]
    Response
    {
      "name": "Result",
      "value": [
        [
          6,
          "vzwCe3Ng5vK1AxiauB+hzdy7vGZQ9lS6HfhGIh8I+QY="
        ],
        [
          7,
          "yYiavuOEAnhSUJIaJWNzr9zTK876pP7/RVmhV5j2lT8="
        ],
        [
          8,
          "ZegpGJUsJCW4x1euQkP71ZI3uPSg15NWW2HyVto0bxA="
        ],
        [
          9,
          "+o/Aob2fEhFX2932xlctKFX58kWVAZ1Xoul91ZPHuYA="
        ]
      ]
    }

    sui_getTransactionsByMutatedObject#

    Full Node API

    Return list of transactions for a specified mutated object.

    Params
    • object : <ObjectID> - the ID of the mutated object
    Result
    • Vec<(GatewayTxSeqNumber,TransactionDigest)> : <[TransactionDigest]>

    Example
    Return the transaction digest for specified mutated object

    Request
    [
      {
        "name": "object",
        "value": "0x49d8f2762542fab41158926da3b7cbf11974f30c"
      }
    ]
    Response
    {
      "name": "Result",
      "value": [
        [
          5,
          "dxdb87ebwYUMZl0r7SUVc4o9CqLe6rAbtp6+W4n11pw="
        ],
        [
          6,
          "zx9TOoePZ2S3EV1tWSahov2Qr+e5aZ/ofpGuiqom6Hk="
        ],
        [
          7,
          "iQyicexKa2Wcq/QGyuLPyXVXzc2dPgyt7MsclALAlEo="
        ]
      ]
    }

    sui_getTransactionsFromAddress#

    Full Node API

    Return list of transactions for a specified sender's Sui address.

    Params
    • addr : <SuiAddress> - the sender's Sui address
    Result
    • Vec<(GatewayTxSeqNumber,TransactionDigest)> : <[TransactionDigest]>

    Example
    Return the transaction digest for specified sender address

    Request
    [
      {
        "name": "addr",
        "value": "0x587155a9dfbfe953b016c2e66289794f740e883a"
      }
    ]
    Response
    {
      "name": "Result",
      "value": [
        [
          5,
          "chpRGYTr8vxSM/SnAyiv1Z+4GqwOvmRUuUv0WYM73G8="
        ],
        [
          6,
          "MY4OD/wPf31k/TkJajQyIG5e69pIfzkjOa+IgRgXOlk="
        ],
        [
          7,
          "q2wlUM9kqI3wyTvsbbmNN2JWna3zAqQPqd9/SVdR8ro="
        ]
      ]
    }

    sui_getTransactionsInRange#

    Read API

    Return list of transaction digests within the queried range.

    Params
    • start : <uint64> - the matching transactions' sequence number will be greater than or equals to the starting sequence number
    • end : <uint64> - the matching transactions' sequence number will be less than the ending sequence number
    Result
    • Vec<(GatewayTxSeqNumber,TransactionDigest)> : <[TransactionDigest]>

    Example
    Return the transaction digest in range

    Request
    [
      {
        "name": "start",
        "value": 5
      },
      {
        "name": "end",
        "value": 8
      }
    ]
    Response
    {
      "name": "Result",
      "value": [
        [
          5,
          "aTy0Q8qkCtxR2anCArDt4y6uOoUOO8ci8NxzjuObgs0="
        ],
        [
          6,
          "gPM3yFEt+j2Vg0MrI4ctGDOaN6IZRc4nR63VWl5mFhQ="
        ],
        [
          7,
          "ArGLnggSaOc8jINVazJaN722be8YEi3IY26DbmurAyM="
        ]
      ]
    }

    sui_getTransactionsToAddress#

    Full Node API

    Return list of transactions for a specified recipient's Sui address.

    Params
    • addr : <SuiAddress> - the recipient's Sui address
    Result
    • Vec<(GatewayTxSeqNumber,TransactionDigest)> : <[TransactionDigest]>

    Example
    Return the transaction digest for specified recipient address

    Request
    [
      {
        "name": "addr",
        "value": "0xd6bfc32867b626b79fe7d827f950170c7c85df10"
      }
    ]
    Response
    {
      "name": "Result",
      "value": [
        [
          5,
          "y11DOFlxQCeK9TfNOBdqzBYbBrgdgkr/1nqAVwXvT+s="
        ],
        [
          6,
          "894Kw8XhVejdW/9QZZPGrYqqtrs7KTISk9klCmnzf5w="
        ],
        [
          7,
          "3r7weq5ciJUCmapKSwMkC7UeH538m6sOExZNtVHhNtQ="
        ]
      ]
    }

    sui_mergeCoins#

    Transaction Builder API

    Create an unsigned transaction to merge multiple coins into one coin.

    Params
    • signer : <SuiAddress> - the transaction signer's Sui address
    • primary_coin : <ObjectID> - the coin object to merge into, this coin will remain after the transaction
    • coin_to_merge : <ObjectID> - the coin object to be merged, this coin will be destroyed, the balance will be added to `primary_coin`
    • gas : <ObjectID> - gas object to be used in this transaction, the gateway will pick one from the signer's possession if not provided
    • gas_budget : <uint64> - the gas budget, the transaction will fail if the gas cost exceed the budget
    Result
    • TransactionBytes : <TransactionBytes>

    sui_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 address
    • package_object_id : <ObjectID> - the Move package ID, e.g. `0x2`
    • module : <string> - the Move module name, e.g. `devnet_nft`
    • function : <string> - the move function name, e.g. `mint`
    • type_arguments : <[TypeTag]> - the type arguments of the Move function
    • arguments : <[SuiJsonValue]> - the arguments to be passed into the Move function, in SuiJson format
    • gas : <ObjectID> - gas object to be used in this transaction, the gateway will pick one from the signer's possession if not provided
    • gas_budget : <uint64> - the gas budget, the transaction will fail if the gas cost exceed the budget
    Result
    • TransactionBytes : <TransactionBytes>

    sui_publish#

    Transaction Builder API

    Create an unsigned transaction to publish Move module.

    Params
    • sender : <SuiAddress> - the transaction signer's Sui address
    • compiled_modules : <[Base64]> - the compiled bytes of a move module, the
    • gas : <ObjectID> - gas object to be used in this transaction, the gateway will pick one from the signer's possession if not provided
    • gas_budget : <uint64> - the gas budget, the transaction will fail if the gas cost exceed the budget
    Result
    • TransactionBytes : <TransactionBytes>

    sui_splitCoin#

    Transaction Builder API

    Create an unsigned transaction to split a coin object into multiple coins.

    Params
    • signer : <SuiAddress> - the transaction signer's Sui address
    • coin_object_id : <ObjectID> - the coin object to be spilt
    • split_amounts : <[]> - the amounts to split out from the coin
    • gas : <ObjectID> - gas object to be used in this transaction, the gateway will pick one from the signer's possession if not provided
    • gas_budget : <uint64> - the gas budget, the transaction will fail if the gas cost exceed the budget
    Result
    • TransactionBytes : <TransactionBytes>

    sui_subscribeEvent#

    Event Subscription, 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
    • SuiEventEnvelope : <EventEnvelope>

    sui_syncAccountState#

    Wallet Sync API

    Synchronize client state with validators.

    Params
    • address : <SuiAddress> - the Sui address to be synchronized
    Result
    • () : <null>

    sui_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 address
    • object_id : <ObjectID> - the ID of the object to be transferred
    • gas : <ObjectID> - gas object to be used in this transaction, the gateway will pick one from the signer's possession if not provided
    • gas_budget : <uint64> - the gas budget, the transaction will fail if the gas cost exceed the budget
    • recipient : <SuiAddress> - the recipient's Sui address
    Result
    • TransactionBytes : <TransactionBytes>

    sui_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 address
    • sui_object_id : <ObjectID> - the Sui coin object to be used in this transaction
    • gas_budget : <uint64> - the gas budget, the transaction will fail if the gas cost exceed the budget
    • recipient : <SuiAddress> - the recipient's Sui address
    • amount : <uint64> - the amount to be split out and transferred
    Result
    • TransactionBytes : <TransactionBytes>