{ "openapi": "3.0.3", "info": { "title": "Sui JSON-RPC API", "description": "Sui JSON-RPC API 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.", "contact": { "name": "Mysten Labs", "url": "https://mystenlabs.com", "email": "build@mystenlabs.com" }, "license": { "name": "Apache-2.0", "url": "https://raw.githubusercontent.com/MystenLabs/sui/main/LICENSE" }, "version": "1.74.0" }, "servers": [ { "url": "https://fullnode.mainnet.sui.io:443", "description": "Sui Mainnet" }, { "url": "https://fullnode.testnet.sui.io:443", "description": "Sui Testnet" }, { "url": "https://fullnode.devnet.sui.io:443", "description": "Sui Devnet" }, { "url": "http://localhost:9000", "description": "Local node (default port)" } ], "paths": { "/#sui_devInspectTransactionBlock": { "post": { "operationId": "sui_devInspectTransactionBlock", "summary": "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.", "tags": [ "Write API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_devInspectTransactionBlock" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_devInspectTransactionBlock", "params": [ "0xd70420418b84502e506794227f897237764dde8d79a01ab2104bf742a277a2ab", "AAACACBnxtMcbJcOVn8D72fYEaT4Q2ZbjePygvpIs+AQO6m77QEAagYVO5/EhuEB8OnicDrIZm0GrsxN3355JqNhlwxlpbECAAAAAAAAACDoQ3EipycU+/EOvBcDPFtMkZiSbdzWAw3CwdmQCAtBWAEBAQEBAAEAAC9cVD1xauQ9RT3rOxmbva8bxwMMdoL4dwPc5DEkj+3gASxDgF0Nb1QCp60Npb3sVJx83qBrxKHTOaIlIe6pM7iJAgAAAAAAAAAgnvsgc1pPauyCE27/c+aBnHN3fSsxRAWdEJYzYFOryNAvXFQ9cWrkPUU96zsZm72vG8cDDHaC+HcD3OQxJI/t4AoAAAAAAAAAoIYBAAAAAAAA", 1000, 8888, null ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/DevInspectResults" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_dryRunTransactionBlock": { "post": { "operationId": "sui_dryRunTransactionBlock", "summary": "sui_dryRunTransactionBlock", "description": "Return transaction execution effects including the gas cost summary, while the effects are not committed to the chain.", "tags": [ "Write API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_dryRunTransactionBlock" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_dryRunTransactionBlock", "params": [ "AAACACB7qR3cfnF89wjJNwYPBASHNuwz+xdG2Zml5YzVxnftgAEAT4LxyFh7mNZMAL+0bDhDvYv2zPp8ZahhOGmM0f3Kw9wCAAAAAAAAACCxDABG4pPAjOwPQHg9msS/SrtNf4IGR/2F0ZGD3ufH/wEBAQEBAAEAAGH7tbTzQqQL2/h/5KlGueONGM+P/HsAALl1F1x7apV2AejYx86GPzE9o9vZKoPvJtEouI/ma/JuDg0Jza9yfR2EAgAAAAAAAAAgzMqpegLMOpgEFnDhYJ23FOmFjJbp5GmFXxzzv9+X6GVh+7W080KkC9v4f+SpRrnjjRjPj/x7AAC5dRdce2qVdgoAAAAAAAAAoIYBAAAAAAAA" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/DryRunTransactionBlockResponse" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_executeTransactionBlock": { "post": { "operationId": "sui_executeTransactionBlock", "summary": "sui_executeTransactionBlock", "description": "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", "tags": [ "Write API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_executeTransactionBlock" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_executeTransactionBlock", "params": [ "AAACACBqEB6aOvXIBwES+Ahkizbvv43uihqC3kbZUE6WoRCKFwEAjvdvVsOZYzousxC8qRJOXy84znOeqsu2YAaIgE4HhEgCAAAAAAAAACB9w3+ufZMpihJFwxtCBojBaGy00TVtFxgN2C6TpIPFqwEBAQEBAAEAAAS0l6kWtGVmCaf6gnoJGE1vR2gdO6dM4NejbGSysfiHAZ+Q9/hmzCnfsdpjc86U+dldylpA9OF2mRjuv5+64AvTAgAAAAAAAAAgjleHL0UiRGjh/BfIFHCJ3EMY/dQA22c2TvNQyVJnbYUEtJepFrRlZgmn+oJ6CRhNb0doHTunTODXo2xksrH4hwoAAAAAAAAAoIYBAAAAAAAA", [ "AKD4XdltkCyBi1Heb4EJJ3lzuV3F4u7+CYeaE+Fd7qXpaT17yd4tHWjMf4CWq3TuXBLxTpkc2MV39P6p7eMV8QnqvbuA0Q1Bqu4RHV3JPpqmH+C527hWJGUBOZN1j9sg8w==" ], { "showInput": true, "showRawInput": true, "showEffects": true, "showEvents": true, "showObjectChanges": true, "showBalanceChanges": true, "showRawEffects": false }, "WaitForLocalExecution" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockResponse" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getChainIdentifier": { "post": { "operationId": "sui_getChainIdentifier", "summary": "sui_getChainIdentifier", "description": "Return the first four bytes of the chain's genesis checkpoint digest.", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getChainIdentifier" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getChainIdentifier", "params": [] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "string" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getCheckpoint": { "post": { "operationId": "sui_getCheckpoint", "summary": "sui_getCheckpoint", "description": "Return a checkpoint", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getCheckpoint" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getCheckpoint", "params": [ "1000" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Checkpoint" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getCheckpoints": { "post": { "operationId": "sui_getCheckpoints", "summary": "sui_getCheckpoints", "description": "Return paginated list of checkpoints", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getCheckpoints" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getCheckpoints", "params": [ "1004", 4, false ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Page_for_Checkpoint_and_BigInt_for_uint64" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getEvents": { "post": { "operationId": "sui_getEvents", "summary": "sui_getEvents", "description": "Return transaction events.", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getEvents" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getEvents", "params": [ "11a72GCQ5hGNpWGh2QhQkkusTEGS6EDqifJqxr7nSYX" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getLatestCheckpointSequenceNumber": { "post": { "operationId": "sui_getLatestCheckpointSequenceNumber", "summary": "sui_getLatestCheckpointSequenceNumber", "description": "Return the sequence number of the latest checkpoint that has been executed", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getLatestCheckpointSequenceNumber" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getLatestCheckpointSequenceNumber", "params": [] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getMoveFunctionArgTypes": { "post": { "operationId": "sui_getMoveFunctionArgTypes", "summary": "sui_getMoveFunctionArgTypes", "description": "Return the argument types of a Move function, based on normalized Type.", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getMoveFunctionArgTypes" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getMoveFunctionArgTypes", "params": [ "0xa0a7b108f5023b7356f2c6a4be6f058e267aae38e08260c7d519d8641897490c", "suifrens", "mint" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/MoveFunctionArgType" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getNormalizedMoveFunction": { "post": { "operationId": "sui_getNormalizedMoveFunction", "summary": "sui_getNormalizedMoveFunction", "description": "Return a structured representation of Move function", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getNormalizedMoveFunction" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getNormalizedMoveFunction", "params": [ "0x9c4eb6769ca8b6a23efeb7298cf0a8d0b837b78749c2cfc711c42036cc6b7621", "moduleName", "functionName" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/SuiMoveNormalizedFunction" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getNormalizedMoveModule": { "post": { "operationId": "sui_getNormalizedMoveModule", "summary": "sui_getNormalizedMoveModule", "description": "Return a structured representation of Move module", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getNormalizedMoveModule" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getNormalizedMoveModule", "params": [ "0x0047d5fa0a823e7d0ff4d55c32b09995a0ae1eedfee9c7b1354e805ed10ee3d0", "module" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/SuiMoveNormalizedModule" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getNormalizedMoveModulesByPackage": { "post": { "operationId": "sui_getNormalizedMoveModulesByPackage", "summary": "sui_getNormalizedMoveModulesByPackage", "description": "Return structured representations of all modules in the given package", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getNormalizedMoveModulesByPackage" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getNormalizedMoveModulesByPackage", "params": [ "0x61630d3505f8905a0f4d42c6ff39a78a6ba2b28f68a3299ec3417bbabc6717dc" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedModule" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getNormalizedMoveStruct": { "post": { "operationId": "sui_getNormalizedMoveStruct", "summary": "sui_getNormalizedMoveStruct", "description": "Return a structured representation of Move struct", "tags": [ "Move Utils" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getNormalizedMoveStruct" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getNormalizedMoveStruct", "params": [ "0xc95b9e341bc3aba1654bdbad707dcd773bd6309363447ef3fe58a960de92aa93", "module", "StructName" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/SuiMoveNormalizedStruct" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getObject": { "post": { "operationId": "sui_getObject", "summary": "sui_getObject", "description": "Return the object information for a specified object", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getObject" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getObject", "params": [ "0x53e4567ccafa5f36ce84c80aa8bc9be64e0d5ae796884274aef3005ae6733809", { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": true, "showBcs": false, "showStorageRebate": true } ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/SuiObjectResponse" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getProtocolConfig": { "post": { "operationId": "sui_getProtocolConfig", "summary": "sui_getProtocolConfig", "description": "Return the protocol config table for the given version number. If none is specified, the node uses the version of the latest epoch it has processed.", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getProtocolConfig" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getProtocolConfig", "params": [ 6 ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/ProtocolConfig" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getTotalTransactionBlocks": { "post": { "operationId": "sui_getTotalTransactionBlocks", "summary": "sui_getTotalTransactionBlocks", "description": "Return the total number of transaction blocks known to the server.", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getTotalTransactionBlocks" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getTotalTransactionBlocks", "params": [] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_getTransactionBlock": { "post": { "operationId": "sui_getTransactionBlock", "summary": "sui_getTransactionBlock", "description": "Return the transaction response object.", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_getTransactionBlock" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_getTransactionBlock", "params": [ "Hay2tj3GcDYcE3AMHrej5WDsHGPVAYsegcubixLUvXUF", { "showInput": true, "showRawInput": false, "showEffects": true, "showEvents": true, "showObjectChanges": false, "showBalanceChanges": false, "showRawEffects": false } ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockResponse" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_multiGetObjects": { "post": { "operationId": "sui_multiGetObjects", "summary": "sui_multiGetObjects", "description": "Return the object data for a list of objects", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_multiGetObjects" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_multiGetObjects", "params": [ [ "0x77b3482580ee8d5bdc5b824808df54bfec4fc817622e5add0e48f749f01def98", "0x9060d87664c26a3f9a509228c21b16dc6797cf787c839a07edc03e6338421091", "0xb37379c527753c5c8ab783f697e7b61439368cd75ebe63d633af32ffb4a022d1", "0xee309e94ff5c9f6b02c5637f018f6ea7bed8f6c3d80f2a595c2305e12dd6d07c", "0x29bc7c8d230db3b417edb1184cf075da5e934f672d3da3e003d989075efaecc7" ], { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": true, "showBcs": false, "showStorageRebate": true } ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectResponse" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_multiGetTransactionBlocks": { "post": { "operationId": "sui_multiGetTransactionBlocks", "summary": "sui_multiGetTransactionBlocks", "description": "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", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_multiGetTransactionBlocks" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_multiGetTransactionBlocks", "params": [ [ "EMqJqkQip6UaTkdff493ewAQNHGQFJwXDDn6m9CTgZzo", "Hn3B25vTQNTFAdThFkWvfkiAAUZxzwTaj4uEengu1ACX", "9vLSG9a4QcLcMdG1xCu6FRdXAjWWqvJHoHBCJfPMKkR9" ], { "showInput": true, "showRawInput": false, "showEffects": true, "showEvents": true, "showObjectChanges": false, "showBalanceChanges": false, "showRawEffects": false } ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionBlockResponse" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_tryGetPastObject": { "post": { "operationId": "sui_tryGetPastObject", "summary": "sui_tryGetPastObject", "description": "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", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_tryGetPastObject" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "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 } ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/ObjectRead" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_tryMultiGetPastObjects": { "post": { "operationId": "sui_tryMultiGetPastObjects", "summary": "sui_tryMultiGetPastObjects", "description": "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", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_tryMultiGetPastObjects" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "sui_tryMultiGetPastObjects", "params": [ [ { "objectId": "0x38b3186a7bb26a1ab2c982a0a9b482aa70f5a010fffc60f20194ef0f597474e8", "version": "4" }, { "objectId": "0xceaf9ee4582d3a233101e322a22cb2a5bea2e681ea5af4e59bd1abb0bb4fcb27", "version": "12" } ], { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": true, "showBcs": false, "showStorageRebate": true } ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRead" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#sui_verifyZkLoginSignature": { "post": { "operationId": "sui_verifyZkLoginSignature", "summary": "sui_verifyZkLoginSignature", "description": "Verify a zklogin signature for the given bytes, intent scope and author.", "tags": [ "Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "sui_verifyZkLoginSignature" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/ZkLoginVerifyResult" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getAllBalances": { "post": { "operationId": "suix_getAllBalances", "summary": "suix_getAllBalances", "description": "Return the total coin balance for all coin type, owned by the address owner.", "tags": [ "Coin Query API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getAllBalances" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getAllBalances", "params": [ "0x94f1a597b4e8f709a396f7f6b1482bdcd65a673d111e49286c527fab7c2d0961" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Balance" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getAllCoins": { "post": { "operationId": "suix_getAllCoins", "summary": "suix_getAllCoins", "description": "Return all Coin objects owned by an address.", "tags": [ "Coin Query API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getAllCoins" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getAllCoins", "params": [ "0x41f5975e3c6bd5c95f041a8493ad7e9934be26e69152d2c2e86d8a9bdbd242b3", "0x2564cd31a71cf9833609b111436d8f0f47b7f8b9927ec3f8975a1dcbf9b25564", 3 ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Page_for_Coin_and_String" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getBalance": { "post": { "operationId": "suix_getBalance", "summary": "suix_getBalance", "description": "Return the total coin balance for one coin type, owned by the address owner.", "tags": [ "Coin Query API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getBalance" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getBalance", "params": [ "0xa6f5a7953a75dc632e696cabe60560522a017bf2fb0bd930d1ec22c06f1ee4e4", "0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Balance" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getCoinMetadata": { "post": { "operationId": "suix_getCoinMetadata", "summary": "suix_getCoinMetadata", "description": "Return metadata (e.g., symbol, decimals) for a coin. Note that if the coin's metadata was wrapped in the transaction that published its marker type, or the latest version of the metadata object is wrapped or deleted, it will not be found.", "tags": [ "Coin Query API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getCoinMetadata" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getCoinMetadata", "params": [ "0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/SuiCoinMetadata" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getCoins": { "post": { "operationId": "suix_getCoins", "summary": "suix_getCoins", "description": "Return all Coin<`coin_type`> objects owned by an address.", "tags": [ "Coin Query API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getCoins" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getCoins", "params": [ "0x6d907beaa3a49db57bdfdb3557e6d405cbf01c293a53e01457d65e92b5d8dd68", "0x2::sui::SUI", "0xee6b5173afedb35330f60397c2cbb48196ba41921246c304be7b490cee0904eb", 3 ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Page_for_Coin_and_String" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getCommitteeInfo": { "post": { "operationId": "suix_getCommitteeInfo", "summary": "suix_getCommitteeInfo", "description": "Return the committee information for the asked `epoch`.", "tags": [ "Governance Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getCommitteeInfo" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getCommitteeInfo", "params": [ "5000" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/CommitteeInfo" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getDynamicFieldObject": { "post": { "operationId": "suix_getDynamicFieldObject", "summary": "suix_getDynamicFieldObject", "description": "Return the dynamic field object information for a specified object", "tags": [ "Extended API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getDynamicFieldObject" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getDynamicFieldObject", "params": [ "0x3ddea0f8c3da994d9ead562ce76e36fdef6a382da344930c73d1298b0e9644b8", { "type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField", "value": "some_value" } ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/SuiObjectResponse" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getDynamicFields": { "post": { "operationId": "suix_getDynamicFields", "summary": "suix_getDynamicFields", "description": "Return the list of dynamic field objects owned by an object.", "tags": [ "Extended API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getDynamicFields" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getDynamicFields", "params": [ "0x5612581eba57ebe7e594b809ccceec2be4dac6ff6945d49b3ecc043d049611f6", "0x671832358f25bfacde706e528df4e15bb8de6dadd21835dfe44f4973139c15f9", 3 ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Page_for_DynamicFieldInfo_and_ObjectID" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getLatestSuiSystemState": { "post": { "operationId": "suix_getLatestSuiSystemState", "summary": "suix_getLatestSuiSystemState", "description": "Return the latest SUI system state object on-chain.", "tags": [ "Governance Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getLatestSuiSystemState" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getLatestSuiSystemState", "params": [] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/SuiSystemStateSummary" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getOwnedObjects": { "post": { "operationId": "suix_getOwnedObjects", "summary": "suix_getOwnedObjects", "description": "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.", "tags": [ "Extended API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getOwnedObjects" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getOwnedObjects", "params": [ "0xdbc9abc01a87906b033a75750e741edb2df5ea5d55c96a611371d22799d26827", { "filter": { "MatchAll": [ { "StructType": "0x2::coin::Coin<0x2::sui::SUI>" }, { "AddressOwner": "0xdbc9abc01a87906b033a75750e741edb2df5ea5d55c96a611371d22799d26827" }, { "Version": "13488" } ] }, "options": { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": false, "showBcs": false, "showStorageRebate": false } }, "0x0cd4bb4d4f520fe9bbf0cf1cebe3f2549412826c3c9261bff9786c240123749f", 3 ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Page_for_SuiObjectResponse_and_ObjectID" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getReferenceGasPrice": { "post": { "operationId": "suix_getReferenceGasPrice", "summary": "suix_getReferenceGasPrice", "description": "Return the reference gas price for the network", "tags": [ "Governance Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getReferenceGasPrice" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getReferenceGasPrice", "params": [] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getStakes": { "post": { "operationId": "suix_getStakes", "summary": "suix_getStakes", "description": "Return all [DelegatedStake].", "tags": [ "Governance Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getStakes" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getStakes", "params": [ "0x9c76d5157eaa77c41a7bfda8db98a8e8080f7cb53b7313088ed085c73f866f21" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatedStake" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getStakesByIds": { "post": { "operationId": "suix_getStakesByIds", "summary": "suix_getStakesByIds", "description": "Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.", "tags": [ "Governance Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getStakesByIds" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getStakesByIds", "params": [ [ "0x378423de90ed03b694cecf443c72b5387b29a731d26d98108d7abc4902107d7d", "0x6a8e0f8fea6fda5488462e58724c034462b6064a08845e2ae2942fe7c4ee816d" ] ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatedStake" } }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getTotalSupply": { "post": { "operationId": "suix_getTotalSupply", "summary": "suix_getTotalSupply", "description": "Return total supply for a coin", "tags": [ "Coin Query API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getTotalSupply" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getTotalSupply", "params": [ "0xe5c651321915b06c81838c2e370109b554a448a78d3a56220f798398dde66eab::acoin::ACOIN" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Supply" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_getValidatorsApy": { "post": { "operationId": "suix_getValidatorsApy", "summary": "suix_getValidatorsApy", "description": "Return the validator APY", "tags": [ "Governance Read API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_getValidatorsApy" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_getValidatorsApy", "params": [] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/ValidatorApys" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_queryEvents": { "post": { "operationId": "suix_queryEvents", "summary": "suix_queryEvents", "description": "Return list of events for a specified query criteria.", "tags": [ "Extended API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_queryEvents" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_queryEvents", "params": [ { "MoveModule": { "package": "0xa395759ca37c6e1ffc179184e98a6f9a2da5d78f6e34b0e5044ed52a6bc0a1bc", "module": "test" } }, { "txDigest": "Eg3ynETJfTfPKyvJzq3VLG6MngURYHPMjjUJ3Xt1t7tf", "eventSeq": "1" }, 100, false ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Page_for_Event_and_EventID" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_queryTransactionBlocks": { "post": { "operationId": "suix_queryTransactionBlocks", "summary": "suix_queryTransactionBlocks", "description": "Return list of transactions for a specified query criteria.", "tags": [ "Extended API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_queryTransactionBlocks" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_queryTransactionBlocks", "params": [ { "filter": { "InputObject": "0x93633829fcba6d6e0ccb13d3dbfe7614b81ea76b255e5d435032cd8595f37eb8" }, "options": null }, "HxidAfFfyr4kXSiWeVq1J6Tk526YUVDoSUY5PSnS4tEJ", 100, false ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Page_for_TransactionBlockResponse_and_TransactionDigest" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_resolveNameServiceAddress": { "post": { "operationId": "suix_resolveNameServiceAddress", "summary": "suix_resolveNameServiceAddress", "description": "Return the resolved address given resolver and name", "tags": [ "Extended API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_resolveNameServiceAddress" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_resolveNameServiceAddress", "params": [ "example.sui" ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/SuiAddress" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_resolveNameServiceNames": { "post": { "operationId": "suix_resolveNameServiceNames", "summary": "suix_resolveNameServiceNames", "description": "Return the resolved names given address, if multiple names are resolved, the first one is the primary name.", "tags": [ "Extended API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_resolveNameServiceNames" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": { "example": { "value": { "jsonrpc": "2.0", "id": 1, "method": "suix_resolveNameServiceNames", "params": [ "0x5cd6fa76ed1d18f05f15e35075252ddec4fb83621d55952d9172fcfcb72feae2", "0xd22bbb46f892c42d9ec0ae4de93e02c75973a51c17180798237326a58694a2cf", 3 ] } } } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Page_for_String_and_ObjectID" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_subscribeEvent": { "post": { "operationId": "suix_subscribeEvent", "summary": "suix_subscribeEvent", "description": "Subscribe to a stream of Sui event", "tags": [ "Extended API", "Websocket", "PubSub" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_subscribeEvent" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/Event" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#suix_subscribeTransaction": { "post": { "operationId": "suix_subscribeTransaction", "summary": "suix_subscribeTransaction", "description": "Subscribe to a stream of Sui transaction effects", "tags": [ "Extended API", "Websocket", "PubSub" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "suix_subscribeTransaction" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockEffects" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_batchTransaction": { "post": { "operationId": "unsafe_batchTransaction", "summary": "unsafe_batchTransaction", "description": "Create an unsigned batched transaction.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_batchTransaction" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_mergeCoins": { "post": { "operationId": "unsafe_mergeCoins", "summary": "unsafe_mergeCoins", "description": "Create an unsigned transaction to merge multiple coins into one coin.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_mergeCoins" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_moveCall": { "post": { "operationId": "unsafe_moveCall", "summary": "unsafe_moveCall", "description": "Create an unsigned transaction to execute a Move call on the network, by calling the specified function in the module of a given package.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_moveCall" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_pay": { "post": { "operationId": "unsafe_pay", "summary": "unsafe_pay", "description": "Send `Coin` 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.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_pay" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_payAllSui": { "post": { "operationId": "unsafe_payAllSui", "summary": "unsafe_payAllSui", "description": "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.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_payAllSui" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_paySui": { "post": { "operationId": "unsafe_paySui", "summary": "unsafe_paySui", "description": "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 coins other than the first one are deleted.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_paySui" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_publish": { "post": { "operationId": "unsafe_publish", "summary": "unsafe_publish", "description": "Create an unsigned transaction to publish a Move package.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_publish" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_requestAddStake": { "post": { "operationId": "unsafe_requestAddStake", "summary": "unsafe_requestAddStake", "description": "Add stake to a validator's staking pool using multiple coins and amount.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_requestAddStake" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_requestWithdrawStake": { "post": { "operationId": "unsafe_requestWithdrawStake", "summary": "unsafe_requestWithdrawStake", "description": "Withdraw stake from a validator's staking pool.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_requestWithdrawStake" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_splitCoin": { "post": { "operationId": "unsafe_splitCoin", "summary": "unsafe_splitCoin", "description": "Create an unsigned transaction to split a coin object into multiple coins.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_splitCoin" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_splitCoinEqual": { "post": { "operationId": "unsafe_splitCoinEqual", "summary": "unsafe_splitCoinEqual", "description": "Create an unsigned transaction to split a coin object into multiple equal-size coins.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_splitCoinEqual" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_transferObject": { "post": { "operationId": "unsafe_transferObject", "summary": "unsafe_transferObject", "description": "Create an unsigned transaction to transfer an object from one address to another. The object's type must allow public transfers", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_transferObject" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } }, "/#unsafe_transferSui": { "post": { "operationId": "unsafe_transferSui", "summary": "unsafe_transferSui", "description": "Create an unsigned transaction to send SUI coin object to a Sui address. The SUI object is also used as the gas object.", "tags": [ "Transaction Builder API" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ], "example": "2.0" }, "id": { "type": "integer", "example": 1 }, "method": { "type": "string", "enum": [ "unsafe_transferSui" ] }, "params": { "type": "array", "description": "Parameters as positional array", "items": {} } } }, "examples": {} } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": "integer" }, "result": { "$ref": "#/components/schemas/TransactionBlockBytes" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } } } } } } }, "components": { "schemas": { "AccumulatorEvent": { "type": "object", "required": [ "accumulatorObj", "address", "operation", "ty", "value" ], "properties": { "accumulatorObj": { "$ref": "#/components/schemas/ObjectID" }, "address": { "$ref": "#/components/schemas/SuiAddress" }, "operation": { "$ref": "#/components/schemas/AccumulatorOperation" }, "ty": { "$ref": "#/components/schemas/TypeTag" }, "value": { "$ref": "#/components/schemas/AccumulatorValue" } } }, "AccumulatorOperation": { "type": "string", "enum": [ "merge", "split" ] }, "AccumulatorValue": { "oneOf": [ { "type": "object", "required": [ "integer" ], "properties": { "integer": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, "additionalProperties": false }, { "type": "object", "required": [ "integerTuple" ], "properties": { "integerTuple": { "type": "array", "items": [ { "type": "integer", "format": "uint64", "minimum": 0.0 }, { "type": "integer", "format": "uint64", "minimum": 0.0 } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "type": "object", "required": [ "eventDigest" ], "properties": { "eventDigest": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "format": "uint64", "minimum": 0.0 }, { "$ref": "#/components/schemas/Digest" } ], "maxItems": 2, "minItems": 2 } } }, "additionalProperties": false } ] }, "AdditionalConsensusStateDigest": { "$ref": "#/components/schemas/Digest" }, "AuthorityPublicKeyBytes": { "description": "Defines the compressed version of the public key that we pass around in Sui", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] }, "Balance": { "type": "object", "required": [ "coinObjectCount", "coinType", "lockedBalance", "totalBalance" ], "properties": { "coinObjectCount": { "type": "integer", "format": "uint", "minimum": 0.0 }, "coinType": { "type": "string" }, "fundsInAddressBalance": { "description": "The portion of `total_balance` that resides in the address balance rather than in the coin objects. `total_balance` is the total amount of funds owned by the address. That is, do not add these two fields together.", "default": "0", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint128" } ] }, "lockedBalance": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BigInt_for_uint128" } }, "totalBalance": { "$ref": "#/components/schemas/BigInt_for_uint128" } } }, "BalanceChange": { "type": "object", "required": [ "amount", "coinType", "owner" ], "properties": { "amount": { "description": "The amount indicate the balance value changes, negative amount means spending coin value and positive means receiving coin value.", "type": "string" }, "coinType": { "type": "string" }, "owner": { "description": "Owner of the balance change", "allOf": [ { "$ref": "#/components/schemas/Owner" } ] } } }, "Base58": { "type": "string" }, "Base64": { "description": "Base64 encoding", "type": "string" }, "BigInt_for_uint128": { "type": "string" }, "BigInt_for_uint16": { "type": "string" }, "BigInt_for_uint32": { "type": "string" }, "BigInt_for_uint64": { "type": "string" }, "Bn254FqElement": { "description": "A struct that stores a Bn254 Fq field element as 32 bytes.", "type": "string" }, "Bn254FrElement": { "description": "A struct that stores a Bn254 Fr field element as 32 bytes.", "type": "string" }, "Checkpoint": { "type": "object", "required": [ "checkpointCommitments", "digest", "epoch", "epochRollingGasCostSummary", "networkTotalTransactions", "sequenceNumber", "timestampMs", "transactions", "validatorSignature" ], "properties": { "checkpointCommitments": { "description": "Commitments to checkpoint state", "type": "array", "items": { "$ref": "#/components/schemas/CheckpointCommitment" } }, "digest": { "description": "Checkpoint digest", "allOf": [ { "$ref": "#/components/schemas/CheckpointDigest" } ] }, "endOfEpochData": { "description": "Present only on the final checkpoint of the epoch.", "anyOf": [ { "$ref": "#/components/schemas/EndOfEpochData" }, { "type": "null" } ] }, "epoch": { "description": "Checkpoint's epoch ID", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "epochRollingGasCostSummary": { "description": "The running total gas costs of all transactions included in the current epoch so far until this checkpoint.", "allOf": [ { "$ref": "#/components/schemas/GasCostSummary" } ] }, "networkTotalTransactions": { "description": "Total number of transactions committed since genesis, including those in this checkpoint.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "previousDigest": { "description": "Digest of the previous checkpoint", "anyOf": [ { "$ref": "#/components/schemas/CheckpointDigest" }, { "type": "null" } ] }, "sequenceNumber": { "description": "Checkpoint sequence number", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "timestampMs": { "description": "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", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "transactions": { "description": "Transaction digests", "type": "array", "items": { "$ref": "#/components/schemas/TransactionDigest" } }, "validatorSignature": { "description": "Validator Signature", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] } } }, "CheckpointArtifactsDigest": { "$ref": "#/components/schemas/Digest" }, "CheckpointCommitment": { "oneOf": [ { "type": "object", "required": [ "ECMHLiveObjectSetDigest" ], "properties": { "ECMHLiveObjectSetDigest": { "$ref": "#/components/schemas/ECMHLiveObjectSetDigest" } }, "additionalProperties": false }, { "type": "object", "required": [ "CheckpointArtifactsDigest" ], "properties": { "CheckpointArtifactsDigest": { "$ref": "#/components/schemas/CheckpointArtifactsDigest" } }, "additionalProperties": false } ] }, "CheckpointDigest": { "description": "Representation of a Checkpoint's digest", "allOf": [ { "$ref": "#/components/schemas/Digest" } ] }, "CheckpointId": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "$ref": "#/components/schemas/CheckpointDigest" } ] }, "Claim": { "description": "A claim consists of value and index_mod_4.", "type": "object", "required": [ "indexMod4", "value" ], "properties": { "indexMod4": { "type": "integer", "format": "uint8", "minimum": 0.0 }, "value": { "type": "string" } } }, "Coin": { "type": "object", "required": [ "balance", "coinObjectId", "coinType", "digest", "previousTransaction", "version" ], "properties": { "balance": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "coinObjectId": { "$ref": "#/components/schemas/ObjectID" }, "coinType": { "type": "string" }, "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "previousTransaction": { "$ref": "#/components/schemas/TransactionDigest" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, "CommitteeInfo": { "description": "RPC representation of the [Committee] type.", "type": "object", "required": [ "epoch", "validators" ], "properties": { "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "validators": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/AuthorityPublicKeyBytes" }, { "$ref": "#/components/schemas/BigInt_for_uint64" } ], "maxItems": 2, "minItems": 2 } } } }, "CompressedSignature": { "description": "Unlike [enum Signature], [enum CompressedSignature] does not contain public key.", "oneOf": [ { "type": "object", "required": [ "Ed25519" ], "properties": { "Ed25519": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256k1" ], "properties": { "Secp256k1": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256r1" ], "properties": { "Secp256r1": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "ZkLogin" ], "properties": { "ZkLogin": { "$ref": "#/components/schemas/ZkLoginAuthenticatorAsBytes" } }, "additionalProperties": false }, { "type": "object", "required": [ "Passkey" ], "properties": { "Passkey": { "$ref": "#/components/schemas/PasskeyAuthenticatorAsBytes" } }, "additionalProperties": false } ] }, "ConsensusCommitDigest": { "$ref": "#/components/schemas/Digest" }, "ConsensusDeterminedVersionAssignments": { "oneOf": [ { "type": "object", "required": [ "CancelledTransactions" ], "properties": { "CancelledTransactions": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SequenceNumber2" } ], "maxItems": 2, "minItems": 2 } } ], "maxItems": 2, "minItems": 2 } } }, "additionalProperties": false }, { "type": "object", "required": [ "CancelledTransactionsV2" ], "properties": { "CancelledTransactionsV2": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "array", "items": { "type": "array", "items": [ { "type": "array", "items": [ { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SequenceNumber2" } ], "maxItems": 2, "minItems": 2 }, { "$ref": "#/components/schemas/SequenceNumber2" } ], "maxItems": 2, "minItems": 2 } } ], "maxItems": 2, "minItems": 2 } } }, "additionalProperties": false } ] }, "Data": { "oneOf": [ { "type": "object", "required": [ "dataType", "fields", "hasPublicTransfer", "type" ], "properties": { "dataType": { "type": "string", "enum": [ "moveObject" ] }, "fields": { "$ref": "#/components/schemas/MoveStruct" }, "hasPublicTransfer": { "type": "boolean" }, "type": { "type": "string" } } }, { "type": "object", "required": [ "dataType", "disassembled" ], "properties": { "dataType": { "type": "string", "enum": [ "package" ] }, "disassembled": { "type": "object", "additionalProperties": true } } } ] }, "DelegatedStake": { "type": "object", "required": [ "stakes", "stakingPool", "validatorAddress" ], "properties": { "stakes": { "type": "array", "items": { "$ref": "#/components/schemas/Stake" } }, "stakingPool": { "description": "Staking pool object id.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "validatorAddress": { "description": "Validator's Address.", "allOf": [ { "$ref": "#/components/schemas/SuiAddress" } ] } } }, "DevInspectArgs": { "description": "Additional rguments supplied to dev inspect beyond what is allowed in today's API.", "type": "object", "properties": { "gasBudget": { "description": "The gas budget for the transaction.", "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "gasObjects": { "description": "The gas objects used to pay for the transaction.", "type": [ "array", "null" ], "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SequenceNumber2" }, { "$ref": "#/components/schemas/ObjectDigest" } ], "maxItems": 3, "minItems": 3 } }, "gasSponsor": { "description": "The sponsor of the gas for the transaction, might be different from the sender.", "anyOf": [ { "$ref": "#/components/schemas/SuiAddress" }, { "type": "null" } ] }, "showRawTxnDataAndEffects": { "description": "Whether to return the raw transaction data and effects.", "type": [ "boolean", "null" ] }, "skipChecks": { "description": "Whether to skip transaction checks for the transaction.", "type": [ "boolean", "null" ] } } }, "DevInspectResults": { "description": "The response from processing a dev inspect transaction", "type": "object", "required": [ "effects", "events" ], "properties": { "effects": { "description": "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.", "allOf": [ { "$ref": "#/components/schemas/TransactionBlockEffects" } ] }, "error": { "description": "Execution error from executing the transactions", "type": [ "string", "null" ] }, "events": { "description": "Events that likely would be generated if the transaction is actually run.", "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "rawEffects": { "description": "The raw effects of the transaction that was dev inspected.", "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "rawTxnData": { "description": "The raw transaction data that was dev inspected.", "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "results": { "description": "Execution results (including return values) from executing the transactions", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/SuiExecutionResult" } } } }, "Digest": { "description": "A representation of a 32 byte digest", "allOf": [ { "$ref": "#/components/schemas/Base58" } ] }, "DisplayFieldsResponse": { "type": "object", "properties": { "data": { "type": [ "object", "null" ], "additionalProperties": { "type": "string" } }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ObjectResponseError" }, { "type": "null" } ] } } }, "DryRunTransactionBlockResponse": { "type": "object", "required": [ "balanceChanges", "effects", "events", "input", "objectChanges" ], "properties": { "balanceChanges": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceChange" } }, "effects": { "$ref": "#/components/schemas/TransactionBlockEffects" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "executionErrorSource": { "type": [ "string", "null" ] }, "input": { "$ref": "#/components/schemas/TransactionBlockData" }, "objectChanges": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectChange" } }, "suggestedGasPrice": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, "DynamicFieldInfo": { "type": "object", "oneOf": [ { "type": "object", "required": [ "bcsEncoding", "bcsName" ], "properties": { "bcsEncoding": { "type": "string", "enum": [ "base64" ] }, "bcsName": { "$ref": "#/components/schemas/Base64" } } }, { "type": "object", "required": [ "bcsEncoding", "bcsName" ], "properties": { "bcsEncoding": { "type": "string", "enum": [ "base58" ] }, "bcsName": { "$ref": "#/components/schemas/Base58" } } } ], "required": [ "digest", "name", "objectId", "objectType", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "name": { "$ref": "#/components/schemas/DynamicFieldName" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "type": { "$ref": "#/components/schemas/DynamicFieldType" }, "version": { "$ref": "#/components/schemas/SequenceNumber2" } } }, "DynamicFieldName": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string" }, "value": true } }, "DynamicFieldType": { "type": "string", "enum": [ "DynamicField", "DynamicObject" ] }, "ECMHLiveObjectSetDigest": { "description": "The Sha256 digest of an EllipticCurveMultisetHash committing to the live object set.", "type": "object", "required": [ "digest" ], "properties": { "digest": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 }, "maxItems": 32, "minItems": 32 } } }, "Ed25519SuiSignature": { "$ref": "#/components/schemas/Base64" }, "EndOfEpochData": { "type": "object", "required": [ "epochCommitments", "nextEpochCommittee", "nextEpochProtocolVersion" ], "properties": { "epochCommitments": { "description": "Commitments to epoch specific state (e.g. live object set)", "type": "array", "items": { "$ref": "#/components/schemas/CheckpointCommitment" } }, "nextEpochCommittee": { "description": "next_epoch_committee is `Some` if and only if the current checkpoint is the last checkpoint of an epoch. Therefore next_epoch_committee can be used to pick the last checkpoint of an epoch, which is often useful to get epoch level summary stats like total gas cost of an epoch, or the total number of transactions from genesis to the end of an epoch. The committee is stored as a vector of validator pub key and stake pairs. The vector should be sorted based on the Committee data structure.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/AuthorityPublicKeyBytes" }, { "$ref": "#/components/schemas/BigInt_for_uint64" } ], "maxItems": 2, "minItems": 2 } }, "nextEpochProtocolVersion": { "description": "The protocol version that is in effect during the epoch that starts immediately after this checkpoint.", "allOf": [ { "$ref": "#/components/schemas/ProtocolVersion" } ] } } }, "Event": { "type": "object", "oneOf": [ { "type": "object", "required": [ "bcs", "bcsEncoding" ], "properties": { "bcs": { "$ref": "#/components/schemas/Base64" }, "bcsEncoding": { "type": "string", "enum": [ "base64" ] } } }, { "type": "object", "required": [ "bcs", "bcsEncoding" ], "properties": { "bcs": { "$ref": "#/components/schemas/Base58" }, "bcsEncoding": { "type": "string", "enum": [ "base58" ] } } } ], "required": [ "id", "packageId", "parsedJson", "sender", "transactionModule", "type" ], "properties": { "id": { "description": "Sequential event ID, ie (transaction seq number, event seq number). 1) Serves as a unique event ID for each fullnode 2) Also serves to sequence events for the purposes of pagination and querying. A higher id is an event seen later by that fullnode. This ID is the \"cursor\" for event querying.", "allOf": [ { "$ref": "#/components/schemas/EventID" } ] }, "packageId": { "description": "Move package where this event was emitted.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "parsedJson": { "description": "Parsed json value of the event" }, "sender": { "description": "Sender's Sui address.", "allOf": [ { "$ref": "#/components/schemas/SuiAddress" } ] }, "timestampMs": { "description": "UTC timestamp in milliseconds since epoch (1/1/1970)", "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "transactionModule": { "description": "Move module where this event was emitted.", "type": "string" }, "type": { "description": "Move event type.", "type": "string" } } }, "EventFilter": { "oneOf": [ { "description": "Return all events.", "type": "object", "required": [ "All" ], "properties": { "All": { "type": "array", "maxItems": 0 } }, "additionalProperties": false }, { "description": "Return events that match any of the given filters. Only supported on event subscriptions.", "type": "object", "required": [ "Any" ], "properties": { "Any": { "type": "array", "items": { "$ref": "#/components/schemas/EventFilter" } } }, "additionalProperties": false }, { "description": "Query by sender address.", "type": "object", "required": [ "Sender" ], "properties": { "Sender": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Return events emitted by the given transaction.", "type": "object", "required": [ "Transaction" ], "properties": { "Transaction": { "$ref": "#/components/schemas/TransactionDigest" } }, "additionalProperties": false }, { "description": "Return events emitted in a specified Move module. If the event is defined in Module A but emitted in a tx with Module B, query `MoveModule` by module B returns the event. Query `MoveEventModule` by module A returns the event too.", "type": "object", "required": [ "MoveModule" ], "properties": { "MoveModule": { "type": "object", "required": [ "module", "package" ], "properties": { "module": { "description": "the module name", "type": "string" }, "package": { "description": "the Move package ID", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] } } } }, "additionalProperties": false }, { "description": "Return events with the given Move event struct name (struct tag). For example, if the event is defined in `0xabcd::MyModule`, and named `Foo`, then the struct tag is `0xabcd::MyModule::Foo`.", "type": "object", "required": [ "MoveEventType" ], "properties": { "MoveEventType": { "type": "string" } }, "additionalProperties": false }, { "description": "Return events with the given Move module name where the event struct is defined. If the event is defined in Module A but emitted in a tx with Module B, query `MoveEventModule` by module A returns the event. Query `MoveModule` by module B returns the event too.", "type": "object", "required": [ "MoveEventModule" ], "properties": { "MoveEventModule": { "type": "object", "required": [ "module", "package" ], "properties": { "module": { "description": "the module name", "type": "string" }, "package": { "description": "the Move package ID", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] } } } }, "additionalProperties": false }, { "description": "Return events emitted in [start_time, end_time] interval", "type": "object", "required": [ "TimeRange" ], "properties": { "TimeRange": { "type": "object", "required": [ "endTime", "startTime" ], "properties": { "endTime": { "description": "right endpoint of time interval, milliseconds since epoch, exclusive", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "startTime": { "description": "left endpoint of time interval, milliseconds since epoch, inclusive", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] } } } }, "additionalProperties": false } ] }, "EventID": { "description": "Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number.", "type": "object", "required": [ "eventSeq", "txDigest" ], "properties": { "eventSeq": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "txDigest": { "$ref": "#/components/schemas/TransactionDigest" } } }, "ExecuteTransactionRequestType": { "type": "string", "enum": [ "WaitForEffectsCert", "WaitForLocalExecution" ] }, "ExecutionStatus": { "oneOf": [ { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "success" ] } } }, { "type": "object", "required": [ "error", "status" ], "properties": { "error": { "type": "string" }, "status": { "type": "string", "enum": [ "failure" ] } } } ] }, "GasCostSummary": { "description": "Summary of the charges in a transaction. Storage is charged independently of computation. There are 3 parts to the storage charges: `storage_cost`: it is the charge of storage at the time the transaction is executed. The cost of storage is the number of bytes of the objects being mutated multiplied by a variable storage cost per byte `storage_rebate`: this is the amount a user gets back when manipulating an object. The `storage_rebate` is the `storage_cost` for an object minus fees. `non_refundable_storage_fee`: not all the value of the object storage cost is given back to user and there is a small fraction that is kept by the system. This value tracks that charge.\n\nWhen looking at a gas cost summary the amount charged to the user is `computation_cost + storage_cost - storage_rebate` and that is the amount that is deducted from the gas coins. `non_refundable_storage_fee` is collected from the objects being mutated/deleted and it is tracked by the system in storage funds.\n\nObjects deleted, including the older versions of objects mutated, have the storage field on the objects added up to a pool of \"potential rebate\". This rebate then is reduced by the \"nonrefundable rate\" such that: `potential_rebate(storage cost of deleted/mutated objects) = storage_rebate + non_refundable_storage_fee`", "type": "object", "required": [ "computationCost", "nonRefundableStorageFee", "storageCost", "storageRebate" ], "properties": { "computationCost": { "description": "Cost of computation/execution", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "nonRefundableStorageFee": { "description": "The fee for the rebate. The portion of the storage rebate kept by the system.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "storageCost": { "description": "Storage cost, it's the sum of all storage cost for all objects created or mutated.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "storageRebate": { "description": "The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] } } }, "GasData": { "type": "object", "required": [ "budget", "owner", "payment", "price" ], "properties": { "budget": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "owner": { "$ref": "#/components/schemas/SuiAddress" }, "payment": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "price": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "GenericSignature": { "description": "Due to the incompatibility of [enum Signature] (which dispatches a trait that assumes signature and pubkey bytes for verification), here we add a wrapper enum where member can just implement a lightweight [trait AuthenticatorTrait]. This way MultiSig (and future Authenticators) can implement its own `verify`.", "oneOf": [ { "type": "object", "required": [ "MultiSig" ], "properties": { "MultiSig": { "$ref": "#/components/schemas/MultiSig" } }, "additionalProperties": false }, { "type": "object", "required": [ "MultiSigLegacy" ], "properties": { "MultiSigLegacy": { "$ref": "#/components/schemas/MultiSigLegacy" } }, "additionalProperties": false }, { "type": "object", "required": [ "Signature" ], "properties": { "Signature": { "$ref": "#/components/schemas/Signature" } }, "additionalProperties": false }, { "type": "object", "required": [ "ZkLoginAuthenticator" ], "properties": { "ZkLoginAuthenticator": { "$ref": "#/components/schemas/ZkLoginAuthenticator" } }, "additionalProperties": false }, { "type": "object", "required": [ "PasskeyAuthenticator" ], "properties": { "PasskeyAuthenticator": { "$ref": "#/components/schemas/PasskeyAuthenticator" } }, "additionalProperties": false } ] }, "GetPastObjectRequest": { "type": "object", "required": [ "objectId", "version" ], "properties": { "objectId": { "description": "the ID of the queried object", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "version": { "description": "the version of the queried object.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber" } ] } } }, "Hex": { "description": "Hex string encoding.", "type": "string" }, "InputObjectKind": { "oneOf": [ { "type": "object", "required": [ "MovePackage" ], "properties": { "MovePackage": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "type": "object", "required": [ "ImmOrOwnedMoveObject" ], "properties": { "ImmOrOwnedMoveObject": { "$ref": "#/components/schemas/ObjectRef" } }, "additionalProperties": false }, { "type": "object", "required": [ "SharedMoveObject" ], "properties": { "SharedMoveObject": { "type": "object", "required": [ "id", "initial_shared_version" ], "properties": { "id": { "$ref": "#/components/schemas/ObjectID" }, "initial_shared_version": { "$ref": "#/components/schemas/SequenceNumber2" }, "mutable": { "default": true, "type": "boolean" } } } }, "additionalProperties": false } ] }, "MoveCallParams": { "type": "object", "required": [ "arguments", "function", "module", "packageObjectId" ], "properties": { "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/SuiJsonValue" } }, "function": { "type": "string" }, "module": { "type": "string" }, "packageObjectId": { "$ref": "#/components/schemas/ObjectID" }, "typeArguments": { "default": [], "type": "array", "items": { "$ref": "#/components/schemas/TypeTag" } } } }, "MoveFunctionArgType": { "oneOf": [ { "type": "string", "enum": [ "Pure" ] }, { "type": "object", "required": [ "Object" ], "properties": { "Object": { "$ref": "#/components/schemas/ObjectValueKind" } }, "additionalProperties": false } ] }, "MoveStruct": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MoveValue" } }, { "type": "object", "required": [ "fields", "type" ], "properties": { "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MoveValue" } }, "type": { "type": "string" } } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MoveValue" } } ] }, "MoveValue": { "anyOf": [ { "type": "integer", "format": "uint32", "minimum": 0.0 }, { "type": "boolean" }, { "$ref": "#/components/schemas/SuiAddress" }, { "type": "array", "items": { "$ref": "#/components/schemas/MoveValue" } }, { "type": "string" }, { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/ObjectID" } } }, { "$ref": "#/components/schemas/MoveStruct" }, { "anyOf": [ { "$ref": "#/components/schemas/MoveValue" }, { "type": "null" } ] }, { "$ref": "#/components/schemas/MoveVariant" } ] }, "MoveVariant": { "type": "object", "required": [ "fields", "type", "variant" ], "properties": { "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MoveValue" } }, "type": { "type": "string" }, "variant": { "type": "string" } } }, "MultiSig": { "description": "The struct that contains signatures and public keys necessary for authenticating a MultiSig.", "type": "object", "required": [ "bitmap", "multisig_pk", "sigs" ], "properties": { "bitmap": { "description": "A bitmap that indicates the position of which public key the signature should be authenticated with.", "type": "integer", "format": "uint16", "minimum": 0.0 }, "multisig_pk": { "description": "The public key encoded with each public key with its signature scheme used along with the corresponding weight.", "allOf": [ { "$ref": "#/components/schemas/MultiSigPublicKey" } ] }, "sigs": { "description": "The plain signature encoded with signature scheme.", "type": "array", "items": { "$ref": "#/components/schemas/CompressedSignature" } } } }, "MultiSigLegacy": { "description": "Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys necessary for authenticating a MultiSigLegacy.", "type": "object", "required": [ "bitmap", "multisig_pk", "sigs" ], "properties": { "bitmap": { "description": "A bitmap that indicates the position of which public key the signature should be authenticated with.", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] }, "multisig_pk": { "description": "The public key encoded with each public key with its signature scheme used along with the corresponding weight.", "allOf": [ { "$ref": "#/components/schemas/MultiSigPublicKeyLegacy" } ] }, "sigs": { "description": "The plain signature encoded with signature scheme.", "type": "array", "items": { "$ref": "#/components/schemas/CompressedSignature" } } } }, "MultiSigPublicKey": { "description": "The struct that contains the public key used for authenticating a MultiSig.", "type": "object", "required": [ "pk_map", "threshold" ], "properties": { "pk_map": { "description": "A list of public key and its corresponding weight.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/PublicKey" }, { "type": "integer", "format": "uint8", "minimum": 0.0 } ], "maxItems": 2, "minItems": 2 } }, "threshold": { "description": "If the total weight of the public keys corresponding to verified signatures is larger than threshold, the MultiSig is verified.", "type": "integer", "format": "uint16", "minimum": 0.0 } } }, "MultiSigPublicKeyLegacy": { "description": "Deprecated, use [struct MultiSigPublicKey] instead. The struct that contains the public key used for authenticating a MultiSig.", "type": "object", "required": [ "pk_map", "threshold" ], "properties": { "pk_map": { "description": "A list of public key and its corresponding weight.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/PublicKey" }, { "type": "integer", "format": "uint8", "minimum": 0.0 } ], "maxItems": 2, "minItems": 2 } }, "threshold": { "description": "If the total weight of the public keys corresponding to verified signatures is larger than threshold, the MultiSig is verified.", "type": "integer", "format": "uint16", "minimum": 0.0 } } }, "ObjectChange": { "description": "ObjectChange are derived from the object mutations in the TransactionEffect to provide richer object information.", "oneOf": [ { "description": "Module published", "type": "object", "required": [ "digest", "modules", "packageId", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "modules": { "type": "array", "items": { "type": "string" } }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "type": { "type": "string", "enum": [ "published" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "Transfer objects to new address / wrap in another object", "type": "object", "required": [ "digest", "objectId", "objectType", "recipient", "sender", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "recipient": { "$ref": "#/components/schemas/Owner" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "transferred" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "Object mutated.", "type": "object", "required": [ "digest", "objectId", "objectType", "owner", "previousVersion", "sender", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "owner": { "$ref": "#/components/schemas/Owner" }, "previousVersion": { "$ref": "#/components/schemas/SequenceNumber" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "mutated" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "Delete object", "type": "object", "required": [ "objectId", "objectType", "sender", "type", "version" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "deleted" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "Wrapped object", "type": "object", "required": [ "objectId", "objectType", "sender", "type", "version" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "wrapped" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "New object creation", "type": "object", "required": [ "digest", "objectId", "objectType", "owner", "sender", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "owner": { "$ref": "#/components/schemas/Owner" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "created" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } ] }, "ObjectData": { "type": "object", "required": [ "digest", "objectId", "version" ], "properties": { "bcs": { "description": "Move object content or package content in BCS, default to be None unless SuiObjectDataOptions.showBcs is set to true", "anyOf": [ { "$ref": "#/components/schemas/RawData" }, { "type": "null" } ] }, "content": { "description": "Move object content or package content, default to be None unless SuiObjectDataOptions.showContent is set to true", "anyOf": [ { "$ref": "#/components/schemas/Data" }, { "type": "null" } ] }, "digest": { "description": "Base64 string representing the object digest", "allOf": [ { "$ref": "#/components/schemas/ObjectDigest" } ] }, "display": { "description": "The Display metadata for frontend UI rendering, default to be None unless SuiObjectDataOptions.showContent is set to true This can also be None if the struct type does not have Display defined See more details in ", "anyOf": [ { "$ref": "#/components/schemas/DisplayFieldsResponse" }, { "type": "null" } ] }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "owner": { "description": "The owner of this object. Default to be None unless SuiObjectDataOptions.showOwner is set to true", "anyOf": [ { "$ref": "#/components/schemas/Owner" }, { "type": "null" } ] }, "previousTransaction": { "description": "The digest of the transaction that created or last mutated this object. Default to be None unless SuiObjectDataOptions.showPreviousTransaction is set to true", "anyOf": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "null" } ] }, "storageRebate": { "description": "The amount of SUI we would rebate if this object gets deleted. This number is re-calculated each time the object is mutated based on the present storage gas price.", "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "type": { "description": "The type of the object. Default to be None unless SuiObjectDataOptions.showType is set to true", "type": [ "string", "null" ] }, "version": { "description": "Object version.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber" } ] } } }, "ObjectDataOptions": { "type": "object", "properties": { "showBcs": { "description": "Whether to show the content in BCS format. Default to be False", "default": false, "type": "boolean" }, "showContent": { "description": "Whether to show the content(i.e., package content or Move struct content) of the object. Default to be False", "default": false, "type": "boolean" }, "showDisplay": { "description": "Whether to show the Display metadata of the object for frontend rendering. Default to be False", "default": false, "type": "boolean" }, "showOwner": { "description": "Whether to show the owner of the object. Default to be False", "default": false, "type": "boolean" }, "showPreviousTransaction": { "description": "Whether to show the previous transaction digest of the object. Default to be False", "default": false, "type": "boolean" }, "showStorageRebate": { "description": "Whether to show the storage rebate of the object. Default to be False", "default": false, "type": "boolean" }, "showType": { "description": "Whether to show the type of the object. Default to be False", "default": false, "type": "boolean" } } }, "ObjectDigest": { "$ref": "#/components/schemas/Digest" }, "ObjectID": { "$ref": "#/components/schemas/Hex" }, "ObjectRead": { "oneOf": [ { "description": "The object exists and is found with this version", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/ObjectData" }, "status": { "type": "string", "enum": [ "VersionFound" ] } } }, { "description": "The object does not exist", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/ObjectID" }, "status": { "type": "string", "enum": [ "ObjectNotExists" ] } } }, { "description": "The object is found to be deleted with this version", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/ObjectRef" }, "status": { "type": "string", "enum": [ "ObjectDeleted" ] } } }, { "description": "The object exists but not found with this version", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "type": "array", "items": [ { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SequenceNumber2" } ], "maxItems": 2, "minItems": 2 }, "status": { "type": "string", "enum": [ "VersionNotFound" ] } } }, { "description": "The asked object version is higher than the latest", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "type": "object", "required": [ "asked_version", "latest_version", "object_id" ], "properties": { "asked_version": { "$ref": "#/components/schemas/SequenceNumber2" }, "latest_version": { "$ref": "#/components/schemas/SequenceNumber2" }, "object_id": { "$ref": "#/components/schemas/ObjectID" } } }, "status": { "type": "string", "enum": [ "VersionTooHigh" ] } } } ] }, "ObjectRef": { "type": "object", "required": [ "digest", "objectId", "version" ], "properties": { "digest": { "description": "Base64 string representing the object digest", "allOf": [ { "$ref": "#/components/schemas/ObjectDigest" } ] }, "objectId": { "description": "Hex code as string representing the object id", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "version": { "description": "Object version.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber" } ] } } }, "ObjectResponseError": { "oneOf": [ { "type": "object", "required": [ "code", "object_id" ], "properties": { "code": { "type": "string", "enum": [ "notExists" ] }, "object_id": { "$ref": "#/components/schemas/ObjectID" } } }, { "type": "object", "required": [ "code", "parent_object_id" ], "properties": { "code": { "type": "string", "enum": [ "dynamicFieldNotFound" ] }, "parent_object_id": { "$ref": "#/components/schemas/ObjectID" } } }, { "type": "object", "required": [ "code", "digest", "object_id", "version" ], "properties": { "code": { "type": "string", "enum": [ "deleted" ] }, "digest": { "description": "Base64 string representing the object digest", "allOf": [ { "$ref": "#/components/schemas/ObjectDigest" } ] }, "object_id": { "$ref": "#/components/schemas/ObjectID" }, "version": { "description": "Object version.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } }, { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "unknown" ] } } }, { "type": "object", "required": [ "code", "error" ], "properties": { "code": { "type": "string", "enum": [ "displayError" ] }, "error": { "type": "string" } } } ] }, "ObjectResponseQuery": { "type": "object", "properties": { "filter": { "description": "If None, no filter will be applied", "default": null, "anyOf": [ { "$ref": "#/components/schemas/SuiObjectDataFilter" }, { "type": "null" } ] }, "options": { "description": "config which fields to include in the response, by default only digest is included", "default": null, "anyOf": [ { "$ref": "#/components/schemas/ObjectDataOptions" }, { "type": "null" } ] } } }, "ObjectValueKind": { "type": "string", "enum": [ "ByImmutableReference", "ByMutableReference", "ByValue" ] }, "OwnedObjectRef": { "type": "object", "required": [ "owner", "reference" ], "properties": { "owner": { "$ref": "#/components/schemas/Owner" }, "reference": { "$ref": "#/components/schemas/ObjectRef" } } }, "Owner": { "oneOf": [ { "description": "Object is exclusively owned by a single address, and is mutable.", "type": "object", "required": [ "AddressOwner" ], "properties": { "AddressOwner": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Object is exclusively owned by a single object, and is mutable. The object ID is converted to SuiAddress as SuiAddress is universal.", "type": "object", "required": [ "ObjectOwner" ], "properties": { "ObjectOwner": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Object is shared, can be used by any address, and is mutable.", "type": "object", "required": [ "Shared" ], "properties": { "Shared": { "type": "object", "required": [ "initial_shared_version" ], "properties": { "initial_shared_version": { "description": "The version at which the object became shared", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } } }, "additionalProperties": false }, { "description": "Object is immutable, and hence ownership doesn't matter.", "type": "string", "enum": [ "Immutable" ] }, { "description": "Object is exclusively owned by a single address and sequenced via consensus.", "type": "object", "required": [ "ConsensusAddressOwner" ], "properties": { "ConsensusAddressOwner": { "type": "object", "required": [ "owner", "start_version" ], "properties": { "owner": { "$ref": "#/components/schemas/SuiAddress" }, "start_version": { "description": "The version at which the object most recently became a consensus object. This serves the same function as `initial_shared_version`, except it may change if the object's Owner type changes.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } } }, "additionalProperties": false } ] }, "Page_for_Checkpoint_and_BigInt_for_uint64": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Checkpoint" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, "Page_for_Coin_and_String": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Coin" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] } } }, "Page_for_DynamicFieldInfo_and_ObjectID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicFieldInfo" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] } } }, "Page_for_Event_and_EventID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/EventID" }, { "type": "null" } ] } } }, "Page_for_String_and_ObjectID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "type": "string" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] } } }, "Page_for_SuiObjectResponse_and_ObjectID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectResponse" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] } } }, "Page_for_TransactionBlockResponse_and_TransactionDigest": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionBlockResponse" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "null" } ] } } }, "PasskeyAuthenticator": { "description": "An passkey authenticator with parsed fields. See field defition below. Can be initialized from [struct RawPasskeyAuthenticator].", "type": "object", "required": [ "authenticator_data", "client_data_json" ], "properties": { "authenticator_data": { "description": "`authenticatorData` is a bytearray that encodes [Authenticator Data](https://www.w3.org/TR/webauthn-2/#sctn-authenticator-data) structure returned by the authenticator attestation response as is.", "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "client_data_json": { "description": "`clientDataJSON` contains a JSON-compatible UTF-8 encoded string of the client data which is passed to the authenticator by the client during the authentication request (see [CollectedClientData](https://www.w3.org/TR/webauthn-2/#dictdef-collectedclientdata))", "type": "string" } } }, "PasskeyAuthenticatorAsBytes": { "$ref": "#/components/schemas/Base64" }, "ProtocolConfig": { "type": "object", "required": [ "attributes", "featureFlags", "maxSupportedProtocolVersion", "minSupportedProtocolVersion", "protocolVersion" ], "properties": { "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/ProtocolConfigValue" }, { "type": "null" } ] } }, "featureFlags": { "type": "object", "additionalProperties": { "type": "boolean" } }, "maxSupportedProtocolVersion": { "$ref": "#/components/schemas/ProtocolVersion" }, "minSupportedProtocolVersion": { "$ref": "#/components/schemas/ProtocolVersion" }, "protocolVersion": { "$ref": "#/components/schemas/ProtocolVersion" } } }, "ProtocolConfigValue": { "oneOf": [ { "type": "object", "required": [ "u16" ], "properties": { "u16": { "$ref": "#/components/schemas/BigInt_for_uint16" } }, "additionalProperties": false }, { "type": "object", "required": [ "u32" ], "properties": { "u32": { "$ref": "#/components/schemas/BigInt_for_uint32" } }, "additionalProperties": false }, { "type": "object", "required": [ "u64" ], "properties": { "u64": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "additionalProperties": false }, { "type": "object", "required": [ "f64" ], "properties": { "f64": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "bool" ], "properties": { "bool": { "type": "string" } }, "additionalProperties": false } ] }, "ProtocolVersion": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "PublicKey": { "oneOf": [ { "type": "object", "required": [ "Ed25519" ], "properties": { "Ed25519": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256k1" ], "properties": { "Secp256k1": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256r1" ], "properties": { "Secp256r1": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "ZkLogin" ], "properties": { "ZkLogin": { "$ref": "#/components/schemas/ZkLoginPublicIdentifier" } }, "additionalProperties": false }, { "type": "object", "required": [ "Passkey" ], "properties": { "Passkey": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false } ] }, "RPCTransactionRequestParams": { "oneOf": [ { "type": "object", "required": [ "transferObjectRequestParams" ], "properties": { "transferObjectRequestParams": { "$ref": "#/components/schemas/TransferObjectParams" } }, "additionalProperties": false }, { "type": "object", "required": [ "moveCallRequestParams" ], "properties": { "moveCallRequestParams": { "$ref": "#/components/schemas/MoveCallParams" } }, "additionalProperties": false } ] }, "RawData": { "oneOf": [ { "type": "object", "required": [ "bcsBytes", "dataType", "hasPublicTransfer", "type", "version" ], "properties": { "bcsBytes": { "$ref": "#/components/schemas/Base64" }, "dataType": { "type": "string", "enum": [ "moveObject" ] }, "hasPublicTransfer": { "type": "boolean" }, "type": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber2" } } }, { "type": "object", "required": [ "dataType", "id", "linkageTable", "moduleMap", "typeOriginTable", "version" ], "properties": { "dataType": { "type": "string", "enum": [ "package" ] }, "id": { "$ref": "#/components/schemas/ObjectID" }, "linkageTable": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UpgradeInfo" } }, "moduleMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Base64" } }, "typeOriginTable": { "type": "array", "items": { "$ref": "#/components/schemas/TypeOrigin" } }, "version": { "$ref": "#/components/schemas/SequenceNumber2" } } } ] }, "Secp256k1SuiSignature": { "$ref": "#/components/schemas/Base64" }, "Secp256r1SuiSignature": { "$ref": "#/components/schemas/Base64" }, "SequenceNumber": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "SequenceNumber2": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "Signature": { "oneOf": [ { "type": "object", "required": [ "Ed25519SuiSignature" ], "properties": { "Ed25519SuiSignature": { "$ref": "#/components/schemas/Ed25519SuiSignature" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256k1SuiSignature" ], "properties": { "Secp256k1SuiSignature": { "$ref": "#/components/schemas/Secp256k1SuiSignature" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256r1SuiSignature" ], "properties": { "Secp256r1SuiSignature": { "$ref": "#/components/schemas/Secp256r1SuiSignature" } }, "additionalProperties": false } ] }, "Stake": { "type": "object", "oneOf": [ { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Pending" ] } } }, { "type": "object", "required": [ "estimatedReward", "status" ], "properties": { "estimatedReward": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "status": { "type": "string", "enum": [ "Active" ] } } }, { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Unstaked" ] } } } ], "required": [ "principal", "stakeActiveEpoch", "stakeRequestEpoch", "stakedSuiId" ], "properties": { "principal": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "stakeActiveEpoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "stakeRequestEpoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "stakedSuiId": { "description": "ID of the StakedSui receipt object.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] } } }, "SuiActiveJwk": { "type": "object", "required": [ "epoch", "jwk", "jwk_id" ], "properties": { "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "jwk": { "$ref": "#/components/schemas/SuiJWK" }, "jwk_id": { "$ref": "#/components/schemas/SuiJwkId" } } }, "SuiAddress": { "$ref": "#/components/schemas/Hex" }, "SuiArgument": { "description": "An argument to a transaction in a programmable transaction block", "oneOf": [ { "description": "The gas coin. The gas coin can only be used by-ref, except for with `TransferObjects`, which can use it by-value.", "type": "string", "enum": [ "GasCoin" ] }, { "description": "One of the input objects or primitive values (from `ProgrammableTransactionBlock` inputs)", "type": "object", "required": [ "Input" ], "properties": { "Input": { "type": "integer", "format": "uint16", "minimum": 0.0 } }, "additionalProperties": false }, { "description": "The result of another transaction (from `ProgrammableTransactionBlock` transactions)", "type": "object", "required": [ "Result" ], "properties": { "Result": { "type": "integer", "format": "uint16", "minimum": 0.0 } }, "additionalProperties": false }, { "description": "Like a `Result` but it accesses a nested result. Currently, the only usage of this is to access a value from a Move call with multiple return values.", "type": "object", "required": [ "NestedResult" ], "properties": { "NestedResult": { "type": "array", "items": [ { "type": "integer", "format": "uint16", "minimum": 0.0 }, { "type": "integer", "format": "uint16", "minimum": 0.0 } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false } ] }, "SuiAuthenticatorStateExpire": { "type": "object", "required": [ "min_epoch" ], "properties": { "min_epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "SuiCallArg": { "oneOf": [ { "type": "object", "oneOf": [ { "type": "object", "required": [ "digest", "objectId", "objectType", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string", "enum": [ "immOrOwnedObject" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "type": "object", "required": [ "initialSharedVersion", "mutable", "objectId", "objectType" ], "properties": { "initialSharedVersion": { "$ref": "#/components/schemas/SequenceNumber" }, "mutable": { "type": "boolean" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string", "enum": [ "sharedObject" ] } } }, { "type": "object", "required": [ "digest", "objectId", "objectType", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string", "enum": [ "receiving" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } ], "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "object" ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "pure" ] }, "value": { "$ref": "#/components/schemas/SuiJsonValue" }, "valueType": { "default": null, "type": [ "string", "null" ] } } }, { "type": "object", "required": [ "reservation", "type", "typeArg", "withdrawFrom" ], "properties": { "reservation": { "$ref": "#/components/schemas/SuiReservation" }, "type": { "type": "string", "enum": [ "fundsWithdrawal" ] }, "typeArg": { "$ref": "#/components/schemas/SuiWithdrawalTypeArg" }, "withdrawFrom": { "$ref": "#/components/schemas/SuiWithdrawFrom" } } } ] }, "SuiChangeEpoch": { "type": "object", "required": [ "computation_charge", "epoch", "epoch_start_timestamp_ms", "storage_charge", "storage_rebate" ], "properties": { "computation_charge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch_start_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storage_charge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storage_rebate": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "SuiCoinMetadata": { "type": "object", "required": [ "decimals", "description", "name", "symbol" ], "properties": { "decimals": { "description": "Number of decimal places the coin uses.", "type": "integer", "format": "uint8", "minimum": 0.0 }, "description": { "description": "Description of the token", "type": "string" }, "iconUrl": { "description": "URL for the token logo", "type": [ "string", "null" ] }, "id": { "description": "Object id for the CoinMetadata object", "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] }, "name": { "description": "Name for the token", "type": "string" }, "symbol": { "description": "Symbol for the token", "type": "string" } } }, "SuiEndOfEpochTransactionKind": { "oneOf": [ { "type": "string", "enum": [ "AuthenticatorStateCreate", "RandomnessStateCreate", "CoinDenyListStateCreate", "StoreExecutionTimeObservations", "AccumulatorRootCreate", "CoinRegistryCreate", "DisplayRegistryCreate", "AddressAliasStateCreate", "WriteAccumulatorStorageCost" ] }, { "type": "object", "required": [ "ChangeEpoch" ], "properties": { "ChangeEpoch": { "$ref": "#/components/schemas/SuiChangeEpoch" } }, "additionalProperties": false }, { "type": "object", "required": [ "AuthenticatorStateExpire" ], "properties": { "AuthenticatorStateExpire": { "$ref": "#/components/schemas/SuiAuthenticatorStateExpire" } }, "additionalProperties": false }, { "type": "object", "required": [ "BridgeStateCreate" ], "properties": { "BridgeStateCreate": { "$ref": "#/components/schemas/CheckpointDigest" } }, "additionalProperties": false }, { "type": "object", "required": [ "BridgeCommitteeUpdate" ], "properties": { "BridgeCommitteeUpdate": { "$ref": "#/components/schemas/SequenceNumber2" } }, "additionalProperties": false } ] }, "SuiExecutionResult": { "type": "object", "properties": { "mutableReferenceOutputs": { "description": "The value of any arguments that were mutably borrowed. Non-mut borrowed values are not included", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiArgument" }, { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, { "$ref": "#/components/schemas/TypeTag" } ], "maxItems": 3, "minItems": 3 } }, "returnValues": { "description": "The return values from the transaction", "type": "array", "items": { "type": "array", "items": [ { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, { "$ref": "#/components/schemas/TypeTag" } ], "maxItems": 2, "minItems": 2 } } } }, "SuiJWK": { "type": "object", "required": [ "alg", "e", "kty", "n" ], "properties": { "alg": { "type": "string" }, "e": { "type": "string" }, "kty": { "type": "string" }, "n": { "type": "string" } } }, "SuiJsonValue": {}, "SuiJwkId": { "type": "object", "required": [ "iss", "kid" ], "properties": { "iss": { "type": "string" }, "kid": { "type": "string" } } }, "SuiMoveAbility": { "type": "string", "enum": [ "Copy", "Drop", "Store", "Key" ] }, "SuiMoveAbilitySet": { "type": "object", "required": [ "abilities" ], "properties": { "abilities": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveAbility" } } } }, "SuiMoveAbort": { "type": "object", "properties": { "error_code": { "type": [ "integer", "null" ], "format": "uint64", "minimum": 0.0 }, "function": { "type": [ "string", "null" ] }, "line": { "type": [ "integer", "null" ], "format": "uint16", "minimum": 0.0 }, "module_id": { "type": [ "string", "null" ] } } }, "SuiMoveModuleId": { "type": "object", "required": [ "address", "name" ], "properties": { "address": { "type": "string" }, "name": { "type": "string" } } }, "SuiMoveNormalizedEnum": { "type": "object", "required": [ "abilities", "typeParameters", "variants" ], "properties": { "abilities": { "$ref": "#/components/schemas/SuiMoveAbilitySet" }, "typeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveStructTypeParameter" } }, "variantDeclarationOrder": { "default": null, "type": [ "array", "null" ], "items": { "type": "string" } }, "variants": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedField" } } } } }, "SuiMoveNormalizedField": { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } } }, "SuiMoveNormalizedFunction": { "type": "object", "required": [ "isEntry", "parameters", "return", "typeParameters", "visibility" ], "properties": { "isEntry": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "return": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "typeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveAbilitySet" } }, "visibility": { "$ref": "#/components/schemas/SuiMoveVisibility" } } }, "SuiMoveNormalizedModule": { "type": "object", "required": [ "address", "exposedFunctions", "fileFormatVersion", "friends", "name", "structs" ], "properties": { "address": { "type": "string" }, "enums": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedEnum" } }, "exposedFunctions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedFunction" } }, "fileFormatVersion": { "type": "integer", "format": "uint32", "minimum": 0.0 }, "friends": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveModuleId" } }, "name": { "type": "string" }, "structs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedStruct" } } } }, "SuiMoveNormalizedStruct": { "type": "object", "required": [ "abilities", "fields", "typeParameters" ], "properties": { "abilities": { "$ref": "#/components/schemas/SuiMoveAbilitySet" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedField" } }, "typeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveStructTypeParameter" } } } }, "SuiMoveNormalizedType": { "oneOf": [ { "type": "string", "enum": [ "Bool", "U8", "U16", "U32", "U64", "U128", "U256", "Address", "Signer" ] }, { "type": "object", "required": [ "Struct" ], "properties": { "Struct": { "type": "object", "required": [ "address", "module", "name", "typeArguments" ], "properties": { "address": { "type": "string" }, "module": { "type": "string" }, "name": { "type": "string" }, "typeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } } } } }, "additionalProperties": false }, { "type": "object", "required": [ "Vector" ], "properties": { "Vector": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "additionalProperties": false }, { "type": "object", "required": [ "TypeParameter" ], "properties": { "TypeParameter": { "type": "integer", "format": "uint16", "minimum": 0.0 } }, "additionalProperties": false }, { "type": "object", "required": [ "Reference" ], "properties": { "Reference": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "additionalProperties": false }, { "type": "object", "required": [ "MutableReference" ], "properties": { "MutableReference": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "additionalProperties": false } ] }, "SuiMoveStructTypeParameter": { "type": "object", "required": [ "constraints", "isPhantom" ], "properties": { "constraints": { "$ref": "#/components/schemas/SuiMoveAbilitySet" }, "isPhantom": { "type": "boolean" } } }, "SuiMoveVisibility": { "type": "string", "enum": [ "Private", "Public", "Friend" ] }, "SuiObjectDataFilter": { "oneOf": [ { "type": "object", "required": [ "MatchAll" ], "properties": { "MatchAll": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectDataFilter" } } }, "additionalProperties": false }, { "type": "object", "required": [ "MatchAny" ], "properties": { "MatchAny": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectDataFilter" } } }, "additionalProperties": false }, { "type": "object", "required": [ "MatchNone" ], "properties": { "MatchNone": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectDataFilter" } } }, "additionalProperties": false }, { "description": "Query by type a specified Package.", "type": "object", "required": [ "Package" ], "properties": { "Package": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "description": "Query by type a specified Move module.", "type": "object", "required": [ "MoveModule" ], "properties": { "MoveModule": { "type": "object", "required": [ "module", "package" ], "properties": { "module": { "description": "the module name", "type": "string" }, "package": { "description": "the Move package ID", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] } } } }, "additionalProperties": false }, { "description": "Query by type", "type": "object", "required": [ "StructType" ], "properties": { "StructType": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "AddressOwner" ], "properties": { "AddressOwner": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "type": "object", "required": [ "ObjectOwner" ], "properties": { "ObjectOwner": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "type": "object", "required": [ "ObjectId" ], "properties": { "ObjectId": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "type": "object", "required": [ "ObjectIds" ], "properties": { "ObjectIds": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, "additionalProperties": false }, { "type": "object", "required": [ "Version" ], "properties": { "Version": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "additionalProperties": false } ] }, "SuiObjectResponse": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/ObjectData" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ObjectResponseError" }, { "type": "null" } ] } } }, "SuiProgrammableMoveCall": { "description": "The transaction for calling a Move function, either an entry function or a public function (which cannot return references).", "type": "object", "required": [ "function", "module", "package" ], "properties": { "arguments": { "description": "The arguments to the function.", "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } }, "function": { "description": "The function to be called.", "type": "string" }, "module": { "description": "The specific module in the package containing the function.", "type": "string" }, "package": { "description": "The package containing the module and function.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "type_arguments": { "description": "The type arguments to the function.", "type": "array", "items": { "type": "string" } } } }, "SuiReservation": { "oneOf": [ { "type": "object", "required": [ "maxAmountU64" ], "properties": { "maxAmountU64": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "additionalProperties": false } ] }, "SuiSystemStateSummary": { "description": "This is the JSON-RPC type for the SUI system state object. It flattens all fields to make them top-level fields such that it as minimum dependencies to the internal data structures of the SUI system state type.", "type": "object", "required": [ "activeValidators", "atRiskValidators", "epoch", "epochDurationMs", "epochStartTimestampMs", "inactivePoolsId", "inactivePoolsSize", "maxValidatorCount", "minValidatorJoiningStake", "pendingActiveValidatorsId", "pendingActiveValidatorsSize", "pendingRemovals", "protocolVersion", "referenceGasPrice", "safeMode", "safeModeComputationRewards", "safeModeNonRefundableStorageFee", "safeModeStorageRebates", "safeModeStorageRewards", "stakeSubsidyBalance", "stakeSubsidyCurrentDistributionAmount", "stakeSubsidyDecreaseRate", "stakeSubsidyDistributionCounter", "stakeSubsidyPeriodLength", "stakeSubsidyStartEpoch", "stakingPoolMappingsId", "stakingPoolMappingsSize", "storageFundNonRefundableBalance", "storageFundTotalObjectStorageRebates", "systemStateVersion", "totalStake", "validatorCandidatesId", "validatorCandidatesSize", "validatorLowStakeGracePeriod", "validatorLowStakeThreshold", "validatorReportRecords", "validatorVeryLowStakeThreshold" ], "properties": { "activeValidators": { "description": "The list of active validators in the current epoch.", "type": "array", "items": { "$ref": "#/components/schemas/SuiValidatorSummary" } }, "atRiskValidators": { "description": "Map storing the number of epochs for which each validator has been below the low stake threshold.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiAddress" }, { "$ref": "#/components/schemas/BigInt_for_uint64" } ], "maxItems": 2, "minItems": 2 } }, "epoch": { "description": "The current epoch ID, starting from 0.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "epochDurationMs": { "description": "The duration of an epoch, in milliseconds.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "epochStartTimestampMs": { "description": "Unix timestamp of the current epoch start", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "inactivePoolsId": { "description": "ID of the object that maps from a staking pool ID to the inactive validator that has that pool as its staking pool.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "inactivePoolsSize": { "description": "Number of inactive staking pools.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "maxValidatorCount": { "description": "Maximum number of active validators at any moment. We do not allow the number of validators in any epoch to go above this.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "minValidatorJoiningStake": { "description": "Lower-bound on the amount of stake required to become a validator.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "pendingActiveValidatorsId": { "description": "ID of the object that contains the list of new validators that will join at the end of the epoch.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "pendingActiveValidatorsSize": { "description": "Number of new validators that will join at the end of the epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "pendingRemovals": { "description": "Removal requests from the validators. Each element is an index pointing to `active_validators`.", "type": "array", "items": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "protocolVersion": { "description": "The current protocol version, starting from 1.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "referenceGasPrice": { "description": "The reference gas price for the current epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "safeMode": { "description": "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.", "type": "boolean" }, "safeModeComputationRewards": { "description": "Amount of computation rewards accumulated (and not yet distributed) during safe mode.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "safeModeNonRefundableStorageFee": { "description": "Amount of non-refundable storage fee accumulated during safe mode.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "safeModeStorageRebates": { "description": "Amount of storage rebates accumulated (and not yet burned) during safe mode.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "safeModeStorageRewards": { "description": "Amount of storage rewards accumulated (and not yet distributed) during safe mode.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyBalance": { "description": "Balance of SUI set aside for stake subsidies that will be drawn down over time.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyCurrentDistributionAmount": { "description": "The amount of stake subsidy to be drawn down per epoch. This amount decays and decreases over time.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyDecreaseRate": { "description": "The rate at which the distribution amount decays at the end of each period. Expressed in basis points.", "type": "integer", "format": "uint16", "minimum": 0.0 }, "stakeSubsidyDistributionCounter": { "description": "This counter may be different from the current epoch number if in some epochs we decide to skip the subsidy.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyPeriodLength": { "description": "Number of distributions to occur before the distribution amount decays.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyStartEpoch": { "description": "The starting epoch in which stake subsidies start being paid out", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakingPoolMappingsId": { "description": "ID of the object that maps from staking pool's ID to the sui address of a validator.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "stakingPoolMappingsSize": { "description": "Number of staking pool mappings.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "storageFundNonRefundableBalance": { "description": "The non-refundable portion of the storage fund coming from storage reinvestment, non-refundable storage rebates and any leftover staking rewards.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "storageFundTotalObjectStorageRebates": { "description": "The storage rebates of all the objects on-chain stored in the storage fund.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "systemStateVersion": { "description": "The current version of the system state data structure type.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "totalStake": { "description": "Total amount of stake from all active validators at the beginning of the epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "validatorCandidatesId": { "description": "ID of the object that stores preactive validators, mapping their addresses to their `Validator` structs.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "validatorCandidatesSize": { "description": "Number of preactive validators.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "validatorLowStakeGracePeriod": { "description": "A validator can have stake below `validator_low_stake_threshold` for this many epochs before being kicked out.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "validatorLowStakeThreshold": { "description": "Validators with stake amount below `validator_low_stake_threshold` are considered to have low stake and will be escorted out of the validator set after being below this threshold for more than `validator_low_stake_grace_period` number of epochs.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "validatorReportRecords": { "description": "A map storing the records of validator reporting each other.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiAddress" }, { "type": "array", "items": { "$ref": "#/components/schemas/SuiAddress" } } ], "maxItems": 2, "minItems": 2 } }, "validatorVeryLowStakeThreshold": { "description": "Validators with stake below `validator_very_low_stake_threshold` will be removed immediately at epoch change, no grace period.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] } } }, "SuiTransaction": { "description": "A single transaction in a programmable transaction block.", "oneOf": [ { "description": "A call to either an entry or a public Move function", "type": "object", "required": [ "MoveCall" ], "properties": { "MoveCall": { "$ref": "#/components/schemas/SuiProgrammableMoveCall" } }, "additionalProperties": false }, { "description": "`(Vec, address)` It sends n-objects to the specified address. These objects must have store (public transfer) and either the previous owner must be an address or the object must be newly created.", "type": "object", "required": [ "TransferObjects" ], "properties": { "TransferObjects": { "type": "array", "items": [ { "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } }, { "$ref": "#/components/schemas/SuiArgument" } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "description": "`(&mut Coin, Vec)` -> `Vec>` It splits off some amounts into a new coins with those amounts", "type": "object", "required": [ "SplitCoins" ], "properties": { "SplitCoins": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiArgument" }, { "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "description": "`(&mut Coin, Vec>)` It merges n-coins into the first coin", "type": "object", "required": [ "MergeCoins" ], "properties": { "MergeCoins": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiArgument" }, { "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "description": "Publishes a Move package. It takes the package bytes and a list of the package's transitive dependencies to link against on-chain.", "type": "object", "required": [ "Publish" ], "properties": { "Publish": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, "additionalProperties": false }, { "description": "Upgrades a Move package", "type": "object", "required": [ "Upgrade" ], "properties": { "Upgrade": { "type": "array", "items": [ { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } }, { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SuiArgument" } ], "maxItems": 3, "minItems": 3 } }, "additionalProperties": false }, { "description": "`forall T: Vec -> vector` Given n-values of the same type, it constructs a vector. For non objects or an empty vector, the type tag must be specified.", "type": "object", "required": [ "MakeMoveVec" ], "properties": { "MakeMoveVec": { "type": "array", "items": [ { "type": [ "string", "null" ] }, { "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false } ] }, "SuiTransactionBlockBuilderMode": { "oneOf": [ { "description": "Regular Sui Transactions that are committed on chain", "type": "string", "enum": [ "Commit" ] }, { "description": "Simulated transaction that allows calling any Move function with arbitrary values.", "type": "string", "enum": [ "DevInspect" ] } ] }, "SuiValidatorSummary": { "description": "This is the JSON-RPC type for the SUI validator. It flattens all inner structures to top-level fields so that they are decoupled from the internal definitions.", "type": "object", "required": [ "commissionRate", "description", "exchangeRatesId", "exchangeRatesSize", "gasPrice", "imageUrl", "name", "netAddress", "networkPubkeyBytes", "nextEpochCommissionRate", "nextEpochGasPrice", "nextEpochStake", "operationCapId", "p2pAddress", "pendingPoolTokenWithdraw", "pendingStake", "pendingTotalSuiWithdraw", "poolTokenBalance", "primaryAddress", "projectUrl", "proofOfPossessionBytes", "protocolPubkeyBytes", "rewardsPool", "stakingPoolId", "stakingPoolSuiBalance", "suiAddress", "votingPower", "workerAddress", "workerPubkeyBytes" ], "properties": { "commissionRate": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "description": { "type": "string" }, "exchangeRatesId": { "description": "ID of the exchange rate table object.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "exchangeRatesSize": { "description": "Number of exchange rates in the table.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "gasPrice": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "imageUrl": { "type": "string" }, "name": { "type": "string" }, "netAddress": { "type": "string" }, "networkPubkeyBytes": { "$ref": "#/components/schemas/Base64" }, "nextEpochCommissionRate": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "nextEpochGasPrice": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "nextEpochNetAddress": { "type": [ "string", "null" ] }, "nextEpochNetworkPubkeyBytes": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/Base64" }, { "type": "null" } ] }, "nextEpochP2pAddress": { "type": [ "string", "null" ] }, "nextEpochPrimaryAddress": { "type": [ "string", "null" ] }, "nextEpochProofOfPossession": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/Base64" }, { "type": "null" } ] }, "nextEpochProtocolPubkeyBytes": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/Base64" }, { "type": "null" } ] }, "nextEpochStake": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "nextEpochWorkerAddress": { "type": [ "string", "null" ] }, "nextEpochWorkerPubkeyBytes": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/Base64" }, { "type": "null" } ] }, "operationCapId": { "$ref": "#/components/schemas/ObjectID" }, "p2pAddress": { "type": "string" }, "pendingPoolTokenWithdraw": { "description": "Pending pool token withdrawn during the current epoch, emptied at epoch boundaries.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "pendingStake": { "description": "Pending stake amount for this epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "pendingTotalSuiWithdraw": { "description": "Pending stake withdrawn during the current epoch, emptied at epoch boundaries.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "poolTokenBalance": { "description": "Total number of pool tokens issued by the pool.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "primaryAddress": { "type": "string" }, "projectUrl": { "type": "string" }, "proofOfPossessionBytes": { "$ref": "#/components/schemas/Base64" }, "protocolPubkeyBytes": { "$ref": "#/components/schemas/Base64" }, "rewardsPool": { "description": "The epoch stake rewards will be added here at the end of each epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakingPoolActivationEpoch": { "description": "The epoch at which this pool became active.", "default": null, "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "stakingPoolDeactivationEpoch": { "description": "The epoch at which this staking pool ceased to be active. `None` = {pre-active, active},", "default": null, "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "stakingPoolId": { "description": "ID of the staking pool object.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "stakingPoolSuiBalance": { "description": "The total number of SUI tokens in this pool.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "suiAddress": { "$ref": "#/components/schemas/SuiAddress" }, "votingPower": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "workerAddress": { "type": "string" }, "workerPubkeyBytes": { "$ref": "#/components/schemas/Base64" } } }, "SuiWithdrawFrom": { "type": "string", "enum": [ "sender", "sponsor" ] }, "SuiWithdrawalTypeArg": { "oneOf": [ { "type": "object", "required": [ "balance" ], "properties": { "balance": { "$ref": "#/components/schemas/TypeTag" } }, "additionalProperties": false } ] }, "Supply": { "type": "object", "required": [ "value" ], "properties": { "value": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "TransactionBlock": { "type": "object", "required": [ "data", "txSignatures" ], "properties": { "data": { "$ref": "#/components/schemas/TransactionBlockData" }, "txSignatures": { "type": "array", "items": { "$ref": "#/components/schemas/GenericSignature" } } } }, "TransactionBlockBytes": { "type": "object", "required": [ "gas", "inputObjects", "txBytes" ], "properties": { "gas": { "description": "the gas objects to be used", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "inputObjects": { "description": "objects to be used in this transaction", "type": "array", "items": { "$ref": "#/components/schemas/InputObjectKind" } }, "txBytes": { "description": "BCS serialized transaction data bytes without its type tag, as base-64 encoded string.", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] } } }, "TransactionBlockData": { "oneOf": [ { "type": "object", "required": [ "gasData", "messageVersion", "sender", "transaction" ], "properties": { "gasData": { "$ref": "#/components/schemas/GasData" }, "messageVersion": { "type": "string", "enum": [ "v1" ] }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transaction": { "$ref": "#/components/schemas/TransactionBlockKind" } } } ] }, "TransactionBlockEffects": { "oneOf": [ { "description": "The response from processing a transaction or a certified transaction", "type": "object", "required": [ "executedEpoch", "gasObject", "gasUsed", "messageVersion", "status", "transactionDigest" ], "properties": { "abortError": { "description": "The abort error populated if the transaction failed with an abort code.", "anyOf": [ { "$ref": "#/components/schemas/SuiMoveAbort" }, { "type": "null" } ] }, "accumulatorEvents": { "type": "array", "items": { "$ref": "#/components/schemas/AccumulatorEvent" } }, "created": { "description": "ObjectRef and owner of new objects created.", "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "deleted": { "description": "Object Refs of objects now deleted (the old refs).", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "dependencies": { "description": "The set of transaction digests this transaction depends on.", "type": "array", "items": { "$ref": "#/components/schemas/TransactionDigest" } }, "eventsDigest": { "description": "The digest of the events emitted during execution, can be None if the transaction does not emit any event.", "anyOf": [ { "$ref": "#/components/schemas/TransactionEventsDigest" }, { "type": "null" } ] }, "executedEpoch": { "description": "The epoch when this transaction was executed.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "gasObject": { "description": "The updated gas object reference. Have a dedicated field for convenient access. It's also included in mutated.", "allOf": [ { "$ref": "#/components/schemas/OwnedObjectRef" } ] }, "gasUsed": { "$ref": "#/components/schemas/GasCostSummary" }, "messageVersion": { "type": "string", "enum": [ "v1" ] }, "modifiedAtVersions": { "description": "The version that every modified (mutated or deleted) object had before it was modified by this transaction.", "type": "array", "items": { "$ref": "#/components/schemas/TransactionBlockEffectsModifiedAtVersions" } }, "mutated": { "description": "ObjectRef and owner of mutated objects, including gas object.", "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "sharedObjects": { "description": "The object references of the shared objects used in this transaction. Empty if no shared objects were used.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "status": { "description": "The status of the execution", "allOf": [ { "$ref": "#/components/schemas/ExecutionStatus" } ] }, "transactionDigest": { "description": "The transaction digest", "allOf": [ { "$ref": "#/components/schemas/TransactionDigest" } ] }, "unwrapped": { "description": "ObjectRef and owner of objects that are unwrapped in this transaction. Unwrapped objects are objects that were wrapped into other objects in the past, and just got extracted out.", "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "unwrappedThenDeleted": { "description": "Object refs of objects previously wrapped in other objects but now deleted.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "wrapped": { "description": "Object refs of objects now wrapped in other objects.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } } } } ] }, "TransactionBlockEffectsModifiedAtVersions": { "type": "object", "required": [ "objectId", "sequenceNumber" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "sequenceNumber": { "$ref": "#/components/schemas/SequenceNumber" } } }, "TransactionBlockKind": { "oneOf": [ { "description": "A system transaction that will update epoch information on-chain.", "type": "object", "required": [ "computation_charge", "epoch", "epoch_start_timestamp_ms", "kind", "storage_charge", "storage_rebate" ], "properties": { "computation_charge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch_start_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ChangeEpoch" ] }, "storage_charge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storage_rebate": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "description": "A system transaction used for initializing the initial state of the chain.", "type": "object", "required": [ "kind", "objects" ], "properties": { "kind": { "type": "string", "enum": [ "Genesis" ] }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } } }, { "description": "A system transaction marking the start of a series of transactions scheduled as part of a checkpoint", "type": "object", "required": [ "commit_timestamp_ms", "epoch", "kind", "round" ], "properties": { "commit_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ConsensusCommitPrologue" ] }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "description": "A series of transactions where the results of one transaction can be used in future transactions", "type": "object", "required": [ "inputs", "kind", "transactions" ], "properties": { "inputs": { "description": "Input objects or primitive values", "type": "array", "items": { "$ref": "#/components/schemas/SuiCallArg" } }, "kind": { "type": "string", "enum": [ "ProgrammableTransaction" ] }, "transactions": { "description": "The transactions to be executed sequentially. A failure in any transaction will result in the failure of the entire programmable transaction block.", "type": "array", "items": { "$ref": "#/components/schemas/SuiTransaction" } } } }, { "description": "A transaction which updates global authenticator state", "type": "object", "required": [ "epoch", "kind", "new_active_jwks", "round" ], "properties": { "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "AuthenticatorStateUpdate" ] }, "new_active_jwks": { "type": "array", "items": { "$ref": "#/components/schemas/SuiActiveJwk" } }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "description": "A transaction which updates global randomness state", "type": "object", "required": [ "epoch", "kind", "random_bytes", "randomness_round" ], "properties": { "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "RandomnessStateUpdate" ] }, "random_bytes": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "randomness_round": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "description": "The transaction which occurs only at the end of the epoch", "type": "object", "required": [ "kind", "transactions" ], "properties": { "kind": { "type": "string", "enum": [ "EndOfEpochTransaction" ] }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/SuiEndOfEpochTransactionKind" } } } }, { "type": "object", "required": [ "commit_timestamp_ms", "consensus_commit_digest", "epoch", "kind", "round" ], "properties": { "commit_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "consensus_commit_digest": { "$ref": "#/components/schemas/ConsensusCommitDigest" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ConsensusCommitPrologueV2" ] }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "type": "object", "required": [ "commit_timestamp_ms", "consensus_commit_digest", "consensus_determined_version_assignments", "epoch", "kind", "round" ], "properties": { "commit_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "consensus_commit_digest": { "$ref": "#/components/schemas/ConsensusCommitDigest" }, "consensus_determined_version_assignments": { "$ref": "#/components/schemas/ConsensusDeterminedVersionAssignments" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ConsensusCommitPrologueV3" ] }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "sub_dag_index": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, { "type": "object", "required": [ "additional_state_digest", "commit_timestamp_ms", "consensus_commit_digest", "consensus_determined_version_assignments", "epoch", "kind", "round" ], "properties": { "additional_state_digest": { "$ref": "#/components/schemas/AdditionalConsensusStateDigest" }, "commit_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "consensus_commit_digest": { "$ref": "#/components/schemas/ConsensusCommitDigest" }, "consensus_determined_version_assignments": { "$ref": "#/components/schemas/ConsensusDeterminedVersionAssignments" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ConsensusCommitPrologueV4" ] }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "sub_dag_index": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, { "description": "A series of commands where the results of one command can be used in future commands", "type": "object", "required": [ "inputs", "kind", "transactions" ], "properties": { "inputs": { "description": "Input objects or primitive values", "type": "array", "items": { "$ref": "#/components/schemas/SuiCallArg" } }, "kind": { "type": "string", "enum": [ "ProgrammableSystemTransaction" ] }, "transactions": { "description": "The transactions to be executed sequentially. A failure in any transaction will result in the failure of the entire programmable transaction block.", "type": "array", "items": { "$ref": "#/components/schemas/SuiTransaction" } } } } ] }, "TransactionBlockResponse": { "type": "object", "required": [ "digest" ], "properties": { "balanceChanges": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/BalanceChange" } }, "checkpoint": { "description": "The checkpoint number when this transaction was included and hence finalized. This is only returned in the read api, not in the transaction execution api.", "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "confirmedLocalExecution": { "type": [ "boolean", "null" ] }, "digest": { "$ref": "#/components/schemas/TransactionDigest" }, "effects": { "anyOf": [ { "$ref": "#/components/schemas/TransactionBlockEffects" }, { "type": "null" } ] }, "errors": { "type": "array", "items": { "type": "string" } }, "events": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/Event" } }, "objectChanges": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ObjectChange" } }, "rawEffects": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "rawTransaction": { "description": "BCS encoded [SenderSignedData] that includes input object references returns empty array if `show_raw_transaction` is false", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] }, "timestampMs": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "transaction": { "description": "Transaction input data", "anyOf": [ { "$ref": "#/components/schemas/TransactionBlock" }, { "type": "null" } ] } } }, "TransactionBlockResponseOptions": { "type": "object", "properties": { "showBalanceChanges": { "description": "Whether to show balance_changes. Default to be False", "default": false, "type": "boolean" }, "showEffects": { "description": "Whether to show transaction effects. Default to be False", "default": false, "type": "boolean" }, "showEvents": { "description": "Whether to show transaction events. Default to be False", "default": false, "type": "boolean" }, "showInput": { "description": "Whether to show transaction input data. Default to be False", "default": false, "type": "boolean" }, "showObjectChanges": { "description": "Whether to show object_changes. Default to be False", "default": false, "type": "boolean" }, "showRawEffects": { "description": "Whether to show raw transaction effects. Default to be False", "default": false, "type": "boolean" }, "showRawInput": { "description": "Whether to show bcs-encoded transaction input data", "default": false, "type": "boolean" } } }, "TransactionBlockResponseQuery": { "type": "object", "properties": { "filter": { "description": "If None, no filter will be applied", "default": null, "anyOf": [ { "$ref": "#/components/schemas/TransactionFilter" }, { "type": "null" } ] }, "options": { "description": "config which fields to include in the response, by default only digest is included", "default": null, "anyOf": [ { "$ref": "#/components/schemas/TransactionBlockResponseOptions" }, { "type": "null" } ] } } }, "TransactionDigest": { "description": "A transaction will have a (unique) digest.", "allOf": [ { "$ref": "#/components/schemas/Digest" } ] }, "TransactionEventsDigest": { "$ref": "#/components/schemas/Digest" }, "TransactionFilter": { "oneOf": [ { "description": "CURRENTLY NOT SUPPORTED. Query by checkpoint.", "type": "object", "required": [ "Checkpoint" ], "properties": { "Checkpoint": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "additionalProperties": false }, { "description": "Query by move function.", "type": "object", "required": [ "MoveFunction" ], "properties": { "MoveFunction": { "type": "object", "required": [ "package" ], "properties": { "function": { "type": [ "string", "null" ] }, "module": { "type": [ "string", "null" ] }, "package": { "$ref": "#/components/schemas/ObjectID" } } } }, "additionalProperties": false }, { "description": "Query by input object.", "type": "object", "required": [ "InputObject" ], "properties": { "InputObject": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "description": "Query by changed object, including created, mutated and unwrapped objects.", "type": "object", "required": [ "ChangedObject" ], "properties": { "ChangedObject": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "description": "Query for transactions that touch this object.", "type": "object", "required": [ "AffectedObject" ], "properties": { "AffectedObject": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "description": "Query by sender address.", "type": "object", "required": [ "FromAddress" ], "properties": { "FromAddress": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Query by recipient address.", "type": "object", "required": [ "ToAddress" ], "properties": { "ToAddress": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Query by sender and recipient address.", "type": "object", "required": [ "FromAndToAddress" ], "properties": { "FromAndToAddress": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "$ref": "#/components/schemas/SuiAddress" }, "to": { "$ref": "#/components/schemas/SuiAddress" } } } }, "additionalProperties": false }, { "description": "CURRENTLY NOT SUPPORTED. Query txs that have a given address as sender or recipient.", "type": "object", "required": [ "FromOrToAddress" ], "properties": { "FromOrToAddress": { "type": "object", "required": [ "addr" ], "properties": { "addr": { "$ref": "#/components/schemas/SuiAddress" } } } }, "additionalProperties": false }, { "description": "Query by transaction kind", "type": "object", "required": [ "TransactionKind" ], "properties": { "TransactionKind": { "type": "string" } }, "additionalProperties": false }, { "description": "Query transactions of any given kind in the input.", "type": "object", "required": [ "TransactionKindIn" ], "properties": { "TransactionKindIn": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "TransferObjectParams": { "type": "object", "required": [ "objectId", "recipient" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "recipient": { "$ref": "#/components/schemas/SuiAddress" } } }, "TypeOrigin": { "description": "Identifies a struct and the module it was defined in", "type": "object", "required": [ "datatype_name", "module_name", "package" ], "properties": { "datatype_name": { "type": "string" }, "module_name": { "type": "string" }, "package": { "$ref": "#/components/schemas/ObjectID" } } }, "TypeTag": { "type": "string" }, "UpgradeInfo": { "description": "Upgraded package info for the linkage table", "type": "object", "required": [ "upgraded_id", "upgraded_version" ], "properties": { "upgraded_id": { "description": "ID of the upgraded packages", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "upgraded_version": { "description": "Version of the upgraded package", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } }, "ValidatorApy": { "type": "object", "required": [ "address", "apy" ], "properties": { "address": { "$ref": "#/components/schemas/SuiAddress" }, "apy": { "type": "number", "format": "double" } } }, "ValidatorApys": { "type": "object", "required": [ "apys", "epoch" ], "properties": { "apys": { "type": "array", "items": { "$ref": "#/components/schemas/ValidatorApy" } }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "ZkLoginAuthenticator": { "description": "An zk login authenticator with all the necessary fields.", "type": "object", "required": [ "inputs", "maxEpoch", "userSignature" ], "properties": { "inputs": { "$ref": "#/components/schemas/ZkLoginInputs" }, "maxEpoch": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "userSignature": { "$ref": "#/components/schemas/Signature" } } }, "ZkLoginAuthenticatorAsBytes": { "$ref": "#/components/schemas/Base64" }, "ZkLoginInputs": { "description": "All inputs required for the zk login proof verification and other public inputs.", "type": "object", "required": [ "addressSeed", "headerBase64", "issBase64Details", "proofPoints" ], "properties": { "addressSeed": { "$ref": "#/components/schemas/Bn254FrElement" }, "headerBase64": { "type": "string" }, "issBase64Details": { "$ref": "#/components/schemas/Claim" }, "proofPoints": { "$ref": "#/components/schemas/ZkLoginProof" } } }, "ZkLoginIntentScope": { "type": "string", "enum": [ "TransactionData", "PersonalMessage" ] }, "ZkLoginProof": { "description": "The struct for zk login proof.", "type": "object", "required": [ "a", "b", "c" ], "properties": { "a": { "type": "array", "items": { "$ref": "#/components/schemas/Bn254FqElement" } }, "b": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/Bn254FqElement" } } }, "c": { "type": "array", "items": { "$ref": "#/components/schemas/Bn254FqElement" } } } }, "ZkLoginPublicIdentifier": { "description": "A wrapper struct to retrofit in [enum PublicKey] for zkLogin. Useful to construct [struct MultiSigPublicKey].", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] }, "ZkLoginVerifyResult": { "type": "object", "required": [ "errors", "success" ], "properties": { "errors": { "description": "The errors field captures any verification error", "type": "array", "items": { "type": "string" } }, "success": { "description": "The boolean result of the verification. If true, errors should be empty.", "type": "boolean" } } } } }, "tags": [ { "name": "Read API", "description": "Methods for reading blockchain state" }, { "name": "Write API", "description": "Methods for submitting transactions" }, { "name": "Extended API", "description": "Extended query methods (suix_ prefix)" }, { "name": "Unsafe API", "description": "Transaction builder methods (deprecated, use Sui SDK instead)" }, { "name": "Subscriptions", "description": "Real-time event subscriptions" } ] }