{ "openrpc": "1.2.6", "info": { "title": "Sui JSON-RPC", "description": "Sui JSON-RPC API for interaction with Sui Full node.", "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": "0.24.0" }, "methods": [ { "name": "sui_batchTransaction", "tags": [ { "name": "Transaction Builder API" } ], "description": "Create an unsigned batched transaction.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "single_transaction_params", "description": "list of transaction request parameters", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RPCTransactionRequestParams" } } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, { "name": "txn_builder_mode", "description": "Whether this is a regular transaction or a Dev Inspect Transaction", "schema": { "$ref": "#/components/schemas/SuiTransactionBuilderMode" } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } }, "examples": [ { "name": "Create unsigned batch transaction data.", "params": [ { "name": "signer", "value": "0x9b07815f04497e2e05d22cac3aa061410b20868c" }, { "name": "single_transaction_params", "value": [ { "moveCallRequestParams": { "packageObjectId": "0x0000000000000000000000000000000000000002", "module": "devnet_nft", "function": "mint", "typeArguments": [], "arguments": [ "Example NFT", "An NFT created by the Sui Command Line Tool", "ipfs://bafkreibngqhl3gaa7daob4i2vccziay2jjlp435cf66vhono7nrvww53ty" ] } }, { "transferObjectRequestParams": { "recipient": "0xc619154c42a1c61be9902717b24b8ec168fe4896", "objectId": "0xefef92cbf44b581f23222c10916b17a369b4da03" } } ] }, { "name": "gas", "value": "0xf5b70ccb10f1a705e061d0fdfa189618d28b0d44" }, { "name": "gas_budget", "value": 1000 }, { "name": "txn_builder_mode", "value": "Commit" } ], "result": { "name": "Result", "value": { "txBytes": "AQICAAAAAAAAAAAAAAAAAAAAAAAAAAIKZGV2bmV0X25mdARtaW50AAMAC0V4YW1wbGUgTkZUACtBbiBORlQgY3JlYXRlZCBieSB0aGUgU3VpIENvbW1hbmQgTGluZSBUb29sAEJpcGZzOi8vYmFma3JlaWJuZ3FobDNnYWE3ZGFvYjRpMnZjY3ppYXkyampscDQzNWNmNjZ2aG9ubzducnZ3dzUzdHkAxhkVTEKhxhvpkCcXskuOwWj+SJbv75LL9EtYHyMiLBCRaxejabTaAwEAAAAAAAAAIJ0HWVK1gDbyp7VhRGWSQDxnLw2+Ep8eORE/n2Fk6ihnmweBXwRJfi4F0iysOqBhQQsghoz1twzLEPGnBeBh0P36GJYY0osNRAEAAAAAAAAAIPjezPPDxRjxRt6VVPA/J6g9WxGF855x7zV+K9nhOWJRAQAAAAAAAADoAwAAAAAAAA==", "gas": { "objectId": "0xf5b70ccb10f1a705e061d0fdfa189618d28b0d44", "version": 1, "digest": "+N7M88PFGPFG3pVU8D8nqD1bEYXznnHvNX4r2eE5YlE=" }, "inputObjects": [ { "MovePackage": "0x0000000000000000000000000000000000000002" }, { "ImmOrOwnedMoveObject": { "objectId": "0xefef92cbf44b581f23222c10916b17a369b4da03", "version": 1, "digest": "nQdZUrWANvKntWFEZZJAPGcvDb4Snx45ET+fYWTqKGc=" } }, { "ImmOrOwnedMoveObject": { "objectId": "0xf5b70ccb10f1a705e061d0fdfa189618d28b0d44", "version": 1, "digest": "+N7M88PFGPFG3pVU8D8nqD1bEYXznnHvNX4r2eE5YlE=" } } ] } } } ] }, { "name": "sui_devInspectTransaction", "tags": [ { "name": "Full Node API" } ], "description": "Runs the transaction in dev-inpsect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.", "params": [ { "name": "sender_address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "tx_bytes", "description": "BCS encoded TransactionKind(as opposed to TransactionData, which include gasBudget and gasPrice)", "required": true, "schema": { "$ref": "#/components/schemas/Base64" } }, { "name": "gas_price", "description": "Gas is not charged, but gas usage is still calculated. Default to use reference gas price", "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, { "name": "epoch", "description": "The epoch to perform the call. Will be set from the system state object if not provided", "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "DevInspectResults", "required": true, "schema": { "$ref": "#/components/schemas/DevInspectResults" } } }, { "name": "sui_dryRunTransaction", "tags": [ { "name": "Full Node API" } ], "description": "Return transaction execution effects including the gas cost summary, while the effects are not committed to the chain.", "params": [ { "name": "tx_bytes", "required": true, "schema": { "$ref": "#/components/schemas/Base64" } } ], "result": { "name": "SuiTransactionEffects", "required": true, "schema": { "$ref": "#/components/schemas/TransactionEffects" } } }, { "name": "sui_executeTransaction", "tags": [ { "name": "APIs to execute transactions." } ], "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.", "params": [ { "name": "tx_bytes", "description": "BCS serialized transaction data bytes without its type tag, as base-64 encoded string.", "required": true, "schema": { "$ref": "#/components/schemas/Base64" } }, { "name": "signature", "description": "`flag || signature || pubkey` bytes, as base-64 encoded string, signature is committed to the intent message of the transaction data, as base-64 encoded string.", "required": true, "schema": { "$ref": "#/components/schemas/Base64" } }, { "name": "request_type", "description": "The request type", "required": true, "schema": { "$ref": "#/components/schemas/ExecuteTransactionRequestType" } } ], "result": { "name": "SuiExecuteTransactionResponse", "required": true, "schema": { "$ref": "#/components/schemas/SuiExecuteTransactionResponse" } }, "examples": [ { "name": "Execute an transaction with serialized signature", "params": [ { "name": "tx_bytes", "value": "AACVVpf+K3BMlUCjhG6SmLddtyXB7jAnt4PqaJ4aOOtHbG78RO21zT3+AgAAAAAAAAAgAouPAuQwKlWV2IiaZ8bTHGyXDlZ/A+9n2BGk+ENmW40QurA5KK57xHIiIuMF8/Nig+JbtjL0v2w+isQu7xOF4BQD5JpLKWrcAgAAAAAAAAAgsi6ifTyS5M4iVqxkXLq9w2zxufLshIGibKfYEWlVl5QBAAAAAAAAAOgDAAAAAAAA" }, { "name": "signature", "value": "AACunVNQ+43nTvpMty4ILN+tTvYAaUsYn3Spu1eZu7SZVTPs5tkYxPF8h1o6iFDgDgq/rrua+hMNxMkGYVhXtw+NZVNaIOpz/rPnTIA7TCFEizybXsMse2pIqWIapAFigQ==" }, { "name": "request_type", "value": "WaitForLocalExecution" } ], "result": { "name": "Result", "value": { "certificate": { "transactionDigest": "5Cb9XuZbdpd2behLmGAhQTu1YYZbWae53KHiQxeqEPoR", "data": { "transactions": [ { "TransferObject": { "recipient": "0x955697fe2b704c9540a3846e9298b75db725c1ee", "objectRef": { "objectId": "0x3027b783ea689e1a38eb476c6efc44edb5cd3dfe", "version": 2, "digest": "AouPAuQwKlWV2IiaZ8bTHGyXDlZ/A+9n2BGk+ENmW40=" } } } ], "sender": "0x10bab03928ae7bc4722222e305f3f36283e25bb6", "gasPayment": { "objectId": "0x32f4bf6c3e8ac42eef1385e01403e49a4b296adc", "version": 2, "digest": "si6ifTyS5M4iVqxkXLq9w2zxufLshIGibKfYEWlVl5Q=" }, "gasPrice": 1, "gasBudget": 1000 }, "txSignature": "AACunVNQ+43nTvpMty4ILN+tTvYAaUsYn3Spu1eZu7SZVTPs5tkYxPF8h1o6iFDgDgq/rrua+hMNxMkGYVhXtw+NZVNaIOpz/rPnTIA7TCFEizybXsMse2pIqWIapAFigQ==", "authSignInfo": { "epoch": 0, "signature": "AaCQESRLSxMntCxHAXuRk66nmlID2DZn3gU64vkZ7iHSjE2Nbhfr21Ovri7AMdAl4Q==", "signers_map": [ 58, 48, 0, 0, 0, 0, 0, 0 ] } }, "effects": { "status": { "status": "success" }, "gasUsed": { "computationCost": 100, "storageCost": 100, "storageRebate": 10 }, "transactionDigest": "GLp2W9z46XqdUwj5QHrfvYhoRdu1oC2UVnxowTcjFLuh", "mutated": [ { "owner": { "AddressOwner": "0x10bab03928ae7bc4722222e305f3f36283e25bb6" }, "reference": { "objectId": "0x32f4bf6c3e8ac42eef1385e01403e49a4b296adc", "version": 2, "digest": "si6ifTyS5M4iVqxkXLq9w2zxufLshIGibKfYEWlVl5Q=" } }, { "owner": { "AddressOwner": "0x955697fe2b704c9540a3846e9298b75db725c1ee" }, "reference": { "objectId": "0x3027b783ea689e1a38eb476c6efc44edb5cd3dfe", "version": 2, "digest": "AouPAuQwKlWV2IiaZ8bTHGyXDlZ/A+9n2BGk+ENmW40=" } } ], "gasObject": { "owner": { "ObjectOwner": "0x10bab03928ae7bc4722222e305f3f36283e25bb6" }, "reference": { "objectId": "0x32f4bf6c3e8ac42eef1385e01403e49a4b296adc", "version": 2, "digest": "si6ifTyS5M4iVqxkXLq9w2zxufLshIGibKfYEWlVl5Q=" } }, "events": [ { "transferObject": { "packageId": "0x0000000000000000000000000000000000000002", "transactionModule": "native", "sender": "0x10bab03928ae7bc4722222e305f3f36283e25bb6", "recipient": { "AddressOwner": "0x955697fe2b704c9540a3846e9298b75db725c1ee" }, "objectType": "0x2::example::Object", "objectId": "0x3027b783ea689e1a38eb476c6efc44edb5cd3dfe", "version": 2 } } ] }, "timestamp_ms": null, "parsed_data": null } } } ] }, { "name": "sui_executeTransactionSerializedSig", "tags": [ { "name": "APIs to execute transactions." } ], "params": [ { "name": "tx_bytes", "description": "BCS serialized transaction data bytes without its type tag, as base-64 encoded string.", "required": true, "schema": { "$ref": "#/components/schemas/Base64" } }, { "name": "signature", "description": "`flag || signature || pubkey` bytes, as base-64 encoded string, signature is committed to the intent message of the transaction data, as base-64 encoded string.", "required": true, "schema": { "$ref": "#/components/schemas/Base64" } }, { "name": "request_type", "description": "The request type", "required": true, "schema": { "$ref": "#/components/schemas/ExecuteTransactionRequestType" } } ], "result": { "name": "SuiExecuteTransactionResponse", "required": true, "schema": { "$ref": "#/components/schemas/SuiExecuteTransactionResponse" } } }, { "name": "sui_getAllBalances", "tags": [ { "name": "Coin Query API" } ], "description": "Return the total coin balance for all coin type, owned by the address owner.", "params": [ { "name": "owner", "description": "the owner's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Balance" } } } }, { "name": "sui_getAllCoins", "tags": [ { "name": "Coin Query API" } ], "description": "Return all Coin objects owned by an address.", "params": [ { "name": "owner", "description": "the owner's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "cursor", "description": "optional paging cursor", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "limit", "description": "maximum number of items per page", "schema": { "type": "integer", "format": "uint", "minimum": 0.0 } } ], "result": { "name": "CoinPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_Coin_and_ObjectID" } } }, { "name": "sui_getBalance", "tags": [ { "name": "Coin Query API" } ], "description": "Return the total coin balance for one coin type, owned by the address owner.", "params": [ { "name": "owner", "description": "the owner's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "coin_type", "description": "optional type names for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC), default to 0x2::sui::SUI if not specified.", "schema": { "type": "string" } } ], "result": { "name": "Balance", "required": true, "schema": { "$ref": "#/components/schemas/Balance" } } }, { "name": "sui_getCheckpointContents", "tags": [ { "name": "Full Node API" } ], "description": "Return contents of a checkpoint, namely a list of execution digests", "params": [ { "name": "sequence_number", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "CheckpointContents", "required": true, "schema": { "$ref": "#/components/schemas/CheckpointContents" } } }, { "name": "sui_getCheckpointContentsByDigest", "tags": [ { "name": "Full Node API" } ], "description": "Return contents of a checkpoint based on checkpoint content digest", "params": [ { "name": "digest", "required": true, "schema": { "$ref": "#/components/schemas/CheckpointContentsDigest" } } ], "result": { "name": "CheckpointContents", "required": true, "schema": { "$ref": "#/components/schemas/CheckpointContents" } } }, { "name": "sui_getCheckpointSummary", "tags": [ { "name": "Full Node API" } ], "description": "Return a checkpoint summary based on a checkpoint sequence number", "params": [ { "name": "sequence_number", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "CheckpointSummary", "required": true, "schema": { "$ref": "#/components/schemas/CheckpointSummary" } } }, { "name": "sui_getCheckpointSummaryByDigest", "tags": [ { "name": "Full Node API" } ], "description": "Return a checkpoint summary based on checkpoint digest", "params": [ { "name": "digest", "required": true, "schema": { "$ref": "#/components/schemas/CheckpointDigest" } } ], "result": { "name": "CheckpointSummary", "required": true, "schema": { "$ref": "#/components/schemas/CheckpointSummary" } } }, { "name": "sui_getCoinMetadata", "tags": [ { "name": "Coin Query API" } ], "description": "Return metadata(e.g., symbol, decimals) for a coin", "params": [ { "name": "coin_type", "description": "type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC)", "required": true, "schema": { "type": "string" } } ], "result": { "name": "SuiCoinMetadata", "required": true, "schema": { "$ref": "#/components/schemas/SuiCoinMetadata" } } }, { "name": "sui_getCoins", "tags": [ { "name": "Coin Query API" } ], "description": "Return all Coin<`coin_type`> objects owned by an address.", "params": [ { "name": "owner", "description": "the owner's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "coin_type", "description": "optional type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC), default to 0x2::sui::SUI if not specified.", "schema": { "type": "string" } }, { "name": "cursor", "description": "optional paging cursor", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "limit", "description": "maximum number of items per page", "schema": { "type": "integer", "format": "uint", "minimum": 0.0 } } ], "result": { "name": "CoinPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_Coin_and_ObjectID" } } }, { "name": "sui_getCommitteeInfo", "tags": [ { "name": "Governance Read API" } ], "description": "Return the committee information for the asked `epoch`.", "params": [ { "name": "epoch", "description": "The epoch of interest. If None, default to the latest epoch", "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "CommitteeInfoResponse", "required": true, "schema": { "$ref": "#/components/schemas/CommitteeInfoResponse" } } }, { "name": "sui_getDelegatedStakes", "tags": [ { "name": "Governance Read API" } ], "description": "Return all [DelegatedStake].", "params": [ { "name": "owner", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatedStake" } } } }, { "name": "sui_getDynamicFieldObject", "tags": [ { "name": "Read API" } ], "description": "Return the dynamic field object information for a specified object", "params": [ { "name": "parent_object_id", "description": "The ID of the queried parent object", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "name", "description": "The Name of the dynamic field", "required": true, "schema": { "type": "string" } } ], "result": { "name": "GetObjectDataResponse", "required": true, "schema": { "$ref": "#/components/schemas/ObjectRead" } } }, { "name": "sui_getDynamicFields", "tags": [ { "name": "Read API" } ], "description": "Return the list of dynamic field objects owned by an object.", "params": [ { "name": "parent_object_id", "description": "The ID of the parent object", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "cursor", "description": "Optional paging cursor", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "limit", "description": "Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.", "schema": { "type": "integer", "format": "uint", "minimum": 0.0 } } ], "result": { "name": "DynamicFieldPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_DynamicFieldInfo_and_ObjectID" } } }, { "name": "sui_getEvents", "tags": [ { "name": "Event Read API" } ], "description": "Return list of events for a specified query criteria.", "params": [ { "name": "query", "description": "the event query criteria.", "required": true, "schema": { "$ref": "#/components/schemas/EventQuery" } }, { "name": "cursor", "description": "optional paging cursor", "schema": { "$ref": "#/components/schemas/EventID" } }, { "name": "limit", "description": "maximum number of items per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.", "schema": { "type": "integer", "format": "uint", "minimum": 0.0 } }, { "name": "descending_order", "description": "query result ordering, default to false (ascending order), oldest record first.", "schema": { "type": "boolean" } } ], "result": { "name": "EventPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_EventEnvelope_and_EventID" } }, "examples": [ { "name": "Return the Events emitted by a transaction", "params": [ { "name": "query", "value": { "Transaction": "MT81NY2FQZFxoWgxTJAf1kfc44Ao7SwdXSQg8jMVY5P" } }, { "name": "cursor", "value": { "txDigest": "MT81NY2FQZFxoWgxTJAf1kfc44Ao7SwdXSQg8jMVY5P", "eventSeq": 10 } }, { "name": "limit", "value": 1 }, { "name": "descending_order", "value": false } ], "result": { "name": "Result", "value": { "data": [ { "timestamp": 0, "txDigest": "MT81NY2FQZFxoWgxTJAf1kfc44Ao7SwdXSQg8jMVY5P", "id": { "txDigest": "MT81NY2FQZFxoWgxTJAf1kfc44Ao7SwdXSQg8jMVY5P", "eventSeq": 0 }, "event": { "transferObject": { "packageId": "0x0000000000000000000000000000000000000002", "transactionModule": "native", "sender": "0x5b6c1765a66e97ca69993c5fcd284d826ea21e3d", "recipient": { "AddressOwner": "0x98d2d7d17ba91ddc7e717cf708c937060f040487" }, "objectType": "0x2::example::Object", "objectId": "0x36ec33fb1746d999a5e58cd5c677ed804f82f1c8", "version": 2 } } } ], "nextCursor": { "txDigest": "11a72GCQ5hGNpWGh2QhQkkusTEGS6EDqifJqxr7nSYX", "eventSeq": 5 } } } } ] }, { "name": "sui_getLatestCheckpointSequenceNumber", "tags": [ { "name": "Full Node API" } ], "description": "Return the sequence number of the latest checkpoint that has been executed", "params": [], "result": { "name": "CheckpointSequenceNumber", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, { "name": "sui_getMoveFunctionArgTypes", "tags": [ { "name": "Full Node API" } ], "description": "Return the argument types of a Move function, based on normalized Type.", "params": [ { "name": "package", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "module", "required": true, "schema": { "type": "string" } }, { "name": "function", "required": true, "schema": { "type": "string" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MoveFunctionArgType" } } } }, { "name": "sui_getNormalizedMoveFunction", "tags": [ { "name": "Full Node API" } ], "description": "Return a structured representation of Move function", "params": [ { "name": "package", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "module_name", "required": true, "schema": { "type": "string" } }, { "name": "function_name", "required": true, "schema": { "type": "string" } } ], "result": { "name": "SuiMoveNormalizedFunction", "required": true, "schema": { "$ref": "#/components/schemas/SuiMoveNormalizedFunction" } } }, { "name": "sui_getNormalizedMoveModule", "tags": [ { "name": "Full Node API" } ], "description": "Return a structured representation of Move module", "params": [ { "name": "package", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "module_name", "required": true, "schema": { "type": "string" } } ], "result": { "name": "SuiMoveNormalizedModule", "required": true, "schema": { "$ref": "#/components/schemas/SuiMoveNormalizedModule" } } }, { "name": "sui_getNormalizedMoveModulesByPackage", "tags": [ { "name": "Full Node API" } ], "description": "Return structured representations of all modules in the given package", "params": [ { "name": "package", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } } ], "result": { "name": "BTreeMap", "required": true, "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedModule" } } } }, { "name": "sui_getNormalizedMoveStruct", "tags": [ { "name": "Full Node API" } ], "description": "Return a structured representation of Move struct", "params": [ { "name": "package", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "module_name", "required": true, "schema": { "type": "string" } }, { "name": "struct_name", "required": true, "schema": { "type": "string" } } ], "result": { "name": "SuiMoveNormalizedStruct", "required": true, "schema": { "$ref": "#/components/schemas/SuiMoveNormalizedStruct" } } }, { "name": "sui_getObject", "tags": [ { "name": "Read API" } ], "description": "Return the object information for a specified object", "params": [ { "name": "object_id", "description": "the ID of the queried object", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } } ], "result": { "name": "GetObjectDataResponse", "required": true, "schema": { "$ref": "#/components/schemas/ObjectRead" } }, "examples": [ { "name": "Get Object data", "params": [ { "name": "object_id", "value": "0x6b0a41403276437b25f0ffbe897cf476c0777e9d" } ], "result": { "name": "Result", "value": { "status": "Exists", "details": { "data": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "has_public_transfer": true, "fields": { "balance": "10000", "id": { "id": "0x6b0a41403276437b25f0ffbe897cf476c0777e9d" } } }, "owner": { "AddressOwner": "0x246ff3974ac5f1b350aa16c42ea0d7117b30c8c8" }, "previousTransaction": "5YCdeSBAf4VzmLzCarqjbTXNsbMxR3tWXkRuiYQv75qd", "storageRebate": 100, "reference": { "objectId": "0x6b0a41403276437b25f0ffbe897cf476c0777e9d", "version": 1, "digest": "rvMAWuZzOAnI7B1bhN1iieGTufiN5KmUNYyfhWE1I2w=" } } } } } ] }, { "name": "sui_getObjectsOwnedByAddress", "tags": [ { "name": "Read API" } ], "description": "Return the list of objects owned by an address.", "params": [ { "name": "address", "description": "the owner's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectInfo" } } }, "examples": [ { "name": "Get objects owned by an address", "params": [ { "name": "address", "value": "0x3568c40e814d9d5396d23087a0fd641e91e0e00d" } ], "result": { "name": "Result", "value": [ { "objectId": "0xf6c012cded9ef9ba5e5bf042464b5ca6488b897c", "version": 0, "digest": "AFsuF/APwLyOftPyq1nWB7DjWGvaHNpOQrQUWyb6Neo=", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x3568c40e814d9d5396d23087a0fd641e91e0e00d" }, "previousTransaction": "2joDzF1sDVAVv9ej7j8197ZwiZ1hX73kSFW48c1nNxv3" }, { "objectId": "0xc11638af89d575beb99003d30a245ac74a02e26e", "version": 0, "digest": "RcuA7hucAKkzRc5fEr6p/+BHSNZpbDBjFzUZOuqVuPk=", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x3568c40e814d9d5396d23087a0fd641e91e0e00d" }, "previousTransaction": "YuETTgp5A2zikmTFCnY7M9gPdCq1UY3BCtarCCm3Jcx" }, { "objectId": "0x6b632eafa229ec3dd885442b44972526c4e8ce25", "version": 0, "digest": "oEFsOVXYGLsasOgyh31igjPj4dZPdrcagOxPMy9NGmc=", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x3568c40e814d9d5396d23087a0fd641e91e0e00d" }, "previousTransaction": "5VeL6DH6La2Ra9bjCCZY9wzHVytTjiytJq9DnTdDEvEp" }, { "objectId": "0x842f736ab973e87f53b4857842789a1dd5916762", "version": 0, "digest": "mzxcq+R9v0iCfsCBjgDeSyl/BHw77aQ9bp+bGxvETN8=", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x3568c40e814d9d5396d23087a0fd641e91e0e00d" }, "previousTransaction": "EsxGG1qQpq9FKm6VbYxCv8MAPkfPGEyb8nerSao5Pxmo" } ] } } ] }, { "name": "sui_getObjectsOwnedByObject", "tags": [ { "name": "Read API" } ], "description": "Return the list of objects owned by an object.", "params": [ { "name": "object_id", "description": "the ID of the owner object", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectInfo" } } }, "examples": [ { "name": "Get objects owned by an object", "params": [ { "name": "object_id", "value": "0x0a7c6df2389c373c8fbe06bda7a61120652668dd" } ], "result": { "name": "Result", "value": [ { "objectId": "0x5687fee73fac7a2c564da689e9da76e1430d191f", "version": 0, "digest": "vJN9QvdBBKopGHH0udEg92WDodpdESPyuKCsYGuUCmY=", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "ObjectOwner": "0x0a7c6df2389c373c8fbe06bda7a61120652668dd" }, "previousTransaction": "GMjWn2ePzjwK2NJF4qk5ce3mRyV5NeGJhrTFzb6jcvFe" }, { "objectId": "0x515cf7ca6afb887dd1e09be8e451cd3c36407662", "version": 0, "digest": "PAIxiYvgciwI5OsinETLlX0pz3Nwr4obnFQtSbPIPPs=", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "ObjectOwner": "0x0a7c6df2389c373c8fbe06bda7a61120652668dd" }, "previousTransaction": "BXYoMBzXjW5zDKqYF2xGhCsWGcpFhSvWXY3bQEsm1MAi" }, { "objectId": "0xea244dd060d2b6538196d048b7a6d04c8edc8957", "version": 0, "digest": "nYb9P8kMUvmhTGuBK5T+YTxbzrte6x1EniUWFm1X1x8=", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "ObjectOwner": "0x0a7c6df2389c373c8fbe06bda7a61120652668dd" }, "previousTransaction": "FzJLpC3XPKB68U3XnwpTy3enfqfW228Xk7qWuRb7so7f" }, { "objectId": "0xf5e2facded84d03b5373514f16e3d66e00081051", "version": 0, "digest": "ZLtzoe1YssGLDL83d5LiBua4DU1e6mTi5wVjsViQJsQ=", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "ObjectOwner": "0x0a7c6df2389c373c8fbe06bda7a61120652668dd" }, "previousTransaction": "GK4NxEKSrK88XkPNeuBqtJYPmU9yMTWMD7K9TdU4ybKN" } ] } } ] }, { "name": "sui_getRawObject", "tags": [ { "name": "BCS API" } ], "description": "Return the raw BCS serialized move object bytes for a specified object.", "params": [ { "name": "object_id", "description": "the id of the object", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } } ], "result": { "name": "GetRawObjectDataResponse", "required": true, "schema": { "$ref": "#/components/schemas/ObjectRead" } }, "examples": [ { "name": "Get Raw Object data", "params": [ { "name": "object_id", "value": "0x4b2e27c1eed56c33b579034150ea46bccf7653e0" } ], "result": { "name": "Result", "value": { "status": "Exists", "details": { "data": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "has_public_transfer": true, "version": 1, "bcs_bytes": "Sy4nwe7VbDO1eQNBUOpGvM92U+AQJwAAAAAAAA==" }, "owner": { "AddressOwner": "0x0b6f24b63bd04da68bc160c74cd844f922623fa5" }, "previousTransaction": "AUsv3PDEebWLmheMkD55iUDuem1pvAVVqmf9GTXAjTAw", "storageRebate": 100, "reference": { "objectId": "0x4b2e27c1eed56c33b579034150ea46bccf7653e0", "version": 1, "digest": "NWbFsqU1QQ3aod0/xK8yGNdsx6pr4YAE5eOMs1zK8Ys=" } } } } } ] }, { "name": "sui_getReferenceGasPrice", "tags": [ { "name": "Governance Read API" } ], "description": "Return the reference gas price for the network", "params": [], "result": { "name": "u64", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, { "name": "sui_getSuiSystemState", "tags": [ { "name": "Governance Read API" } ], "description": "Return [SuiSystemState]", "params": [], "result": { "name": "SuiSystemState", "required": true, "schema": { "$ref": "#/components/schemas/SuiSystemState" } } }, { "name": "sui_getTotalSupply", "tags": [ { "name": "Coin Query API" } ], "description": "Return total supply for a coin", "params": [ { "name": "coin_type", "description": "type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC)", "required": true, "schema": { "type": "string" } } ], "result": { "name": "Supply", "required": true, "schema": { "$ref": "#/components/schemas/Supply" } } }, { "name": "sui_getTotalTransactionNumber", "tags": [ { "name": "Read API" } ], "description": "Return the total number of transactions known to the server.", "params": [], "result": { "name": "u64", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, "examples": [ { "name": "Get total number of transactions", "params": [], "result": { "name": "Result", "value": 100 } } ] }, { "name": "sui_getTransaction", "tags": [ { "name": "Read API" } ], "description": "Return the transaction response object.", "params": [ { "name": "digest", "description": "the digest of the queried transaction", "required": true, "schema": { "$ref": "#/components/schemas/TransactionDigest" } } ], "result": { "name": "SuiTransactionResponse", "required": true, "schema": { "$ref": "#/components/schemas/SuiTransactionResponse" } }, "examples": [ { "name": "Return the transaction response object for specified transaction digest", "params": [ { "name": "digest", "value": "EF5c2cKt1tkhQXGDLyUwPfYThUSGGJm21A6fSAf1wgL1" } ], "result": { "name": "Result", "value": { "certificate": { "transactionDigest": "EF5c2cKt1tkhQXGDLyUwPfYThUSGGJm21A6fSAf1wgL1", "data": { "transactions": [ { "TransferObject": { "recipient": "0xd3dbd682f600d1f62dc0921f7f7dbfca95055adc", "objectRef": { "objectId": "0x5e147a1eee2edd23714474444689c946f69a5859", "version": 2, "digest": "b7coq0GHgxIG0VGB/3xQdyQXWGqTYzgp/LptbgzLE9M=" } } } ], "sender": "0xc92b7e018bc38f6a58cf45882572aed10aebf170", "gasPayment": { "objectId": "0x24b91c4b8ae6d4cd6e1e02f6658d21bce9b88bdc", "version": 2, "digest": "7uEpQUTuxHzzk4i7aA9pt0JrxSkpaS/cfS/zdMP4cPM=" }, "gasPrice": 1, "gasBudget": 1000 }, "txSignature": "AFZ8tG38gA3u5IuKSokps32CdlDnnpmimXshB3im6qUj+22Ltqqk63mAb3IHgOo1+oNueMdQURjAsGWt5eENpAQDLkEuBAj2KOz9QdstOZDvZkpc3HAEpmjABCW7F+5FSQ==", "authSignInfo": { "epoch": 0, "signature": "AaCQESRLSxMntCxHAXuRk66nmlID2DZn3gU64vkZ7iHSjE2Nbhfr21Ovri7AMdAl4Q==", "signers_map": [ 58, 48, 0, 0, 0, 0, 0, 0 ] } }, "effects": { "status": { "status": "success" }, "gasUsed": { "computationCost": 100, "storageCost": 100, "storageRebate": 10 }, "transactionDigest": "FomLHyaFXekRw2wdCcQqn9EvUaQhruUv3sH4FQYZEVoo", "mutated": [ { "owner": { "AddressOwner": "0xc92b7e018bc38f6a58cf45882572aed10aebf170" }, "reference": { "objectId": "0x24b91c4b8ae6d4cd6e1e02f6658d21bce9b88bdc", "version": 2, "digest": "7uEpQUTuxHzzk4i7aA9pt0JrxSkpaS/cfS/zdMP4cPM=" } }, { "owner": { "AddressOwner": "0xd3dbd682f600d1f62dc0921f7f7dbfca95055adc" }, "reference": { "objectId": "0x5e147a1eee2edd23714474444689c946f69a5859", "version": 2, "digest": "b7coq0GHgxIG0VGB/3xQdyQXWGqTYzgp/LptbgzLE9M=" } } ], "gasObject": { "owner": { "ObjectOwner": "0xc92b7e018bc38f6a58cf45882572aed10aebf170" }, "reference": { "objectId": "0x24b91c4b8ae6d4cd6e1e02f6658d21bce9b88bdc", "version": 2, "digest": "7uEpQUTuxHzzk4i7aA9pt0JrxSkpaS/cfS/zdMP4cPM=" } }, "events": [ { "transferObject": { "packageId": "0x0000000000000000000000000000000000000002", "transactionModule": "native", "sender": "0xc92b7e018bc38f6a58cf45882572aed10aebf170", "recipient": { "AddressOwner": "0xd3dbd682f600d1f62dc0921f7f7dbfca95055adc" }, "objectType": "0x2::example::Object", "objectId": "0x5e147a1eee2edd23714474444689c946f69a5859", "version": 2 } } ] }, "timestamp_ms": null, "parsed_data": null } } } ] }, { "name": "sui_getTransactionAuthSigners", "tags": [ { "name": "Read API" } ], "description": "Return the authority public keys that commits to the authority signature of the transaction.", "params": [ { "name": "digest", "description": "the digest of the queried transaction", "required": true, "schema": { "$ref": "#/components/schemas/TransactionDigest" } } ], "result": { "name": "SuiTransactionAuthSignersResponse", "required": true, "schema": { "$ref": "#/components/schemas/SuiTransactionAuthSignersResponse" } }, "examples": [ { "name": "Return the list of authorities that committed to the authority signature of the specified transaction digest", "params": [ { "name": "digest", "value": "HS465DxR24tPw728qwsngp5LABDWBVYGbEw54Bc39EP6" } ], "result": { "name": "Result", "value": { "signers": [ "mfJe9h+AMrkUY2RgmCxcxvE07x3a52ZX8sv+wev8jQlzdAgN9vzw3Li8Sw2OCvXYDrv/K0xZn1T0LWMS38MUJ2B4wcw0fru+xRmL4lhRPzhrkw0CwnSagD4jMJVevRoQ", "ltGcU/G+4hWMP8+1uy8G06gjdmdSnS2PD7si/lw7PmR0hCC0EDZ0SQR22YUw0GMnEiLSpZsPeTKQnMRVow8AxpOA5ohTdelCQ/dGjpVjqtKTMKynq0MZJ1QOlQiIjw4c", "rfLiNQ/ppY8/pQd3SZ8gMxxFUKtw9qT7JaWMYbULU2YQe1wGMy5xu0eqmc4tXAf+DasEuK9xWJ8PKSxQOC66atTJCssBCrnbdBKYiyq6EBiq+ECxOQqLK+4/3jW0q3/f" ] } } } ] }, { "name": "sui_getTransactions", "tags": [ { "name": "Full Node API" } ], "description": "Return list of transactions for a specified query criteria.", "params": [ { "name": "query", "description": "the transaction query criteria.", "required": true, "schema": { "$ref": "#/components/schemas/TransactionQuery" } }, { "name": "cursor", "description": "Optional paging cursor", "schema": { "$ref": "#/components/schemas/TransactionDigest" } }, { "name": "limit", "description": "Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.", "schema": { "type": "integer", "format": "uint", "minimum": 0.0 } }, { "name": "descending_order", "description": "query result ordering, default to false (ascending order), oldest record first.", "schema": { "type": "boolean" } } ], "result": { "name": "TransactionsPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_TransactionDigest_and_TransactionDigest" } }, "examples": [ { "name": "Return the transaction digest for specified query criteria", "params": [ { "name": "query", "value": { "InputObject": "0x1848666ffed2291ae24a3f8177353a05220d765c" } }, { "name": "cursor", "value": "CRhMuouDv9VGZv5QNcDtQC2ZTDvpJPnnDv9xgKjJDSpT" }, { "name": "limit", "value": 100 }, { "name": "descending_order", "value": false } ], "result": { "name": "Result", "value": { "data": [ "CyGJmgvA8He9m1TNHdQYzZPKeQy9r8FVtJ5amhc88wnw", "GD9ggktpmg7emKWoWvK9mjHY3XuaR9dmdhBiCPCyABZT", "2EL37wRGHvRyT6q4nZYMDm8AsKmYG4todK6QH6Hftrys" ], "nextCursor": "79WsaYhq5UEkgKg5SGQBXb8BA6A4ZDQiprDPyKC1GAY9" } } } ] }, { "name": "sui_getTransactionsInRange", "tags": [ { "name": "Read API" } ], "description": "Return list of transaction digests within the queried range.", "params": [ { "name": "start", "description": "the matching transactions' sequence number will be greater than or equals to the starting sequence number", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, { "name": "end", "description": "the matching transactions' sequence number will be less than the ending sequence number", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDigest" } } } }, { "name": "sui_getValidators", "tags": [ { "name": "Governance Read API" } ], "description": "Return all validators available for stake delegation.", "params": [], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValidatorMetadata" } } } }, { "name": "sui_mergeCoins", "tags": [ { "name": "Transaction Builder API" } ], "description": "Create an unsigned transaction to merge multiple coins into one coin.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "primary_coin", "description": "the coin object to merge into, this coin will remain after the transaction", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "coin_to_merge", "description": "the coin object to be merged, this coin will be destroyed, the balance will be added to `primary_coin`", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_moveCall", "tags": [ { "name": "Transaction Builder API" } ], "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.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "package_object_id", "description": "the Move package ID, e.g. `0x2`", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "module", "description": "the Move module name, e.g. `devnet_nft`", "required": true, "schema": { "type": "string" } }, { "name": "function", "description": "the move function name, e.g. `mint`", "required": true, "schema": { "type": "string" } }, { "name": "type_arguments", "description": "the type arguments of the Move function", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TypeTag" } } }, { "name": "arguments", "description": "the arguments to be passed into the Move function, in [SuiJson](https://docs.sui.io/build/sui-json) format", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SuiJsonValue" } } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, { "name": "execution_mode", "description": "Whether this is a Normal transaction or a Dev Inspect Transaction. Default to be `SuiTransactionBuilderMode::Commit` when it's None.", "schema": { "$ref": "#/components/schemas/SuiTransactionBuilderMode" } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_pay", "tags": [ { "name": "Transaction Builder API" } ], "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.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "input_coins", "description": "the Sui coins to be used in this transaction", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, { "name": "recipients", "description": "the recipients' addresses, the length of this vector must be the same as amounts.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SuiAddress" } } }, { "name": "amounts", "description": "the amounts to be transferred to recipients, following the same order", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_payAllSui", "tags": [ { "name": "Transaction Builder API" } ], "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.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "input_coins", "description": "the Sui coins to be used in this transaction, including the coin for gas payment.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, { "name": "recipient", "description": "the recipient address,", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_paySui", "tags": [ { "name": "Transaction Builder API" } ], "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 coints other than the first one are deleted.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "input_coins", "description": "the Sui coins to be used in this transaction, including the coin for gas payment.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, { "name": "recipients", "description": "the recipients' addresses, the length of this vector must be the same as amounts.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SuiAddress" } } }, { "name": "amounts", "description": "the amounts to be transferred to recipients, following the same order", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_publish", "tags": [ { "name": "Transaction Builder API" } ], "description": "Create an unsigned transaction to publish Move module.", "params": [ { "name": "sender", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "compiled_modules", "description": "the compiled bytes of a move module, the", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base64" } } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_requestAddDelegation", "tags": [ { "name": "Transaction Builder API" } ], "description": "Add delegated stake to a validator's staking pool using multiple coins and amount.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "coins", "description": "Coin or LockedCoin object to delegate", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, { "name": "amount", "description": "delegation amount", "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, { "name": "validator", "description": "the validator's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_requestSwitchDelegation", "tags": [ { "name": "Transaction Builder API" } ], "description": "Switch delegation from the current validator to a new one.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "delegation", "description": "Delegation object ID", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "staked_sui", "description": "StakedSui object ID", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "new_validator_address", "description": "Validator to switch to", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_requestWithdrawDelegation", "tags": [ { "name": "Transaction Builder API" } ], "description": "Withdraw a delegation from a validator's staking pool.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "delegation", "description": "Delegation object ID", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "staked_sui", "description": "StakedSui object ID", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_splitCoin", "tags": [ { "name": "Transaction Builder API" } ], "description": "Create an unsigned transaction to split a coin object into multiple coins.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "coin_object_id", "description": "the coin object to be spilt", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "split_amounts", "description": "the amounts to split out from the coin", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_splitCoinEqual", "tags": [ { "name": "Transaction Builder API" } ], "description": "Create an unsigned transaction to split a coin object into multiple equal-size coins.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "coin_object_id", "description": "the coin object to be spilt", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "split_count", "description": "the number of coins to split into", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_subscribeEvent", "tags": [ { "name": "Event Subscription" }, { "name": "Websocket" }, { "name": "PubSub" } ], "description": "Subscribe to a stream of Sui event", "params": [ { "name": "filter", "description": "the filter criteria of the event stream, see the [Sui docs](https://docs.sui.io/build/pubsub#event-filters) for detailed examples.", "required": true, "schema": { "$ref": "#/components/schemas/EventFilter" } } ], "result": { "name": "SuiEventEnvelope", "required": true, "schema": { "$ref": "#/components/schemas/EventEnvelope" } } }, { "name": "sui_tblsSignRandomnessObject", "tags": [ { "name": "Threshold BLS APIs" } ], "description": "Sign an a Randomness object with threshold BLS.", "params": [ { "name": "object_id", "description": "The object ID.", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "commitment_type", "description": "The way in which the commitment on the object creation should be verified.", "required": true, "schema": { "$ref": "#/components/schemas/SuiTBlsSignObjectCommitmentType" } } ], "result": { "name": "SuiTBlsSignRandomnessObjectResponse", "required": true, "schema": { "$ref": "#/components/schemas/SuiTBlsSignRandomnessObjectResponse" } } }, { "name": "sui_transferObject", "tags": [ { "name": "Transaction Builder API" } ], "description": "Create an unsigned transaction to transfer an object from one address to another. The object's type must allow public transfers", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "object_id", "description": "the ID of the object to be transferred", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas", "description": "gas object to be used in this transaction, node will pick one from the signer's possession if not provided", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, { "name": "recipient", "description": "the recipient's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_transferSui", "tags": [ { "name": "Transaction Builder API" } ], "description": "Create an unsigned transaction to send SUI coin object to a Sui address. The SUI object is also used as the gas object.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "sui_object_id", "description": "the Sui coin object to be used in this transaction", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, { "name": "recipient", "description": "the recipient's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "amount", "description": "the amount to be split out and transferred", "schema": { "type": "integer", "format": "uint64", "minimum": 0.0 } } ], "result": { "name": "TransactionBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBytes" } } }, { "name": "sui_tryGetPastObject", "tags": [ { "name": "Full Node API" } ], "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", "params": [ { "name": "object_id", "description": "the ID of the queried object", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "version", "description": "the version of the queried object. If None, default to the latest known version", "required": true, "schema": { "$ref": "#/components/schemas/SequenceNumber" } } ], "result": { "name": "GetPastObjectDataResponse", "required": true, "schema": { "$ref": "#/components/schemas/ObjectRead" } }, "examples": [ { "name": "Get Past Object data", "params": [ { "name": "object_id", "value": "0x3e75a925e1c77ac34127c8baefbea0939f152471" }, { "name": "version", "value": 4 } ], "result": { "name": "Result", "value": { "status": "VersionFound", "details": { "data": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "has_public_transfer": true, "fields": { "balance": "10000", "id": { "id": "0x3e75a925e1c77ac34127c8baefbea0939f152471" } } }, "owner": { "AddressOwner": "0x2b4d37a020b28cdd32138ae34d22e6397af3a9a7" }, "previousTransaction": "33K5ZXJ3RyubvYaHuEnQ1QXmmbhgtrFwp199dnEbL4n7", "storageRebate": 100, "reference": { "objectId": "0x3e75a925e1c77ac34127c8baefbea0939f152471", "version": 4, "digest": "Ea9LhE/5Sz++9uNrUY2jrUxYVvpoZGRSSodrRj0Sl2A=" } } } } } ] } ], "components": { "schemas": { "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": [ "value" ], "properties": { "value": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "BalanceChangeType": { "type": "string", "enum": [ "Gas", "Pay", "Receive" ] }, "Base58": { "type": "string" }, "Base64": { "description": "Base64 encoding", "type": "string" }, "CertifiedTransaction": { "type": "object", "required": [ "authSignInfo", "data", "transactionDigest", "txSignature" ], "properties": { "authSignInfo": { "description": "authority signature information, if available, is signed by an authority, applied on `data`.", "allOf": [ { "$ref": "#/components/schemas/SuiAuthorityStrongQuorumSignInfo" } ] }, "data": { "$ref": "#/components/schemas/TransactionData" }, "transactionDigest": { "$ref": "#/components/schemas/TransactionDigest" }, "txSignature": { "description": "tx_signature is signed by the transaction sender, committing to the intent message containing the transaction data and intent.", "allOf": [ { "$ref": "#/components/schemas/Signature" } ] } } }, "CertifiedTransactionEffects": { "description": "The certified Transaction Effects which has signatures from >= 2/3 of validators", "type": "object", "required": [ "authSignInfo", "effects", "transactionEffectsDigest" ], "properties": { "authSignInfo": { "description": "authority signature information signed by the quorum of the validators.", "allOf": [ { "$ref": "#/components/schemas/SuiAuthorityStrongQuorumSignInfo" } ] }, "effects": { "$ref": "#/components/schemas/TransactionEffects" }, "transactionEffectsDigest": { "$ref": "#/components/schemas/TransactionEffectsDigest" } } }, "CheckpointContents": { "description": "CheckpointContents are the transactions included in an upcoming checkpoint. They must have already been causally ordered. Since the causal order algorithm is the same among validators, we expect all honest validators to come up with the same order for each checkpoint content.", "type": "object", "required": [ "transactions", "user_signatures" ], "properties": { "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionDigests" } }, "user_signatures": { "description": "This field 'pins' user signatures for the checkpoint:\n\n* For normal checkpoint this field will contain same number of elements as transactions. * Genesis checkpoint has transactions but this field is empty. * Last checkpoint in the epoch will have (last)extra system transaction in the transactions list not covered in the signatures list", "type": "array", "items": { "$ref": "#/components/schemas/Signature" } } } }, "CheckpointContentsDigest": { "$ref": "#/components/schemas/Base58" }, "CheckpointDigest": { "$ref": "#/components/schemas/Base58" }, "CheckpointSummary": { "type": "object", "required": [ "content_digest", "epoch", "epoch_rolling_gas_cost_summary", "network_total_transactions", "sequence_number", "timestamp_ms" ], "properties": { "content_digest": { "$ref": "#/components/schemas/CheckpointContentsDigest" }, "epoch": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "epoch_rolling_gas_cost_summary": { "description": "The running total gas costs of all transactions included in the current epoch so far until this checkpoint.", "allOf": [ { "$ref": "#/components/schemas/GasCostSummary" } ] }, "network_total_transactions": { "description": "Total number of transactions committed since genesis, including those in this checkpoint.", "type": "integer", "format": "uint64", "minimum": 0.0 }, "next_epoch_committee": { "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", "null" ], "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/AuthorityPublicKeyBytes" }, { "type": "integer", "format": "uint64", "minimum": 0.0 } ], "maxItems": 2, "minItems": 2 } }, "previous_digest": { "anyOf": [ { "$ref": "#/components/schemas/CheckpointDigest" }, { "type": "null" } ] }, "sequence_number": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "timestamp_ms": { "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", "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "Coin": { "type": "object", "required": [ "balance", "coinObjectId", "coinType", "digest", "previousTransaction", "version" ], "properties": { "balance": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "coinObjectId": { "$ref": "#/components/schemas/ObjectID" }, "coinType": { "type": "string" }, "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "lockedUntilEpoch": { "type": [ "integer", "null" ], "format": "uint64", "minimum": 0.0 }, "previousTransaction": { "$ref": "#/components/schemas/TransactionDigest" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, "CommitteeInfoResponse": { "type": "object", "required": [ "epoch" ], "properties": { "committee_info": { "type": [ "array", "null" ], "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/AuthorityPublicKeyBytes" }, { "type": "integer", "format": "uint64", "minimum": 0.0 } ], "maxItems": 2, "minItems": 2 } }, "epoch": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "Data": { "oneOf": [ { "type": "object", "required": [ "bcs_bytes", "dataType", "has_public_transfer", "type", "version" ], "properties": { "bcs_bytes": { "$ref": "#/components/schemas/Base64" }, "dataType": { "type": "string", "enum": [ "moveObject" ] }, "has_public_transfer": { "type": "boolean" }, "type": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "type": "object", "required": [ "dataType", "id", "module_map" ], "properties": { "dataType": { "type": "string", "enum": [ "package" ] }, "id": { "$ref": "#/components/schemas/ObjectID" }, "module_map": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Base64" } } } } ] }, "DelegatedStake": { "type": "object", "required": [ "delegation_status", "staked_sui" ], "properties": { "delegation_status": { "$ref": "#/components/schemas/DelegationStatus" }, "staked_sui": { "$ref": "#/components/schemas/StakedSui" } } }, "Delegation": { "type": "object", "required": [ "id", "pool_tokens", "principal_sui_amount", "staked_sui_id" ], "properties": { "id": { "$ref": "#/components/schemas/UID" }, "pool_tokens": { "$ref": "#/components/schemas/Balance" }, "principal_sui_amount": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "staked_sui_id": { "$ref": "#/components/schemas/ObjectID" } } }, "DelegationStatus": { "oneOf": [ { "type": "string", "enum": [ "Pending" ] }, { "type": "object", "required": [ "Active" ], "properties": { "Active": { "$ref": "#/components/schemas/Delegation" } }, "additionalProperties": false } ] }, "DevInspectResults": { "description": "The response from processing a dev inspect transaction", "type": "object", "required": [ "effects", "results" ], "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/TransactionEffects" } ] }, "results": { "description": "Execution results (including return values) from executing the transactions Currently contains only return values from Move calls", "allOf": [ { "$ref": "#/components/schemas/Result_of_Array_of_Tuple_of_uint_and_SuiExecutionResult_or_String" } ] } } }, "DynamicFieldInfo": { "type": "object", "required": [ "digest", "name", "objectId", "objectType", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "name": { "type": "string" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "type": { "$ref": "#/components/schemas/DynamicFieldType" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, "DynamicFieldType": { "type": "string", "enum": [ "DynamicField", "DynamicObject" ] }, "Ed25519SuiSignature": { "$ref": "#/components/schemas/Base64" }, "Entry_for_SuiAddress_and_VecSet_for_SuiAddress": { "description": "Rust version of the Move sui::vec_map::Entry type", "type": "object", "required": [ "key", "value" ], "properties": { "key": { "$ref": "#/components/schemas/SuiAddress" }, "value": { "$ref": "#/components/schemas/VecSet_for_SuiAddress" } } }, "Entry_for_ValidatorPair_and_TableVec": { "description": "Rust version of the Move sui::vec_map::Entry type", "type": "object", "required": [ "key", "value" ], "properties": { "key": { "$ref": "#/components/schemas/ValidatorPair" }, "value": { "$ref": "#/components/schemas/TableVec" } } }, "Event": { "oneOf": [ { "description": "Move-specific event", "type": "object", "required": [ "moveEvent" ], "properties": { "moveEvent": { "type": "object", "required": [ "bcs", "packageId", "sender", "transactionModule", "type" ], "properties": { "bcs": { "$ref": "#/components/schemas/Base64" }, "fields": { "anyOf": [ { "$ref": "#/components/schemas/MoveStruct" }, { "type": "null" } ] }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transactionModule": { "type": "string" }, "type": { "type": "string" } } } }, "additionalProperties": false }, { "description": "Module published", "type": "object", "required": [ "publish" ], "properties": { "publish": { "type": "object", "required": [ "digest", "packageId", "sender", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } }, "additionalProperties": false }, { "description": "Coin balance changing event", "type": "object", "required": [ "coinBalanceChange" ], "properties": { "coinBalanceChange": { "type": "object", "required": [ "amount", "changeType", "coinObjectId", "coinType", "owner", "packageId", "sender", "transactionModule", "version" ], "properties": { "amount": { "type": "integer", "format": "int128" }, "changeType": { "$ref": "#/components/schemas/BalanceChangeType" }, "coinObjectId": { "$ref": "#/components/schemas/ObjectID" }, "coinType": { "type": "string" }, "owner": { "$ref": "#/components/schemas/Owner" }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transactionModule": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } }, "additionalProperties": false }, { "description": "Epoch change", "type": "object", "required": [ "epochChange" ], "properties": { "epochChange": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, "additionalProperties": false }, { "description": "New checkpoint", "type": "object", "required": [ "checkpoint" ], "properties": { "checkpoint": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, "additionalProperties": false }, { "description": "Transfer objects to new address / wrap in another object / coin", "type": "object", "required": [ "transferObject" ], "properties": { "transferObject": { "type": "object", "required": [ "objectId", "objectType", "packageId", "recipient", "sender", "transactionModule", "version" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "recipient": { "$ref": "#/components/schemas/Owner" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transactionModule": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } }, "additionalProperties": false }, { "description": "Object mutated.", "type": "object", "required": [ "mutateObject" ], "properties": { "mutateObject": { "type": "object", "required": [ "objectId", "objectType", "packageId", "sender", "transactionModule", "version" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transactionModule": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } }, "additionalProperties": false }, { "description": "Delete object", "type": "object", "required": [ "deleteObject" ], "properties": { "deleteObject": { "type": "object", "required": [ "objectId", "packageId", "sender", "transactionModule", "version" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transactionModule": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } }, "additionalProperties": false }, { "description": "New object creation", "type": "object", "required": [ "newObject" ], "properties": { "newObject": { "type": "object", "required": [ "objectId", "objectType", "packageId", "recipient", "sender", "transactionModule", "version" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "recipient": { "$ref": "#/components/schemas/Owner" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transactionModule": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } }, "additionalProperties": false } ] }, "EventEnvelope": { "type": "object", "required": [ "event", "id", "timestamp", "txDigest" ], "properties": { "event": { "description": "Specific event type", "allOf": [ { "$ref": "#/components/schemas/Event" } ] }, "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" } ] }, "timestamp": { "description": "UTC timestamp in milliseconds since epoch (1/1/1970)", "type": "integer", "format": "uint64", "minimum": 0.0 }, "txDigest": { "description": "Transaction digest of associated transaction", "allOf": [ { "$ref": "#/components/schemas/TransactionDigest" } ] } } }, "EventFilter": { "oneOf": [ { "type": "object", "required": [ "Package" ], "properties": { "Package": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "type": "object", "required": [ "Module" ], "properties": { "Module": { "type": "string" } }, "additionalProperties": false }, { "description": "Move StructTag string value of the event type e.g. `0x2::devnet_nft::MintNFTEvent`", "type": "object", "required": [ "MoveEventType" ], "properties": { "MoveEventType": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "MoveEventField" ], "properties": { "MoveEventField": { "type": "object", "required": [ "path", "value" ], "properties": { "path": { "type": "string" }, "value": true } } }, "additionalProperties": false }, { "type": "object", "required": [ "SenderAddress" ], "properties": { "SenderAddress": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "type": "object", "required": [ "EventType" ], "properties": { "EventType": { "$ref": "#/components/schemas/EventType" } }, "additionalProperties": false }, { "type": "object", "required": [ "ObjectId" ], "properties": { "ObjectId": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "type": "object", "required": [ "All" ], "properties": { "All": { "type": "array", "items": { "$ref": "#/components/schemas/EventFilter" } } }, "additionalProperties": false }, { "type": "object", "required": [ "Any" ], "properties": { "Any": { "type": "array", "items": { "$ref": "#/components/schemas/EventFilter" } } }, "additionalProperties": false }, { "type": "object", "required": [ "And" ], "properties": { "And": { "type": "array", "items": [ { "$ref": "#/components/schemas/EventFilter" }, { "$ref": "#/components/schemas/EventFilter" } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "type": "object", "required": [ "Or" ], "properties": { "Or": { "type": "array", "items": [ { "$ref": "#/components/schemas/EventFilter" }, { "$ref": "#/components/schemas/EventFilter" } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false } ] }, "EventID": { "description": "Unique ID of a Sui Event, the ID is a combination of tx seq number and event seq number, the ID is local to this particular fullnode and will be different from other fullnode.", "type": "object", "required": [ "eventSeq", "txDigest" ], "properties": { "eventSeq": { "type": "integer", "format": "int64" }, "txDigest": { "$ref": "#/components/schemas/TransactionDigest" } } }, "EventQuery": { "oneOf": [ { "description": "Return all events.", "type": "string", "enum": [ "All" ] }, { "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", "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", "type": "object", "required": [ "MoveEvent" ], "properties": { "MoveEvent": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "EventType" ], "properties": { "EventType": { "$ref": "#/components/schemas/EventType" } }, "additionalProperties": false }, { "description": "Query by sender address.", "type": "object", "required": [ "Sender" ], "properties": { "Sender": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Query by recipient address.", "type": "object", "required": [ "Recipient" ], "properties": { "Recipient": { "$ref": "#/components/schemas/Owner" } }, "additionalProperties": false }, { "description": "Return events associated with the given object", "type": "object", "required": [ "Object" ], "properties": { "Object": { "$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", "type": "integer", "format": "uint64", "minimum": 0.0 }, "startTime": { "description": "left endpoint of time interval, milliseconds since epoch, inclusive", "type": "integer", "format": "uint64", "minimum": 0.0 } } } }, "additionalProperties": false } ] }, "EventType": { "description": "Auto-generated discriminant enum variants", "oneOf": [ { "description": "Transaction level event Move-specific event", "type": "string", "enum": [ "MoveEvent" ] }, { "description": "Module published", "type": "string", "enum": [ "Publish" ] }, { "description": "Coin balance changing event", "type": "string", "enum": [ "CoinBalanceChange" ] }, { "description": "Epoch change", "type": "string", "enum": [ "EpochChange" ] }, { "description": "New checkpoint", "type": "string", "enum": [ "Checkpoint" ] }, { "description": "Object level event Transfer objects to new address / wrap in another object", "type": "string", "enum": [ "TransferObject" ] }, { "description": "Object level event Object mutated.", "type": "string", "enum": [ "MutateObject" ] }, { "description": "Delete object", "type": "string", "enum": [ "DeleteObject" ] }, { "description": "New object creation", "type": "string", "enum": [ "NewObject" ] } ] }, "ExecuteTransactionRequestType": { "type": "string", "enum": [ "WaitForEffectsCert", "WaitForLocalExecution" ] }, "ExecutionDigests": { "type": "object", "required": [ "effects", "transaction" ], "properties": { "effects": { "$ref": "#/components/schemas/TransactionEffectsDigest" }, "transaction": { "$ref": "#/components/schemas/TransactionDigest" } } }, "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": { "type": "object", "required": [ "computationCost", "storageCost", "storageRebate" ], "properties": { "computationCost": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "storageCost": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "storageRebate": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "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/SequenceNumber" }, "mutable": { "default": true, "type": "boolean" } } } }, "additionalProperties": false } ] }, "LinkedTable_for_ObjectID": { "description": "Rust version of the Move sui::linked_table::LinkedTable type. Putting it here since we only use it in sui_system in the framework.", "type": "object", "required": [ "head", "id", "size", "tail" ], "properties": { "head": { "$ref": "#/components/schemas/MoveOption_for_ObjectID" }, "id": { "$ref": "#/components/schemas/ObjectID" }, "size": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "tail": { "$ref": "#/components/schemas/MoveOption_for_ObjectID" } } }, "MoveCall": { "type": "object", "required": [ "function", "module", "package" ], "properties": { "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/SuiJsonValue" } }, "function": { "type": "string" }, "module": { "type": "string" }, "package": { "$ref": "#/components/schemas/ObjectID" }, "typeArguments": { "type": "array", "items": { "type": "string" } } } }, "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 } ] }, "MoveOption_for_ObjectID": { "description": "Rust version of the Move std::option::Option type. Putting it in this file because it's only used here.", "type": "object", "required": [ "vec" ], "properties": { "vec": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } } }, "MovePackage": { "type": "object", "required": [ "disassembled" ], "properties": { "disassembled": { "type": "object", "additionalProperties": true } } }, "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": "uint64", "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" } ] } ] }, "Object": { "type": "object", "required": [ "data", "owner", "previousTransaction", "reference", "storageRebate" ], "properties": { "data": { "description": "The meat of the object", "allOf": [ { "$ref": "#/components/schemas/Data" } ] }, "owner": { "description": "The owner that unlocks this object", "allOf": [ { "$ref": "#/components/schemas/Owner" } ] }, "previousTransaction": { "description": "The digest of the transaction that created or last mutated this object", "allOf": [ { "$ref": "#/components/schemas/TransactionDigest" } ] }, "reference": { "$ref": "#/components/schemas/ObjectRef" }, "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.", "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "ObjectDigest": { "$ref": "#/components/schemas/Base64" }, "ObjectID": { "$ref": "#/components/schemas/Hex" }, "ObjectInfo": { "type": "object", "required": [ "digest", "objectId", "owner", "previousTransaction", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "owner": { "$ref": "#/components/schemas/Owner" }, "previousTransaction": { "$ref": "#/components/schemas/TransactionDigest" }, "type": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, "ObjectRead": { "oneOf": [ { "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/Object" }, "status": { "type": "string", "enum": [ "Exists" ] } } }, { "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/ObjectID" }, "status": { "type": "string", "enum": [ "NotExists" ] } } }, { "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/ObjectRef" }, "status": { "type": "string", "enum": [ "Deleted" ] } } } ] }, "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" } ] } } }, "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/SequenceNumber" } ] } } } }, "additionalProperties": false }, { "description": "Object is immutable, and hence ownership doesn't matter.", "type": "string", "enum": [ "Immutable" ] } ] }, "Page_for_Coin_and_ObjectID": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Coin" } }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] } } }, "Page_for_DynamicFieldInfo_and_ObjectID": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicFieldInfo" } }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] } } }, "Page_for_EventEnvelope_and_EventID": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EventEnvelope" } }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/EventID" }, { "type": "null" } ] } } }, "Page_for_TransactionDigest_and_TransactionDigest": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDigest" } }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "null" } ] } } }, "Pay": { "type": "object", "required": [ "amounts", "coins", "recipients" ], "properties": { "amounts": { "description": "The amounts each recipient will receive. Must be the same length as amounts", "type": "array", "items": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, "coins": { "description": "The coins to be used for payment", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "recipients": { "description": "The addresses that will receive payment", "type": "array", "items": { "$ref": "#/components/schemas/SuiAddress" } } } }, "PayAllSui": { "description": "Send all SUI coins to one recipient. only for SUI coin and does not require a separate gas coin object either. 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.", "type": "object", "required": [ "coins", "recipient" ], "properties": { "coins": { "description": "The coins to be used for payment", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "recipient": { "description": "The addresses that will receive payment", "allOf": [ { "$ref": "#/components/schemas/SuiAddress" } ] } } }, "PaySui": { "description": "Send SUI coins to a list of addresses, following a list of amounts. only for SUI coin and does not require a separate gas coin object. Specifically, what pay_sui does are: 1. debit each input_coin to create new coin following the order of amounts and assign it to the corresponding recipient. 2. accumulate all residual SUI from input coins left and deposit all SUI to the first input coin, then use the first input coin as the gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - sum(amounts) - actual_gas_cost 4. all other input coints other than the first one are deleted.", "type": "object", "required": [ "amounts", "coins", "recipients" ], "properties": { "amounts": { "description": "The amounts each recipient will receive. Must be the same length as amounts", "type": "array", "items": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, "coins": { "description": "The coins to be used for payment", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "recipients": { "description": "The addresses that will receive payment", "type": "array", "items": { "$ref": "#/components/schemas/SuiAddress" } } } }, "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 } ] }, "Result_of_Array_of_Tuple_of_uint_and_SuiExecutionResult_or_String": { "oneOf": [ { "type": "object", "required": [ "Ok" ], "properties": { "Ok": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "format": "uint", "minimum": 0.0 }, { "$ref": "#/components/schemas/SuiExecutionResult" } ], "maxItems": 2, "minItems": 2 } } } }, { "type": "object", "required": [ "Err" ], "properties": { "Err": { "type": "string" } } } ] }, "Secp256k1SuiSignature": { "$ref": "#/components/schemas/Base64" }, "Secp256r1SuiSignature": { "$ref": "#/components/schemas/Base64" }, "SequenceNumber": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "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 } ] }, "StakeSubsidy": { "type": "object", "required": [ "balance", "current_epoch_amount", "epoch_counter" ], "properties": { "balance": { "$ref": "#/components/schemas/Balance" }, "current_epoch_amount": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "epoch_counter": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "StakedSui": { "type": "object", "required": [ "delegation_request_epoch", "id", "pool_starting_epoch", "principal", "validator_address" ], "properties": { "delegation_request_epoch": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "id": { "$ref": "#/components/schemas/UID" }, "pool_starting_epoch": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "principal": { "$ref": "#/components/schemas/Balance" }, "sui_token_lock": { "type": [ "integer", "null" ], "format": "uint64", "minimum": 0.0 }, "validator_address": { "$ref": "#/components/schemas/SuiAddress" } } }, "StakingPool": { "description": "Rust version of the Move sui::staking_pool::StakingPool type", "type": "object", "required": [ "delegation_token_supply", "pending_delegations", "pending_withdraws", "rewards_pool", "starting_epoch", "sui_balance", "validator_address" ], "properties": { "delegation_token_supply": { "$ref": "#/components/schemas/Supply" }, "pending_delegations": { "$ref": "#/components/schemas/LinkedTable_for_ObjectID" }, "pending_withdraws": { "$ref": "#/components/schemas/TableVec" }, "rewards_pool": { "$ref": "#/components/schemas/Balance" }, "starting_epoch": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "sui_balance": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "validator_address": { "$ref": "#/components/schemas/SuiAddress" } } }, "SuiAddress": { "$ref": "#/components/schemas/Hex" }, "SuiAuthorityStrongQuorumSignInfo": { "type": "object", "required": [ "epoch", "signature", "signers_map" ], "properties": { "epoch": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "signature": { "$ref": "#/components/schemas/Base64" }, "signers_map": { "$ref": "#/components/schemas/Base64" } } }, "SuiChangeEpoch": { "type": "object", "required": [ "computation_charge", "epoch", "storage_charge" ], "properties": { "computation_charge": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "epoch": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "storage_charge": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "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" } } }, "SuiExecuteTransactionResponse": { "oneOf": [ { "type": "object", "required": [ "EffectsCert" ], "properties": { "EffectsCert": { "type": "object", "required": [ "certificate", "confirmed_local_execution", "effects" ], "properties": { "certificate": { "$ref": "#/components/schemas/CertifiedTransaction" }, "confirmed_local_execution": { "type": "boolean" }, "effects": { "$ref": "#/components/schemas/CertifiedTransactionEffects" } } } }, "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": [ { "type": "integer", "format": "uint8", "minimum": 0.0 }, { "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 function", "type": "array", "items": { "type": "array", "items": [ { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, { "$ref": "#/components/schemas/TypeTag" } ], "maxItems": 2, "minItems": 2 } } } }, "SuiGenesisTransaction": { "type": "object", "required": [ "objects" ], "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } } }, "SuiJsonValue": {}, "SuiMoveAbility": { "type": "string", "enum": [ "Copy", "Drop", "Store", "Key" ] }, "SuiMoveAbilitySet": { "type": "object", "required": [ "abilities" ], "properties": { "abilities": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveAbility" } } } }, "SuiMoveModuleId": { "type": "object", "required": [ "address", "name" ], "properties": { "address": { "type": "string" }, "name": { "type": "string" } } }, "SuiMoveNormalizedField": { "type": "object", "required": [ "name", "type_" ], "properties": { "name": { "type": "string" }, "type_": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } } }, "SuiMoveNormalizedFunction": { "type": "object", "required": [ "is_entry", "parameters", "return_", "type_parameters", "visibility" ], "properties": { "is_entry": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "return_": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "type_parameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveAbilitySet" } }, "visibility": { "$ref": "#/components/schemas/SuiMoveVisibility" } } }, "SuiMoveNormalizedModule": { "type": "object", "required": [ "address", "exposed_functions", "file_format_version", "friends", "name", "structs" ], "properties": { "address": { "type": "string" }, "exposed_functions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedFunction" } }, "file_format_version": { "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", "type_parameters" ], "properties": { "abilities": { "$ref": "#/components/schemas/SuiMoveAbilitySet" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedField" } }, "type_parameters": { "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", "type_arguments" ], "properties": { "address": { "type": "string" }, "module": { "type": "string" }, "name": { "type": "string" }, "type_arguments": { "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", "is_phantom" ], "properties": { "constraints": { "$ref": "#/components/schemas/SuiMoveAbilitySet" }, "is_phantom": { "type": "boolean" } } }, "SuiMoveVisibility": { "type": "string", "enum": [ "Private", "Public", "Friend" ] }, "SuiParsedMergeCoinResponse": { "type": "object", "required": [ "updatedCoin", "updatedGas" ], "properties": { "updatedCoin": { "description": "The updated original coin object after merge", "allOf": [ { "$ref": "#/components/schemas/Object" } ] }, "updatedGas": { "description": "The updated gas payment object after deducting payment", "allOf": [ { "$ref": "#/components/schemas/Object" } ] } } }, "SuiParsedPublishResponse": { "type": "object", "required": [ "createdObjects", "package", "updatedGas" ], "properties": { "createdObjects": { "description": "List of Move objects created as part of running the module initializers in the package", "type": "array", "items": { "$ref": "#/components/schemas/Object" } }, "package": { "description": "The newly published package object reference.", "allOf": [ { "$ref": "#/components/schemas/ObjectRef" } ] }, "updatedGas": { "description": "The updated gas payment object after deducting payment", "allOf": [ { "$ref": "#/components/schemas/Object" } ] } } }, "SuiParsedSplitCoinResponse": { "type": "object", "required": [ "newCoins", "updatedCoin", "updatedGas" ], "properties": { "newCoins": { "description": "All the newly created coin objects generated from the split", "type": "array", "items": { "$ref": "#/components/schemas/Object" } }, "updatedCoin": { "description": "The updated original coin object after split", "allOf": [ { "$ref": "#/components/schemas/Object" } ] }, "updatedGas": { "description": "The updated gas payment object after deducting payment", "allOf": [ { "$ref": "#/components/schemas/Object" } ] } } }, "SuiParsedTransactionResponse": { "oneOf": [ { "type": "object", "required": [ "Publish" ], "properties": { "Publish": { "$ref": "#/components/schemas/SuiParsedPublishResponse" } }, "additionalProperties": false }, { "type": "object", "required": [ "MergeCoin" ], "properties": { "MergeCoin": { "$ref": "#/components/schemas/SuiParsedMergeCoinResponse" } }, "additionalProperties": false }, { "type": "object", "required": [ "SplitCoin" ], "properties": { "SplitCoin": { "$ref": "#/components/schemas/SuiParsedSplitCoinResponse" } }, "additionalProperties": false } ] }, "SuiSystemState": { "description": "Rust version of the Move sui::sui_system::SuiSystemState type", "type": "object", "required": [ "epoch", "epoch_start_timestamp_ms", "info", "parameters", "reference_gas_price", "safe_mode", "stake_subsidy", "storage_fund", "treasury_cap", "validator_report_records", "validators" ], "properties": { "epoch": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "epoch_start_timestamp_ms": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "info": { "$ref": "#/components/schemas/UID" }, "parameters": { "$ref": "#/components/schemas/SystemParameters" }, "reference_gas_price": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "safe_mode": { "type": "boolean" }, "stake_subsidy": { "$ref": "#/components/schemas/StakeSubsidy" }, "storage_fund": { "$ref": "#/components/schemas/Balance" }, "treasury_cap": { "$ref": "#/components/schemas/Supply" }, "validator_report_records": { "$ref": "#/components/schemas/VecMap_for_SuiAddress_and_VecSet_for_SuiAddress" }, "validators": { "$ref": "#/components/schemas/ValidatorSet" } } }, "SuiTBlsSignObjectCommitmentType": { "oneOf": [ { "description": "Check that the object is committed by the consensus.", "type": "string", "enum": [ "ConsensusCommitted" ] }, { "description": "Check that the object is committed using the effects certificate.", "type": "object", "required": [ "FastPathCommitted" ], "properties": { "FastPathCommitted": { "$ref": "#/components/schemas/CertifiedTransactionEffects" } }, "additionalProperties": false } ] }, "SuiTBlsSignRandomnessObjectResponse": { "type": "object", "required": [ "signature" ], "properties": { "signature": { "$ref": "#/components/schemas/Base64" } } }, "SuiTransactionAuthSignersResponse": { "type": "object", "required": [ "signers" ], "properties": { "signers": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityPublicKeyBytes" } } } }, "SuiTransactionBuilderMode": { "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" ] } ] }, "SuiTransactionResponse": { "type": "object", "required": [ "certificate", "effects" ], "properties": { "certificate": { "$ref": "#/components/schemas/CertifiedTransaction" }, "effects": { "$ref": "#/components/schemas/TransactionEffects" }, "parsed_data": { "anyOf": [ { "$ref": "#/components/schemas/SuiParsedTransactionResponse" }, { "type": "null" } ] }, "timestamp_ms": { "type": [ "integer", "null" ], "format": "uint64", "minimum": 0.0 } } }, "Supply": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "SystemParameters": { "description": "Rust version of the Move sui::sui_system::SystemParameters type", "type": "object", "required": [ "max_validator_candidate_count", "min_validator_stake" ], "properties": { "max_validator_candidate_count": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "min_validator_stake": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "Table": { "description": "Rust version of the Move sui::table::Table type. Putting it here since we only use it in sui_system in the framework.", "type": "object", "required": [ "id", "size" ], "properties": { "id": { "$ref": "#/components/schemas/ObjectID" }, "size": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "TableVec": { "description": "Rust version of the Move sui::table::Table type. Putting it here since we only use it in sui_system in the framework.", "type": "object", "required": [ "contents" ], "properties": { "contents": { "$ref": "#/components/schemas/Table" } } }, "TransactionBytes": { "type": "object", "required": [ "gas", "inputObjects", "txBytes" ], "properties": { "gas": { "description": "the gas object to be used", "allOf": [ { "$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" } ] } } }, "TransactionData": { "type": "object", "required": [ "gasBudget", "gasPayment", "gasPrice", "sender", "transactions" ], "properties": { "gasBudget": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "gasPayment": { "$ref": "#/components/schemas/ObjectRef" }, "gasPrice": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionKind" } } } }, "TransactionDigest": { "description": "A transaction will have a (unique) digest.", "allOf": [ { "$ref": "#/components/schemas/Base58" } ] }, "TransactionEffects": { "description": "The response from processing a transaction or a certified transaction", "type": "object", "required": [ "gasObject", "gasUsed", "status", "transactionDigest" ], "properties": { "created": { "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "deleted": { "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" } }, "events": { "description": "The events emitted during execution. Note that only successful transactions emit events", "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "gasObject": { "$ref": "#/components/schemas/OwnedObjectRef" }, "gasUsed": { "$ref": "#/components/schemas/GasCostSummary" }, "mutated": { "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "sharedObjects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "status": { "$ref": "#/components/schemas/ExecutionStatus" }, "transactionDigest": { "$ref": "#/components/schemas/TransactionDigest" }, "unwrapped": { "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "wrapped": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } } } }, "TransactionEffectsDigest": { "$ref": "#/components/schemas/Base64" }, "TransactionKind": { "oneOf": [ { "description": "Initiate an object transfer between addresses", "type": "object", "required": [ "TransferObject" ], "properties": { "TransferObject": { "$ref": "#/components/schemas/TransferObject" } }, "additionalProperties": false }, { "description": "Pay one or more recipients from a set of input coins", "type": "object", "required": [ "Pay" ], "properties": { "Pay": { "$ref": "#/components/schemas/Pay" } }, "additionalProperties": false }, { "description": "Pay one or more recipients from a set of Sui coins, the input coins are also used to for gas payments.", "type": "object", "required": [ "PaySui" ], "properties": { "PaySui": { "$ref": "#/components/schemas/PaySui" } }, "additionalProperties": false }, { "description": "Pay one or more recipients from a set of Sui coins, the input coins are also used to for gas payments.", "type": "object", "required": [ "PayAllSui" ], "properties": { "PayAllSui": { "$ref": "#/components/schemas/PayAllSui" } }, "additionalProperties": false }, { "description": "Publish a new Move module", "type": "object", "required": [ "Publish" ], "properties": { "Publish": { "$ref": "#/components/schemas/MovePackage" } }, "additionalProperties": false }, { "description": "Call a function in a published Move module", "type": "object", "required": [ "Call" ], "properties": { "Call": { "$ref": "#/components/schemas/MoveCall" } }, "additionalProperties": false }, { "description": "Initiate a SUI coin transfer between addresses", "type": "object", "required": [ "TransferSui" ], "properties": { "TransferSui": { "$ref": "#/components/schemas/TransferSui" } }, "additionalProperties": false }, { "description": "A system transaction that will update epoch information on-chain.", "type": "object", "required": [ "ChangeEpoch" ], "properties": { "ChangeEpoch": { "$ref": "#/components/schemas/SuiChangeEpoch" } }, "additionalProperties": false }, { "description": "A system transaction used for initializing the initial state of the chain.", "type": "object", "required": [ "Genesis" ], "properties": { "Genesis": { "$ref": "#/components/schemas/SuiGenesisTransaction" } }, "additionalProperties": false } ] }, "TransactionQuery": { "oneOf": [ { "description": "All transaction hashes.", "type": "string", "enum": [ "All" ] }, { "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 mutated object.", "type": "object", "required": [ "MutatedObject" ], "properties": { "MutatedObject": { "$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 } ] }, "TransferObject": { "type": "object", "required": [ "objectRef", "recipient" ], "properties": { "objectRef": { "$ref": "#/components/schemas/ObjectRef" }, "recipient": { "$ref": "#/components/schemas/SuiAddress" } } }, "TransferObjectParams": { "type": "object", "required": [ "objectId", "recipient" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "recipient": { "$ref": "#/components/schemas/SuiAddress" } } }, "TransferSui": { "type": "object", "required": [ "recipient" ], "properties": { "amount": { "type": [ "integer", "null" ], "format": "uint64", "minimum": 0.0 }, "recipient": { "$ref": "#/components/schemas/SuiAddress" } } }, "TypeTag": { "type": "string" }, "UID": { "description": "Rust version of the Move sui::object::Info type", "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/ObjectID" } } }, "Validator": { "description": "Rust version of the Move sui::validator::Validator type", "type": "object", "required": [ "commission_rate", "delegation_staking_pool", "gas_price", "metadata", "pending_stake", "pending_withdraw", "stake_amount", "voting_power" ], "properties": { "commission_rate": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "delegation_staking_pool": { "$ref": "#/components/schemas/StakingPool" }, "gas_price": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "metadata": { "$ref": "#/components/schemas/ValidatorMetadata" }, "pending_stake": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "pending_withdraw": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "stake_amount": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "voting_power": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "ValidatorMetadata": { "type": "object", "required": [ "consensus_address", "description", "image_url", "name", "net_address", "network_pubkey_bytes", "next_epoch_commission_rate", "next_epoch_delegation", "next_epoch_gas_price", "next_epoch_stake", "project_url", "proof_of_possession_bytes", "pubkey_bytes", "sui_address", "worker_address", "worker_pubkey_bytes" ], "properties": { "consensus_address": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "description": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "image_url": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "name": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "net_address": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "network_pubkey_bytes": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "next_epoch_commission_rate": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "next_epoch_delegation": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "next_epoch_gas_price": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "next_epoch_stake": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "project_url": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "proof_of_possession_bytes": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "pubkey_bytes": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "sui_address": { "$ref": "#/components/schemas/SuiAddress" }, "worker_address": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } }, "worker_pubkey_bytes": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0.0 } } } }, "ValidatorPair": { "description": "Rust version of the Move sui::validator_set::ValidatorPair type", "type": "object", "required": [ "from", "to" ], "properties": { "from": { "$ref": "#/components/schemas/SuiAddress" }, "to": { "$ref": "#/components/schemas/SuiAddress" } } }, "ValidatorSet": { "description": "Rust version of the Move sui::validator_set::ValidatorSet type", "type": "object", "required": [ "active_validators", "delegation_stake", "next_epoch_validators", "pending_delegation_switches", "pending_removals", "pending_validators", "validator_stake" ], "properties": { "active_validators": { "type": "array", "items": { "$ref": "#/components/schemas/Validator" } }, "delegation_stake": { "type": "integer", "format": "uint64", "minimum": 0.0 }, "next_epoch_validators": { "type": "array", "items": { "$ref": "#/components/schemas/ValidatorMetadata" } }, "pending_delegation_switches": { "$ref": "#/components/schemas/VecMap_for_ValidatorPair_and_TableVec" }, "pending_removals": { "type": "array", "items": { "type": "integer", "format": "uint64", "minimum": 0.0 } }, "pending_validators": { "type": "array", "items": { "$ref": "#/components/schemas/Validator" } }, "validator_stake": { "type": "integer", "format": "uint64", "minimum": 0.0 } } }, "VecMap_for_SuiAddress_and_VecSet_for_SuiAddress": { "description": "Rust version of the Move sui::vec_map::VecMap type", "type": "object", "required": [ "contents" ], "properties": { "contents": { "type": "array", "items": { "$ref": "#/components/schemas/Entry_for_SuiAddress_and_VecSet_for_SuiAddress" } } } }, "VecMap_for_ValidatorPair_and_TableVec": { "description": "Rust version of the Move sui::vec_map::VecMap type", "type": "object", "required": [ "contents" ], "properties": { "contents": { "type": "array", "items": { "$ref": "#/components/schemas/Entry_for_ValidatorPair_and_TableVec" } } } }, "VecSet_for_SuiAddress": { "description": "Rust version of the Move sui::vec_set::VecSet type", "type": "object", "required": [ "contents" ], "properties": { "contents": { "type": "array", "items": { "$ref": "#/components/schemas/SuiAddress" } } } } } } }