{ "openrpc": "1.2.6", "info": { "title": "Sui JSON-RPC", "description": "Sui JSON-RPC API served by Inodra.", "license": { "name": "Apache-2.0", "url": "https://raw.githubusercontent.com/MystenLabs/sui/main/LICENSE" }, "version": "1.81.1" }, "methods": [ { "name": "sui_devInspectTransactionBlock", "tags": [ { "name": "Write API" } ], "description": "Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.", "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "name": "epoch", "description": "The epoch to perform the call. Will be set from the system state object if not provided", "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "name": "additional_args", "description": "Additional arguments including gas_budget, gas_objects, gas_sponsor and skip_checks.", "schema": { "$ref": "#/components/schemas/DevInspectArgs" } } ], "result": { "name": "DevInspectResults", "required": true, "schema": { "$ref": "#/components/schemas/DevInspectResults" } }, "examples": [ { "name": "Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.", "params": [ { "name": "sender_address", "value": "0xd70420418b84502e506794227f897237764dde8d79a01ab2104bf742a277a2ab" }, { "name": "tx_bytes", "value": "AAACACBnxtMcbJcOVn8D72fYEaT4Q2ZbjePygvpIs+AQO6m77QEAagYVO5/EhuEB8OnicDrIZm0GrsxN3355JqNhlwxlpbECAAAAAAAAACDoQ3EipycU+/EOvBcDPFtMkZiSbdzWAw3CwdmQCAtBWAEBAQEBAAEAAC9cVD1xauQ9RT3rOxmbva8bxwMMdoL4dwPc5DEkj+3gASxDgF0Nb1QCp60Npb3sVJx83qBrxKHTOaIlIe6pM7iJAgAAAAAAAAAgnvsgc1pPauyCE27/c+aBnHN3fSsxRAWdEJYzYFOryNAvXFQ9cWrkPUU96zsZm72vG8cDDHaC+HcD3OQxJI/t4AoAAAAAAAAAoIYBAAAAAAAA" }, { "name": "gas_price", "value": 1000 }, { "name": "epoch", "value": 8888 }, { "name": "additional_args", "value": null } ], "result": { "name": "Result", "value": { "effects": { "messageVersion": "v1", "status": { "status": "success" }, "executedEpoch": "0", "gasUsed": { "computationCost": "100", "storageCost": "100", "storageRebate": "10", "nonRefundableStorageFee": "0" }, "transactionDigest": "76gyHCk7FRrGACRqXM7Ybj5uJLtAzgEMJ5P9CeEzxZSG", "mutated": [ { "owner": { "AddressOwner": "0x2f5c543d716ae43d453deb3b199bbdaf1bc7030c7682f87703dce431248fede0" }, "reference": { "objectId": "0x2c43805d0d6f5402a7ad0da5bdec549c7cdea06bc4a1d339a22521eea933b889", "version": 2, "digest": "BhbWpBeESxuRWvmvLMyb2JNUuFa6j4aG1T4WUiPgKAHm" } }, { "owner": { "AddressOwner": "0x67c6d31c6c970e567f03ef67d811a4f843665b8de3f282fa48b3e0103ba9bbed" }, "reference": { "objectId": "0x6a06153b9fc486e101f0e9e2703ac8666d06aecc4ddf7e7926a361970c65a5b1", "version": 2, "digest": "GdfET1avZReDftpJNB8LSuHJ2cKUheSbEaLMzuPVXHsM" } } ], "gasObject": { "owner": { "ObjectOwner": "0x2f5c543d716ae43d453deb3b199bbdaf1bc7030c7682f87703dce431248fede0" }, "reference": { "objectId": "0x2c43805d0d6f5402a7ad0da5bdec549c7cdea06bc4a1d339a22521eea933b889", "version": 2, "digest": "BhbWpBeESxuRWvmvLMyb2JNUuFa6j4aG1T4WUiPgKAHm" } }, "eventsDigest": "6kerMphN4S5QTfd9TAhwMiFq1q9c2YwfpheBfWm85vUq" }, "events": [] } } } ] }, { "name": "sui_dryRunTransactionBlock", "tags": [ { "name": "Write 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": "DryRunTransactionBlockResponse", "required": true, "schema": { "$ref": "#/components/schemas/DryRunTransactionBlockResponse" } }, "examples": [ { "name": "Dry runs a transaction block to get back estimated gas fees and other potential effects.", "params": [ { "name": "tx_bytes", "value": "AAACACB7qR3cfnF89wjJNwYPBASHNuwz+xdG2Zml5YzVxnftgAEAT4LxyFh7mNZMAL+0bDhDvYv2zPp8ZahhOGmM0f3Kw9wCAAAAAAAAACCxDABG4pPAjOwPQHg9msS/SrtNf4IGR/2F0ZGD3ufH/wEBAQEBAAEAAGH7tbTzQqQL2/h/5KlGueONGM+P/HsAALl1F1x7apV2AejYx86GPzE9o9vZKoPvJtEouI/ma/JuDg0Jza9yfR2EAgAAAAAAAAAgzMqpegLMOpgEFnDhYJ23FOmFjJbp5GmFXxzzv9+X6GVh+7W080KkC9v4f+SpRrnjjRjPj/x7AAC5dRdce2qVdgoAAAAAAAAAoIYBAAAAAAAA" } ], "result": { "name": "Result", "value": { "digest": "DNtx7EmGqSywGbnSC1CKoqmBFEXGvApXpRVt6bU855xP", "transaction": { "data": { "messageVersion": "v1", "transaction": { "kind": "ProgrammableTransaction", "inputs": [ { "type": "pure", "valueType": "address", "value": "0x7ba91ddc7e717cf708c937060f04048736ec33fb1746d999a5e58cd5c677ed80" }, { "type": "object", "objectType": "immOrOwnedObject", "objectId": "0x4f82f1c8587b98d64c00bfb46c3843bd8bf6ccfa7c65a86138698cd1fdcac3dc", "version": "2", "digest": "Cv7n2YaM7Am1ssZGu4khsFkcKHnpgVhwFCSs4kLjrtLW" } ], "transactions": [ { "TransferObjects": [ [ { "Input": 1 } ], { "Input": 0 } ] } ] }, "sender": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576", "gasData": { "payment": [ { "objectId": "0xe8d8c7ce863f313da3dbd92a83ef26d128b88fe66bf26e0e0d09cdaf727d1d84", "version": 2, "digest": "EnRQXe1hDGAJCFyF2ds2GmPHdvf9V6yxf24LisEsDkYt" } ], "owner": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576", "price": "10", "budget": "100000" } }, "txSignatures": [ "AG+AHZMT7BZWQVagaGfENXyiFQ2nYRkG4XdnwqwToeJEmZ4J1IxKw0xKzTATGiUzFedY/nxKVuHikFibNlZ3wg9Dij1TvBYKLcfLNo8fq6GASb9yfo6uvuwNUBGkTf54wQ==" ] }, "rawTransaction": "AQAAAAAAAgAge6kd3H5xfPcIyTcGDwQEhzbsM/sXRtmZpeWM1cZ37YABAE+C8chYe5jWTAC/tGw4Q72L9sz6fGWoYThpjNH9ysPcAgAAAAAAAAAgsQwARuKTwIzsD0B4PZrEv0q7TX+CBkf9hdGRg97nx/8BAQEBAQABAABh+7W080KkC9v4f+SpRrnjjRjPj/x7AAC5dRdce2qVdgHo2MfOhj8xPaPb2SqD7ybRKLiP5mvybg4NCc2vcn0dhAIAAAAAAAAAIMzKqXoCzDqYBBZw4WCdtxTphYyW6eRphV8c87/fl+hlYfu1tPNCpAvb+H/kqUa5440Yz4/8ewAAuXUXXHtqlXYKAAAAAAAAAKCGAQAAAAAAAAFhAG+AHZMT7BZWQVagaGfENXyiFQ2nYRkG4XdnwqwToeJEmZ4J1IxKw0xKzTATGiUzFedY/nxKVuHikFibNlZ3wg9Dij1TvBYKLcfLNo8fq6GASb9yfo6uvuwNUBGkTf54wQ==", "effects": { "messageVersion": "v1", "status": { "status": "success" }, "executedEpoch": "0", "gasUsed": { "computationCost": "100", "storageCost": "100", "storageRebate": "10", "nonRefundableStorageFee": "0" }, "transactionDigest": "8UExPV121BEfWkbymSPDYhh23rVNh3MSWtC5juJ9JGMJ", "mutated": [ { "owner": { "AddressOwner": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576" }, "reference": { "objectId": "0xe8d8c7ce863f313da3dbd92a83ef26d128b88fe66bf26e0e0d09cdaf727d1d84", "version": 2, "digest": "EnRQXe1hDGAJCFyF2ds2GmPHdvf9V6yxf24LisEsDkYt" } }, { "owner": { "AddressOwner": "0x7ba91ddc7e717cf708c937060f04048736ec33fb1746d999a5e58cd5c677ed80" }, "reference": { "objectId": "0x4f82f1c8587b98d64c00bfb46c3843bd8bf6ccfa7c65a86138698cd1fdcac3dc", "version": 2, "digest": "Cv7n2YaM7Am1ssZGu4khsFkcKHnpgVhwFCSs4kLjrtLW" } } ], "gasObject": { "owner": { "ObjectOwner": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576" }, "reference": { "objectId": "0xe8d8c7ce863f313da3dbd92a83ef26d128b88fe66bf26e0e0d09cdaf727d1d84", "version": 2, "digest": "EnRQXe1hDGAJCFyF2ds2GmPHdvf9V6yxf24LisEsDkYt" } }, "eventsDigest": "55TNn3v5vpuXjQfjqamw76P9GZD522pumo4NuT7RYeFB" }, "objectChanges": [ { "type": "transferred", "sender": "0x61fbb5b4f342a40bdbf87fe4a946b9e38d18cf8ffc7b0000b975175c7b6a9576", "recipient": { "AddressOwner": "0x7ba91ddc7e717cf708c937060f04048736ec33fb1746d999a5e58cd5c677ed80" }, "objectType": "0x2::example::Object", "objectId": "0x4f82f1c8587b98d64c00bfb46c3843bd8bf6ccfa7c65a86138698cd1fdcac3dc", "version": "2", "digest": "B3xLC8EbyvTxy5pgiwTNUzHLa6kS7uwD6sZdErKB8F8f" } ] } } } ] }, { "name": "sui_executeTransactionBlock", "tags": [ { "name": "Write API" } ], "description": "Execute the transaction and wait for results if desired. Request types: 1. WaitForEffectsCert: waits for TransactionEffectsCert and then return to client. This mode is a proxy for transaction finality. 2. WaitForLocalExecution: waits for TransactionEffectsCert and make sure the node executed the transaction locally before returning the client. The local execution makes sure this node is aware of this transaction when client fires subsequent queries. However if the node fails to execute the transaction locally in a timely manner, a bool type in the response is set to false to indicated the case. request_type is default to be `WaitForEffectsCert` unless options.show_events or options.show_effects is true", "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": "signatures", "description": "A list of signatures (`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": { "type": "array", "items": { "$ref": "#/components/schemas/Base64" } } }, { "name": "options", "description": "options for specifying the content to be returned", "schema": { "$ref": "#/components/schemas/TransactionBlockResponseOptions" } }, { "name": "request_type", "description": "The request type, derived from `SuiTransactionBlockResponseOptions` if None", "schema": { "$ref": "#/components/schemas/ExecuteTransactionRequestType" } } ], "result": { "name": "SuiTransactionBlockResponse", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockResponse" } }, "examples": [ { "name": "Executes a transaction with serialized signatures.", "params": [ { "name": "tx_bytes", "value": "AAACACBqEB6aOvXIBwES+Ahkizbvv43uihqC3kbZUE6WoRCKFwEAjvdvVsOZYzousxC8qRJOXy84znOeqsu2YAaIgE4HhEgCAAAAAAAAACB9w3+ufZMpihJFwxtCBojBaGy00TVtFxgN2C6TpIPFqwEBAQEBAAEAAAS0l6kWtGVmCaf6gnoJGE1vR2gdO6dM4NejbGSysfiHAZ+Q9/hmzCnfsdpjc86U+dldylpA9OF2mRjuv5+64AvTAgAAAAAAAAAgjleHL0UiRGjh/BfIFHCJ3EMY/dQA22c2TvNQyVJnbYUEtJepFrRlZgmn+oJ6CRhNb0doHTunTODXo2xksrH4hwoAAAAAAAAAoIYBAAAAAAAA" }, { "name": "signatures", "value": [ "AKD4XdltkCyBi1Heb4EJJ3lzuV3F4u7+CYeaE+Fd7qXpaT17yd4tHWjMf4CWq3TuXBLxTpkc2MV39P6p7eMV8QnqvbuA0Q1Bqu4RHV3JPpqmH+C527hWJGUBOZN1j9sg8w==" ] }, { "name": "options", "value": { "showInput": true, "showRawInput": true, "showEffects": true, "showEvents": true, "showObjectChanges": true, "showBalanceChanges": true, "showRawEffects": false } }, { "name": "request_type", "value": "WaitForLocalExecution" } ], "result": { "name": "Result", "value": { "digest": "Gx7V6EteEAqSsptc1kbi1nUEMP7mhr4qV2cYS7JjzbBd", "transaction": { "data": { "messageVersion": "v1", "transaction": { "kind": "ProgrammableTransaction", "inputs": [ { "type": "pure", "valueType": "address", "value": "0x6a101e9a3af5c8070112f808648b36efbf8dee8a1a82de46d9504e96a1108a17" }, { "type": "object", "objectType": "immOrOwnedObject", "objectId": "0x8ef76f56c399633a2eb310bca9124e5f2f38ce739eaacbb6600688804e078448", "version": "2", "digest": "9Tvs1pGrMbNv7kkr1PoKLsWamyQpaFz5UWbL2AQ1ezk2" } ], "transactions": [ { "TransferObjects": [ [ { "Input": 1 } ], { "Input": 0 } ] } ] }, "sender": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887", "gasData": { "payment": [ { "objectId": "0x9f90f7f866cc29dfb1da6373ce94f9d95dca5a40f4e1769918eebf9fbae00bd3", "version": 2, "digest": "AaeJbTYkUuyromsivxzkoxSkHt7pCESTyQG7xz6nbQ2G" } ], "owner": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887", "price": "10", "budget": "100000" } }, "txSignatures": [ "AKD4XdltkCyBi1Heb4EJJ3lzuV3F4u7+CYeaE+Fd7qXpaT17yd4tHWjMf4CWq3TuXBLxTpkc2MV39P6p7eMV8QnqvbuA0Q1Bqu4RHV3JPpqmH+C527hWJGUBOZN1j9sg8w==" ] }, "rawTransaction": "AQAAAAAAAgAgahAemjr1yAcBEvgIZIs277+N7ooagt5G2VBOlqEQihcBAI73b1bDmWM6LrMQvKkSTl8vOM5znqrLtmAGiIBOB4RIAgAAAAAAAAAgfcN/rn2TKYoSRcMbQgaIwWhstNE1bRcYDdguk6SDxasBAQEBAQABAAAEtJepFrRlZgmn+oJ6CRhNb0doHTunTODXo2xksrH4hwGfkPf4Zswp37HaY3POlPnZXcpaQPThdpkY7r+fuuAL0wIAAAAAAAAAII5Xhy9FIkRo4fwXyBRwidxDGP3UANtnNk7zUMlSZ22FBLSXqRa0ZWYJp/qCegkYTW9HaB07p0zg16NsZLKx+IcKAAAAAAAAAKCGAQAAAAAAAAFhAKD4XdltkCyBi1Heb4EJJ3lzuV3F4u7+CYeaE+Fd7qXpaT17yd4tHWjMf4CWq3TuXBLxTpkc2MV39P6p7eMV8QnqvbuA0Q1Bqu4RHV3JPpqmH+C527hWJGUBOZN1j9sg8w==", "effects": { "messageVersion": "v1", "status": { "status": "success" }, "executedEpoch": "0", "gasUsed": { "computationCost": "100", "storageCost": "100", "storageRebate": "10", "nonRefundableStorageFee": "0" }, "transactionDigest": "9agZ3azEMgMqxrDVG8P4GddELfWag2HhimEkpjixHhGE", "mutated": [ { "owner": { "AddressOwner": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887" }, "reference": { "objectId": "0x9f90f7f866cc29dfb1da6373ce94f9d95dca5a40f4e1769918eebf9fbae00bd3", "version": 2, "digest": "AaeJbTYkUuyromsivxzkoxSkHt7pCESTyQG7xz6nbQ2G" } }, { "owner": { "AddressOwner": "0x6a101e9a3af5c8070112f808648b36efbf8dee8a1a82de46d9504e96a1108a17" }, "reference": { "objectId": "0x8ef76f56c399633a2eb310bca9124e5f2f38ce739eaacbb6600688804e078448", "version": 2, "digest": "9Tvs1pGrMbNv7kkr1PoKLsWamyQpaFz5UWbL2AQ1ezk2" } } ], "gasObject": { "owner": { "ObjectOwner": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887" }, "reference": { "objectId": "0x9f90f7f866cc29dfb1da6373ce94f9d95dca5a40f4e1769918eebf9fbae00bd3", "version": 2, "digest": "AaeJbTYkUuyromsivxzkoxSkHt7pCESTyQG7xz6nbQ2G" } }, "eventsDigest": "816hEv4WAW2reK9xkf11PeHiaZJrp7PQT9oGJZhdf9TN" }, "objectChanges": [ { "type": "transferred", "sender": "0x04b497a916b4656609a7fa827a09184d6f47681d3ba74ce0d7a36c64b2b1f887", "recipient": { "AddressOwner": "0x6a101e9a3af5c8070112f808648b36efbf8dee8a1a82de46d9504e96a1108a17" }, "objectType": "0x2::example::Object", "objectId": "0x8ef76f56c399633a2eb310bca9124e5f2f38ce739eaacbb6600688804e078448", "version": "2", "digest": "7PsBHpUW6yfGNov2WrbVafLjgT9nYziQ3gVDbRq6zTbF" } ] } } } ] }, { "name": "sui_getChainIdentifier", "tags": [ { "name": "Read API" } ], "description": "Return the first four bytes of the chain's genesis checkpoint digest.", "params": [], "result": { "name": "String", "required": true, "schema": { "type": "string" } }, "examples": [ { "name": "Gets the identifier for the chain receiving the POST.", "params": [], "result": { "name": "Result", "value": "4c78adac" } } ] }, { "name": "sui_getCheckpoint", "tags": [ { "name": "Read API" } ], "description": "Return a checkpoint", "params": [ { "name": "id", "description": "Checkpoint identifier, can use either checkpoint digest, or checkpoint sequence number as input.", "required": true, "schema": { "$ref": "#/components/schemas/CheckpointId" } } ], "result": { "name": "Checkpoint", "required": true, "schema": { "$ref": "#/components/schemas/Checkpoint" } }, "examples": [ { "name": "Gets checkpoint information for the checkpoint ID in the request.", "params": [ { "name": "id", "value": "1000" } ], "result": { "name": "Result", "value": { "epoch": "5000", "sequenceNumber": "1000", "digest": "G6Dtzr1ZSfHFhotGsTE3cLENa7L1ooe1BBvknAUsARbV", "networkTotalTransactions": "792385", "previousDigest": "6tBy8RXZKrdrB4XkMQn7J3MNG4fQCo9XcRduFFvYrL5Z", "epochRollingGasCostSummary": { "computationCost": "0", "storageCost": "0", "storageRebate": "0", "nonRefundableStorageFee": "0" }, "timestampMs": "1676911928", "transactions": [ "mN8YNBgVR3wB7vfXmjVgDRF4oqxVRRjzmJ6U4mzbq77" ], "checkpointCommitments": [], "validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } } } ] }, { "name": "sui_getCheckpoints", "tags": [ { "name": "Read API" } ], "description": "Return paginated list of checkpoints", "params": [ { "name": "cursor", "description": "An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.", "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "name": "limit", "description": "Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT_CHECKPOINTS] if not specified.", "schema": { "type": "integer", "format": "uint", "minimum": 0 } }, { "name": "descending_order", "description": "query result ordering, default to false (ascending order), oldest record first.", "required": true, "schema": { "type": "boolean" } } ], "result": { "name": "CheckpointPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_Checkpoint_and_BigInt_for_uint64" } }, "examples": [ { "name": "Gets a paginated list in descending order of all checkpoints starting at the provided cursor. Each page of results has a maximum number of checkpoints set by the provided limit.", "params": [ { "name": "cursor", "value": "1004" }, { "name": "limit", "value": 4 }, { "name": "descending_order", "value": false } ], "result": { "name": "Result", "value": { "data": [ { "epoch": "5000", "sequenceNumber": "1005", "digest": "9zA7Q9Ka1ykvYjSQGhQCdCf32FZkcWNWx7L22JczXGsk", "networkTotalTransactions": "792385", "previousDigest": "8BLFxLTjWZ2KqaGc3FjR1o9aL6kbyYrmhuNfJLU1ehYt", "epochRollingGasCostSummary": { "computationCost": "0", "storageCost": "0", "storageRebate": "0", "nonRefundableStorageFee": "0" }, "timestampMs": "1676911928", "transactions": [ "7RudGLkQDBNJyqrptkrNU66Zd3pvq8MHVAHYz9WpBm59" ], "checkpointCommitments": [], "validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" }, { "epoch": "5000", "sequenceNumber": "1006", "digest": "FAUWHyWacmb4Vg4QGi9a6gqeVb7ixAZiL73FaGd6WpoV", "networkTotalTransactions": "792385", "previousDigest": "6Pn25cieaE62AT6BwCeBoca13AGZuneucaaTGqt3gNCo", "epochRollingGasCostSummary": { "computationCost": "0", "storageCost": "0", "storageRebate": "0", "nonRefundableStorageFee": "0" }, "timestampMs": "1676911928", "transactions": [ "7r7tmP5hzgrusiN6cucFwfTveqDb7K75tMJ7oNCyoDmy" ], "checkpointCommitments": [], "validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" }, { "epoch": "5000", "sequenceNumber": "1007", "digest": "B3mzC6gy87SomUQwPsmVY7mtwkZLxfm5WwNi3kKyEb3x", "networkTotalTransactions": "792385", "previousDigest": "CnHTfdUJr1UUqwXkYUhbQjXeM16xR33UR62jE72toCis", "epochRollingGasCostSummary": { "computationCost": "0", "storageCost": "0", "storageRebate": "0", "nonRefundableStorageFee": "0" }, "timestampMs": "1676911928", "transactions": [ "Gb1UDqhmKMzMJ5FL37kBqCcuy4TtBL2ay3qec8tEUBLj" ], "checkpointCommitments": [], "validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" }, { "epoch": "5000", "sequenceNumber": "1008", "digest": "HunuJWKu7azBfS47rJTq9FHTMvUDNVo2SK4hQeh5brXp", "networkTotalTransactions": "792385", "previousDigest": "38fLUfuigyzLPEDrsmRhcQmhKtbEUohuFBP9NDcWBmFz", "epochRollingGasCostSummary": { "computationCost": "0", "storageCost": "0", "storageRebate": "0", "nonRefundableStorageFee": "0" }, "timestampMs": "1676911928", "transactions": [ "GWTS9QR7mjNz9fBWGkk4JZU3mrzMXrmj74uS59Cd5und" ], "checkpointCommitments": [], "validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } ], "nextCursor": "1008", "hasNextPage": true } } } ] }, { "name": "sui_getEvents", "tags": [ { "name": "Read API" } ], "description": "Return transaction events.", "params": [ { "name": "transaction_digest", "description": "the event query criteria.", "required": true, "schema": { "$ref": "#/components/schemas/TransactionDigest" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } }, "examples": [ { "name": "Returns the events the transaction in the request emits.", "params": [ { "name": "transaction_digest", "value": "11a72GCQ5hGNpWGh2QhQkkusTEGS6EDqifJqxr7nSYX" } ], "result": { "name": "Result", "value": { "data": [ { "id": { "txDigest": "11a72GCQ5hGNpWGh2QhQkkusTEGS6EDqifJqxr7nSYX", "eventSeq": "0" }, "packageId": "0xc54ab30a3d9adc07c1429c4d6bbecaf9457c9af77a91f631760853934d383634", "transactionModule": "test_module", "sender": "0xbcf7c32655009a61f1de0eae420a2e4ae1bb772ab2dd5d5a7dfa949c0ef06908", "type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestEvent", "parsedJson": { "test": "example value" }, "bcsEncoding": "base64", "bcs": "" } ], "nextCursor": { "txDigest": "11a72GCQ5hGNpWGh2QhQkkusTEGS6EDqifJqxr7nSYX", "eventSeq": "5" }, "hasNextPage": false } } } ] }, { "name": "sui_getLatestCheckpointSequenceNumber", "tags": [ { "name": "Read API" } ], "description": "Return the sequence number of the latest checkpoint that has been executed", "params": [], "result": { "name": "BigInt", "required": true, "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "examples": [ { "name": "Gets the sequence number for the latest checkpoint.", "params": [], "result": { "name": "Result", "value": "507021" } } ] }, { "name": "sui_getMoveFunctionArgTypes", "tags": [ { "name": "Move Utils" } ], "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" } } }, "examples": [ { "name": "Returns the argument types for the package and function the request provides.", "params": [ { "name": "package", "value": "0xa0a7b108f5023b7356f2c6a4be6f058e267aae38e08260c7d519d8641897490c" }, { "name": "module", "value": "suifrens" }, { "name": "function", "value": "mint" } ], "result": { "name": "Result", "value": [ { "Object": "ByMutableReference" }, "Pure", "Pure", { "Object": "ByValue" }, { "Object": "ByImmutableReference" }, { "Object": "ByValue" }, { "Object": "ByMutableReference" } ] } } ] }, { "name": "sui_getNormalizedMoveFunction", "tags": [ { "name": "Move Utils" } ], "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" } }, "examples": [ { "name": "Returns the structured representation of the function the request provides.", "params": [ { "name": "package", "value": "0x9c4eb6769ca8b6a23efeb7298cf0a8d0b837b78749c2cfc711c42036cc6b7621" }, { "name": "module_name", "value": "moduleName" }, { "name": "function_name", "value": "functionName" } ], "result": { "name": "Result", "value": { "visibility": "Public", "isEntry": false, "typeParameters": [ { "abilities": [ "Store", "Key" ] } ], "parameters": [ "U64" ], "return": [ "U64" ] } } } ] }, { "name": "sui_getNormalizedMoveModule", "tags": [ { "name": "Move Utils" } ], "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" } }, "examples": [ { "name": "Gets a structured representation of the Move module for the package in the request.", "params": [ { "name": "package", "value": "0x0047d5fa0a823e7d0ff4d55c32b09995a0ae1eedfee9c7b1354e805ed10ee3d0" }, { "name": "module_name", "value": "module" } ], "result": { "name": "Result", "value": { "fileFormatVersion": 6, "address": "0x1639f3606a53f61f3a566963b3eac49fe3bb57d304a454ed2f4859b44f4e4918", "name": "module", "friends": [], "structs": {}, "exposedFunctions": {} } } } ] }, { "name": "sui_getNormalizedMoveModulesByPackage", "tags": [ { "name": "Move Utils" } ], "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" } } }, "examples": [ { "name": "Gets structured representations of all the modules for the package in the request.", "params": [ { "name": "package", "value": "0x61630d3505f8905a0f4d42c6ff39a78a6ba2b28f68a3299ec3417bbabc6717dc" } ], "result": { "name": "Result", "value": { "fileFormatVersion": 6, "address": "0x800105867da4655eca6d9eb1258bfd1ad92af329a07781ee71e60065e00f2de9", "name": "module", "friends": [], "structs": {}, "exposedFunctions": {} } } } ] }, { "name": "sui_getNormalizedMoveStruct", "tags": [ { "name": "Move Utils" } ], "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" } }, "examples": [ { "name": "Gets a structured representation of the struct in the request.", "params": [ { "name": "package", "value": "0xc95b9e341bc3aba1654bdbad707dcd773bd6309363447ef3fe58a960de92aa93" }, { "name": "module_name", "value": "module" }, { "name": "struct_name", "value": "StructName" } ], "result": { "name": "Result", "value": { "abilities": { "abilities": [ "Store", "Key" ] }, "typeParameters": [], "fields": [] } } } ] }, { "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" } }, { "name": "options", "description": "options for specifying the content to be returned", "schema": { "$ref": "#/components/schemas/ObjectDataOptions" } } ], "result": { "name": "SuiObjectResponse", "required": true, "schema": { "$ref": "#/components/schemas/SuiObjectResponse" } }, "examples": [ { "name": "Gets Object data for the ID in the request.", "params": [ { "name": "object_id", "value": "0x53e4567ccafa5f36ce84c80aa8bc9be64e0d5ae796884274aef3005ae6733809" }, { "name": "options", "value": { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": true, "showBcs": false, "showStorageRebate": true } } ], "result": { "name": "Result", "value": { "data": { "objectId": "0x53e4567ccafa5f36ce84c80aa8bc9be64e0d5ae796884274aef3005ae6733809", "version": "1", "digest": "33K5ZXJ3RyubvYaHuEnQ1QXmmbhgtrFwp199dnEbL4n7", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0xc8ec1d5b84dd6289e193b9f88de4a994358c9f856135236c3e75a925e1c77ac3" }, "previousTransaction": "5PLgmQye6rraDYqpV3npV6H1cUXoJZgJh1dPCyRa3WCv", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "100000000", "id": { "id": "0x53e4567ccafa5f36ce84c80aa8bc9be64e0d5ae796884274aef3005ae6733809" } } } } } } } ] }, { "name": "sui_getProtocolConfig", "tags": [ { "name": "Read API" } ], "description": "Return the protocol config table for the given version number. If none is specified, the node uses the version of the latest epoch it has processed.", "params": [ { "name": "version", "description": "An optional protocol version specifier. If omitted, the latest protocol config table for the node will be returned.", "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "ProtocolConfigResponse", "required": true, "schema": { "$ref": "#/components/schemas/ProtocolConfig" } }, "examples": [ { "name": "Returns the protocol config for the given protocol version. If none is specified, the node uses the version of the latest epoch it has processed", "params": [ { "name": "version", "value": 6 } ], "result": { "name": "Result", "value": { "minSupportedProtocolVersion": "1", "maxSupportedProtocolVersion": "112", "protocolVersion": "6", "featureFlags": { "abstract_size_in_object_runtime": false, "accept_passkey_in_multisig": false, "accept_zklogin_in_multisig": false, "additional_borrow_checks": false, "additional_consensus_digest_indirect_state": false, "additional_multisig_checks": false, "address_aliases": false, "advance_epoch_start_time_in_safe_mode": true, "advance_to_highest_supported_protocol_version": false, "allow_private_accumulator_entrypoints": false, "allow_receiving_object_id": false, "allow_references_in_ptbs": false, "allow_unbounded_system_objects": false, "authority_capabilities_v2": false, "ban_entry_init": false, "better_adapter_type_resolution_errors": false, "better_loader_errors": false, "bridge": false, "cancel_for_failed_dkg_early": false, "check_for_init_during_upgrade": false, "commit_root_state_digest": false, "consensus_always_accept_system_transactions": false, "consensus_batched_block_sync": false, "consensus_checkpoint_signature_key_includes_digest": false, "consensus_distributed_vote_scoring_strategy": false, "consensus_linearize_subdag_v2": false, "consensus_median_based_commit_timestamp": false, "consensus_order_end_of_epoch_last": true, "consensus_round_prober": false, "consensus_round_prober_probe_accepted_rounds": false, "consensus_skip_gced_accept_votes": false, "consensus_skip_gced_blocks_in_direct_finalization": false, "consensus_smart_ancestor_selection": false, "consensus_zstd_compression": false, "convert_type_argument_error": false, "convert_withdrawal_compatibility_ptb_arguments": false, "correct_gas_payment_limit_check": false, "create_root_accumulator_object": false, "debug_fatal_on_move_invariant_violation": false, "dependency_linkage_error": false, "deprecate_global_storage_ops": false, "deprecate_global_storage_ops_during_deserialization": false, "disable_entry_point_signature_check": false, "disable_invariant_violation_check_in_swap_loc": false, "disable_preconsensus_locking": false, "disallow_adding_abilities_on_upgrade": false, "disallow_change_struct_type_params_on_upgrade": false, "disallow_new_modules_in_deps_only_packages": false, "disallow_self_identifier": false, "enable_accumulators": false, "enable_address_balance_gas_payments": false, "enable_authenticated_event_streams": false, "enable_coin_deny_list": false, "enable_coin_deny_list_v2": false, "enable_coin_registry": false, "enable_coin_reservation_obj_refs": false, "enable_display_registry": false, "enable_effects_v2": false, "enable_group_ops_native_function_msm": false, "enable_group_ops_native_functions": false, "enable_jwk_consensus_updates": false, "enable_multi_epoch_transaction_expiration": false, "enable_nitro_attestation": false, "enable_nitro_attestation_all_nonzero_pcrs_parsing": false, "enable_nitro_attestation_always_include_required_pcrs_parsing": false, "enable_nitro_attestation_upgraded_parsing": false, "enable_non_exclusive_writes": false, "enable_object_funds_withdraw": false, "enable_party_transfer": false, "enable_poseidon": false, "enable_ptb_execution_v2": false, "enable_ristretto255_group_ops": false, "enable_vdf": false, "end_of_epoch_transaction_supported": false, "enforce_checkpoint_timestamp_monotonicity": false, "fix_checkpoint_signature_mapping": false, "flexible_tx_context_positions": false, "fresh_vm_on_framework_upgrade": false, "gas_rounding_halve_digits": false, "generate_df_type_layouts": false, "hardened_otw_check": false, "ignore_execution_time_observations_after_certs_closed": false, "include_cancelled_randomness_txns_in_prologue": false, "include_checkpoint_artifacts_digest_in_summary": false, "include_consensus_digest_in_prologue": false, "loaded_child_object_format": false, "loaded_child_object_format_type": false, "loaded_child_objects_fixed": true, "max_ptb_value_size_v2": false, "minimize_child_object_mutations": false, "missing_type_is_compatibility_error": true, "move_native_context": false, "mysticeti_fastpath": false, "mysticeti_leader_scoring_and_schedule": false, "mysticeti_use_committed_subdag_digest": false, "narwhal_certificate_v2": false, "narwhal_new_leader_election_schedule": false, "narwhal_versioned_metadata": false, "native_charging_v2": false, "no_extraneous_module_bytes": false, "normalize_ptb_arguments": false, "object_runtime_charge_cache_load_gas": false, "package_digest_hash_module": false, "package_upgrades": true, "passkey_auth": false, "per_command_shared_object_transfer_rules": false, "prepend_prologue_tx_in_consensus_commit_in_checkpoints": false, "private_generics_verifier_v2": false, "random_beacon": false, "receive_objects": false, "recompute_has_public_transfer_in_execution": false, "record_additional_state_digest_in_prologue": false, "record_consensus_determined_version_assignments_in_prologue": false, "record_consensus_determined_version_assignments_in_prologue_v2": false, "record_time_estimate_processed": false, "reject_mutable_random_on_entry_functions": false, "relocate_event_module": false, "reshare_at_same_initial_version": false, "resolve_abort_locations_to_package_id": false, "resolve_type_input_ids_to_defining_id": false, "restrict_hot_or_not_entry_functions": false, "rethrow_serialization_type_layout_errors": false, "scoring_decision_with_validity_cutoff": true, "shared_object_deletion": false, "simple_conservation_checks": false, "simplified_unwrap_then_delete": false, "soft_bundle": false, "split_checkpoints_in_consensus_handler": false, "throughput_aware_consensus_submission": false, "txn_base_cost_as_multiplier": false, "type_tags_in_object_runtime": false, "uncompressed_g1_group_elements": false, "upgraded_multisig_supported": false, "use_mfp_txns_in_load_initial_object_debts": false, "use_new_commit_handler": false, "validate_identifier_inputs": false, "validate_zklogin_public_identifier": false, "validator_metadata_verify_v2": false, "variant_nodes": false, "verify_legacy_zklogin_address": false, "zklogin_auth": false }, "attributes": { "accumulator_object_storage_cost": null, "address_from_bytes_cost_base": { "u64": "52" }, "address_from_u256_cost_base": { "u64": "52" }, "address_to_u256_cost_base": { "u64": "52" }, "allowed_txn_cost_overage_burst_per_object_in_commit": null, "base_tx_cost_fixed": { "u64": "2000" }, "base_tx_cost_per_byte": { "u64": "0" }, "bcs_failure_cost": null, "bcs_legacy_min_output_size_cost": null, "bcs_per_byte_serialized_cost": null, "binary_address_identifiers": null, "binary_constant_pool": null, "binary_enum_def_instantiations": null, "binary_enum_defs": null, "binary_field_handles": null, "binary_field_instantiations": null, "binary_friend_decls": null, "binary_function_defs": null, "binary_function_handles": null, "binary_function_instantiations": null, "binary_identifiers": null, "binary_module_handles": null, "binary_signatures": null, "binary_struct_def_instantiations": null, "binary_struct_defs": null, "binary_struct_handles": null, "binary_variant_handles": null, "binary_variant_instantiation_handles": null, "bls12381_bls12381_min_pk_verify_cost_base": { "u64": "52" }, "bls12381_bls12381_min_pk_verify_msg_cost_per_block": { "u64": "2" }, "bls12381_bls12381_min_pk_verify_msg_cost_per_byte": { "u64": "2" }, "bls12381_bls12381_min_sig_verify_cost_base": { "u64": "52" }, "bls12381_bls12381_min_sig_verify_msg_cost_per_block": { "u64": "2" }, "bls12381_bls12381_min_sig_verify_msg_cost_per_byte": { "u64": "2" }, "bridge_should_try_to_finalize_committee": null, "buffer_stake_for_protocol_upgrade_bps": { "u64": "5000" }, "check_zklogin_id_cost_base": null, "check_zklogin_issuer_cost_base": null, "checkpoint_summary_version_specific_data": null, "config_read_setting_impl_cost_base": null, "config_read_setting_impl_cost_per_byte": null, "consensus_bad_nodes_stake_threshold": null, "consensus_commit_rate_estimation_window_size": null, "consensus_gc_depth": null, "consensus_max_num_transactions_in_block": null, "consensus_max_transaction_size_bytes": null, "consensus_max_transactions_in_block_bytes": null, "consensus_voting_rounds": null, "crypto_invalid_arguments_cost": { "u64": "100" }, "debug_print_base_cost": null, "debug_print_stack_trace_base_cost": null, "dynamic_field_add_child_object_cost_base": { "u64": "100" }, "dynamic_field_add_child_object_struct_tag_cost_per_byte": { "u64": "10" }, "dynamic_field_add_child_object_type_cost_per_byte": { "u64": "10" }, "dynamic_field_add_child_object_value_cost_per_byte": { "u64": "10" }, "dynamic_field_borrow_child_object_child_ref_cost_per_byte": { "u64": "10" }, "dynamic_field_borrow_child_object_cost_base": { "u64": "100" }, "dynamic_field_borrow_child_object_type_cost_per_byte": { "u64": "10" }, "dynamic_field_has_child_object_cost_base": { "u64": "100" }, "dynamic_field_has_child_object_with_ty_cost_base": { "u64": "100" }, "dynamic_field_has_child_object_with_ty_type_cost_per_byte": { "u64": "2" }, "dynamic_field_has_child_object_with_ty_type_tag_cost_per_byte": { "u64": "2" }, "dynamic_field_hash_type_and_key_cost_base": { "u64": "100" }, "dynamic_field_hash_type_and_key_type_cost_per_byte": { "u64": "2" }, "dynamic_field_hash_type_and_key_type_tag_cost_per_byte": { "u64": "2" }, "dynamic_field_hash_type_and_key_value_cost_per_byte": { "u64": "2" }, "dynamic_field_remove_child_object_child_cost_per_byte": { "u64": "2" }, "dynamic_field_remove_child_object_cost_base": { "u64": "100" }, "dynamic_field_remove_child_object_type_cost_per_byte": { "u64": "2" }, "ecdsa_k1_decompress_pubkey_cost_base": { "u64": "52" }, "ecdsa_k1_ecrecover_keccak256_cost_base": { "u64": "52" }, "ecdsa_k1_ecrecover_keccak256_msg_cost_per_block": { "u64": "2" }, "ecdsa_k1_ecrecover_keccak256_msg_cost_per_byte": { "u64": "2" }, "ecdsa_k1_ecrecover_sha256_cost_base": { "u64": "52" }, "ecdsa_k1_ecrecover_sha256_msg_cost_per_block": { "u64": "2" }, "ecdsa_k1_ecrecover_sha256_msg_cost_per_byte": { "u64": "2" }, "ecdsa_k1_secp256k1_verify_keccak256_cost_base": { "u64": "52" }, "ecdsa_k1_secp256k1_verify_keccak256_msg_cost_per_block": { "u64": "2" }, "ecdsa_k1_secp256k1_verify_keccak256_msg_cost_per_byte": { "u64": "2" }, "ecdsa_k1_secp256k1_verify_sha256_cost_base": { "u64": "52" }, "ecdsa_k1_secp256k1_verify_sha256_msg_cost_per_block": { "u64": "2" }, "ecdsa_k1_secp256k1_verify_sha256_msg_cost_per_byte": { "u64": "2" }, "ecdsa_r1_ecrecover_keccak256_cost_base": { "u64": "52" }, "ecdsa_r1_ecrecover_keccak256_msg_cost_per_block": { "u64": "2" }, "ecdsa_r1_ecrecover_keccak256_msg_cost_per_byte": { "u64": "2" }, "ecdsa_r1_ecrecover_sha256_cost_base": { "u64": "52" }, "ecdsa_r1_ecrecover_sha256_msg_cost_per_block": { "u64": "2" }, "ecdsa_r1_ecrecover_sha256_msg_cost_per_byte": { "u64": "2" }, "ecdsa_r1_secp256r1_verify_keccak256_cost_base": { "u64": "52" }, "ecdsa_r1_secp256r1_verify_keccak256_msg_cost_per_block": { "u64": "2" }, "ecdsa_r1_secp256r1_verify_keccak256_msg_cost_per_byte": { "u64": "2" }, "ecdsa_r1_secp256r1_verify_sha256_cost_base": { "u64": "52" }, "ecdsa_r1_secp256r1_verify_sha256_msg_cost_per_block": { "u64": "2" }, "ecdsa_r1_secp256r1_verify_sha256_msg_cost_per_byte": { "u64": "2" }, "ecvrf_ecvrf_verify_alpha_string_cost_per_block": { "u64": "2" }, "ecvrf_ecvrf_verify_alpha_string_cost_per_byte": { "u64": "2" }, "ecvrf_ecvrf_verify_cost_base": { "u64": "52" }, "ed25519_ed25519_verify_cost_base": { "u64": "52" }, "ed25519_ed25519_verify_msg_cost_per_block": { "u64": "2" }, "ed25519_ed25519_verify_msg_cost_per_byte": { "u64": "2" }, "event_emit_auth_stream_cost": null, "event_emit_cost_base": { "u64": "52" }, "event_emit_output_cost_per_byte": { "u64": "10" }, "event_emit_tag_size_derivation_cost_per_byte": { "u64": "5" }, "event_emit_value_size_derivation_cost_per_byte": { "u64": "2" }, "execution_version": null, "gas_budget_based_txn_cost_absolute_cap_commit_count": null, "gas_budget_based_txn_cost_cap_factor": null, "gas_model_version": { "u64": "5" }, "gas_rounding_step": null, "groth16_prepare_verifying_key_bls12381_cost_base": { "u64": "52" }, "groth16_prepare_verifying_key_bn254_cost_base": { "u64": "52" }, "groth16_verify_groth16_proof_internal_bls12381_cost_base": { "u64": "52" }, "groth16_verify_groth16_proof_internal_bls12381_cost_per_public_input": { "u64": "2" }, "groth16_verify_groth16_proof_internal_bn254_cost_base": { "u64": "52" }, "groth16_verify_groth16_proof_internal_bn254_cost_per_public_input": { "u64": "2" }, "groth16_verify_groth16_proof_internal_public_input_cost_per_byte": { "u64": "2" }, "group_ops_bls12381_decode_g1_cost": null, "group_ops_bls12381_decode_g2_cost": null, "group_ops_bls12381_decode_gt_cost": null, "group_ops_bls12381_decode_scalar_cost": null, "group_ops_bls12381_g1_add_cost": null, "group_ops_bls12381_g1_div_cost": null, "group_ops_bls12381_g1_hash_to_base_cost": null, "group_ops_bls12381_g1_hash_to_cost_per_byte": null, "group_ops_bls12381_g1_msm_base_cost": null, "group_ops_bls12381_g1_msm_base_cost_per_input": null, "group_ops_bls12381_g1_mul_cost": null, "group_ops_bls12381_g1_sub_cost": null, "group_ops_bls12381_g1_to_uncompressed_g1_cost": null, "group_ops_bls12381_g2_add_cost": null, "group_ops_bls12381_g2_div_cost": null, "group_ops_bls12381_g2_hash_to_base_cost": null, "group_ops_bls12381_g2_hash_to_cost_per_byte": null, "group_ops_bls12381_g2_msm_base_cost": null, "group_ops_bls12381_g2_msm_base_cost_per_input": null, "group_ops_bls12381_g2_mul_cost": null, "group_ops_bls12381_g2_sub_cost": null, "group_ops_bls12381_gt_add_cost": null, "group_ops_bls12381_gt_div_cost": null, "group_ops_bls12381_gt_mul_cost": null, "group_ops_bls12381_gt_sub_cost": null, "group_ops_bls12381_msm_max_len": null, "group_ops_bls12381_pairing_cost": null, "group_ops_bls12381_scalar_add_cost": null, "group_ops_bls12381_scalar_div_cost": null, "group_ops_bls12381_scalar_mul_cost": null, "group_ops_bls12381_scalar_sub_cost": null, "group_ops_bls12381_uncompressed_g1_sum_base_cost": null, "group_ops_bls12381_uncompressed_g1_sum_cost_per_term": null, "group_ops_bls12381_uncompressed_g1_sum_max_terms": null, "group_ops_bls12381_uncompressed_g1_to_g1_cost": null, "group_ops_ristretto_decode_point_cost": null, "group_ops_ristretto_decode_scalar_cost": null, "group_ops_ristretto_point_add_cost": null, "group_ops_ristretto_point_div_cost": null, "group_ops_ristretto_point_mul_cost": null, "group_ops_ristretto_point_sub_cost": null, "group_ops_ristretto_scalar_add_cost": null, "group_ops_ristretto_scalar_div_cost": null, "group_ops_ristretto_scalar_mul_cost": null, "group_ops_ristretto_scalar_sub_cost": null, "hash_blake2b256_cost_base": { "u64": "52" }, "hash_blake2b256_data_cost_per_block": { "u64": "2" }, "hash_blake2b256_data_cost_per_byte": { "u64": "2" }, "hash_keccak256_cost_base": { "u64": "52" }, "hash_keccak256_data_cost_per_block": { "u64": "2" }, "hash_keccak256_data_cost_per_byte": { "u64": "2" }, "hash_sha2_256_base_cost": null, "hash_sha2_256_legacy_min_input_len_cost": null, "hash_sha2_256_per_byte_cost": null, "hash_sha3_256_base_cost": null, "hash_sha3_256_legacy_min_input_len_cost": null, "hash_sha3_256_per_byte_cost": null, "hmac_hmac_sha3_256_cost_base": { "u64": "52" }, "hmac_hmac_sha3_256_input_cost_per_block": { "u64": "2" }, "hmac_hmac_sha3_256_input_cost_per_byte": { "u64": "2" }, "max_accumulated_randomness_txn_cost_per_object_in_mysticeti_commit": null, "max_accumulated_txn_cost_per_object_in_mysticeti_commit": null, "max_accumulated_txn_cost_per_object_in_narwhal_commit": null, "max_age_of_jwk_in_epochs": null, "max_arguments": { "u32": "512" }, "max_back_edges_per_function": { "u64": "10000" }, "max_back_edges_per_module": { "u64": "10000" }, "max_basic_blocks": { "u64": "1024" }, "max_checkpoint_size_bytes": { "u64": "31457280" }, "max_deferral_rounds_for_congestion_control": null, "max_dependency_depth": { "u64": "100" }, "max_event_emit_size": { "u64": "256000" }, "max_event_emit_size_total": null, "max_fields_in_struct": { "u64": "32" }, "max_function_definitions": { "u64": "1000" }, "max_function_parameters": { "u64": "128" }, "max_gas_computation_bucket": { "u64": "5000000" }, "max_gas_payment_objects": { "u32": "256" }, "max_gas_price": { "u64": "100000" }, "max_gas_price_rgp_factor_for_aborted_transactions": null, "max_generic_instantiation_length": { "u64": "32" }, "max_input_objects": { "u64": "2048" }, "max_jwk_votes_per_validator_per_epoch": null, "max_loop_depth": { "u64": "5" }, "max_meter_ticks_per_module": { "u64": "6000000" }, "max_meter_ticks_per_package": null, "max_modules_in_publish": { "u32": "128" }, "max_move_enum_variants": null, "max_move_identifier_len": null, "max_move_object_size": { "u64": "256000" }, "max_move_package_size": { "u64": "102400" }, "max_move_value_depth": null, "max_move_vector_len": { "u64": "262144" }, "max_num_deleted_move_object_ids": { "u64": "2048" }, "max_num_deleted_move_object_ids_system_tx": { "u64": "32768" }, "max_num_event_emit": { "u64": "256" }, "max_num_new_move_object_ids": { "u64": "2048" }, "max_num_new_move_object_ids_system_tx": { "u64": "32768" }, "max_num_transferred_move_object_ids": { "u64": "2048" }, "max_num_transferred_move_object_ids_system_tx": { "u64": "32768" }, "max_package_dependencies": null, "max_programmable_tx_commands": { "u32": "1024" }, "max_ptb_value_size": null, "max_publish_or_upgrade_per_ptb": null, "max_pure_argument_size": { "u32": "16384" }, "max_push_size": { "u64": "10000" }, "max_serialized_tx_effects_size_bytes": { "u64": "524288" }, "max_serialized_tx_effects_size_bytes_system_tx": { "u64": "8388608" }, "max_size_written_objects": { "u64": "5000000" }, "max_size_written_objects_system_tx": { "u64": "50000000" }, "max_soft_bundle_size": null, "max_struct_definitions": { "u64": "200" }, "max_transactions_per_checkpoint": { "u64": "10000" }, "max_tx_gas": { "u64": "50000000000" }, "max_tx_size_bytes": { "u64": "131072" }, "max_txn_cost_overage_per_object_in_commit": null, "max_type_argument_depth": { "u32": "16" }, "max_type_arguments": { "u32": "16" }, "max_type_nodes": { "u64": "256" }, "max_type_to_layout_nodes": null, "max_updates_per_settlement_txn": null, "max_value_stack_size": { "u64": "1024" }, "max_verifier_meter_ticks_per_function": { "u64": "6000000" }, "min_checkpoint_interval_ms": null, "min_move_binary_format_version": null, "move_binary_format_version": { "u32": "6" }, "nitro_attestation_parse_base_cost": null, "nitro_attestation_parse_cost_per_byte": null, "nitro_attestation_verify_base_cost": null, "nitro_attestation_verify_cost_per_cert": null, "obj_access_cost_delete_per_byte": { "u64": "40" }, "obj_access_cost_mutate_per_byte": { "u64": "40" }, "obj_access_cost_read_per_byte": { "u64": "15" }, "obj_access_cost_verify_per_byte": { "u64": "200" }, "obj_data_cost_refundable": { "u64": "100" }, "obj_metadata_cost_non_refundable": { "u64": "50" }, "object_borrow_uid_cost_base": { "u64": "52" }, "object_delete_impl_cost_base": { "u64": "52" }, "object_record_new_uid_cost_base": { "u64": "52" }, "object_runtime_max_num_cached_objects": { "u64": "1000" }, "object_runtime_max_num_cached_objects_system_tx": { "u64": "16000" }, "object_runtime_max_num_store_entries": { "u64": "1000" }, "object_runtime_max_num_store_entries_system_tx": { "u64": "16000" }, "package_publish_cost_fixed": { "u64": "1000" }, "package_publish_cost_per_byte": { "u64": "80" }, "poseidon_bn254_cost_base": null, "poseidon_bn254_cost_per_block": null, "random_beacon_dkg_timeout_round": null, "random_beacon_dkg_version": null, "random_beacon_min_round_interval_ms": null, "random_beacon_reduction_allowed_delta": null, "random_beacon_reduction_lower_bound": null, "reward_slashing_rate": { "u64": "10000" }, "sip_45_consensus_amplification_threshold": null, "storage_fund_reinvest_rate": { "u64": "500" }, "storage_gas_price": { "u64": "76" }, "storage_rebate_rate": { "u64": "9900" }, "string_check_utf8_base_cost": null, "string_check_utf8_per_byte_cost": null, "string_index_of_base_cost": null, "string_index_of_per_byte_pattern_cost": null, "string_index_of_per_byte_searched_cost": null, "string_is_char_boundary_base_cost": null, "string_sub_string_base_cost": null, "string_sub_string_per_byte_cost": null, "transfer_freeze_object_cost_base": { "u64": "52" }, "transfer_party_transfer_internal_cost_base": null, "transfer_receive_object_cost_base": null, "transfer_share_object_cost_base": { "u64": "52" }, "transfer_transfer_internal_cost_base": { "u64": "52" }, "translation_per_command_base_charge": null, "translation_per_input_base_charge": null, "translation_per_linkage_entry_charge": null, "translation_per_reference_node_charge": null, "translation_per_type_node_charge": null, "translation_pure_input_per_byte_charge": null, "tx_context_derive_id_cost_base": { "u64": "52" }, "tx_context_epoch_cost_base": null, "tx_context_epoch_timestamp_ms_cost_base": null, "tx_context_fresh_id_cost_base": null, "tx_context_gas_budget_cost_base": null, "tx_context_gas_price_cost_base": null, "tx_context_ids_created_cost_base": null, "tx_context_replace_cost_base": null, "tx_context_rgp_cost_base": null, "tx_context_sender_cost_base": null, "tx_context_sponsor_cost_base": null, "type_name_get_base_cost": null, "type_name_get_per_byte_cost": null, "type_name_id_base_cost": null, "types_is_one_time_witness_cost_base": { "u64": "52" }, "types_is_one_time_witness_type_cost_per_byte": { "u64": "2" }, "types_is_one_time_witness_type_tag_cost_per_byte": { "u64": "2" }, "use_object_per_epoch_marker_table_v2": null, "validator_validate_metadata_cost_base": { "u64": "52" }, "validator_validate_metadata_data_cost_per_byte": { "u64": "2" }, "vdf_hash_to_input_cost": null, "vdf_verify_vdf_cost": null, "vector_borrow_base_cost": null, "vector_destroy_empty_base_cost": null, "vector_empty_base_cost": null, "vector_length_base_cost": null, "vector_pop_back_base_cost": null, "vector_push_back_base_cost": null, "vector_push_back_legacy_per_abstract_memory_unit_cost": null, "vector_swap_base_cost": null } } } } ] }, { "name": "sui_getTotalTransactionBlocks", "tags": [ { "name": "Read API" } ], "description": "Return the total number of transaction blocks known to the server.", "params": [], "result": { "name": "BigInt", "required": true, "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "examples": [ { "name": "Gets total number of transactions on the network.", "params": [], "result": { "name": "Result", "value": "2451485" } } ] }, { "name": "sui_getTransactionBlock", "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" } }, { "name": "options", "description": "options for specifying the content to be returned", "schema": { "$ref": "#/components/schemas/TransactionBlockResponseOptions" } } ], "result": { "name": "SuiTransactionBlockResponse", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockResponse" } }, "examples": [ { "name": "Returns the transaction response object for specified transaction digest.", "params": [ { "name": "digest", "value": "Hay2tj3GcDYcE3AMHrej5WDsHGPVAYsegcubixLUvXUF" }, { "name": "options", "value": { "showInput": true, "showRawInput": false, "showEffects": true, "showEvents": true, "showObjectChanges": false, "showBalanceChanges": false, "showRawEffects": false } } ], "result": { "name": "Result", "value": { "digest": "Hay2tj3GcDYcE3AMHrej5WDsHGPVAYsegcubixLUvXUF", "transaction": { "data": { "messageVersion": "v1", "transaction": { "kind": "ProgrammableTransaction", "inputs": [ { "type": "pure", "valueType": "address", "value": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb" }, { "type": "object", "objectType": "immOrOwnedObject", "objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc", "version": "2", "digest": "GK4NxEKSrK88XkPNeuBqtJYPmU9yMTWMD7K9TdU4ybKN" } ], "transactions": [ { "TransferObjects": [ [ { "Input": 1 } ], { "Input": 0 } ] } ] }, "sender": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66", "gasData": { "payment": [ { "objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051", "version": 2, "digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9" } ], "owner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66", "price": "10", "budget": "100000" } }, "txSignatures": [ "AMU7cJTEsJ5WoVlKZ2zsVuGMk9linDuNqLV9eGIIrqarP2x4R9riuvmmMgXfdxMm7jTzYxbHrsDNMwlxpTbbFghtCxWrqsEEHAdxoMDwblU5hyWJ8H3zFvk20E2fO5bzHA==" ] }, "rawTransaction": "AQAAAAAAAgAggZbQSLem0EyO3IlXnYb9P8kMUvmhTGuBK5T+YTxbzrsBAF7rHUSeJRYWbVfXH96xVNDcns23swBX0KkyaEysNSzcAgAAAAAAAAAg43+UGkUe+CCaD7+/G1SbK7Jrjq7giJUUbfJ7w88mEMEBAQEBAQABAACCF5xX1Ylbq/tlXNYujohqUzNLXnvpvmWOt1nMNeP8ZgEaPomAKdAk7sHUTGr14vrN7YTQO1NzUU8W49ZuAAgQUQIAAAAAAAAAIGS7c6HtWLLBiwy/N3eS4gbmuA1NXupk4ucFY7FYkCbEghecV9WJW6v7ZVzWLo6IalMzS1576b5ljrdZzDXj/GYKAAAAAAAAAKCGAQAAAAAAAAFhAMU7cJTEsJ5WoVlKZ2zsVuGMk9linDuNqLV9eGIIrqarP2x4R9riuvmmMgXfdxMm7jTzYxbHrsDNMwlxpTbbFghtCxWrqsEEHAdxoMDwblU5hyWJ8H3zFvk20E2fO5bzHA==", "effects": { "messageVersion": "v1", "status": { "status": "success" }, "executedEpoch": "0", "gasUsed": { "computationCost": "100", "storageCost": "100", "storageRebate": "10", "nonRefundableStorageFee": "0" }, "transactionDigest": "6AyFnAuKAKCqm1cD94EyGzBqJCDDJ716ojjmsKF2rqoi", "mutated": [ { "owner": { "AddressOwner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66" }, "reference": { "objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051", "version": 2, "digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9" } }, { "owner": { "AddressOwner": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb" }, "reference": { "objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc", "version": 2, "digest": "GK4NxEKSrK88XkPNeuBqtJYPmU9yMTWMD7K9TdU4ybKN" } } ], "gasObject": { "owner": { "ObjectOwner": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66" }, "reference": { "objectId": "0x1a3e898029d024eec1d44c6af5e2facded84d03b5373514f16e3d66e00081051", "version": 2, "digest": "7nDZ5J4VyvYGUbX2f6mQdhkr3RFrb3vZqui1ogoyApD9" } }, "eventsDigest": "9BQobwxQvJ1JxSXNn8v8htZPTu8FEzJJGgcD4kgLUuMd" }, "objectChanges": [ { "type": "transferred", "sender": "0x82179c57d5895babfb655cd62e8e886a53334b5e7be9be658eb759cc35e3fc66", "recipient": { "AddressOwner": "0x8196d048b7a6d04c8edc89579d86fd3fc90c52f9a14c6b812b94fe613c5bcebb" }, "objectType": "0x2::example::Object", "objectId": "0x5eeb1d449e2516166d57d71fdeb154d0dc9ecdb7b30057d0a932684cac352cdc", "version": "2", "digest": "64UQ3a7m1mjWuzgyGoH8RnMyPGDN4XYTC9dS4qiSfdK4" } ] } } } ] }, { "name": "sui_multiGetObjects", "tags": [ { "name": "Read API" } ], "description": "Return the object data for a list of objects", "params": [ { "name": "object_ids", "description": "the IDs of the queried objects", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, { "name": "options", "description": "options for specifying the content to be returned", "schema": { "$ref": "#/components/schemas/ObjectDataOptions" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectResponse" } } }, "examples": [ { "name": "Gets objects by IDs.", "params": [ { "name": "object_ids", "value": [ "0x77b3482580ee8d5bdc5b824808df54bfec4fc817622e5add0e48f749f01def98", "0x9060d87664c26a3f9a509228c21b16dc6797cf787c839a07edc03e6338421091", "0xb37379c527753c5c8ab783f697e7b61439368cd75ebe63d633af32ffb4a022d1", "0xee309e94ff5c9f6b02c5637f018f6ea7bed8f6c3d80f2a595c2305e12dd6d07c", "0x29bc7c8d230db3b417edb1184cf075da5e934f672d3da3e003d989075efaecc7" ] }, { "name": "options", "value": { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": true, "showBcs": false, "showStorageRebate": true } } ], "result": { "name": "Result", "value": [ { "data": { "objectId": "0x77b3482580ee8d5bdc5b824808df54bfec4fc817622e5add0e48f749f01def98", "version": "1", "digest": "2QwXW3qzMEZPAyyP9VHtXbC2tp7iomypQc5XnkyPsu5d", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x504d411325e3c7f89d412044fe99007efb0f94f1e64d2e8090c619a39299d87e" }, "previousTransaction": "GcjpL3GJBoiqc7RNwfV1R4411dFPYz4hTNyXQchsq6Sa", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "100000000", "id": { "id": "0x77b3482580ee8d5bdc5b824808df54bfec4fc817622e5add0e48f749f01def98" } } } } }, { "data": { "objectId": "0x9060d87664c26a3f9a509228c21b16dc6797cf787c839a07edc03e6338421091", "version": "1", "digest": "5itvhMFvtJcV6fY2VY4x7F9Ex18q2N4Rr5WU4FXTJsFU", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x23618df6438d21a48040e6bb568cafc13246bd847c60448160e0358cac4a1134" }, "previousTransaction": "6m5GPm6XurdzRcEBd7epcnn4rDv8s3fVUK7dN6vYiYk8", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "100000000", "id": { "id": "0x9060d87664c26a3f9a509228c21b16dc6797cf787c839a07edc03e6338421091" } } } } }, { "data": { "objectId": "0xb37379c527753c5c8ab783f697e7b61439368cd75ebe63d633af32ffb4a022d1", "version": "1", "digest": "8rsTRNPs13DZvD2xneZEtf2nAAipep6uHXPXWVXfzDBr", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x8b95b4eaa9fd3b22b43f6b2c8e92090bd6d16522a6fd4fa83ec70a5f197ad656" }, "previousTransaction": "FgEJG8uwH2z3e5e4d2QGeVDYH5tdhbR3vKyXsXWf2zqY", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "100000000", "id": { "id": "0xb37379c527753c5c8ab783f697e7b61439368cd75ebe63d633af32ffb4a022d1" } } } } }, { "data": { "objectId": "0xee309e94ff5c9f6b02c5637f018f6ea7bed8f6c3d80f2a595c2305e12dd6d07c", "version": "1", "digest": "3w6ars2tmgBST4ozGxPWzSpEGyn4AdxMBv3K9sdkCWfR", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x3fbbd3ebef7dbcc7b02346cdf05674452cc61f316af5d5d7c02b94b023242685" }, "previousTransaction": "13Y8Ukebq34DkeL6dKEdr6ySSzeRMUpqhQXtZC9KmtTQ", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "100000000", "id": { "id": "0xee309e94ff5c9f6b02c5637f018f6ea7bed8f6c3d80f2a595c2305e12dd6d07c" } } } } }, { "data": { "objectId": "0x29bc7c8d230db3b417edb1184cf075da5e934f672d3da3e003d989075efaecc7", "version": "1", "digest": "BE9GoMd7Mr8fGte3EdsXxUMwYjcErW71n6Gsm4iPvDmv", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x9b5cd5df0df2a168259b7115a41ccc0a372b6fd0026e0c63043492ce4d0c19a6" }, "previousTransaction": "5CxnSSi2hCEo7beFke1fCp23W1rCKKRfPJrAELCpxiHc", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "100000000", "id": { "id": "0x29bc7c8d230db3b417edb1184cf075da5e934f672d3da3e003d989075efaecc7" } } } } } ] } } ] }, { "name": "sui_multiGetTransactionBlocks", "tags": [ { "name": "Read API" } ], "description": "Returns an ordered list of transaction responses The method will throw an error if the input contains any duplicate or the input size exceeds QUERY_MAX_RESULT_LIMIT", "params": [ { "name": "digests", "description": "A list of transaction digests.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDigest" } } }, { "name": "options", "description": "config options to control which fields to fetch", "schema": { "$ref": "#/components/schemas/TransactionBlockResponseOptions" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionBlockResponse" } } }, "examples": [ { "name": "Returns the transaction data for specified digest.", "params": [ { "name": "digests", "value": [ "EMqJqkQip6UaTkdff493ewAQNHGQFJwXDDn6m9CTgZzo", "Hn3B25vTQNTFAdThFkWvfkiAAUZxzwTaj4uEengu1ACX", "9vLSG9a4QcLcMdG1xCu6FRdXAjWWqvJHoHBCJfPMKkR9" ] }, { "name": "options", "value": { "showInput": true, "showRawInput": false, "showEffects": true, "showEvents": true, "showObjectChanges": false, "showBalanceChanges": false, "showRawEffects": false } } ], "result": { "name": "Result", "value": [ { "digest": "EMqJqkQip6UaTkdff493ewAQNHGQFJwXDDn6m9CTgZzo", "transaction": { "data": { "messageVersion": "v1", "transaction": { "kind": "ProgrammableTransaction", "inputs": [ { "type": "pure", "valueType": "address", "value": "0x751b2dd4de1138554a9ff7b4f6b59f9426c321c8013afed093481dd4ef1267c6" }, { "type": "object", "objectType": "immOrOwnedObject", "objectId": "0x7a8e9a0d074f90fddb42cd928f74b986c6f539a734f3d7c9a75a9cb227ec3157", "version": "2", "digest": "JAgYeYMPm5VLzBYcYxxQUEatfG9gHdFqSNwmBBS41Bri" } ], "transactions": [ { "TransferObjects": [ [ { "Input": 1 } ], { "Input": 0 } ] } ] }, "sender": "0x5e52f7bcaae1fd72a7c420c1e68537e485d215b1e8ea45572b1b2980408ff9b5", "gasData": { "payment": [ { "objectId": "0x24962ee4193c8c0d2fb28bbe0eb4ba5fc87a2c6d1a7c12c9454872c5ea06d5e1", "version": 2, "digest": "B4g7NgvgmCFYzG2BPH6nT6kM5bPaRMD76LVJ4LWysq5w" } ], "owner": "0x5e52f7bcaae1fd72a7c420c1e68537e485d215b1e8ea45572b1b2980408ff9b5", "price": "10", "budget": "100000" } }, "txSignatures": [ "ADCkpLtz9B6h6by9gst01e1ap3M9XyCjZ75pT59rvq6esYIxNzb7+KWZb+L5uZ7xsmzUtxR9ayYrSkXO99Rj5gkHrX7t0yuVOWkkiOMuz7HdUZsfbMy0efpXac3VZ8UVmA==" ] }, "rawTransaction": "AQAAAAAAAgAgdRst1N4ROFVKn/e09rWflCbDIcgBOv7Qk0gd1O8SZ8YBAHqOmg0HT5D920LNko90uYbG9TmnNPPXyadanLIn7DFXAgAAAAAAAAAg/xGekvV6500bJQ1d8stRcHgqikOPv2ge3tTR4KLNffsBAQEBAQABAABeUve8quH9cqfEIMHmhTfkhdIVsejqRVcrGymAQI/5tQEkli7kGTyMDS+yi74OtLpfyHosbRp8EslFSHLF6gbV4QIAAAAAAAAAIJWF1VkVIb/RLew6Ny79U5EIuoB6Davtbl2g8XTvw/WOXlL3vKrh/XKnxCDB5oU35IXSFbHo6kVXKxspgECP+bUKAAAAAAAAAKCGAQAAAAAAAAFhADCkpLtz9B6h6by9gst01e1ap3M9XyCjZ75pT59rvq6esYIxNzb7+KWZb+L5uZ7xsmzUtxR9ayYrSkXO99Rj5gkHrX7t0yuVOWkkiOMuz7HdUZsfbMy0efpXac3VZ8UVmA==", "effects": { "messageVersion": "v1", "status": { "status": "success" }, "executedEpoch": "0", "gasUsed": { "computationCost": "100", "storageCost": "100", "storageRebate": "10", "nonRefundableStorageFee": "0" }, "transactionDigest": "J4k64LwycebB7TQhKrPaZ954yCK64rwbDJMSrSUW4Ba4", "mutated": [ { "owner": { "AddressOwner": "0x5e52f7bcaae1fd72a7c420c1e68537e485d215b1e8ea45572b1b2980408ff9b5" }, "reference": { "objectId": "0x24962ee4193c8c0d2fb28bbe0eb4ba5fc87a2c6d1a7c12c9454872c5ea06d5e1", "version": 2, "digest": "B4g7NgvgmCFYzG2BPH6nT6kM5bPaRMD76LVJ4LWysq5w" } }, { "owner": { "AddressOwner": "0x751b2dd4de1138554a9ff7b4f6b59f9426c321c8013afed093481dd4ef1267c6" }, "reference": { "objectId": "0x7a8e9a0d074f90fddb42cd928f74b986c6f539a734f3d7c9a75a9cb227ec3157", "version": 2, "digest": "JAgYeYMPm5VLzBYcYxxQUEatfG9gHdFqSNwmBBS41Bri" } } ], "gasObject": { "owner": { "ObjectOwner": "0x5e52f7bcaae1fd72a7c420c1e68537e485d215b1e8ea45572b1b2980408ff9b5" }, "reference": { "objectId": "0x24962ee4193c8c0d2fb28bbe0eb4ba5fc87a2c6d1a7c12c9454872c5ea06d5e1", "version": 2, "digest": "B4g7NgvgmCFYzG2BPH6nT6kM5bPaRMD76LVJ4LWysq5w" } }, "eventsDigest": "2SY11dmdTQv6JLD2wqcsMiJNqXbXUkn87Rzw5NHib8Mf" }, "objectChanges": [ { "type": "transferred", "sender": "0x5e52f7bcaae1fd72a7c420c1e68537e485d215b1e8ea45572b1b2980408ff9b5", "recipient": { "AddressOwner": "0x751b2dd4de1138554a9ff7b4f6b59f9426c321c8013afed093481dd4ef1267c6" }, "objectType": "0x2::example::Object", "objectId": "0x7a8e9a0d074f90fddb42cd928f74b986c6f539a734f3d7c9a75a9cb227ec3157", "version": "2", "digest": "3gmeyj5oEdE8A4PvjWsDSHchC6tb6YQj18gnD7xnDqGz" } ] }, { "digest": "Hn3B25vTQNTFAdThFkWvfkiAAUZxzwTaj4uEengu1ACX", "transaction": { "data": { "messageVersion": "v1", "transaction": { "kind": "ProgrammableTransaction", "inputs": [ { "type": "pure", "valueType": "address", "value": "0x7cbab4983e180ad2c31e8c3681aa4f7d35488cf6bf1135d2fc8703690e085797" }, { "type": "object", "objectType": "immOrOwnedObject", "objectId": "0xc3e4f846a282754946e181e00f4341a53b5e895ef8ec3c73d2378a0a11825e23", "version": "2", "digest": "snEA8RNnDvsYjKJx2NMUP49TMjoAuQXx3LJgwe4qo9B" } ], "transactions": [ { "TransferObjects": [ [ { "Input": 1 } ], { "Input": 0 } ] } ] }, "sender": "0x62d4daf6e506989ba7a25b0d8915142e81252c859e8cd22db530ae213eec1925", "gasData": { "payment": [ { "objectId": "0x2fac1a70e20e146fb1303bd60eb4bea9bd453e50690b423241f0e2e9beabd601", "version": 2, "digest": "DeJhcQ3CmMPwyhVct22PP7hYaVny6zbz8V7gnTw3yoAT" } ], "owner": "0x62d4daf6e506989ba7a25b0d8915142e81252c859e8cd22db530ae213eec1925", "price": "10", "budget": "100000" } }, "txSignatures": [ "AND+G9umCSLK1La6UWAgniuJWhkB3BNqVfk66Fj+f2hK1qIT2uJUWRYSwWYky6TO0unNN8egfzwvLJjFCMXU9gRy3O9A+7GacyYQAw/at8erjWXdUi4gR/xfdp6t5wPBDg==" ] }, "rawTransaction": "AQAAAAAAAgAgfLq0mD4YCtLDHow2gapPfTVIjPa/ETXS/IcDaQ4IV5cBAMPk+EaignVJRuGB4A9DQaU7Xole+Ow8c9I3igoRgl4jAgAAAAAAAAAgDQItueIaDwm8uJB3PRHBq9cXZ7H2eoBAJneIID85dyIBAQEBAQABAABi1Nr25QaYm6eiWw2JFRQugSUshZ6M0i21MK4hPuwZJQEvrBpw4g4Ub7EwO9YOtL6pvUU+UGkLQjJB8OLpvqvWAQIAAAAAAAAAILvavygo7pyn5CJ6Yc/4Uf75+2oIrkRMlvmBAnXWr5c8YtTa9uUGmJunolsNiRUULoElLIWejNIttTCuIT7sGSUKAAAAAAAAAKCGAQAAAAAAAAFhAND+G9umCSLK1La6UWAgniuJWhkB3BNqVfk66Fj+f2hK1qIT2uJUWRYSwWYky6TO0unNN8egfzwvLJjFCMXU9gRy3O9A+7GacyYQAw/at8erjWXdUi4gR/xfdp6t5wPBDg==", "effects": { "messageVersion": "v1", "status": { "status": "success" }, "executedEpoch": "0", "gasUsed": { "computationCost": "100", "storageCost": "100", "storageRebate": "10", "nonRefundableStorageFee": "0" }, "transactionDigest": "CHia3BiES8mt5kqMYhzBpjAeLRpjcsMNDMFakBAdcVAg", "mutated": [ { "owner": { "AddressOwner": "0x62d4daf6e506989ba7a25b0d8915142e81252c859e8cd22db530ae213eec1925" }, "reference": { "objectId": "0x2fac1a70e20e146fb1303bd60eb4bea9bd453e50690b423241f0e2e9beabd601", "version": 2, "digest": "DeJhcQ3CmMPwyhVct22PP7hYaVny6zbz8V7gnTw3yoAT" } }, { "owner": { "AddressOwner": "0x7cbab4983e180ad2c31e8c3681aa4f7d35488cf6bf1135d2fc8703690e085797" }, "reference": { "objectId": "0xc3e4f846a282754946e181e00f4341a53b5e895ef8ec3c73d2378a0a11825e23", "version": 2, "digest": "snEA8RNnDvsYjKJx2NMUP49TMjoAuQXx3LJgwe4qo9B" } } ], "gasObject": { "owner": { "ObjectOwner": "0x62d4daf6e506989ba7a25b0d8915142e81252c859e8cd22db530ae213eec1925" }, "reference": { "objectId": "0x2fac1a70e20e146fb1303bd60eb4bea9bd453e50690b423241f0e2e9beabd601", "version": 2, "digest": "DeJhcQ3CmMPwyhVct22PP7hYaVny6zbz8V7gnTw3yoAT" } }, "eventsDigest": "69bh3Q9RhRgMFKwmQn8LYE8vYujFTpYyUSVBht3oYkm6" }, "objectChanges": [ { "type": "transferred", "sender": "0x62d4daf6e506989ba7a25b0d8915142e81252c859e8cd22db530ae213eec1925", "recipient": { "AddressOwner": "0x7cbab4983e180ad2c31e8c3681aa4f7d35488cf6bf1135d2fc8703690e085797" }, "objectType": "0x2::example::Object", "objectId": "0xc3e4f846a282754946e181e00f4341a53b5e895ef8ec3c73d2378a0a11825e23", "version": "2", "digest": "HyJbrm9Th6ox4oU9vrrRzgZSaCu1n3omMJ1fAcHswvvo" } ] }, { "digest": "9vLSG9a4QcLcMdG1xCu6FRdXAjWWqvJHoHBCJfPMKkR9", "transaction": { "data": { "messageVersion": "v1", "transaction": { "kind": "ProgrammableTransaction", "inputs": [ { "type": "pure", "valueType": "address", "value": "0x385b00a1a8902e84e81f871c47c3149e27b12500da884afdf5c30b19c017a0d1" }, { "type": "object", "objectType": "immOrOwnedObject", "objectId": "0x0388c28ddd5977a58e206acd19639c875a4fbecf3342b825c8384300ac7e3bad", "version": "2", "digest": "9CpH2aW4XPVxaZBGHRwHueXEQUvN3Pf7JQpASHiEsNCw" } ], "transactions": [ { "TransferObjects": [ [ { "Input": 1 } ], { "Input": 0 } ] } ] }, "sender": "0x9b7489accb55a928190cfa87f52022d722c0686eda7677b3595dcd6167a4b4e5", "gasData": { "payment": [ { "objectId": "0xc820a75b574224b920aa9b005093b820df24ef8b43715499f4fff4e056c0cd5c", "version": 2, "digest": "FYD6KHzkQnbwS52WA8rYS9WbJza1K583ootS5MK9BR2T" } ], "owner": "0x9b7489accb55a928190cfa87f52022d722c0686eda7677b3595dcd6167a4b4e5", "price": "10", "budget": "100000" } }, "txSignatures": [ "AIPB1qErFsOHPUI/MJO9d5n2tTpG6fhxRumDT54vvkGYqtiHX9nlqhyujSbprdl0Th2qM/n3z18p/tLCmnjWMgR0l3KzifzaD4mmOjFLz1qKIB/e8f9eE9s+E+w2jwNGDQ==" ] }, "rawTransaction": "AQAAAAAAAgAgOFsAoaiQLoToH4ccR8MUniexJQDaiEr99cMLGcAXoNEBAAOIwo3dWXeljiBqzRljnIdaT77PM0K4Jcg4QwCsfjutAgAAAAAAAAAgeeRW/wE/VlPau21sld3X01pC0x86m+u7aD22booGcGgBAQEBAQABAACbdImsy1WpKBkM+of1ICLXIsBobtp2d7NZXc1hZ6S05QHIIKdbV0IkuSCqmwBQk7gg3yTvi0NxVJn0//TgVsDNXAIAAAAAAAAAINgCS0s5p/7ScTSwc9qGOEVBETllGTeeiIyDq68OYAUEm3SJrMtVqSgZDPqH9SAi1yLAaG7adnezWV3NYWektOUKAAAAAAAAAKCGAQAAAAAAAAFhAIPB1qErFsOHPUI/MJO9d5n2tTpG6fhxRumDT54vvkGYqtiHX9nlqhyujSbprdl0Th2qM/n3z18p/tLCmnjWMgR0l3KzifzaD4mmOjFLz1qKIB/e8f9eE9s+E+w2jwNGDQ==", "effects": { "messageVersion": "v1", "status": { "status": "success" }, "executedEpoch": "0", "gasUsed": { "computationCost": "100", "storageCost": "100", "storageRebate": "10", "nonRefundableStorageFee": "0" }, "transactionDigest": "HaFQHEJugXDGh95A9Ye1tp7GikbuAQNiEanrQuVLvpfz", "mutated": [ { "owner": { "AddressOwner": "0x9b7489accb55a928190cfa87f52022d722c0686eda7677b3595dcd6167a4b4e5" }, "reference": { "objectId": "0xc820a75b574224b920aa9b005093b820df24ef8b43715499f4fff4e056c0cd5c", "version": 2, "digest": "FYD6KHzkQnbwS52WA8rYS9WbJza1K583ootS5MK9BR2T" } }, { "owner": { "AddressOwner": "0x385b00a1a8902e84e81f871c47c3149e27b12500da884afdf5c30b19c017a0d1" }, "reference": { "objectId": "0x0388c28ddd5977a58e206acd19639c875a4fbecf3342b825c8384300ac7e3bad", "version": 2, "digest": "9CpH2aW4XPVxaZBGHRwHueXEQUvN3Pf7JQpASHiEsNCw" } } ], "gasObject": { "owner": { "ObjectOwner": "0x9b7489accb55a928190cfa87f52022d722c0686eda7677b3595dcd6167a4b4e5" }, "reference": { "objectId": "0xc820a75b574224b920aa9b005093b820df24ef8b43715499f4fff4e056c0cd5c", "version": 2, "digest": "FYD6KHzkQnbwS52WA8rYS9WbJza1K583ootS5MK9BR2T" } }, "eventsDigest": "DzJWHtFNHttaBdpECZGDMF7tcx5NYZfNfCk5NsaaRgmn" }, "objectChanges": [ { "type": "transferred", "sender": "0x9b7489accb55a928190cfa87f52022d722c0686eda7677b3595dcd6167a4b4e5", "recipient": { "AddressOwner": "0x385b00a1a8902e84e81f871c47c3149e27b12500da884afdf5c30b19c017a0d1" }, "objectType": "0x2::example::Object", "objectId": "0x0388c28ddd5977a58e206acd19639c875a4fbecf3342b825c8384300ac7e3bad", "version": "2", "digest": "6jsxetsBSZJ5ozgZuDmHXJzn9ZBp8emivfYHe6tnHg7C" } ] } ] } } ] }, { "name": "sui_tryGetPastObject", "tags": [ { "name": "Read 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/SequenceNumber2" } }, { "name": "options", "description": "options for specifying the content to be returned", "schema": { "$ref": "#/components/schemas/ObjectDataOptions" } } ], "result": { "name": "SuiPastObjectResponse", "required": true, "schema": { "$ref": "#/components/schemas/ObjectRead" } }, "examples": [ { "name": "Gets Past Object data.", "params": [ { "name": "object_id", "value": "0x11af4b844ff94b3fbef6e36b518da3ad4c5856fa686464524a876b463d129760" }, { "name": "version", "value": 4 }, { "name": "options", "value": { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": true, "showBcs": false, "showStorageRebate": true } } ], "result": { "name": "Result", "value": { "status": "VersionFound", "details": { "objectId": "0x11af4b844ff94b3fbef6e36b518da3ad4c5856fa686464524a876b463d129760", "version": "4", "digest": "5VPAwDXy3BL72ehFc7gSJoz27ahMd6spUg5YwYc4ibcv", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x3568c40e814d9d5396d23087a0fd641e91e0e00df6c012cded9ef9ba5e5bf042" }, "previousTransaction": "5jQByoouHBwaico5pQB73GdbzerC2StjTiHh5garBjiV", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "10000", "id": { "id": "0x11af4b844ff94b3fbef6e36b518da3ad4c5856fa686464524a876b463d129760" } } } } } } } ] }, { "name": "sui_tryMultiGetPastObjects", "tags": [ { "name": "Read 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": "past_objects", "description": "a vector of object and versions to be queried", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetPastObjectRequest" } } }, { "name": "options", "description": "options for specifying the content to be returned", "schema": { "$ref": "#/components/schemas/ObjectDataOptions" } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRead" } } }, "examples": [ { "name": "Gets Past Object data for a vector of objects.", "params": [ { "name": "past_objects", "value": [ { "objectId": "0x38b3186a7bb26a1ab2c982a0a9b482aa70f5a010fffc60f20194ef0f597474e8", "version": "4" }, { "objectId": "0xceaf9ee4582d3a233101e322a22cb2a5bea2e681ea5af4e59bd1abb0bb4fcb27", "version": "12" } ] }, { "name": "options", "value": { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": true, "showBcs": false, "showStorageRebate": true } } ], "result": { "name": "Result", "value": [ { "status": "VersionFound", "details": { "objectId": "0x38b3186a7bb26a1ab2c982a0a9b482aa70f5a010fffc60f20194ef0f597474e8", "version": "4", "digest": "hvBGBXvKVhC7XYgVPujuiLjxASR6UGAkSFrCRtVxX1F", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0x47866ff92885a3c21a7703f564721c198308aa0c71b771ada6b96c16fc9c0fa7" }, "previousTransaction": "6heEteheiLZcS8iVNXsNUnU7oVjzT7UHYzprGcuWQ4gG", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "10000", "id": { "id": "0x38b3186a7bb26a1ab2c982a0a9b482aa70f5a010fffc60f20194ef0f597474e8" } } } } }, { "status": "VersionFound", "details": { "objectId": "0xceaf9ee4582d3a233101e322a22cb2a5bea2e681ea5af4e59bd1abb0bb4fcb27", "version": "12", "digest": "B5z4YkAgTi78fdxMbxG3fv2V4YBkhpc8PRCPz8MzLtbf", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0xa6ced287081357950315a8842c3870f2d83f980fe0996a92d351d6749a0a0b47" }, "previousTransaction": "BLN2oUCHmwmaAXXCxbojTcozUqZYfvXx4Bkgi7xcgyVc", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x2::coin::Coin<0x2::sui::SUI>", "hasPublicTransfer": true, "fields": { "balance": "20000", "id": { "id": "0x38b3186a7bb26a1ab2c982a0a9b482aa70f5a010fffc60f20194ef0f597474e8" } } } } } ] } } ] }, { "name": "sui_verifyZkLoginSignature", "tags": [ { "name": "Read API" } ], "description": "Verify a zklogin signature for the given bytes, intent scope and author.", "params": [ { "name": "bytes", "description": "The Base64 string of bcs bytes for raw transaction data or personal message indicated by intent_scope.", "required": true, "schema": { "type": "string" } }, { "name": "signature", "description": "The Base64 string of the zklogin signature to verify.", "required": true, "schema": { "type": "string" } }, { "name": "intent_scope", "description": "The intent scope, either transaction data or personal message. Used to parse bytes.", "required": true, "schema": { "$ref": "#/components/schemas/ZkLoginIntentScope" } }, { "name": "author", "description": "The author of the signature.", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } } ], "result": { "name": "ZkLoginVerifyResult", "required": true, "schema": { "$ref": "#/components/schemas/ZkLoginVerifyResult" } }, "examples": [] }, { "name": "suix_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" } } }, "examples": [ { "name": "Gets all balances for the address in the request.", "params": [ { "name": "owner", "value": "0x94f1a597b4e8f709a396f7f6b1482bdcd65a673d111e49286c527fab7c2d0961" } ], "result": { "name": "Result", "value": [ { "coinType": "0x2::sui::SUI", "coinObjectCount": 15, "totalBalance": "3000000000", "lockedBalance": {}, "fundsInAddressBalance": "42" } ] } } ] }, { "name": "suix_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": { "type": "string" } }, { "name": "limit", "description": "maximum number of items per page", "schema": { "type": "integer", "format": "uint", "minimum": 0 } } ], "result": { "name": "CoinPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_Coin_and_String" } }, "examples": [ { "name": "Gets all coins for the address in the request body. Begin listing the coins that are after the provided `cursor` value and return only the `limit` amount of results per page.", "params": [ { "name": "owner", "value": "0x41f5975e3c6bd5c95f041a8493ad7e9934be26e69152d2c2e86d8a9bdbd242b3" }, { "name": "cursor", "value": "0x2564cd31a71cf9833609b111436d8f0f47b7f8b9927ec3f8975a1dcbf9b25564" }, { "name": "limit", "value": 3 } ], "result": { "name": "Result", "value": { "data": [ { "coinType": "0x2::sui::SUI", "coinObjectId": "0x861c5e055605b2bb1199faf653a8771e448930bc95a0369fad43a9870a2e5878", "version": "103626", "digest": "Ao1QyN9UTmYzb2ead3D5xhSBk7TvACRvmnJW8gRbwP99", "balance": "200000000", "previousTransaction": "7dp5WtTmtGp83EXYYFMzjBJRFeSgR67AzqMETLrfgeFx" }, { "coinType": "0x2::sui::SUI", "coinObjectId": "0x7e769678d059761bff8a8f3944642e4c33a6e4fb0b55f8face36fadaa22f2a0d", "version": "103626", "digest": "5taVxHU9QLQD5cNdqxt8kNGAab93GMG4vX7zYDxEaohx", "balance": "200000000", "previousTransaction": "9xLdMXezY8d1yRA2TtN6pYjapyy2EVKHWNriGPFGCFvd" }, { "coinType": "0x2::sui::SUI", "coinObjectId": "0xa323d541ba5cf9e34919d2644cda38a263f69f47ae954dec65295231e0d2c7c8", "version": "103626", "digest": "82ZNKSSueWUQkpFNbBZGHSr3sUL5Rxfr7ucVRsvgQzz2", "balance": "200000000", "previousTransaction": "5xexWFq6QpGHBQyC9P2cbAJXq9qm2EjzfuRM9NwS1uyG" } ], "nextCursor": "abcd", "hasNextPage": true } } } ] }, { "name": "suix_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" } }, "examples": [ { "name": "Gets the balance of the specified type of coin for the address in the request.", "params": [ { "name": "owner", "value": "0xa6f5a7953a75dc632e696cabe60560522a017bf2fb0bd930d1ec22c06f1ee4e4" }, { "name": "coin_type", "value": "0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC" } ], "result": { "name": "Result", "value": { "coinType": "0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC", "coinObjectCount": 15, "totalBalance": "15", "lockedBalance": {}, "fundsInAddressBalance": "42" } } } ] }, { "name": "suix_getBridgeObjectInitialSharedVersion", "tags": [ { "name": "Bridge Read API" } ], "description": "Returns the initial shared version of the bridge object, usually for the purpose of constructing an ObjectArg in a transaction.", "params": [], "result": { "name": "u64", "required": true, "schema": { "type": "integer", "format": "uint64", "minimum": 0 } }, "examples": [] }, { "name": "suix_getCoinMetadata", "tags": [ { "name": "Coin Query API" } ], "description": "Return metadata (e.g., symbol, decimals) for a coin. Note that if the coin's metadata was wrapped in the transaction that published its marker type, or the latest version of the metadata object is wrapped or deleted, it will not be found.", "params": [ { "name": "coin_type", "description": "type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC)", "required": true, "schema": { "type": "string" } } ], "result": { "name": "SuiCoinMetadata", "schema": { "$ref": "#/components/schemas/SuiCoinMetadata" } }, "examples": [ { "name": "Gets the metadata for the coin type in the request.", "params": [ { "name": "coin_type", "value": "0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC" } ], "result": { "name": "Result", "value": { "decimals": 9, "name": "Usdc", "symbol": "USDC", "description": "Stable coin.", "iconUrl": null, "id": "0x51ceab2edc89f74730e683ebee65578cb3bc9237ba6fca019438a9737cf156ae" } } } ] }, { "name": "suix_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": { "type": "string" } }, { "name": "limit", "description": "maximum number of items per page", "schema": { "type": "integer", "format": "uint", "minimum": 0 } } ], "result": { "name": "CoinPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_Coin_and_String" } }, "examples": [ { "name": "Gets all SUI coins owned by the address provided. Return a paginated list of `limit` results per page. Similar to `suix_getAllCoins`, but provides a way to filter by coin type.", "params": [ { "name": "owner", "value": "0x6d907beaa3a49db57bdfdb3557e6d405cbf01c293a53e01457d65e92b5d8dd68" }, { "name": "coin_type", "value": "0x2::sui::SUI" }, { "name": "cursor", "value": "0xee6b5173afedb35330f60397c2cbb48196ba41921246c304be7b490cee0904eb" }, { "name": "limit", "value": 3 } ], "result": { "name": "Result", "value": { "data": [ { "coinType": "0x2::sui::SUI", "coinObjectId": "0xd62ca040aba24f862a763851c54908cd2a0ee7d709c11b93d4a2083747b76856", "version": "103626", "digest": "C9fdokK19BpDCgUgWsJv3cfd4LDyk7WGYBeGhFHbEL2Z", "balance": "200000000", "previousTransaction": "tw5DzJTfdxTn4f3rekFrhN7dQTUezBgsEhycDobTBLb" }, { "coinType": "0x2::sui::SUI", "coinObjectId": "0xf44d295a385dc3544d211411b865e8bc4f01f49186970c7cf61e1cc829cc0be7", "version": "103626", "digest": "5qZkmtN5J5uGHURtiy9BtBhnXATPR2Wa6BJBDLrMzCaf", "balance": "200000000", "previousTransaction": "AfgFe7ZfjJ5dWV6VAy2LbtvBFhcABkvdvwEjLrRcFqtr" }, { "coinType": "0x2::sui::SUI", "coinObjectId": "0x42ef9314ccc792dd4401a88e69c66b4c5e43f21e9e57f4abe3c702649d3a7dd0", "version": "103626", "digest": "FLE2nB2Wio3oUyTx6HyzkrMsWiZxDg9Kk8s7ivvuoBbD", "balance": "200000000", "previousTransaction": "9er6jxigfuQEKsn9gtPV2oW1zGQRcFtKNijHVe88GUJD" } ], "nextCursor": "abcd", "hasNextPage": true } } } ] }, { "name": "suix_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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "SuiCommittee", "required": true, "schema": { "$ref": "#/components/schemas/CommitteeInfo" } }, "examples": [ { "name": "Gets committee information for epoch 5000.", "params": [ { "name": "epoch", "value": "5000" } ], "result": { "name": "Result", "value": { "epoch": "5000", "validators": [ [ "jc/20VUECmVvSBmxMRG1LFdGqGunLzlfuv4uw4R9HoFA5iSnUf32tfIFC8cgXPnTAATJCwx0Cv/TJs5nPMKyOi0k1T4q/rKG38Zo/UBgCJ1tKxe3md02+Q0zLlSnozjU", "2500" ], [ "mfJe9h+AMrkUY2RgmCxcxvE07x3a52ZX8sv+wev8jQlzdAgN9vzw3Li8Sw2OCvXYDrv/K0xZn1T0LWMS38MUJ2B4wcw0fru+xRmL4lhRPzhrkw0CwnSagD4jMJVevRoQ", "2500" ], [ "rd7vlNiYyI5A297/kcXxBfnPLHR/tvK8N+wD1ske2y4aV4z1RL6LCTHiXyQ9WbDDDZihbOO6HWzx1/UEJpkusK2zE0sFW+gUDS218l+wDYP45CIr8B/WrJOh/0152ljy", "2500" ], [ "s/1e+1yHJAOkrRPxGZUTYG0jNUqEUkmuoVdWTCP/PBXGyeZSty10DoysuTy8wGhrDsDMDBx2C/tCtDZRn8WoBUt2UzqXqfI5h9CX75ax8lJrsgc/oQp3GZQXcjR+8nT0", "2500" ] ] } } } ] }, { "name": "suix_getCurrentEpoch", "tags": [ { "name": "Extended API" } ], "description": "Return current epoch info", "params": [], "result": { "name": "EpochInfo", "required": true, "schema": { "$ref": "#/components/schemas/EpochInfo" } }, "examples": [] }, { "name": "suix_getDynamicFieldObject", "tags": [ { "name": "Extended 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": { "$ref": "#/components/schemas/DynamicFieldName" } } ], "result": { "name": "SuiObjectResponse", "required": true, "schema": { "$ref": "#/components/schemas/SuiObjectResponse" } }, "examples": [ { "name": "Gets the information for the dynamic field the request provides.", "params": [ { "name": "parent_object_id", "value": "0x3ddea0f8c3da994d9ead562ce76e36fdef6a382da344930c73d1298b0e9644b8" }, { "name": "name", "value": { "type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField", "value": "some_value" } } ], "result": { "name": "Result", "value": { "data": { "objectId": "0x3ddea0f8c3da994d9ead562ce76e36fdef6a382da344930c73d1298b0e9644b8", "version": "1", "digest": "Faiv4yqGR4HjAW8WhMN1NHHNStxXgP3u22dVPyvLad2z", "type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField", "owner": { "AddressOwner": "0x5ea6f7a348f4a7bd1a9ab069eb7f63865de3075cc5a4e62432f634b50fd2bb2b" }, "previousTransaction": "5qTpesGST3v9NmMTkzV7HHNZRJh52BSqUTErc6L6XGm", "storageRebate": "100", "content": { "dataType": "moveObject", "type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField", "hasPublicTransfer": true, "fields": {} } } } } } ] }, { "name": "suix_getDynamicFields", "tags": [ { "name": "Extended 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": "An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.", "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 } } ], "result": { "name": "DynamicFieldPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_DynamicFieldInfo_and_ObjectID" } }, "examples": [ { "name": "Gets dynamic fields for the object the request provides in a paginated list of `limit` dynamic field results per page. The default limit is 50.", "params": [ { "name": "parent_object_id", "value": "0x5612581eba57ebe7e594b809ccceec2be4dac6ff6945d49b3ecc043d049611f6" }, { "name": "cursor", "value": "0x671832358f25bfacde706e528df4e15bb8de6dadd21835dfe44f4973139c15f9" }, { "name": "limit", "value": 3 } ], "result": { "name": "Result", "value": { "data": [ { "name": { "type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField", "value": "some_value" }, "bcsEncoding": "base64", "bcsName": "FDB4OTo6dGVzdDo6VGVzdEZpZWxk", "type": "DynamicField", "objectType": "test", "objectId": "0xcfd10bca4d517e9452ad5486d69ee482b758c2399039dbbedd5db24385e934d6", "version": 1, "digest": "9oCJR2QHVThbwWtSYwmWv6oSFw26PuxXkLyFrUbNqpU2" }, { "name": { "type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField", "value": "some_value" }, "bcsEncoding": "base64", "bcsName": "FDB4OTo6dGVzdDo6VGVzdEZpZWxk", "type": "DynamicField", "objectType": "test", "objectId": "0x05a4a796534a1833ca2c4df8fda7d073bbbf2715d2cd82ed40dc051dd5e05f7f", "version": 1, "digest": "3F8njMJQe6DNxeuvUnHPVjuR9Lt3RNwfsBoxDcB9SXAa" }, { "name": { "type": "0x0000000000000000000000000000000000000000000000000000000000000009::test::TestField", "value": "some_value" }, "bcsEncoding": "base64", "bcsName": "FDB4OTo6dGVzdDo6VGVzdEZpZWxk", "type": "DynamicField", "objectType": "test", "objectId": "0x6d95af2033dd243fe6bdc6886d51b7d1cb695b9491893f88a5ae1b9d4f235b3c", "version": 1, "digest": "9Ury7TXnLtHDrxreKjv5eMJpDAU4wZRuev4JJ1UnJBMp" } ], "nextCursor": "0xfd0b2c4326c56b1fec231d73038dba0f0885b97982f5fcac3ec6f5c8cae16743", "hasNextPage": true } } } ] }, { "name": "suix_getEpochs", "tags": [ { "name": "Extended API" } ], "description": "Return a list of epoch info", "params": [ { "name": "cursor", "description": "optional paging cursor", "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "name": "limit", "description": "maximum number of items per page", "schema": { "type": "integer", "format": "uint", "minimum": 0 } }, { "name": "descending_order", "description": "flag to return results in descending order", "schema": { "type": "boolean" } } ], "result": { "name": "EpochPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_EpochInfo_and_BigInt_for_uint64" } }, "examples": [] }, { "name": "suix_getLatestBridge", "tags": [ { "name": "Bridge Read API" } ], "description": "Returns the latest BridgeSummary", "params": [], "result": { "name": "BridgeSummary", "required": true, "schema": { "$ref": "#/components/schemas/BridgeSummary" } }, "examples": [] }, { "name": "suix_getLatestSuiSystemState", "tags": [ { "name": "Governance Read API" } ], "description": "Return the latest SUI system state object on-chain.", "params": [], "result": { "name": "SuiSystemStateSummary", "required": true, "schema": { "$ref": "#/components/schemas/SuiSystemStateSummary" } }, "examples": [ { "name": "Gets objects owned by the address in the request.", "params": [], "result": { "name": "Result", "value": "some_system_state" } } ] }, { "name": "suix_getOwnedObjects", "tags": [ { "name": "Extended API" } ], "description": "Return the list of objects owned by an address. Note that if the address owns more than `QUERY_MAX_RESULT_LIMIT` objects, the pagination is not accurate, because previous page may have been updated when the next page is fetched. Please use suix_queryObjects if this is a concern.", "params": [ { "name": "address", "description": "the owner's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "query", "description": "the objects query criteria.", "schema": { "$ref": "#/components/schemas/ObjectResponseQuery" } }, { "name": "cursor", "description": "An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "limit", "description": "Max number of items returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.", "schema": { "type": "integer", "format": "uint", "minimum": 0 } } ], "result": { "name": "ObjectsPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_SuiObjectResponse_and_ObjectID" } }, "examples": [ { "name": "Returns all the objects the address provided in the request owns and that match the filter. By default, only the digest value is returned, but the request returns additional information by setting the relevant keys to true. A cursor value is also provided, so the list of results begin after that value.", "params": [ { "name": "address", "value": "0xdbc9abc01a87906b033a75750e741edb2df5ea5d55c96a611371d22799d26827" }, { "name": "query", "value": { "filter": { "MatchAll": [ { "StructType": "0x2::coin::Coin<0x2::sui::SUI>" }, { "AddressOwner": "0xdbc9abc01a87906b033a75750e741edb2df5ea5d55c96a611371d22799d26827" }, { "Version": "13488" } ] }, "options": { "showType": true, "showOwner": true, "showPreviousTransaction": true, "showDisplay": false, "showContent": false, "showBcs": false, "showStorageRebate": false } } }, { "name": "cursor", "value": "0x0cd4bb4d4f520fe9bbf0cf1cebe3f2549412826c3c9261bff9786c240123749f" }, { "name": "limit", "value": 3 } ], "result": { "name": "Result", "value": { "data": [ { "data": { "objectId": "0x0b37a91692359a98496738a58c17a9334aeacc435c70ab9635e47a277d8f8dd9", "version": "13488", "digest": "FZzfCnKCSRW2jN9AwkiarjYQapViUQAh799aiRMZ4YC2", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0xdbc9abc01a87906b033a75750e741edb2df5ea5d55c96a611371d22799d26827" }, "previousTransaction": "AJhAseKLEndWYT45FbvYGgCJQTqZP537xqNnthY9FqSa", "storageRebate": "100" } }, { "data": { "objectId": "0xd4feace07fc863a2eef286c3e95ed48e2c181bb65db5beaf7ea664b4ca6b744c", "version": "13488", "digest": "3cxBDcfnkVgtXWhnMnKKkMGtZdiEorUhb1vdp2DkVyfi", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0xdbc9abc01a87906b033a75750e741edb2df5ea5d55c96a611371d22799d26827" }, "previousTransaction": "8qCvxDHh5LtDfF95Ci9G7vvQN2P6y4v55S9xoKBYp7FM", "storageRebate": "100" } }, { "data": { "objectId": "0xe26860fac6839ce2d7ed7e6f29d276a1b4c23f2d9a9b6f0d8b2c17beace292b7", "version": "13488", "digest": "3tX9sgYC4A6nVKGjKEE5xxW6t4zkvDL9BwjuaxMg8arP", "type": "0x2::coin::Coin<0x2::sui::SUI>", "owner": { "AddressOwner": "0xdbc9abc01a87906b033a75750e741edb2df5ea5d55c96a611371d22799d26827" }, "previousTransaction": "5Ka3vDaDy9h5UYk3Maz3vssWHrhbcGXQgwg8fL2ygyTi", "storageRebate": "100" } } ], "nextCursor": "0xe26860fac6839ce2d7ed7e6f29d276a1b4c23f2d9a9b6f0d8b2c17beace292b7", "hasNextPage": true } } } ] }, { "name": "suix_getReferenceGasPrice", "tags": [ { "name": "Governance Read API" } ], "description": "Return the reference gas price for the network", "params": [], "result": { "name": "BigInt", "required": true, "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "examples": [ { "name": "Gets reference gas price information for the network.", "params": [], "result": { "name": "Result", "value": 1000 } } ] }, { "name": "suix_getStakes", "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" } } }, "examples": [ { "name": "Returns the staking information for the address the request provides.", "params": [ { "name": "owner", "value": "0x9c76d5157eaa77c41a7bfda8db98a8e8080f7cb53b7313088ed085c73f866f21" } ], "result": { "name": "Result", "value": [ { "validatorAddress": "0x3befb84f03a24386492bd3b05b1fd386172eb450e5059ce7df0ea6d9d6cefcaa", "stakingPool": "0x9a95cf69368e31b4dbe8ee9bdb3c0587bbc79d8fc6edf4007e185a962fd906df", "stakes": [ { "stakedSuiId": "0xb4eeb46b70f0bebcae832aeef9f7c5db76052ab656e5f81853d0cf701cdbc8eb", "stakeRequestEpoch": "62", "stakeActiveEpoch": "63", "principal": "200000000000", "status": "Active", "estimatedReward": "520000000" }, { "stakedSuiId": "0xf27ab513fc6ef8c344406c78da3d5ad3a5fcc295dc8803c15989a62d33ee8590", "stakeRequestEpoch": "142", "stakeActiveEpoch": "143", "principal": "200000000000", "status": "Pending" } ] }, { "validatorAddress": "0x14cfd5e91c13a481370240e392464c329a203fb9f0a8158aaab9b2a90044b26e", "stakingPool": "0x14cc7fee4100fdcabda6d15c63c4b49c45ae23f2b936495cd38b1a4b04010295", "stakes": [ { "stakedSuiId": "0xbaa75ac72e548aeecf2ce8b4e88530651d6e8f93e0fb79b4bc65a512beb5b9f3", "stakeRequestEpoch": "244", "stakeActiveEpoch": "245", "principal": "200000000000", "status": "Unstaked" } ] } ] } } ] }, { "name": "suix_getStakesByIds", "tags": [ { "name": "Governance Read API" } ], "description": "Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.", "params": [ { "name": "staked_sui_ids", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } } ], "result": { "name": "Vec", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatedStake" } } }, "examples": [ { "name": "Returns the staking information for the address the request provides.", "params": [ { "name": "staked_sui_ids", "value": [ "0x378423de90ed03b694cecf443c72b5387b29a731d26d98108d7abc4902107d7d", "0x6a8e0f8fea6fda5488462e58724c034462b6064a08845e2ae2942fe7c4ee816d" ] } ], "result": { "name": "Result", "value": { "validatorAddress": "0x754eb2eed23e6c6bb32c89fe1f21ab588374445e72e0402aea014b2956105799", "stakingPool": "0x63ee67e81398729f87d81d62f399c041b0f8d0938923ea7e3917608ee62df437", "stakes": [ { "stakedSuiId": "0x378423de90ed03b694cecf443c72b5387b29a731d26d98108d7abc4902107d7d", "stakeRequestEpoch": "62", "stakeActiveEpoch": "63", "principal": "200000000000", "status": "Active", "estimatedReward": "520000000" }, { "stakedSuiId": "0x6a8e0f8fea6fda5488462e58724c034462b6064a08845e2ae2942fe7c4ee816d", "stakeRequestEpoch": "244", "stakeActiveEpoch": "245", "principal": "200000000000", "status": "Unstaked" } ] } } } ] }, { "name": "suix_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" } }, "examples": [ { "name": "Gets total supply for the type of coin provided.", "params": [ { "name": "coin_type", "value": "0xe5c651321915b06c81838c2e370109b554a448a78d3a56220f798398dde66eab::acoin::ACOIN" } ], "result": { "name": "Result", "value": { "value": "12023692" } } } ] }, { "name": "suix_getTotalTransactions", "tags": [ { "name": "Extended API" } ], "params": [], "result": { "name": "BigInt", "required": true, "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "examples": [] }, { "name": "suix_getValidatorsApy", "tags": [ { "name": "Governance Read API" } ], "description": "Return the validator APY", "params": [], "result": { "name": "ValidatorApys", "required": true, "schema": { "$ref": "#/components/schemas/ValidatorApys" } }, "examples": [ { "name": "Gets the APY for all validators.", "params": [], "result": { "name": "Result", "value": { "apys": [ { "address": "0x9d77e49d53f92bc8310f0ccc3257dcc85bada4a729d650f77622264321297809", "apy": 0.06 }, { "address": "0x27838b06db0346808ffb0676099de0408b31759f57b69c52e09410a66f9a23c3", "apy": 0.02 }, { "address": "0x4be9913b6697a5e83e02e2a0fc747057ba0901e4d9b1e04de75ea2699a441321", "apy": 0.05 } ], "epoch": "420" } } } ] }, { "name": "suix_queryEvents", "tags": [ { "name": "Extended API" } ], "description": "Return list of events for a specified query criteria.", "params": [ { "name": "query", "description": "The event query criteria. See [Event filter](https://docs.sui.io/build/event_api#event-filters) documentation for examples.", "required": true, "schema": { "$ref": "#/components/schemas/EventFilter" } }, { "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 } }, { "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_Event_and_EventID" } }, "examples": [ { "name": "Returns the events for a specified query criteria.", "params": [ { "name": "query", "value": { "MoveModule": { "package": "0xa395759ca37c6e1ffc179184e98a6f9a2da5d78f6e34b0e5044ed52a6bc0a1bc", "module": "test" } } }, { "name": "cursor", "value": { "txDigest": "Eg3ynETJfTfPKyvJzq3VLG6MngURYHPMjjUJ3Xt1t7tf", "eventSeq": "1" } }, { "name": "limit", "value": 100 }, { "name": "descending_order", "value": false } ], "result": { "name": "Result", "value": { "data": [ { "id": { "txDigest": "FFwCMgC7FHBLEwfL9JeSeR2EhMAZMykUPVW1kE3HgTMe", "eventSeq": "1" }, "packageId": "0xb2fd632992b01aa25900867288b63d6255ff8223c12b0fd985c49d5777a0d65a", "transactionModule": "test", "sender": "0xcceee09f44d558691334ec0aff47af033f57162a2f33056e2585e2c46863ac02", "type": "0x3::test::Test<0x3::test::Test>", "parsedJson": "some_value", "bcsEncoding": "base64", "bcs": "" }, { "id": { "txDigest": "FUMhRSj76es8MYeaRYeaBnppk56cuEehKwL2CiU82U7B", "eventSeq": "1" }, "packageId": "0xb2fd632992b01aa25900867288b63d6255ff8223c12b0fd985c49d5777a0d65a", "transactionModule": "test", "sender": "0x84bd999f9ff7a1804872957fafa528628a24386298faa98850887f64da841b87", "type": "0x3::test::Test<0x3::test::Test>", "parsedJson": "some_value", "bcsEncoding": "base64", "bcs": "" }, { "id": { "txDigest": "CkEYWW2zxTCGBLvUcTARhyX92fu2uc7cnCUXfCiqAypp", "eventSeq": "1" }, "packageId": "0xb2fd632992b01aa25900867288b63d6255ff8223c12b0fd985c49d5777a0d65a", "transactionModule": "test", "sender": "0x279efd098d59a66a3d9adc87cce81fe9ec69dc8105b2b60140589ec8be44c29f", "type": "0x3::test::Test<0x3::test::Test>", "parsedJson": "some_value", "bcsEncoding": "base64", "bcs": "" }, { "id": { "txDigest": "Eg3ynETJfTfPKyvJzq3VLG6MngURYHPMjjUJ3Xt1t7tf", "eventSeq": "1" }, "packageId": "0xb2fd632992b01aa25900867288b63d6255ff8223c12b0fd985c49d5777a0d65a", "transactionModule": "test", "sender": "0x289be027d2a94f744b4c59fda7b528f9c59f430eaba84b8bee9b43a30f9cc83f", "type": "0x3::test::Test<0x3::test::Test>", "parsedJson": "some_value", "bcsEncoding": "base64", "bcs": "" } ], "nextCursor": { "txDigest": "Eg3ynETJfTfPKyvJzq3VLG6MngURYHPMjjUJ3Xt1t7tf", "eventSeq": "1" }, "hasNextPage": false } } } ] }, { "name": "suix_queryObjects", "tags": [ { "name": "Extended API" } ], "description": "Return the list of queried objects. Note that this is an enhanced full node only api.", "params": [ { "name": "query", "description": "the objects query criteria.", "required": true, "schema": { "$ref": "#/components/schemas/ObjectResponseQuery" } }, { "name": "cursor", "description": "An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.", "schema": { "$ref": "#/components/schemas/CheckpointedObjectID" } }, { "name": "limit", "description": "Max number of items returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.", "schema": { "type": "integer", "format": "uint", "minimum": 0 } } ], "result": { "name": "QueryObjectsPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_SuiObjectResponse_and_CheckpointedObjectID" } }, "examples": [] }, { "name": "suix_queryTransactionBlocks", "tags": [ { "name": "Extended 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/TransactionBlockResponseQuery" } }, { "name": "cursor", "description": "An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.", "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 } }, { "name": "descending_order", "description": "query result ordering, default to false (ascending order), oldest record first.", "schema": { "type": "boolean" } } ], "result": { "name": "TransactionBlocksPage", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_TransactionBlockResponse_and_TransactionDigest" } }, "examples": [ { "name": "Returns the transaction digest for specified query criteria.", "params": [ { "name": "query", "value": { "filter": { "InputObject": "0x93633829fcba6d6e0ccb13d3dbfe7614b81ea76b255e5d435032cd8595f37eb8" }, "options": null } }, { "name": "cursor", "value": "HxidAfFfyr4kXSiWeVq1J6Tk526YUVDoSUY5PSnS4tEJ" }, { "name": "limit", "value": 100 }, { "name": "descending_order", "value": false } ], "result": { "name": "Result", "value": { "data": [ { "digest": "GUPcK4cmRmgsTFr52ab9f6fnzNVg3Lz6hF2aXFcsRzaD" }, { "digest": "B2iV1SVbBjgTKfbJKPQrvTT6F3kNdekFuBwY9tQcAxV2" }, { "digest": "8QrPa4x9iNG5r2zQfmeH8pJoVjjtq9AGzp8rp2fxi8Sk" }, { "digest": "3nek86HEjXZ7K3EtrAcBG4wMrCS21gqr8BqwwC6M6P7F" } ], "nextCursor": "3nek86HEjXZ7K3EtrAcBG4wMrCS21gqr8BqwwC6M6P7F", "hasNextPage": false } } } ] }, { "name": "suix_resolveNameServiceAddress", "tags": [ { "name": "Extended API" } ], "description": "Return the resolved address given resolver and name", "params": [ { "name": "name", "description": "The name to resolve", "required": true, "schema": { "type": "string" } } ], "result": { "name": "SuiAddress", "schema": { "$ref": "#/components/schemas/SuiAddress" } }, "examples": [ { "name": "Returns the resolved address for the name the request provides.", "params": [ { "name": "name", "value": "example.sui" } ], "result": { "name": "Result", "value": "0x6710024f81dd33ab6833482ee8034e779a48e6ef635c7f856df4905022458bfb" } } ] }, { "name": "suix_resolveNameServiceNames", "tags": [ { "name": "Extended API" } ], "description": "Return the resolved names given address, if multiple names are resolved, the first one is the primary name.", "params": [ { "name": "address", "description": "The address to resolve", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "name": "cursor", "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "limit", "schema": { "type": "integer", "format": "uint", "minimum": 0 } } ], "result": { "name": "Page", "required": true, "schema": { "$ref": "#/components/schemas/Page_for_String_and_ObjectID" } }, "examples": [ { "name": "Returns the SuiNS name for the address the request provides. Currently, the API returns only the first name in cases where there are multiple. Future support will use the cursor ID and limit values in the request to control pagination of the response for addresses with multiple names.", "params": [ { "name": "address", "value": "0x5cd6fa76ed1d18f05f15e35075252ddec4fb83621d55952d9172fcfcb72feae2" }, { "name": "cursor", "value": "0xd22bbb46f892c42d9ec0ae4de93e02c75973a51c17180798237326a58694a2cf" }, { "name": "limit", "value": 3 } ], "result": { "name": "Result", "value": { "data": [ "example.sui" ], "nextCursor": "0xd22bbb46f892c42d9ec0ae4de93e02c75973a51c17180798237326a58694a2cf", "hasNextPage": false } } } ] }, { "name": "unsafe_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": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "name": "txn_builder_mode", "description": "Whether this is a regular transaction or a Dev Inspect Transaction", "schema": { "$ref": "#/components/schemas/SuiTransactionBlockBuilderMode" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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. `pay`", "required": true, "schema": { "type": "string" } }, { "name": "function", "description": "the move function name, e.g. `split`", "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "name": "execution_mode", "description": "Whether this is a Normal transaction or a Dev Inspect Transaction. Default to be `SuiTransactionBlockBuilderMode::Commit` when it's None.", "schema": { "$ref": "#/components/schemas/SuiTransactionBlockBuilderMode" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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 coins 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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "name": "gas_budget", "description": "the gas budget, the transaction will fail if the gas cost exceed the budget", "required": true, "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_publish", "tags": [ { "name": "Transaction Builder API" } ], "description": "Create an unsigned transaction to publish a Move package.", "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 package", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Base64" } } }, { "name": "dependencies", "description": "a list of transitive dependency addresses that this set of modules depends on.", "required": true, "schema": { "type": "array", "items": { "$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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_requestAddStake", "tags": [ { "name": "Transaction Builder API" } ], "description": "Add 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 object to stake", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, { "name": "amount", "description": "stake amount", "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_requestWithdrawStake", "tags": [ { "name": "Transaction Builder API" } ], "description": "Withdraw stake from a validator's staking pool.", "params": [ { "name": "signer", "description": "the transaction signer's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } }, { "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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 split", "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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 split", "required": true, "schema": { "$ref": "#/components/schemas/ObjectID" } }, { "name": "split_count", "description": "the number of coins to split into", "required": true, "schema": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "name": "recipient", "description": "the recipient's Sui address", "required": true, "schema": { "$ref": "#/components/schemas/SuiAddress" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] }, { "name": "unsafe_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": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, { "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": { "$ref": "#/components/schemas/BigInt_for_uint64" } } ], "result": { "name": "TransactionBlockBytes", "required": true, "schema": { "$ref": "#/components/schemas/TransactionBlockBytes" } }, "examples": [] } ], "components": { "schemas": { "AccumulatorEvent": { "type": "object", "required": [ "accumulatorObj", "address", "operation", "ty", "value" ], "properties": { "accumulatorObj": { "$ref": "#/components/schemas/ObjectID" }, "address": { "$ref": "#/components/schemas/SuiAddress" }, "operation": { "$ref": "#/components/schemas/AccumulatorOperation" }, "ty": { "$ref": "#/components/schemas/TypeTag" }, "value": { "$ref": "#/components/schemas/AccumulatorValue" } } }, "AccumulatorOperation": { "type": "string", "enum": [ "merge", "split" ] }, "AccumulatorValue": { "oneOf": [ { "type": "object", "required": [ "integer" ], "properties": { "integer": { "type": "integer", "format": "uint64", "minimum": 0 } }, "additionalProperties": false }, { "type": "object", "required": [ "integerTuple" ], "properties": { "integerTuple": { "type": "array", "items": [ { "type": "integer", "format": "uint64", "minimum": 0 }, { "type": "integer", "format": "uint64", "minimum": 0 } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "type": "object", "required": [ "eventDigest" ], "properties": { "eventDigest": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "format": "uint64", "minimum": 0 }, { "$ref": "#/components/schemas/Digest" } ], "maxItems": 2, "minItems": 2 } } }, "additionalProperties": false } ] }, "AdditionalConsensusStateDigest": { "$ref": "#/components/schemas/Digest" }, "AuthorityPublicKeyBytes": { "description": "Defines the compressed version of the public key that we pass around in Sui", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] }, "Balance": { "type": "object", "required": [ "coinObjectCount", "coinType", "lockedBalance", "totalBalance" ], "properties": { "coinObjectCount": { "type": "integer", "format": "uint", "minimum": 0 }, "coinType": { "type": "string" }, "fundsInAddressBalance": { "description": "The portion of `total_balance` that resides in the address balance rather than in the coin objects. `total_balance` is the total amount of funds owned by the address. That is, do not add these two fields together.", "default": "0", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint128" } ] }, "lockedBalance": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BigInt_for_uint128" } }, "totalBalance": { "$ref": "#/components/schemas/BigInt_for_uint128" } } }, "BalanceChange": { "type": "object", "required": [ "amount", "coinType", "owner" ], "properties": { "amount": { "description": "The amount indicate the balance value changes, negative amount means spending coin value and positive means receiving coin value.", "type": "string" }, "coinType": { "type": "string" }, "owner": { "description": "Owner of the balance change", "allOf": [ { "$ref": "#/components/schemas/Owner" } ] } } }, "Base58": { "type": "string" }, "Base64": { "description": "Base64 encoding", "type": "string" }, "BigInt_for_uint128": { "type": "string" }, "BigInt_for_uint16": { "type": "string" }, "BigInt_for_uint32": { "type": "string" }, "BigInt_for_uint64": { "type": "string" }, "Bn254FqElement": { "description": "A struct that stores a Bn254 Fq field element as 32 bytes.", "type": "string" }, "Bn254FrElement": { "description": "A struct that stores a Bn254 Fr field element as 32 bytes.", "type": "string" }, "BridgeChainId": { "type": "string", "enum": [ "SuiMainnet", "SuiTestnet", "SuiCustom", "EthMainnet", "EthSepolia", "EthCustom" ] }, "BridgeCommitteeSummary": { "type": "object", "required": [ "lastCommitteeUpdateEpoch", "memberRegistration", "members" ], "properties": { "lastCommitteeUpdateEpoch": { "type": "integer", "format": "uint64", "minimum": 0 }, "memberRegistration": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiAddress" }, { "$ref": "#/components/schemas/MoveTypeCommitteeMemberRegistration" } ], "maxItems": 2, "minItems": 2 } }, "members": { "type": "array", "items": { "type": "array", "items": [ { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, { "$ref": "#/components/schemas/MoveTypeCommitteeMember" } ], "maxItems": 2, "minItems": 2 } } } }, "BridgeLimiterSummary": { "type": "object", "required": [ "transferLimit", "transferRecords" ], "properties": { "transferLimit": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/BridgeChainId" }, { "$ref": "#/components/schemas/BridgeChainId" }, { "type": "integer", "format": "uint64", "minimum": 0 } ], "maxItems": 3, "minItems": 3 } }, "transferRecords": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/BridgeChainId" }, { "$ref": "#/components/schemas/BridgeChainId" }, { "$ref": "#/components/schemas/MoveTypeBridgeTransferRecord" } ], "maxItems": 3, "minItems": 3 } } } }, "BridgeSummary": { "type": "object", "required": [ "bridgeRecordsId", "bridgeVersion", "chainId", "committee", "isFrozen", "limiter", "messageVersion", "sequenceNums", "treasury" ], "properties": { "bridgeRecordsId": { "description": "Object ID of bridge Records (dynamic field)", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "bridgeVersion": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "chainId": { "description": "Self Chain ID", "type": "integer", "format": "uint8", "minimum": 0 }, "committee": { "$ref": "#/components/schemas/BridgeCommitteeSummary" }, "isFrozen": { "description": "Whether the bridge is currently frozen or not", "type": "boolean" }, "limiter": { "description": "Summary of the limiter", "allOf": [ { "$ref": "#/components/schemas/BridgeLimiterSummary" } ] }, "messageVersion": { "type": "integer", "format": "uint8", "minimum": 0 }, "sequenceNums": { "description": "Sequence numbers of all message types", "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "format": "uint8", "minimum": 0 }, { "$ref": "#/components/schemas/BigInt_for_uint64" } ], "maxItems": 2, "minItems": 2 } }, "treasury": { "description": "Summary of the treasury", "allOf": [ { "$ref": "#/components/schemas/BridgeTreasurySummary" } ] } } }, "BridgeTokenMetadata": { "type": "object", "required": [ "decimalMultiplier", "id", "nativeToken", "notionalValue" ], "properties": { "decimalMultiplier": { "type": "integer", "format": "uint64", "minimum": 0 }, "id": { "type": "integer", "format": "uint8", "minimum": 0 }, "nativeToken": { "type": "boolean" }, "notionalValue": { "type": "integer", "format": "uint64", "minimum": 0 } } }, "BridgeTreasurySummary": { "type": "object", "required": [ "idTokenTypeMap", "supportedTokens" ], "properties": { "idTokenTypeMap": { "type": "array", "items": { "type": "array", "items": [ { "type": "integer", "format": "uint8", "minimum": 0 }, { "type": "string" } ], "maxItems": 2, "minItems": 2 } }, "supportedTokens": { "type": "array", "items": { "type": "array", "items": [ { "type": "string" }, { "$ref": "#/components/schemas/BridgeTokenMetadata" } ], "maxItems": 2, "minItems": 2 } } } }, "Checkpoint": { "type": "object", "required": [ "checkpointCommitments", "digest", "epoch", "epochRollingGasCostSummary", "networkTotalTransactions", "sequenceNumber", "timestampMs", "transactions", "validatorSignature" ], "properties": { "checkpointCommitments": { "description": "Commitments to checkpoint state", "type": "array", "items": { "$ref": "#/components/schemas/CheckpointCommitment" } }, "digest": { "description": "Checkpoint digest", "allOf": [ { "$ref": "#/components/schemas/CheckpointDigest" } ] }, "endOfEpochData": { "description": "Present only on the final checkpoint of the epoch.", "anyOf": [ { "$ref": "#/components/schemas/EndOfEpochData" }, { "type": "null" } ] }, "epoch": { "description": "Checkpoint's epoch ID", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "epochRollingGasCostSummary": { "description": "The running total gas costs of all transactions included in the current epoch so far until this checkpoint.", "allOf": [ { "$ref": "#/components/schemas/GasCostSummary" } ] }, "networkTotalTransactions": { "description": "Total number of transactions committed since genesis, including those in this checkpoint.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "previousDigest": { "description": "Digest of the previous checkpoint", "anyOf": [ { "$ref": "#/components/schemas/CheckpointDigest" }, { "type": "null" } ] }, "sequenceNumber": { "description": "Checkpoint sequence number", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "timestampMs": { "description": "Timestamp of the checkpoint - number of milliseconds from the Unix epoch Checkpoint timestamps are monotonic, but not strongly monotonic - subsequent checkpoints can have same timestamp if they originate from the same underlining consensus commit", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "transactions": { "description": "Transaction digests", "type": "array", "items": { "$ref": "#/components/schemas/TransactionDigest" } }, "validatorSignature": { "description": "Validator Signature", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] } } }, "CheckpointArtifactsDigest": { "$ref": "#/components/schemas/Digest" }, "CheckpointCommitment": { "oneOf": [ { "type": "object", "required": [ "ECMHLiveObjectSetDigest" ], "properties": { "ECMHLiveObjectSetDigest": { "$ref": "#/components/schemas/ECMHLiveObjectSetDigest" } }, "additionalProperties": false }, { "type": "object", "required": [ "CheckpointArtifactsDigest" ], "properties": { "CheckpointArtifactsDigest": { "$ref": "#/components/schemas/CheckpointArtifactsDigest" } }, "additionalProperties": false } ] }, "CheckpointDigest": { "description": "Representation of a Checkpoint's digest", "allOf": [ { "$ref": "#/components/schemas/Digest" } ] }, "CheckpointId": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "$ref": "#/components/schemas/CheckpointDigest" } ] }, "CheckpointedObjectID": { "type": "object", "required": [ "objectId" ], "properties": { "atCheckpoint": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "objectId": { "$ref": "#/components/schemas/ObjectID" } } }, "Claim": { "description": "A claim consists of value and index_mod_4.", "type": "object", "required": [ "indexMod4", "value" ], "properties": { "indexMod4": { "type": "integer", "format": "uint8", "minimum": 0 }, "value": { "type": "string" } } }, "Coin": { "type": "object", "required": [ "balance", "coinObjectId", "coinType", "digest", "previousTransaction", "version" ], "properties": { "balance": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "coinObjectId": { "$ref": "#/components/schemas/ObjectID" }, "coinType": { "type": "string" }, "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "previousTransaction": { "$ref": "#/components/schemas/TransactionDigest" }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, "CommitteeInfo": { "description": "RPC representation of the [Committee] type.", "type": "object", "required": [ "epoch", "validators" ], "properties": { "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "validators": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/AuthorityPublicKeyBytes" }, { "$ref": "#/components/schemas/BigInt_for_uint64" } ], "maxItems": 2, "minItems": 2 } } } }, "CompressedSignature": { "description": "Unlike [enum Signature], [enum CompressedSignature] does not contain public key.", "oneOf": [ { "type": "object", "required": [ "Ed25519" ], "properties": { "Ed25519": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256k1" ], "properties": { "Secp256k1": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256r1" ], "properties": { "Secp256r1": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "ZkLogin" ], "properties": { "ZkLogin": { "$ref": "#/components/schemas/ZkLoginAuthenticatorAsBytes" } }, "additionalProperties": false }, { "type": "object", "required": [ "Passkey" ], "properties": { "Passkey": { "$ref": "#/components/schemas/PasskeyAuthenticatorAsBytes" } }, "additionalProperties": false } ] }, "ConsensusCommitDigest": { "$ref": "#/components/schemas/Digest" }, "ConsensusDeterminedVersionAssignments": { "oneOf": [ { "type": "object", "required": [ "CancelledTransactions" ], "properties": { "CancelledTransactions": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SequenceNumber2" } ], "maxItems": 2, "minItems": 2 } } ], "maxItems": 2, "minItems": 2 } } }, "additionalProperties": false }, { "type": "object", "required": [ "CancelledTransactionsV2" ], "properties": { "CancelledTransactionsV2": { "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "array", "items": { "type": "array", "items": [ { "type": "array", "items": [ { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SequenceNumber2" } ], "maxItems": 2, "minItems": 2 }, { "$ref": "#/components/schemas/SequenceNumber2" } ], "maxItems": 2, "minItems": 2 } } ], "maxItems": 2, "minItems": 2 } } }, "additionalProperties": false } ] }, "Data": { "oneOf": [ { "type": "object", "required": [ "dataType", "fields", "hasPublicTransfer", "type" ], "properties": { "dataType": { "type": "string", "enum": [ "moveObject" ] }, "fields": { "$ref": "#/components/schemas/MoveStruct" }, "hasPublicTransfer": { "type": "boolean" }, "type": { "type": "string" } } }, { "type": "object", "required": [ "dataType", "disassembled" ], "properties": { "dataType": { "type": "string", "enum": [ "package" ] }, "disassembled": { "type": "object", "additionalProperties": true } } } ] }, "DelegatedStake": { "type": "object", "required": [ "stakes", "stakingPool", "validatorAddress" ], "properties": { "stakes": { "type": "array", "items": { "$ref": "#/components/schemas/Stake" } }, "stakingPool": { "description": "Staking pool object id.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "validatorAddress": { "description": "Validator's Address.", "allOf": [ { "$ref": "#/components/schemas/SuiAddress" } ] } } }, "DevInspectArgs": { "description": "Additional rguments supplied to dev inspect beyond what is allowed in today's API.", "type": "object", "properties": { "gasBudget": { "description": "The gas budget for the transaction.", "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "gasObjects": { "description": "The gas objects used to pay for the transaction.", "type": [ "array", "null" ], "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SequenceNumber2" }, { "$ref": "#/components/schemas/ObjectDigest" } ], "maxItems": 3, "minItems": 3 } }, "gasSponsor": { "description": "The sponsor of the gas for the transaction, might be different from the sender.", "anyOf": [ { "$ref": "#/components/schemas/SuiAddress" }, { "type": "null" } ] }, "showRawTxnDataAndEffects": { "description": "Whether to return the raw transaction data and effects.", "type": [ "boolean", "null" ] }, "skipChecks": { "description": "Whether to skip transaction checks for the transaction.", "type": [ "boolean", "null" ] } } }, "DevInspectResults": { "description": "The response from processing a dev inspect transaction", "type": "object", "required": [ "effects", "events" ], "properties": { "effects": { "description": "Summary of effects that likely would be generated if the transaction is actually run. Note however, that not all dev-inspect transactions are actually usable as transactions so it might not be possible actually generate these effects from a normal transaction.", "allOf": [ { "$ref": "#/components/schemas/TransactionBlockEffects" } ] }, "error": { "description": "Execution error from executing the transactions", "type": [ "string", "null" ] }, "events": { "description": "Events that likely would be generated if the transaction is actually run.", "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "rawEffects": { "description": "The raw effects of the transaction that was dev inspected.", "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "rawTxnData": { "description": "The raw transaction data that was dev inspected.", "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "results": { "description": "Execution results (including return values) from executing the transactions", "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/SuiExecutionResult" } } } }, "Digest": { "description": "A representation of a 32 byte digest", "allOf": [ { "$ref": "#/components/schemas/Base58" } ] }, "DisplayFieldsResponse": { "type": "object", "properties": { "data": { "type": [ "object", "null" ], "additionalProperties": true }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ObjectResponseError" }, { "type": "null" } ] } } }, "DryRunTransactionBlockResponse": { "type": "object", "required": [ "balanceChanges", "effects", "events", "input", "objectChanges" ], "properties": { "balanceChanges": { "type": "array", "items": { "$ref": "#/components/schemas/BalanceChange" } }, "effects": { "$ref": "#/components/schemas/TransactionBlockEffects" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "executionErrorSource": { "type": [ "string", "null" ] }, "input": { "$ref": "#/components/schemas/TransactionBlockData" }, "objectChanges": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectChange" } }, "suggestedGasPrice": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, "DynamicFieldInfo": { "type": "object", "oneOf": [ { "type": "object", "required": [ "bcsEncoding", "bcsName" ], "properties": { "bcsEncoding": { "type": "string", "enum": [ "base64" ] }, "bcsName": { "$ref": "#/components/schemas/Base64" } } }, { "type": "object", "required": [ "bcsEncoding", "bcsName" ], "properties": { "bcsEncoding": { "type": "string", "enum": [ "base58" ] }, "bcsName": { "$ref": "#/components/schemas/Base58" } } } ], "required": [ "digest", "name", "objectId", "objectType", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "name": { "$ref": "#/components/schemas/DynamicFieldName" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "type": { "$ref": "#/components/schemas/DynamicFieldType" }, "version": { "$ref": "#/components/schemas/SequenceNumber2" } } }, "DynamicFieldName": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string" }, "value": true } }, "DynamicFieldType": { "type": "string", "enum": [ "DynamicField", "DynamicObject" ] }, "ECMHLiveObjectSetDigest": { "description": "The Sha256 digest of an EllipticCurveMultisetHash committing to the live object set.", "type": "object", "required": [ "digest" ], "properties": { "digest": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 }, "maxItems": 32, "minItems": 32 } } }, "Ed25519SuiSignature": { "$ref": "#/components/schemas/Base64" }, "EndOfEpochData": { "type": "object", "required": [ "epochCommitments", "nextEpochCommittee", "nextEpochProtocolVersion" ], "properties": { "epochCommitments": { "description": "Commitments to epoch specific state (e.g. live object set)", "type": "array", "items": { "$ref": "#/components/schemas/CheckpointCommitment" } }, "nextEpochCommittee": { "description": "next_epoch_committee is `Some` if and only if the current checkpoint is the last checkpoint of an epoch. Therefore next_epoch_committee can be used to pick the last checkpoint of an epoch, which is often useful to get epoch level summary stats like total gas cost of an epoch, or the total number of transactions from genesis to the end of an epoch. The committee is stored as a vector of validator pub key and stake pairs. The vector should be sorted based on the Committee data structure.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/AuthorityPublicKeyBytes" }, { "$ref": "#/components/schemas/BigInt_for_uint64" } ], "maxItems": 2, "minItems": 2 } }, "nextEpochProtocolVersion": { "description": "The protocol version that is in effect during the epoch that starts immediately after this checkpoint.", "allOf": [ { "$ref": "#/components/schemas/ProtocolVersion" } ] } } }, "EndOfEpochInfo": { "type": "object", "required": [ "epochEndTimestamp", "lastCheckpointId", "leftoverStorageFundInflow", "protocolVersion", "referenceGasPrice", "stakeSubsidyAmount", "storageCharge", "storageFundBalance", "storageFundReinvestment", "storageRebate", "totalGasFees", "totalStake", "totalStakeRewardsDistributed" ], "properties": { "epochEndTimestamp": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "lastCheckpointId": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "leftoverStorageFundInflow": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "protocolVersion": { "description": "existing fields from `SystemEpochInfo`", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "referenceGasPrice": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "stakeSubsidyAmount": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storageCharge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storageFundBalance": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storageFundReinvestment": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storageRebate": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "totalGasFees": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "totalStake": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "totalStakeRewardsDistributed": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "EpochInfo": { "type": "object", "required": [ "epoch", "epochStartTimestamp", "epochTotalTransactions", "firstCheckpointId", "validators" ], "properties": { "endOfEpochInfo": { "anyOf": [ { "$ref": "#/components/schemas/EndOfEpochInfo" }, { "type": "null" } ] }, "epoch": { "description": "epoch number", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "epochStartTimestamp": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epochTotalTransactions": { "description": "count of tx in epoch", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "firstCheckpointId": { "description": "first, last checkpoint sequence numbers", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "referenceGasPrice": { "type": [ "integer", "null" ], "format": "uint64", "minimum": 0 }, "validators": { "description": "list of validators included in epoch", "type": "array", "items": { "$ref": "#/components/schemas/SuiValidatorSummary" } } } }, "Event": { "type": "object", "oneOf": [ { "type": "object", "required": [ "bcs", "bcsEncoding" ], "properties": { "bcs": { "$ref": "#/components/schemas/Base64" }, "bcsEncoding": { "type": "string", "enum": [ "base64" ] } } }, { "type": "object", "required": [ "bcs", "bcsEncoding" ], "properties": { "bcs": { "$ref": "#/components/schemas/Base58" }, "bcsEncoding": { "type": "string", "enum": [ "base58" ] } } } ], "required": [ "id", "packageId", "parsedJson", "sender", "transactionModule", "type" ], "properties": { "id": { "description": "Sequential event ID, ie (transaction seq number, event seq number). 1) Serves as a unique event ID for each fullnode 2) Also serves to sequence events for the purposes of pagination and querying. A higher id is an event seen later by that fullnode. This ID is the \"cursor\" for event querying.", "allOf": [ { "$ref": "#/components/schemas/EventID" } ] }, "packageId": { "description": "Move package where this event was emitted.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "parsedJson": { "description": "Parsed json value of the event" }, "sender": { "description": "Sender's Sui address.", "allOf": [ { "$ref": "#/components/schemas/SuiAddress" } ] }, "timestampMs": { "description": "UTC timestamp in milliseconds since epoch (1/1/1970)", "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "transactionModule": { "description": "Move module where this event was emitted.", "type": "string" }, "type": { "description": "Move event type.", "type": "string" } } }, "EventFilter": { "oneOf": [ { "description": "Return all events.", "type": "object", "required": [ "All" ], "properties": { "All": { "type": "array", "maxItems": 0 } }, "additionalProperties": false }, { "description": "Return events that match any of the given filters. Only supported on event subscriptions.", "type": "object", "required": [ "Any" ], "properties": { "Any": { "type": "array", "items": { "$ref": "#/components/schemas/EventFilter" } } }, "additionalProperties": false }, { "description": "Query by sender address.", "type": "object", "required": [ "Sender" ], "properties": { "Sender": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Return events emitted by the given transaction.", "type": "object", "required": [ "Transaction" ], "properties": { "Transaction": { "$ref": "#/components/schemas/TransactionDigest" } }, "additionalProperties": false }, { "description": "Return events emitted in a specified Move module. If the event is defined in Module A but emitted in a tx with Module B, query `MoveModule` by module B returns the event. Query `MoveEventModule` by module A returns the event too.", "type": "object", "required": [ "MoveModule" ], "properties": { "MoveModule": { "type": "object", "required": [ "module", "package" ], "properties": { "module": { "description": "the module name", "type": "string" }, "package": { "description": "the Move package ID", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] } } } }, "additionalProperties": false }, { "description": "Return events with the given Move event struct name (struct tag). For example, if the event is defined in `0xabcd::MyModule`, and named `Foo`, then the struct tag is `0xabcd::MyModule::Foo`.", "type": "object", "required": [ "MoveEventType" ], "properties": { "MoveEventType": { "type": "string" } }, "additionalProperties": false }, { "description": "Return events with the given Move module name where the event struct is defined. If the event is defined in Module A but emitted in a tx with Module B, query `MoveEventModule` by module A returns the event. Query `MoveModule` by module B returns the event too.", "type": "object", "required": [ "MoveEventModule" ], "properties": { "MoveEventModule": { "type": "object", "required": [ "module", "package" ], "properties": { "module": { "description": "the module name", "type": "string" }, "package": { "description": "the Move package ID", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] } } } }, "additionalProperties": false }, { "description": "Return events emitted in [start_time, end_time] interval", "type": "object", "required": [ "TimeRange" ], "properties": { "TimeRange": { "type": "object", "required": [ "endTime", "startTime" ], "properties": { "endTime": { "description": "right endpoint of time interval, milliseconds since epoch, exclusive", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "startTime": { "description": "left endpoint of time interval, milliseconds since epoch, inclusive", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] } } } }, "additionalProperties": false } ] }, "EventID": { "description": "Unique ID of a Sui Event, the ID is a combination of transaction digest and event seq number.", "type": "object", "required": [ "eventSeq", "txDigest" ], "properties": { "eventSeq": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "txDigest": { "$ref": "#/components/schemas/TransactionDigest" } } }, "ExecuteTransactionRequestType": { "type": "string", "enum": [ "WaitForEffectsCert", "WaitForLocalExecution" ] }, "ExecutionStatus": { "oneOf": [ { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "success" ] } } }, { "type": "object", "required": [ "error", "status" ], "properties": { "error": { "type": "string" }, "status": { "type": "string", "enum": [ "failure" ] } } } ] }, "GasCostSummary": { "description": "Summary of the charges in a transaction. Storage is charged independently of computation. There are 3 parts to the storage charges: `storage_cost`: it is the charge of storage at the time the transaction is executed. The cost of storage is the number of bytes of the objects being mutated multiplied by a variable storage cost per byte `storage_rebate`: this is the amount a user gets back when manipulating an object. The `storage_rebate` is the `storage_cost` for an object minus fees. `non_refundable_storage_fee`: not all the value of the object storage cost is given back to user and there is a small fraction that is kept by the system. This value tracks that charge.\n\nWhen looking at a gas cost summary the amount charged to the user is `computation_cost + storage_cost - storage_rebate` and that is the amount that is deducted from the gas coins. `non_refundable_storage_fee` is collected from the objects being mutated/deleted and it is tracked by the system in storage funds.\n\nObjects deleted, including the older versions of objects mutated, have the storage field on the objects added up to a pool of \"potential rebate\". This rebate then is reduced by the \"nonrefundable rate\" such that: `potential_rebate(storage cost of deleted/mutated objects) = storage_rebate + non_refundable_storage_fee`", "type": "object", "required": [ "computationCost", "nonRefundableStorageFee", "storageCost", "storageRebate" ], "properties": { "computationCost": { "description": "Cost of computation/execution", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "nonRefundableStorageFee": { "description": "The fee for the rebate. The portion of the storage rebate kept by the system.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "storageCost": { "description": "Storage cost, it's the sum of all storage cost for all objects created or mutated.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "storageRebate": { "description": "The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] } } }, "GasData": { "type": "object", "required": [ "budget", "owner", "payment", "price" ], "properties": { "budget": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "owner": { "$ref": "#/components/schemas/SuiAddress" }, "payment": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "price": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "GenericSignature": { "description": "Due to the incompatibility of [enum Signature] (which dispatches a trait that assumes signature and pubkey bytes for verification), here we add a wrapper enum where member can just implement a lightweight [trait AuthenticatorTrait]. This way MultiSig (and future Authenticators) can implement its own `verify`.", "oneOf": [ { "type": "object", "required": [ "MultiSig" ], "properties": { "MultiSig": { "$ref": "#/components/schemas/MultiSig" } }, "additionalProperties": false }, { "type": "object", "required": [ "MultiSigLegacy" ], "properties": { "MultiSigLegacy": { "$ref": "#/components/schemas/MultiSigLegacy" } }, "additionalProperties": false }, { "type": "object", "required": [ "Signature" ], "properties": { "Signature": { "$ref": "#/components/schemas/Signature" } }, "additionalProperties": false }, { "type": "object", "required": [ "ZkLoginAuthenticator" ], "properties": { "ZkLoginAuthenticator": { "$ref": "#/components/schemas/ZkLoginAuthenticator" } }, "additionalProperties": false }, { "type": "object", "required": [ "PasskeyAuthenticator" ], "properties": { "PasskeyAuthenticator": { "$ref": "#/components/schemas/PasskeyAuthenticator" } }, "additionalProperties": false } ] }, "GetPastObjectRequest": { "type": "object", "required": [ "objectId", "version" ], "properties": { "objectId": { "description": "the ID of the queried object", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "version": { "description": "the version of the queried object.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber" } ] } } }, "Hex": { "description": "Hex string encoding.", "type": "string" }, "InputObjectKind": { "oneOf": [ { "type": "object", "required": [ "MovePackage" ], "properties": { "MovePackage": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "type": "object", "required": [ "ImmOrOwnedMoveObject" ], "properties": { "ImmOrOwnedMoveObject": { "$ref": "#/components/schemas/ObjectRef" } }, "additionalProperties": false }, { "type": "object", "required": [ "SharedMoveObject" ], "properties": { "SharedMoveObject": { "type": "object", "required": [ "id", "initial_shared_version" ], "properties": { "id": { "$ref": "#/components/schemas/ObjectID" }, "initial_shared_version": { "$ref": "#/components/schemas/SequenceNumber2" }, "mutable": { "default": true, "type": "boolean" } } } }, "additionalProperties": false } ] }, "MoveCallParams": { "type": "object", "required": [ "arguments", "function", "module", "packageObjectId" ], "properties": { "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/SuiJsonValue" } }, "function": { "type": "string" }, "module": { "type": "string" }, "packageObjectId": { "$ref": "#/components/schemas/ObjectID" }, "typeArguments": { "default": [], "type": "array", "items": { "$ref": "#/components/schemas/TypeTag" } } } }, "MoveFunctionArgType": { "oneOf": [ { "type": "string", "enum": [ "Pure" ] }, { "type": "object", "required": [ "Object" ], "properties": { "Object": { "$ref": "#/components/schemas/ObjectValueKind" } }, "additionalProperties": false } ] }, "MoveStruct": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MoveValue" } }, { "type": "object", "required": [ "fields", "type" ], "properties": { "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MoveValue" } }, "type": { "type": "string" } } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MoveValue" } } ] }, "MoveTypeBridgeTransferRecord": { "description": "Rust version of the Move limiter::TransferRecord type.", "type": "object", "required": [ "hour_head", "hour_tail", "per_hour_amounts", "total_amount" ], "properties": { "hour_head": { "type": "integer", "format": "uint64", "minimum": 0 }, "hour_tail": { "type": "integer", "format": "uint64", "minimum": 0 }, "per_hour_amounts": { "type": "array", "items": { "type": "integer", "format": "uint64", "minimum": 0 } }, "total_amount": { "type": "integer", "format": "uint64", "minimum": 0 } } }, "MoveTypeCommitteeMember": { "description": "Rust version of the Move committee::CommitteeMember type.", "type": "object", "required": [ "blocklisted", "bridgePubkeyBytes", "httpRestUrl", "suiAddress", "votingPower" ], "properties": { "blocklisted": { "type": "boolean" }, "bridgePubkeyBytes": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "httpRestUrl": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "suiAddress": { "$ref": "#/components/schemas/SuiAddress" }, "votingPower": { "type": "integer", "format": "uint64", "minimum": 0 } } }, "MoveTypeCommitteeMemberRegistration": { "description": "Rust version of the Move committee::CommitteeMemberRegistration type.", "type": "object", "required": [ "bridgePubkeyBytes", "httpRestUrl", "suiAddress" ], "properties": { "bridgePubkeyBytes": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "httpRestUrl": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "suiAddress": { "$ref": "#/components/schemas/SuiAddress" } } }, "MoveValue": { "anyOf": [ { "type": "integer", "format": "uint32", "minimum": 0 }, { "type": "boolean" }, { "$ref": "#/components/schemas/SuiAddress" }, { "type": "array", "items": { "$ref": "#/components/schemas/MoveValue" } }, { "type": "string" }, { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/ObjectID" } } }, { "$ref": "#/components/schemas/MoveStruct" }, { "anyOf": [ { "$ref": "#/components/schemas/MoveValue" }, { "type": "null" } ] }, { "$ref": "#/components/schemas/MoveVariant" } ] }, "MoveVariant": { "type": "object", "required": [ "fields", "type", "variant" ], "properties": { "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MoveValue" } }, "type": { "type": "string" }, "variant": { "type": "string" } } }, "MultiSig": { "description": "The struct that contains signatures and public keys necessary for authenticating a MultiSig.", "type": "object", "required": [ "bitmap", "multisig_pk", "sigs" ], "properties": { "bitmap": { "description": "A bitmap that indicates the position of which public key the signature should be authenticated with.", "type": "integer", "format": "uint16", "minimum": 0 }, "multisig_pk": { "description": "The public key encoded with each public key with its signature scheme used along with the corresponding weight.", "allOf": [ { "$ref": "#/components/schemas/MultiSigPublicKey" } ] }, "sigs": { "description": "The plain signature encoded with signature scheme.", "type": "array", "items": { "$ref": "#/components/schemas/CompressedSignature" } } } }, "MultiSigLegacy": { "description": "Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys necessary for authenticating a MultiSigLegacy.", "type": "object", "required": [ "bitmap", "multisig_pk", "sigs" ], "properties": { "bitmap": { "description": "A bitmap that indicates the position of which public key the signature should be authenticated with.", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] }, "multisig_pk": { "description": "The public key encoded with each public key with its signature scheme used along with the corresponding weight.", "allOf": [ { "$ref": "#/components/schemas/MultiSigPublicKeyLegacy" } ] }, "sigs": { "description": "The plain signature encoded with signature scheme.", "type": "array", "items": { "$ref": "#/components/schemas/CompressedSignature" } } } }, "MultiSigPublicKey": { "description": "The struct that contains the public key used for authenticating a MultiSig.", "type": "object", "required": [ "pk_map", "threshold" ], "properties": { "pk_map": { "description": "A list of public key and its corresponding weight.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/PublicKey" }, { "type": "integer", "format": "uint8", "minimum": 0 } ], "maxItems": 2, "minItems": 2 } }, "threshold": { "description": "If the total weight of the public keys corresponding to verified signatures is larger than threshold, the MultiSig is verified.", "type": "integer", "format": "uint16", "minimum": 0 } } }, "MultiSigPublicKeyLegacy": { "description": "Deprecated, use [struct MultiSigPublicKey] instead. The struct that contains the public key used for authenticating a MultiSig.", "type": "object", "required": [ "pk_map", "threshold" ], "properties": { "pk_map": { "description": "A list of public key and its corresponding weight.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/PublicKey" }, { "type": "integer", "format": "uint8", "minimum": 0 } ], "maxItems": 2, "minItems": 2 } }, "threshold": { "description": "If the total weight of the public keys corresponding to verified signatures is larger than threshold, the MultiSig is verified.", "type": "integer", "format": "uint16", "minimum": 0 } } }, "ObjectChange": { "description": "ObjectChange are derived from the object mutations in the TransactionEffect to provide richer object information.", "oneOf": [ { "description": "Module published", "type": "object", "required": [ "digest", "modules", "packageId", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "modules": { "type": "array", "items": { "type": "string" } }, "packageId": { "$ref": "#/components/schemas/ObjectID" }, "type": { "type": "string", "enum": [ "published" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "Transfer objects to new address / wrap in another object", "type": "object", "required": [ "digest", "objectId", "objectType", "recipient", "sender", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "recipient": { "$ref": "#/components/schemas/Owner" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "transferred" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "Object mutated.", "type": "object", "required": [ "digest", "objectId", "objectType", "owner", "previousVersion", "sender", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "owner": { "$ref": "#/components/schemas/Owner" }, "previousVersion": { "$ref": "#/components/schemas/SequenceNumber" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "mutated" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "Delete object", "type": "object", "required": [ "objectId", "objectType", "sender", "type", "version" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "deleted" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "Wrapped object", "type": "object", "required": [ "objectId", "objectType", "sender", "type", "version" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "wrapped" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "description": "New object creation", "type": "object", "required": [ "digest", "objectId", "objectType", "owner", "sender", "type", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string" }, "owner": { "$ref": "#/components/schemas/Owner" }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "type": { "type": "string", "enum": [ "created" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } ] }, "ObjectData": { "type": "object", "required": [ "digest", "objectId", "version" ], "properties": { "bcs": { "description": "Move object content or package content in BCS, default to be None unless SuiObjectDataOptions.showBcs is set to true", "anyOf": [ { "$ref": "#/components/schemas/RawData" }, { "type": "null" } ] }, "content": { "description": "Move object content or package content, default to be None unless SuiObjectDataOptions.showContent is set to true", "anyOf": [ { "$ref": "#/components/schemas/Data" }, { "type": "null" } ] }, "digest": { "description": "Base64 string representing the object digest", "allOf": [ { "$ref": "#/components/schemas/ObjectDigest" } ] }, "display": { "description": "The Display metadata for frontend UI rendering, default to be None unless SuiObjectDataOptions.showContent is set to true This can also be None if the struct type does not have Display defined See more details in ", "anyOf": [ { "$ref": "#/components/schemas/DisplayFieldsResponse" }, { "type": "null" } ] }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "owner": { "description": "The owner of this object. Default to be None unless SuiObjectDataOptions.showOwner is set to true", "anyOf": [ { "$ref": "#/components/schemas/Owner" }, { "type": "null" } ] }, "previousTransaction": { "description": "The digest of the transaction that created or last mutated this object. Default to be None unless SuiObjectDataOptions.showPreviousTransaction is set to true", "anyOf": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "null" } ] }, "storageRebate": { "description": "The amount of SUI we would rebate if this object gets deleted. This number is re-calculated each time the object is mutated based on the present storage gas price.", "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "type": { "description": "The type of the object. Default to be None unless SuiObjectDataOptions.showType is set to true", "type": [ "string", "null" ] }, "version": { "description": "Object version.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber" } ] } } }, "ObjectDataOptions": { "type": "object", "properties": { "showBcs": { "description": "Whether to show the content in BCS format. Default to be False", "default": false, "type": "boolean" }, "showContent": { "description": "Whether to show the content(i.e., package content or Move struct content) of the object. Default to be False", "default": false, "type": "boolean" }, "showDisplay": { "description": "Whether to show the Display metadata of the object for frontend rendering. Default to be False", "default": false, "type": "boolean" }, "showOwner": { "description": "Whether to show the owner of the object. Default to be False", "default": false, "type": "boolean" }, "showPreviousTransaction": { "description": "Whether to show the previous transaction digest of the object. Default to be False", "default": false, "type": "boolean" }, "showStorageRebate": { "description": "Whether to show the storage rebate of the object. Default to be False", "default": false, "type": "boolean" }, "showType": { "description": "Whether to show the type of the object. Default to be False", "default": false, "type": "boolean" } } }, "ObjectDigest": { "$ref": "#/components/schemas/Digest" }, "ObjectID": { "$ref": "#/components/schemas/Hex" }, "ObjectPermissions": { "description": "A bitflag set of `ObjectPermission`s.", "type": "integer", "format": "uint64", "minimum": 0 }, "ObjectRead": { "oneOf": [ { "description": "The object exists and is found with this version", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/ObjectData" }, "status": { "type": "string", "enum": [ "VersionFound" ] } } }, { "description": "The object does not exist", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/ObjectID" }, "status": { "type": "string", "enum": [ "ObjectNotExists" ] } } }, { "description": "The object is found to be deleted with this version", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "$ref": "#/components/schemas/ObjectRef" }, "status": { "type": "string", "enum": [ "ObjectDeleted" ] } } }, { "description": "The object exists but not found with this version", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "type": "array", "items": [ { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SequenceNumber2" } ], "maxItems": 2, "minItems": 2 }, "status": { "type": "string", "enum": [ "VersionNotFound" ] } } }, { "description": "The asked object version is higher than the latest", "type": "object", "required": [ "details", "status" ], "properties": { "details": { "type": "object", "required": [ "asked_version", "latest_version", "object_id" ], "properties": { "asked_version": { "$ref": "#/components/schemas/SequenceNumber2" }, "latest_version": { "$ref": "#/components/schemas/SequenceNumber2" }, "object_id": { "$ref": "#/components/schemas/ObjectID" } } }, "status": { "type": "string", "enum": [ "VersionTooHigh" ] } } } ] }, "ObjectRef": { "type": "object", "required": [ "digest", "objectId", "version" ], "properties": { "digest": { "description": "Base64 string representing the object digest", "allOf": [ { "$ref": "#/components/schemas/ObjectDigest" } ] }, "objectId": { "description": "Hex code as string representing the object id", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "version": { "description": "Object version.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber" } ] } } }, "ObjectResponseError": { "oneOf": [ { "type": "object", "required": [ "code", "object_id" ], "properties": { "code": { "type": "string", "enum": [ "notExists" ] }, "object_id": { "$ref": "#/components/schemas/ObjectID" } } }, { "type": "object", "required": [ "code", "parent_object_id" ], "properties": { "code": { "type": "string", "enum": [ "dynamicFieldNotFound" ] }, "parent_object_id": { "$ref": "#/components/schemas/ObjectID" } } }, { "type": "object", "required": [ "code", "digest", "object_id", "version" ], "properties": { "code": { "type": "string", "enum": [ "deleted" ] }, "digest": { "description": "Base64 string representing the object digest", "allOf": [ { "$ref": "#/components/schemas/ObjectDigest" } ] }, "object_id": { "$ref": "#/components/schemas/ObjectID" }, "version": { "description": "Object version.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } }, { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "unknown" ] } } }, { "type": "object", "required": [ "code", "error" ], "properties": { "code": { "type": "string", "enum": [ "displayError" ] }, "error": { "type": "string" } } } ] }, "ObjectResponseQuery": { "type": "object", "properties": { "filter": { "description": "If None, no filter will be applied", "default": null, "anyOf": [ { "$ref": "#/components/schemas/SuiObjectDataFilter" }, { "type": "null" } ] }, "options": { "description": "config which fields to include in the response, by default only digest is included", "default": null, "anyOf": [ { "$ref": "#/components/schemas/ObjectDataOptions" }, { "type": "null" } ] } } }, "ObjectValueKind": { "type": "string", "enum": [ "ByImmutableReference", "ByMutableReference", "ByValue" ] }, "OwnedObjectRef": { "type": "object", "required": [ "owner", "reference" ], "properties": { "owner": { "$ref": "#/components/schemas/Owner" }, "reference": { "$ref": "#/components/schemas/ObjectRef" } } }, "Owner": { "oneOf": [ { "description": "Object is exclusively owned by a single address, and is mutable.", "type": "object", "required": [ "AddressOwner" ], "properties": { "AddressOwner": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Object is exclusively owned by a single object, and is mutable. The object ID is converted to SuiAddress as SuiAddress is universal.", "type": "object", "required": [ "ObjectOwner" ], "properties": { "ObjectOwner": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Object is shared, can be used by any address, and is mutable.", "type": "object", "required": [ "Shared" ], "properties": { "Shared": { "type": "object", "required": [ "initial_shared_version" ], "properties": { "initial_shared_version": { "description": "The version at which the object became shared", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } } }, "additionalProperties": false }, { "description": "Object is immutable, and hence ownership doesn't matter.", "type": "string", "enum": [ "Immutable" ] }, { "description": "Object is exclusively owned by a single address and sequenced via consensus.", "type": "object", "required": [ "ConsensusAddressOwner" ], "properties": { "ConsensusAddressOwner": { "type": "object", "required": [ "owner", "start_version" ], "properties": { "owner": { "$ref": "#/components/schemas/SuiAddress" }, "start_version": { "description": "The version at which the object most recently became a consensus object. This serves the same function as `initial_shared_version`, except it may change if the object's Owner type changes.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } } }, "additionalProperties": false }, { "description": "Object is sequenced via consensus with per-address permissions. Each address can be granted a subset of [`ObjectPermission`] flags. Addresses not explicitly listed fall back to the default permissions.", "type": "object", "required": [ "Party" ], "properties": { "Party": { "type": "object", "required": [ "permissions", "start_version" ], "properties": { "permissions": { "description": "The permission map for this object.", "allOf": [ { "$ref": "#/components/schemas/Party" } ] }, "start_version": { "description": "The version at which the object most recently became a party object. Serves the same function as `initial_shared_version`, except it may change if the object's Owner type changes.", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } } }, "additionalProperties": false } ] }, "Page_for_Checkpoint_and_BigInt_for_uint64": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Checkpoint" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, "Page_for_Coin_and_String": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Coin" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] } } }, "Page_for_DynamicFieldInfo_and_ObjectID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicFieldInfo" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] } } }, "Page_for_EpochInfo_and_BigInt_for_uint64": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EpochInfo" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, "Page_for_Event_and_EventID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/EventID" }, { "type": "null" } ] } } }, "Page_for_String_and_ObjectID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "type": "string" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] } } }, "Page_for_SuiObjectResponse_and_CheckpointedObjectID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectResponse" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/CheckpointedObjectID" }, { "type": "null" } ] } } }, "Page_for_SuiObjectResponse_and_ObjectID": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectResponse" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] } } }, "Page_for_TransactionBlockResponse_and_TransactionDigest": { "description": "`next_cursor` points to the last item in the page; Reading with `next_cursor` will start from the next item after `next_cursor` if `next_cursor` is `Some`, otherwise it will start from the first item.", "type": "object", "required": [ "data", "hasNextPage" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionBlockResponse" } }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "anyOf": [ { "$ref": "#/components/schemas/TransactionDigest" }, { "type": "null" } ] } } }, "Party": { "description": "Per-address permission map for a party-owned object. Addresses not in `members` receive `default_permissions`.", "type": "object", "required": [ "default_permissions", "members" ], "properties": { "default_permissions": { "description": "The default permissions, used for any party member not explicitly listed in `members`.", "allOf": [ { "$ref": "#/components/schemas/ObjectPermissions" } ] }, "members": { "description": "The permissions for each party member.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ObjectPermissions" } } } }, "PasskeyAuthenticator": { "description": "An passkey authenticator with parsed fields. See field defition below. Can be initialized from [struct RawPasskeyAuthenticator].", "type": "object", "required": [ "authenticator_data", "client_data_json" ], "properties": { "authenticator_data": { "description": "`authenticatorData` is a bytearray that encodes [Authenticator Data](https://www.w3.org/TR/webauthn-2/#sctn-authenticator-data) structure returned by the authenticator attestation response as is.", "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "client_data_json": { "description": "`clientDataJSON` contains a JSON-compatible UTF-8 encoded string of the client data which is passed to the authenticator by the client during the authentication request (see [CollectedClientData](https://www.w3.org/TR/webauthn-2/#dictdef-collectedclientdata))", "type": "string" } } }, "PasskeyAuthenticatorAsBytes": { "$ref": "#/components/schemas/Base64" }, "ProtocolConfig": { "type": "object", "required": [ "attributes", "featureFlags", "maxSupportedProtocolVersion", "minSupportedProtocolVersion", "protocolVersion" ], "properties": { "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/ProtocolConfigValue" }, { "type": "null" } ] } }, "configs": { "description": "Lossless view of every protocol-config attribute and feature flag, rendered to JSON. Unlike `attributes`, this includes non-scalar fields (e.g. lists) and is the preferred surface for clients that need to read complex values.", "default": {}, "type": "object", "additionalProperties": true }, "featureFlags": { "type": "object", "additionalProperties": { "type": "boolean" } }, "maxSupportedProtocolVersion": { "$ref": "#/components/schemas/ProtocolVersion" }, "minSupportedProtocolVersion": { "$ref": "#/components/schemas/ProtocolVersion" }, "protocolVersion": { "$ref": "#/components/schemas/ProtocolVersion" } } }, "ProtocolConfigValue": { "oneOf": [ { "type": "object", "required": [ "u16" ], "properties": { "u16": { "$ref": "#/components/schemas/BigInt_for_uint16" } }, "additionalProperties": false }, { "type": "object", "required": [ "u32" ], "properties": { "u32": { "$ref": "#/components/schemas/BigInt_for_uint32" } }, "additionalProperties": false }, { "type": "object", "required": [ "u64" ], "properties": { "u64": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "additionalProperties": false }, { "type": "object", "required": [ "f64" ], "properties": { "f64": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "bool" ], "properties": { "bool": { "type": "string" } }, "additionalProperties": false } ] }, "ProtocolVersion": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "PublicKey": { "oneOf": [ { "type": "object", "required": [ "Ed25519" ], "properties": { "Ed25519": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256k1" ], "properties": { "Secp256k1": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "Secp256r1" ], "properties": { "Secp256r1": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false }, { "type": "object", "required": [ "ZkLogin" ], "properties": { "ZkLogin": { "$ref": "#/components/schemas/ZkLoginPublicIdentifier" } }, "additionalProperties": false }, { "type": "object", "required": [ "Passkey" ], "properties": { "Passkey": { "$ref": "#/components/schemas/Base64" } }, "additionalProperties": false } ] }, "RPCTransactionRequestParams": { "oneOf": [ { "type": "object", "required": [ "transferObjectRequestParams" ], "properties": { "transferObjectRequestParams": { "$ref": "#/components/schemas/TransferObjectParams" } }, "additionalProperties": false }, { "type": "object", "required": [ "moveCallRequestParams" ], "properties": { "moveCallRequestParams": { "$ref": "#/components/schemas/MoveCallParams" } }, "additionalProperties": false } ] }, "RawData": { "oneOf": [ { "type": "object", "required": [ "bcsBytes", "dataType", "hasPublicTransfer", "type", "version" ], "properties": { "bcsBytes": { "$ref": "#/components/schemas/Base64" }, "dataType": { "type": "string", "enum": [ "moveObject" ] }, "hasPublicTransfer": { "type": "boolean" }, "type": { "type": "string" }, "version": { "$ref": "#/components/schemas/SequenceNumber2" } } }, { "type": "object", "required": [ "dataType", "id", "linkageTable", "moduleMap", "typeOriginTable", "version" ], "properties": { "dataType": { "type": "string", "enum": [ "package" ] }, "id": { "$ref": "#/components/schemas/ObjectID" }, "linkageTable": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UpgradeInfo" } }, "moduleMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Base64" } }, "typeOriginTable": { "type": "array", "items": { "$ref": "#/components/schemas/TypeOrigin" } }, "version": { "$ref": "#/components/schemas/SequenceNumber2" } } } ] }, "Secp256k1SuiSignature": { "$ref": "#/components/schemas/Base64" }, "Secp256r1SuiSignature": { "$ref": "#/components/schemas/Base64" }, "SequenceNumber": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "SequenceNumber2": { "type": "integer", "format": "uint64", "minimum": 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 } ] }, "Stake": { "type": "object", "oneOf": [ { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Pending" ] } } }, { "type": "object", "required": [ "estimatedReward", "status" ], "properties": { "estimatedReward": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "status": { "type": "string", "enum": [ "Active" ] } } }, { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "Unstaked" ] } } } ], "required": [ "principal", "stakeActiveEpoch", "stakeRequestEpoch", "stakedSuiId" ], "properties": { "principal": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "stakeActiveEpoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "stakeRequestEpoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "stakedSuiId": { "description": "ID of the StakedSui receipt object.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] } } }, "SuiActiveJwk": { "type": "object", "required": [ "epoch", "jwk", "jwk_id" ], "properties": { "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "jwk": { "$ref": "#/components/schemas/SuiJWK" }, "jwk_id": { "$ref": "#/components/schemas/SuiJwkId" } } }, "SuiAddress": { "$ref": "#/components/schemas/Hex" }, "SuiArgument": { "description": "An argument to a transaction in a programmable transaction block", "oneOf": [ { "description": "The gas coin. The gas coin can only be used by-ref, except for with `TransferObjects`, which can use it by-value.", "type": "string", "enum": [ "GasCoin" ] }, { "description": "One of the input objects or primitive values (from `ProgrammableTransactionBlock` inputs)", "type": "object", "required": [ "Input" ], "properties": { "Input": { "type": "integer", "format": "uint16", "minimum": 0 } }, "additionalProperties": false }, { "description": "The result of another transaction (from `ProgrammableTransactionBlock` transactions)", "type": "object", "required": [ "Result" ], "properties": { "Result": { "type": "integer", "format": "uint16", "minimum": 0 } }, "additionalProperties": false }, { "description": "Like a `Result` but it accesses a nested result. Currently, the only usage of this is to access a value from a Move call with multiple return values.", "type": "object", "required": [ "NestedResult" ], "properties": { "NestedResult": { "type": "array", "items": [ { "type": "integer", "format": "uint16", "minimum": 0 }, { "type": "integer", "format": "uint16", "minimum": 0 } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false } ] }, "SuiAuthenticatorStateExpire": { "type": "object", "required": [ "min_epoch" ], "properties": { "min_epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "SuiCallArg": { "oneOf": [ { "type": "object", "oneOf": [ { "type": "object", "required": [ "digest", "objectId", "objectType", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string", "enum": [ "immOrOwnedObject" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } }, { "type": "object", "required": [ "initialSharedVersion", "mutable", "objectId", "objectType" ], "properties": { "initialSharedVersion": { "$ref": "#/components/schemas/SequenceNumber" }, "mutable": { "type": "boolean" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string", "enum": [ "sharedObject" ] } } }, { "type": "object", "required": [ "digest", "objectId", "objectType", "version" ], "properties": { "digest": { "$ref": "#/components/schemas/ObjectDigest" }, "objectId": { "$ref": "#/components/schemas/ObjectID" }, "objectType": { "type": "string", "enum": [ "receiving" ] }, "version": { "$ref": "#/components/schemas/SequenceNumber" } } } ], "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "object" ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "pure" ] }, "value": { "$ref": "#/components/schemas/SuiJsonValue" }, "valueType": { "default": null, "type": [ "string", "null" ] } } }, { "type": "object", "required": [ "reservation", "type", "typeArg", "withdrawFrom" ], "properties": { "reservation": { "$ref": "#/components/schemas/SuiReservation" }, "type": { "type": "string", "enum": [ "fundsWithdrawal" ] }, "typeArg": { "$ref": "#/components/schemas/SuiWithdrawalTypeArg" }, "withdrawFrom": { "$ref": "#/components/schemas/SuiWithdrawFrom" } } } ] }, "SuiChangeEpoch": { "type": "object", "required": [ "computation_charge", "epoch", "epoch_start_timestamp_ms", "storage_charge", "storage_rebate" ], "properties": { "computation_charge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch_start_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storage_charge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storage_rebate": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "SuiCoinMetadata": { "type": "object", "required": [ "decimals", "description", "name", "symbol" ], "properties": { "decimals": { "description": "Number of decimal places the coin uses.", "type": "integer", "format": "uint8", "minimum": 0 }, "description": { "description": "Description of the token", "type": "string" }, "iconUrl": { "description": "URL for the token logo", "type": [ "string", "null" ] }, "id": { "description": "Object id for the CoinMetadata object", "anyOf": [ { "$ref": "#/components/schemas/ObjectID" }, { "type": "null" } ] }, "name": { "description": "Name for the token", "type": "string" }, "symbol": { "description": "Symbol for the token", "type": "string" } } }, "SuiEndOfEpochTransactionKind": { "oneOf": [ { "type": "string", "enum": [ "AuthenticatorStateCreate", "RandomnessStateCreate", "CoinDenyListStateCreate", "StoreExecutionTimeObservations", "AccumulatorRootCreate", "CoinRegistryCreate", "DisplayRegistryCreate", "AddressAliasStateCreate", "WriteAccumulatorStorageCost", "ForwardingAddressRegistryCreate" ] }, { "type": "object", "required": [ "ChangeEpoch" ], "properties": { "ChangeEpoch": { "$ref": "#/components/schemas/SuiChangeEpoch" } }, "additionalProperties": false }, { "type": "object", "required": [ "AuthenticatorStateExpire" ], "properties": { "AuthenticatorStateExpire": { "$ref": "#/components/schemas/SuiAuthenticatorStateExpire" } }, "additionalProperties": false }, { "type": "object", "required": [ "BridgeStateCreate" ], "properties": { "BridgeStateCreate": { "$ref": "#/components/schemas/CheckpointDigest" } }, "additionalProperties": false }, { "type": "object", "required": [ "BridgeCommitteeUpdate" ], "properties": { "BridgeCommitteeUpdate": { "$ref": "#/components/schemas/SequenceNumber2" } }, "additionalProperties": false } ] }, "SuiExecutionResult": { "type": "object", "properties": { "mutableReferenceOutputs": { "description": "The value of any arguments that were mutably borrowed. Non-mut borrowed values are not included", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiArgument" }, { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, { "$ref": "#/components/schemas/TypeTag" } ], "maxItems": 3, "minItems": 3 } }, "returnValues": { "description": "The return values from the transaction", "type": "array", "items": { "type": "array", "items": [ { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, { "$ref": "#/components/schemas/TypeTag" } ], "maxItems": 2, "minItems": 2 } } } }, "SuiJWK": { "type": "object", "required": [ "alg", "e", "kty", "n" ], "properties": { "alg": { "type": "string" }, "e": { "type": "string" }, "kty": { "type": "string" }, "n": { "type": "string" } } }, "SuiJsonValue": {}, "SuiJwkId": { "type": "object", "required": [ "iss", "kid" ], "properties": { "iss": { "type": "string" }, "kid": { "type": "string" } } }, "SuiMoveAbility": { "type": "string", "enum": [ "Copy", "Drop", "Store", "Key" ] }, "SuiMoveAbilitySet": { "type": "object", "required": [ "abilities" ], "properties": { "abilities": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveAbility" } } } }, "SuiMoveAbort": { "type": "object", "properties": { "error_code": { "type": [ "integer", "null" ], "format": "uint64", "minimum": 0 }, "function": { "type": [ "string", "null" ] }, "line": { "type": [ "integer", "null" ], "format": "uint16", "minimum": 0 }, "module_id": { "type": [ "string", "null" ] } } }, "SuiMoveModuleId": { "type": "object", "required": [ "address", "name" ], "properties": { "address": { "type": "string" }, "name": { "type": "string" } } }, "SuiMoveNormalizedEnum": { "type": "object", "required": [ "abilities", "typeParameters", "variants" ], "properties": { "abilities": { "$ref": "#/components/schemas/SuiMoveAbilitySet" }, "typeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveStructTypeParameter" } }, "variantDeclarationOrder": { "default": null, "type": [ "array", "null" ], "items": { "type": "string" } }, "variants": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedField" } } } } }, "SuiMoveNormalizedField": { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } } }, "SuiMoveNormalizedFunction": { "type": "object", "required": [ "isEntry", "parameters", "return", "typeParameters", "visibility" ], "properties": { "isEntry": { "type": "boolean" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "return": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "typeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveAbilitySet" } }, "visibility": { "$ref": "#/components/schemas/SuiMoveVisibility" } } }, "SuiMoveNormalizedModule": { "type": "object", "required": [ "address", "exposedFunctions", "fileFormatVersion", "friends", "name", "structs" ], "properties": { "address": { "type": "string" }, "enums": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedEnum" } }, "exposedFunctions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedFunction" } }, "fileFormatVersion": { "type": "integer", "format": "uint32", "minimum": 0 }, "friends": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveModuleId" } }, "name": { "type": "string" }, "structs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SuiMoveNormalizedStruct" } } } }, "SuiMoveNormalizedStruct": { "type": "object", "required": [ "abilities", "fields", "typeParameters" ], "properties": { "abilities": { "$ref": "#/components/schemas/SuiMoveAbilitySet" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedField" } }, "typeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveStructTypeParameter" } } } }, "SuiMoveNormalizedType": { "oneOf": [ { "type": "string", "enum": [ "Bool", "U8", "U16", "U32", "U64", "U128", "U256", "Address", "Signer" ] }, { "type": "object", "required": [ "Struct" ], "properties": { "Struct": { "type": "object", "required": [ "address", "module", "name", "typeArguments" ], "properties": { "address": { "type": "string" }, "module": { "type": "string" }, "name": { "type": "string" }, "typeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } } } } }, "additionalProperties": false }, { "type": "object", "required": [ "Vector" ], "properties": { "Vector": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "additionalProperties": false }, { "type": "object", "required": [ "TypeParameter" ], "properties": { "TypeParameter": { "type": "integer", "format": "uint16", "minimum": 0 } }, "additionalProperties": false }, { "type": "object", "required": [ "Reference" ], "properties": { "Reference": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "additionalProperties": false }, { "type": "object", "required": [ "MutableReference" ], "properties": { "MutableReference": { "$ref": "#/components/schemas/SuiMoveNormalizedType" } }, "additionalProperties": false } ] }, "SuiMoveStructTypeParameter": { "type": "object", "required": [ "constraints", "isPhantom" ], "properties": { "constraints": { "$ref": "#/components/schemas/SuiMoveAbilitySet" }, "isPhantom": { "type": "boolean" } } }, "SuiMoveVisibility": { "type": "string", "enum": [ "Private", "Public", "Friend" ] }, "SuiObjectDataFilter": { "oneOf": [ { "type": "object", "required": [ "MatchAll" ], "properties": { "MatchAll": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectDataFilter" } } }, "additionalProperties": false }, { "type": "object", "required": [ "MatchAny" ], "properties": { "MatchAny": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectDataFilter" } } }, "additionalProperties": false }, { "type": "object", "required": [ "MatchNone" ], "properties": { "MatchNone": { "type": "array", "items": { "$ref": "#/components/schemas/SuiObjectDataFilter" } } }, "additionalProperties": false }, { "description": "Query by type a specified Package.", "type": "object", "required": [ "Package" ], "properties": { "Package": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "description": "Query by type a specified Move module.", "type": "object", "required": [ "MoveModule" ], "properties": { "MoveModule": { "type": "object", "required": [ "module", "package" ], "properties": { "module": { "description": "the module name", "type": "string" }, "package": { "description": "the Move package ID", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] } } } }, "additionalProperties": false }, { "description": "Query by type", "type": "object", "required": [ "StructType" ], "properties": { "StructType": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "AddressOwner" ], "properties": { "AddressOwner": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "type": "object", "required": [ "ObjectOwner" ], "properties": { "ObjectOwner": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "type": "object", "required": [ "ObjectId" ], "properties": { "ObjectId": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "type": "object", "required": [ "ObjectIds" ], "properties": { "ObjectIds": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, "additionalProperties": false }, { "type": "object", "required": [ "Version" ], "properties": { "Version": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "additionalProperties": false } ] }, "SuiObjectResponse": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/ObjectData" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/components/schemas/ObjectResponseError" }, { "type": "null" } ] } } }, "SuiProgrammableMoveCall": { "description": "The transaction for calling a Move function, either an entry function or a public function (which cannot return references).", "type": "object", "required": [ "function", "module", "package" ], "properties": { "arguments": { "description": "The arguments to the function.", "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } }, "function": { "description": "The function to be called.", "type": "string" }, "module": { "description": "The specific module in the package containing the function.", "type": "string" }, "package": { "description": "The package containing the module and function.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "type_arguments": { "description": "The type arguments to the function.", "type": "array", "items": { "type": "string" } } } }, "SuiReservation": { "oneOf": [ { "type": "object", "required": [ "maxAmountU64" ], "properties": { "maxAmountU64": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "additionalProperties": false } ] }, "SuiSystemStateSummary": { "description": "This is the JSON-RPC type for the SUI system state object. It flattens all fields to make them top-level fields such that it as minimum dependencies to the internal data structures of the SUI system state type.", "type": "object", "required": [ "activeValidators", "atRiskValidators", "epoch", "epochDurationMs", "epochStartTimestampMs", "inactivePoolsId", "inactivePoolsSize", "maxValidatorCount", "minValidatorJoiningStake", "pendingActiveValidatorsId", "pendingActiveValidatorsSize", "pendingRemovals", "protocolVersion", "referenceGasPrice", "safeMode", "safeModeComputationRewards", "safeModeNonRefundableStorageFee", "safeModeStorageRebates", "safeModeStorageRewards", "stakeSubsidyBalance", "stakeSubsidyCurrentDistributionAmount", "stakeSubsidyDecreaseRate", "stakeSubsidyDistributionCounter", "stakeSubsidyPeriodLength", "stakeSubsidyStartEpoch", "stakingPoolMappingsId", "stakingPoolMappingsSize", "storageFundNonRefundableBalance", "storageFundTotalObjectStorageRebates", "systemStateVersion", "totalStake", "validatorCandidatesId", "validatorCandidatesSize", "validatorLowStakeGracePeriod", "validatorLowStakeThreshold", "validatorReportRecords", "validatorVeryLowStakeThreshold" ], "properties": { "activeValidators": { "description": "The list of active validators in the current epoch.", "type": "array", "items": { "$ref": "#/components/schemas/SuiValidatorSummary" } }, "atRiskValidators": { "description": "Map storing the number of epochs for which each validator has been below the low stake threshold.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiAddress" }, { "$ref": "#/components/schemas/BigInt_for_uint64" } ], "maxItems": 2, "minItems": 2 } }, "epoch": { "description": "The current epoch ID, starting from 0.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "epochDurationMs": { "description": "The duration of an epoch, in milliseconds.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "epochStartTimestampMs": { "description": "Unix timestamp of the current epoch start", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "inactivePoolsId": { "description": "ID of the object that maps from a staking pool ID to the inactive validator that has that pool as its staking pool.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "inactivePoolsSize": { "description": "Number of inactive staking pools.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "maxValidatorCount": { "description": "Maximum number of active validators at any moment. We do not allow the number of validators in any epoch to go above this.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "minValidatorJoiningStake": { "description": "Lower-bound on the amount of stake required to become a validator.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "pendingActiveValidatorsId": { "description": "ID of the object that contains the list of new validators that will join at the end of the epoch.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "pendingActiveValidatorsSize": { "description": "Number of new validators that will join at the end of the epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "pendingRemovals": { "description": "Removal requests from the validators. Each element is an index pointing to `active_validators`.", "type": "array", "items": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "protocolVersion": { "description": "The current protocol version, starting from 1.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "referenceGasPrice": { "description": "The reference gas price for the current epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "safeMode": { "description": "Whether the system is running in a downgraded safe mode due to a non-recoverable bug. This is set whenever we failed to execute advance_epoch, and ended up executing advance_epoch_safe_mode. It can be reset once we are able to successfully execute advance_epoch.", "type": "boolean" }, "safeModeComputationRewards": { "description": "Amount of computation rewards accumulated (and not yet distributed) during safe mode.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "safeModeNonRefundableStorageFee": { "description": "Amount of non-refundable storage fee accumulated during safe mode.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "safeModeStorageRebates": { "description": "Amount of storage rebates accumulated (and not yet burned) during safe mode.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "safeModeStorageRewards": { "description": "Amount of storage rewards accumulated (and not yet distributed) during safe mode.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyBalance": { "description": "Balance of SUI set aside for stake subsidies that will be drawn down over time.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyCurrentDistributionAmount": { "description": "The amount of stake subsidy to be drawn down per epoch. This amount decays and decreases over time.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyDecreaseRate": { "description": "The rate at which the distribution amount decays at the end of each period. Expressed in basis points.", "type": "integer", "format": "uint16", "minimum": 0 }, "stakeSubsidyDistributionCounter": { "description": "This counter may be different from the current epoch number if in some epochs we decide to skip the subsidy.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyPeriodLength": { "description": "Number of distributions to occur before the distribution amount decays.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakeSubsidyStartEpoch": { "description": "The starting epoch in which stake subsidies start being paid out", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakingPoolMappingsId": { "description": "ID of the object that maps from staking pool's ID to the sui address of a validator.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "stakingPoolMappingsSize": { "description": "Number of staking pool mappings.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "storageFundNonRefundableBalance": { "description": "The non-refundable portion of the storage fund coming from storage reinvestment, non-refundable storage rebates and any leftover staking rewards.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "storageFundTotalObjectStorageRebates": { "description": "The storage rebates of all the objects on-chain stored in the storage fund.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "systemStateVersion": { "description": "The current version of the system state data structure type.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "totalStake": { "description": "Total amount of stake from all active validators at the beginning of the epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "validatorCandidatesId": { "description": "ID of the object that stores preactive validators, mapping their addresses to their `Validator` structs.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "validatorCandidatesSize": { "description": "Number of preactive validators.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "validatorLowStakeGracePeriod": { "description": "A validator can have stake below `validator_low_stake_threshold` for this many epochs before being kicked out.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "validatorLowStakeThreshold": { "description": "Validators with stake amount below `validator_low_stake_threshold` are considered to have low stake and will be escorted out of the validator set after being below this threshold for more than `validator_low_stake_grace_period` number of epochs.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "validatorReportRecords": { "description": "A map storing the records of validator reporting each other.", "type": "array", "items": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiAddress" }, { "type": "array", "items": { "$ref": "#/components/schemas/SuiAddress" } } ], "maxItems": 2, "minItems": 2 } }, "validatorVeryLowStakeThreshold": { "description": "Validators with stake below `validator_very_low_stake_threshold` will be removed immediately at epoch change, no grace period.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] } } }, "SuiTransaction": { "description": "A single transaction in a programmable transaction block.", "oneOf": [ { "description": "A call to either an entry or a public Move function", "type": "object", "required": [ "MoveCall" ], "properties": { "MoveCall": { "$ref": "#/components/schemas/SuiProgrammableMoveCall" } }, "additionalProperties": false }, { "description": "`(Vec, address)` It sends n-objects to the specified address. These objects must have store (public transfer) and either the previous owner must be an address or the object must be newly created.", "type": "object", "required": [ "TransferObjects" ], "properties": { "TransferObjects": { "type": "array", "items": [ { "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } }, { "$ref": "#/components/schemas/SuiArgument" } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "description": "`(&mut Coin, Vec)` -> `Vec>` It splits off some amounts into a new coins with those amounts", "type": "object", "required": [ "SplitCoins" ], "properties": { "SplitCoins": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiArgument" }, { "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "description": "`(&mut Coin, Vec>)` It merges n-coins into the first coin", "type": "object", "required": [ "MergeCoins" ], "properties": { "MergeCoins": { "type": "array", "items": [ { "$ref": "#/components/schemas/SuiArgument" }, { "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false }, { "description": "Publishes a Move package. It takes the package bytes and a list of the package's transitive dependencies to link against on-chain.", "type": "object", "required": [ "Publish" ], "properties": { "Publish": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } }, "additionalProperties": false }, { "description": "Upgrades a Move package", "type": "object", "required": [ "Upgrade" ], "properties": { "Upgrade": { "type": "array", "items": [ { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } }, { "$ref": "#/components/schemas/ObjectID" }, { "$ref": "#/components/schemas/SuiArgument" } ], "maxItems": 3, "minItems": 3 } }, "additionalProperties": false }, { "description": "`forall T: Vec -> vector` Given n-values of the same type, it constructs a vector. For non objects or an empty vector, the type tag must be specified.", "type": "object", "required": [ "MakeMoveVec" ], "properties": { "MakeMoveVec": { "type": "array", "items": [ { "type": [ "string", "null" ] }, { "type": "array", "items": { "$ref": "#/components/schemas/SuiArgument" } } ], "maxItems": 2, "minItems": 2 } }, "additionalProperties": false } ] }, "SuiTransactionBlockBuilderMode": { "oneOf": [ { "description": "Regular Sui Transactions that are committed on chain", "type": "string", "enum": [ "Commit" ] }, { "description": "Simulated transaction that allows calling any Move function with arbitrary values.", "type": "string", "enum": [ "DevInspect" ] } ] }, "SuiValidatorSummary": { "description": "This is the JSON-RPC type for the SUI validator. It flattens all inner structures to top-level fields so that they are decoupled from the internal definitions.", "type": "object", "required": [ "commissionRate", "description", "exchangeRatesId", "exchangeRatesSize", "gasPrice", "imageUrl", "name", "netAddress", "networkPubkeyBytes", "nextEpochCommissionRate", "nextEpochGasPrice", "nextEpochStake", "operationCapId", "p2pAddress", "pendingPoolTokenWithdraw", "pendingStake", "pendingTotalSuiWithdraw", "poolTokenBalance", "primaryAddress", "projectUrl", "proofOfPossessionBytes", "protocolPubkeyBytes", "rewardsPool", "stakingPoolId", "stakingPoolSuiBalance", "suiAddress", "votingPower", "workerAddress", "workerPubkeyBytes" ], "properties": { "commissionRate": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "description": { "type": "string" }, "exchangeRatesId": { "description": "ID of the exchange rate table object.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "exchangeRatesSize": { "description": "Number of exchange rates in the table.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "gasPrice": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "imageUrl": { "type": "string" }, "name": { "type": "string" }, "netAddress": { "type": "string" }, "networkPubkeyBytes": { "$ref": "#/components/schemas/Base64" }, "nextEpochCommissionRate": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "nextEpochGasPrice": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "nextEpochNetAddress": { "type": [ "string", "null" ] }, "nextEpochNetworkPubkeyBytes": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/Base64" }, { "type": "null" } ] }, "nextEpochP2pAddress": { "type": [ "string", "null" ] }, "nextEpochPrimaryAddress": { "type": [ "string", "null" ] }, "nextEpochProofOfPossession": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/Base64" }, { "type": "null" } ] }, "nextEpochProtocolPubkeyBytes": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/Base64" }, { "type": "null" } ] }, "nextEpochStake": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "nextEpochWorkerAddress": { "type": [ "string", "null" ] }, "nextEpochWorkerPubkeyBytes": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/Base64" }, { "type": "null" } ] }, "operationCapId": { "$ref": "#/components/schemas/ObjectID" }, "p2pAddress": { "type": "string" }, "pendingPoolTokenWithdraw": { "description": "Pending pool token withdrawn during the current epoch, emptied at epoch boundaries.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "pendingStake": { "description": "Pending stake amount for this epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "pendingTotalSuiWithdraw": { "description": "Pending stake withdrawn during the current epoch, emptied at epoch boundaries.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "poolTokenBalance": { "description": "Total number of pool tokens issued by the pool.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "primaryAddress": { "type": "string" }, "projectUrl": { "type": "string" }, "proofOfPossessionBytes": { "$ref": "#/components/schemas/Base64" }, "protocolPubkeyBytes": { "$ref": "#/components/schemas/Base64" }, "rewardsPool": { "description": "The epoch stake rewards will be added here at the end of each epoch.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "stakingPoolActivationEpoch": { "description": "The epoch at which this pool became active.", "default": null, "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "stakingPoolDeactivationEpoch": { "description": "The epoch at which this staking pool ceased to be active. `None` = {pre-active, active},", "default": null, "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "stakingPoolId": { "description": "ID of the staking pool object.", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "stakingPoolSuiBalance": { "description": "The total number of SUI tokens in this pool.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "suiAddress": { "$ref": "#/components/schemas/SuiAddress" }, "votingPower": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "workerAddress": { "type": "string" }, "workerPubkeyBytes": { "$ref": "#/components/schemas/Base64" } } }, "SuiWithdrawFrom": { "type": "string", "enum": [ "sender", "sponsor" ] }, "SuiWithdrawalTypeArg": { "oneOf": [ { "type": "object", "required": [ "balance" ], "properties": { "balance": { "$ref": "#/components/schemas/TypeTag" } }, "additionalProperties": false } ] }, "Supply": { "type": "object", "required": [ "value" ], "properties": { "value": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "TransactionBlock": { "type": "object", "required": [ "data", "txSignatures" ], "properties": { "data": { "$ref": "#/components/schemas/TransactionBlockData" }, "txSignatures": { "type": "array", "items": { "$ref": "#/components/schemas/GenericSignature" } } } }, "TransactionBlockBytes": { "type": "object", "required": [ "gas", "inputObjects", "txBytes" ], "properties": { "gas": { "description": "the gas objects to be used", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "inputObjects": { "description": "objects to be used in this transaction", "type": "array", "items": { "$ref": "#/components/schemas/InputObjectKind" } }, "txBytes": { "description": "BCS serialized transaction data bytes without its type tag, as base-64 encoded string.", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] } } }, "TransactionBlockData": { "oneOf": [ { "type": "object", "required": [ "gasData", "messageVersion", "sender", "transaction" ], "properties": { "gasData": { "$ref": "#/components/schemas/GasData" }, "messageVersion": { "type": "string", "enum": [ "v1" ] }, "sender": { "$ref": "#/components/schemas/SuiAddress" }, "transaction": { "$ref": "#/components/schemas/TransactionBlockKind" } } } ] }, "TransactionBlockEffects": { "oneOf": [ { "description": "The response from processing a transaction or a certified transaction", "type": "object", "required": [ "executedEpoch", "gasObject", "gasUsed", "messageVersion", "status", "transactionDigest" ], "properties": { "abortError": { "description": "The abort error populated if the transaction failed with an abort code.", "anyOf": [ { "$ref": "#/components/schemas/SuiMoveAbort" }, { "type": "null" } ] }, "accumulatorEvents": { "type": "array", "items": { "$ref": "#/components/schemas/AccumulatorEvent" } }, "created": { "description": "ObjectRef and owner of new objects created.", "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "deleted": { "description": "Object Refs of objects now deleted (the old refs).", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "dependencies": { "description": "The set of transaction digests this transaction depends on.", "type": "array", "items": { "$ref": "#/components/schemas/TransactionDigest" } }, "eventsDigest": { "description": "The digest of the events emitted during execution, can be None if the transaction does not emit any event.", "anyOf": [ { "$ref": "#/components/schemas/TransactionEventsDigest" }, { "type": "null" } ] }, "executedEpoch": { "description": "The epoch when this transaction was executed.", "allOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" } ] }, "gasObject": { "description": "The updated gas object reference. Have a dedicated field for convenient access. It's also included in mutated.", "allOf": [ { "$ref": "#/components/schemas/OwnedObjectRef" } ] }, "gasUsed": { "$ref": "#/components/schemas/GasCostSummary" }, "messageVersion": { "type": "string", "enum": [ "v1" ] }, "modifiedAtVersions": { "description": "The version that every modified (mutated or deleted) object had before it was modified by this transaction.", "type": "array", "items": { "$ref": "#/components/schemas/TransactionBlockEffectsModifiedAtVersions" } }, "mutated": { "description": "ObjectRef and owner of mutated objects, including gas object.", "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "sharedObjects": { "description": "The object references of the shared objects used in this transaction. Empty if no shared objects were used.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "status": { "description": "The status of the execution", "allOf": [ { "$ref": "#/components/schemas/ExecutionStatus" } ] }, "transactionDigest": { "description": "The transaction digest", "allOf": [ { "$ref": "#/components/schemas/TransactionDigest" } ] }, "unwrapped": { "description": "ObjectRef and owner of objects that are unwrapped in this transaction. Unwrapped objects are objects that were wrapped into other objects in the past, and just got extracted out.", "type": "array", "items": { "$ref": "#/components/schemas/OwnedObjectRef" } }, "unwrappedThenDeleted": { "description": "Object refs of objects previously wrapped in other objects but now deleted.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "wrapped": { "description": "Object refs of objects now wrapped in other objects.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } } } } ] }, "TransactionBlockEffectsModifiedAtVersions": { "type": "object", "required": [ "objectId", "sequenceNumber" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "sequenceNumber": { "$ref": "#/components/schemas/SequenceNumber" } } }, "TransactionBlockKind": { "oneOf": [ { "description": "A system transaction that will update epoch information on-chain.", "type": "object", "required": [ "computation_charge", "epoch", "epoch_start_timestamp_ms", "kind", "storage_charge", "storage_rebate" ], "properties": { "computation_charge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch_start_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ChangeEpoch" ] }, "storage_charge": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "storage_rebate": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "description": "A system transaction used for initializing the initial state of the chain.", "type": "object", "required": [ "kind", "objects" ], "properties": { "kind": { "type": "string", "enum": [ "Genesis" ] }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectID" } } } }, { "description": "A system transaction marking the start of a series of transactions scheduled as part of a checkpoint", "type": "object", "required": [ "commit_timestamp_ms", "epoch", "kind", "round" ], "properties": { "commit_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ConsensusCommitPrologue" ] }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "description": "A series of transactions where the results of one transaction can be used in future transactions", "type": "object", "required": [ "inputs", "kind", "transactions" ], "properties": { "inputs": { "description": "Input objects or primitive values", "type": "array", "items": { "$ref": "#/components/schemas/SuiCallArg" } }, "kind": { "type": "string", "enum": [ "ProgrammableTransaction" ] }, "transactions": { "description": "The transactions to be executed sequentially. A failure in any transaction will result in the failure of the entire programmable transaction block.", "type": "array", "items": { "$ref": "#/components/schemas/SuiTransaction" } } } }, { "description": "A transaction which updates global authenticator state", "type": "object", "required": [ "epoch", "kind", "new_active_jwks", "round" ], "properties": { "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "AuthenticatorStateUpdate" ] }, "new_active_jwks": { "type": "array", "items": { "$ref": "#/components/schemas/SuiActiveJwk" } }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "description": "A transaction which updates global randomness state", "type": "object", "required": [ "epoch", "kind", "random_bytes", "randomness_round" ], "properties": { "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "RandomnessStateUpdate" ] }, "random_bytes": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "randomness_round": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "description": "The transaction which occurs only at the end of the epoch", "type": "object", "required": [ "kind", "transactions" ], "properties": { "kind": { "type": "string", "enum": [ "EndOfEpochTransaction" ] }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/SuiEndOfEpochTransactionKind" } } } }, { "type": "object", "required": [ "commit_timestamp_ms", "consensus_commit_digest", "epoch", "kind", "round" ], "properties": { "commit_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "consensus_commit_digest": { "$ref": "#/components/schemas/ConsensusCommitDigest" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ConsensusCommitPrologueV2" ] }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, { "type": "object", "required": [ "commit_timestamp_ms", "consensus_commit_digest", "consensus_determined_version_assignments", "epoch", "kind", "round" ], "properties": { "commit_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "consensus_commit_digest": { "$ref": "#/components/schemas/ConsensusCommitDigest" }, "consensus_determined_version_assignments": { "$ref": "#/components/schemas/ConsensusDeterminedVersionAssignments" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ConsensusCommitPrologueV3" ] }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "sub_dag_index": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, { "type": "object", "required": [ "additional_state_digest", "commit_timestamp_ms", "consensus_commit_digest", "consensus_determined_version_assignments", "epoch", "kind", "round" ], "properties": { "additional_state_digest": { "$ref": "#/components/schemas/AdditionalConsensusStateDigest" }, "commit_timestamp_ms": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "consensus_commit_digest": { "$ref": "#/components/schemas/ConsensusCommitDigest" }, "consensus_determined_version_assignments": { "$ref": "#/components/schemas/ConsensusDeterminedVersionAssignments" }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "kind": { "type": "string", "enum": [ "ConsensusCommitPrologueV4" ] }, "round": { "$ref": "#/components/schemas/BigInt_for_uint64" }, "sub_dag_index": { "default": null, "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] } } }, { "description": "A series of commands where the results of one command can be used in future commands", "type": "object", "required": [ "inputs", "kind", "transactions" ], "properties": { "inputs": { "description": "Input objects or primitive values", "type": "array", "items": { "$ref": "#/components/schemas/SuiCallArg" } }, "kind": { "type": "string", "enum": [ "ProgrammableSystemTransaction" ] }, "transactions": { "description": "The transactions to be executed sequentially. A failure in any transaction will result in the failure of the entire programmable transaction block.", "type": "array", "items": { "$ref": "#/components/schemas/SuiTransaction" } } } } ] }, "TransactionBlockResponse": { "type": "object", "required": [ "digest" ], "properties": { "balanceChanges": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/BalanceChange" } }, "checkpoint": { "description": "The checkpoint number when this transaction was included and hence finalized. This is only returned in the read api, not in the transaction execution api.", "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "confirmedLocalExecution": { "type": [ "boolean", "null" ] }, "digest": { "$ref": "#/components/schemas/TransactionDigest" }, "effects": { "anyOf": [ { "$ref": "#/components/schemas/TransactionBlockEffects" }, { "type": "null" } ] }, "errors": { "type": "array", "items": { "type": "string" } }, "events": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/Event" } }, "objectChanges": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/ObjectChange" } }, "rawEffects": { "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0 } }, "rawTransaction": { "description": "BCS encoded [SenderSignedData] that includes input object references returns empty array if `show_raw_transaction` is false", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] }, "timestampMs": { "anyOf": [ { "$ref": "#/components/schemas/BigInt_for_uint64" }, { "type": "null" } ] }, "transaction": { "description": "Transaction input data", "anyOf": [ { "$ref": "#/components/schemas/TransactionBlock" }, { "type": "null" } ] } } }, "TransactionBlockResponseOptions": { "type": "object", "properties": { "showBalanceChanges": { "description": "Whether to show balance_changes. Default to be False", "default": false, "type": "boolean" }, "showEffects": { "description": "Whether to show transaction effects. Default to be False", "default": false, "type": "boolean" }, "showEvents": { "description": "Whether to show transaction events. Default to be False", "default": false, "type": "boolean" }, "showInput": { "description": "Whether to show transaction input data. Default to be False", "default": false, "type": "boolean" }, "showObjectChanges": { "description": "Whether to show object_changes. Default to be False", "default": false, "type": "boolean" }, "showRawEffects": { "description": "Whether to show raw transaction effects. Default to be False", "default": false, "type": "boolean" }, "showRawInput": { "description": "Whether to show bcs-encoded transaction input data", "default": false, "type": "boolean" } } }, "TransactionBlockResponseQuery": { "type": "object", "properties": { "filter": { "description": "If None, no filter will be applied", "default": null, "anyOf": [ { "$ref": "#/components/schemas/TransactionFilter" }, { "type": "null" } ] }, "options": { "description": "config which fields to include in the response, by default only digest is included", "default": null, "anyOf": [ { "$ref": "#/components/schemas/TransactionBlockResponseOptions" }, { "type": "null" } ] } } }, "TransactionDigest": { "description": "A transaction will have a (unique) digest.", "allOf": [ { "$ref": "#/components/schemas/Digest" } ] }, "TransactionEventsDigest": { "$ref": "#/components/schemas/Digest" }, "TransactionFilter": { "oneOf": [ { "description": "Query by checkpoint.", "type": "object", "required": [ "Checkpoint" ], "properties": { "Checkpoint": { "$ref": "#/components/schemas/BigInt_for_uint64" } }, "additionalProperties": false }, { "description": "Query by move function.", "type": "object", "required": [ "MoveFunction" ], "properties": { "MoveFunction": { "type": "object", "required": [ "package" ], "properties": { "function": { "type": [ "string", "null" ] }, "module": { "type": [ "string", "null" ] }, "package": { "$ref": "#/components/schemas/ObjectID" } } } }, "additionalProperties": false }, { "description": "Query by input object.", "type": "object", "required": [ "InputObject" ], "properties": { "InputObject": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "description": "Query by changed object, including created, mutated and unwrapped objects.", "type": "object", "required": [ "ChangedObject" ], "properties": { "ChangedObject": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "description": "Query for transactions that touch this object.", "type": "object", "required": [ "AffectedObject" ], "properties": { "AffectedObject": { "$ref": "#/components/schemas/ObjectID" } }, "additionalProperties": false }, { "description": "Query by sender address.", "type": "object", "required": [ "FromAddress" ], "properties": { "FromAddress": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Query by recipient address.", "type": "object", "required": [ "ToAddress" ], "properties": { "ToAddress": { "$ref": "#/components/schemas/SuiAddress" } }, "additionalProperties": false }, { "description": "Query by sender and recipient address.", "type": "object", "required": [ "FromAndToAddress" ], "properties": { "FromAndToAddress": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "$ref": "#/components/schemas/SuiAddress" }, "to": { "$ref": "#/components/schemas/SuiAddress" } } } }, "additionalProperties": false }, { "description": "Query txs that have a given address as sender or recipient.", "type": "object", "required": [ "FromOrToAddress" ], "properties": { "FromOrToAddress": { "type": "object", "required": [ "addr" ], "properties": { "addr": { "$ref": "#/components/schemas/SuiAddress" } } } }, "additionalProperties": false }, { "description": "Query by transaction kind", "type": "object", "required": [ "TransactionKind" ], "properties": { "TransactionKind": { "type": "string" } }, "additionalProperties": false }, { "description": "Query transactions of any given kind in the input.", "type": "object", "required": [ "TransactionKindIn" ], "properties": { "TransactionKindIn": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "TransferObjectParams": { "type": "object", "required": [ "objectId", "recipient" ], "properties": { "objectId": { "$ref": "#/components/schemas/ObjectID" }, "recipient": { "$ref": "#/components/schemas/SuiAddress" } } }, "TypeOrigin": { "description": "Identifies a struct and the module it was defined in", "type": "object", "required": [ "datatype_name", "module_name", "package" ], "properties": { "datatype_name": { "type": "string" }, "module_name": { "type": "string" }, "package": { "$ref": "#/components/schemas/ObjectID" } } }, "TypeTag": { "type": "string" }, "UpgradeInfo": { "description": "Upgraded package info for the linkage table", "type": "object", "required": [ "upgraded_id", "upgraded_version" ], "properties": { "upgraded_id": { "description": "ID of the upgraded packages", "allOf": [ { "$ref": "#/components/schemas/ObjectID" } ] }, "upgraded_version": { "description": "Version of the upgraded package", "allOf": [ { "$ref": "#/components/schemas/SequenceNumber2" } ] } } }, "ValidatorApy": { "type": "object", "required": [ "address", "apy" ], "properties": { "address": { "$ref": "#/components/schemas/SuiAddress" }, "apy": { "type": "number", "format": "double" } } }, "ValidatorApys": { "type": "object", "required": [ "apys", "epoch" ], "properties": { "apys": { "type": "array", "items": { "$ref": "#/components/schemas/ValidatorApy" } }, "epoch": { "$ref": "#/components/schemas/BigInt_for_uint64" } } }, "ZkLoginAuthenticator": { "description": "An zk login authenticator with all the necessary fields.", "type": "object", "required": [ "inputs", "maxEpoch", "userSignature" ], "properties": { "inputs": { "$ref": "#/components/schemas/ZkLoginInputs" }, "maxEpoch": { "type": "integer", "format": "uint64", "minimum": 0 }, "userSignature": { "$ref": "#/components/schemas/Signature" } } }, "ZkLoginAuthenticatorAsBytes": { "$ref": "#/components/schemas/Base64" }, "ZkLoginInputs": { "description": "All inputs required for the zk login proof verification and other public inputs.", "type": "object", "required": [ "addressSeed", "headerBase64", "issBase64Details", "proofPoints" ], "properties": { "addressSeed": { "$ref": "#/components/schemas/Bn254FrElement" }, "headerBase64": { "type": "string" }, "issBase64Details": { "$ref": "#/components/schemas/Claim" }, "proofPoints": { "$ref": "#/components/schemas/ZkLoginProof" } } }, "ZkLoginIntentScope": { "type": "string", "enum": [ "TransactionData", "PersonalMessage" ] }, "ZkLoginProof": { "description": "The struct for zk login proof.", "type": "object", "required": [ "a", "b", "c" ], "properties": { "a": { "type": "array", "items": { "$ref": "#/components/schemas/Bn254FqElement" } }, "b": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/Bn254FqElement" } } }, "c": { "type": "array", "items": { "$ref": "#/components/schemas/Bn254FqElement" } } } }, "ZkLoginPublicIdentifier": { "description": "A wrapper struct to retrofit in [enum PublicKey] for zkLogin. Useful to construct [struct MultiSigPublicKey].", "allOf": [ { "$ref": "#/components/schemas/Base64" } ] }, "ZkLoginVerifyResult": { "type": "object", "required": [ "errors", "success" ], "properties": { "errors": { "description": "The errors field captures any verification error", "type": "array", "items": { "type": "string" } }, "success": { "description": "The boolean result of the verification. If true, errors should be empty.", "type": "boolean" } } } } }, "servers": [ { "name": "mainnet", "url": "https://mainnet-api.inodra.com/v1/jsonrpc" }, { "name": "testnet", "url": "https://testnet-api.inodra.com/v1/jsonrpc" } ] }