diff --git a/.prettierignore b/.prettierignore index 60cc6179..5bb6b427 100644 --- a/.prettierignore +++ b/.prettierignore @@ -3,7 +3,7 @@ pnpm-lock.yaml **/node_modules .astro/** **/.tmp -aptos-spec.json +public/aptos-spec.json # MDX files are handled by remark **/*.mdx diff --git a/.vscode/launch.json b/.vscode/launch.json index 3f9410b6..bfa07b49 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -7,6 +7,12 @@ "request": "launch", "type": "node-terminal" }, + { + "command": "./node_modules/.bin/astro build", + "name": "Build", + "request": "launch", + "type": "node-terminal" + }, { "type": "node", "request": "launch", diff --git a/public/aptos-spec.json b/public/aptos-spec.json deleted file mode 100644 index b81f0802..00000000 --- a/public/aptos-spec.json +++ /dev/null @@ -1,17987 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Aptos Node API", - "description": "The Aptos Node API is a RESTful API for client applications to interact with the Aptos blockchain.", - "version": "1.2.0", - "contact": { - "name": "Aptos Labs", - "url": "https://github.com/aptos-labs/aptos-core" - }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "servers": [ - { - "url": "/v1" - } - ], - "tags": [ - { - "name": "Accounts", - "description": "Access to accounts, resources, and modules" - }, - { - "name": "Blocks", - "description": "Access to blocks" - }, - { - "name": "Events", - "description": "Access to events" - }, - { - "name": "Experimental", - "description": "Experimental APIs, no guarantees" - }, - { - "name": "General", - "description": "General information" - }, - { - "name": "Tables", - "description": "Access to tables" - }, - { - "name": "Transactions", - "description": "Access to transactions" - }, - { - "name": "View", - "description": "View functions," - } - ], - "paths": { - "/accounts/{address}": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Get account", - "description": "Return the authentication key and the sequence number for an account\naddress. Optionally, a ledger version can be specified. If the ledger\nversion is not specified in the request, the latest ledger version is used.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Address of account with or without a `0x` prefix", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AccountData" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_account" - } - }, - "/accounts/{address}/resources": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Get account resources", - "description": "Retrieves all account resources for a given account and a specific ledger version. If the\nledger version is not specified in the request, the latest ledger version is used.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf the requested ledger version has been pruned, the server responds with a 410.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Address of account with or without a `0x` prefix", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "start", - "schema": { - "$ref": "#/components/schemas/StateKeyWrapper" - }, - "in": "query", - "description": "Cursor specifying where to start for pagination\n\nThis cursor cannot be derived manually client-side. Instead, you must\ncall this endpoint once without this query parameter specified, and\nthen use the cursor returned in the X-Aptos-Cursor header in the\nresponse.", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "limit", - "schema": { - "type": "integer", - "format": "uint16" - }, - "in": "query", - "description": "Max number of account resources to retrieve\n\nIf not provided, defaults to default page size.", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MoveResource" - } - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_account_resources" - } - }, - "/accounts/{address}/balance/{asset_type}": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Get account resources", - "description": "Retrieves all account resources for a given account and a specific ledger version. If the\nledger version is not specified in the request, the latest ledger version is used.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf the requested ledger version has been pruned, the server responds with a 410.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Address of account with or without a `0x` prefix", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "asset_type", - "schema": { - "$ref": "#/components/schemas/AssetType" - }, - "in": "path", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_account_balance" - } - }, - "/accounts/{address}/modules": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Get account modules", - "description": "Retrieves all account modules' bytecode for a given account at a specific ledger version.\nIf the ledger version is not specified in the request, the latest ledger version is used.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf the requested ledger version has been pruned, the server responds with a 410.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Address of account with or without a `0x` prefix", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "start", - "schema": { - "$ref": "#/components/schemas/StateKeyWrapper" - }, - "in": "query", - "description": "Cursor specifying where to start for pagination\n\nThis cursor cannot be derived manually client-side. Instead, you must\ncall this endpoint once without this query parameter specified, and\nthen use the cursor returned in the X-Aptos-Cursor header in the\nresponse.", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "limit", - "schema": { - "type": "integer", - "format": "uint16" - }, - "in": "query", - "description": "Max number of account modules to retrieve\n\nIf not provided, defaults to default page size.", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MoveModuleBytecode" - } - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_account_modules" - } - }, - "/spec": { - "get": { - "tags": [ - "General" - ], - "summary": "Show OpenAPI explorer", - "description": "Provides a UI that you can use to explore the API. You can also\nretrieve the API directly at `/spec.yaml` and `/spec.json`.", - "responses": { - "200": { - "description": "", - "content": { - "text/html": { - "schema": { - "type": "string" - } - } - } - } - }, - "operationId": "spec" - } - }, - "/info": { - "get": { - "tags": [ - "General" - ], - "summary": "Show some basic info of the node.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": {} - } - } - } - } - }, - "operationId": "info" - } - }, - "/-/healthy": { - "get": { - "tags": [ - "General" - ], - "summary": "Check basic node health", - "description": "By default this endpoint just checks that it can get the latest ledger\ninfo and then returns 200.\n\nIf the duration_secs param is provided, this endpoint will return a\n200 if the following condition is true:\n\n`server_latest_ledger_info_timestamp >= server_current_time_timestamp - duration_secs`", - "parameters": [ - { - "name": "duration_secs", - "schema": { - "type": "integer", - "format": "uint32" - }, - "in": "query", - "description": "Threshold in seconds that the server can be behind to be considered healthy\n\nIf not provided, the healthcheck will always succeed", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HealthCheckSuccess" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "healthy" - } - }, - "/blocks/by_height/{block_height}": { - "get": { - "tags": [ - "Blocks" - ], - "summary": "Get blocks by height", - "description": "This endpoint allows you to get the transactions in a block\nand the corresponding block information.\n\nTransactions are limited by max default transactions size. If not all transactions\nare present, the user will need to query for the rest of the transactions via the\nget transactions API.\n\nIf the block is pruned, it will return a 410", - "parameters": [ - { - "name": "block_height", - "schema": { - "type": "integer", - "format": "uint64" - }, - "in": "path", - "description": "Block height to lookup. Starts at 0", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "with_transactions", - "schema": { - "type": "boolean" - }, - "in": "query", - "description": "If set to true, include all transactions in the block\n\nIf not provided, no transactions will be retrieved", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Block" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_block_by_height" - } - }, - "/blocks/by_version/{version}": { - "get": { - "tags": [ - "Blocks" - ], - "summary": "Get blocks by version", - "description": "This endpoint allows you to get the transactions in a block\nand the corresponding block information given a version in the block.\n\nTransactions are limited by max default transactions size. If not all transactions\nare present, the user will need to query for the rest of the transactions via the\nget transactions API.\n\nIf the block has been pruned, it will return a 410", - "parameters": [ - { - "name": "version", - "schema": { - "type": "integer", - "format": "uint64" - }, - "in": "path", - "description": "Ledger version to lookup block information for.", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "with_transactions", - "schema": { - "type": "boolean" - }, - "in": "query", - "description": "If set to true, include all transactions in the block\n\nIf not provided, no transactions will be retrieved", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Block" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_block_by_version" - } - }, - "/accounts/{address}/events/{creation_number}": { - "get": { - "tags": [ - "Events" - ], - "summary": "Get events by creation number", - "description": "Event types are globally identifiable by an account `address` and\nmonotonically increasing `creation_number`, one per event type emitted\nto the given account. This API returns events corresponding to that\nthat event type.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Hex-encoded 32 byte Aptos account, with or without a `0x` prefix, for\nwhich events are queried. This refers to the account that events were\nemitted to, not the account hosting the move module that emits that\nevent type.", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "creation_number", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "path", - "description": "Creation number corresponding to the event stream originating\nfrom the given account.", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "start", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Starting sequence number of events.\n\nIf unspecified, by default will retrieve the most recent events", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "limit", - "schema": { - "type": "integer", - "format": "uint16" - }, - "in": "query", - "description": "Max number of events to retrieve.\n\nIf unspecified, defaults to default page size", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VersionedEvent" - } - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_events_by_creation_number" - } - }, - "/accounts/{address}/events/{event_handle}/{field_name}": { - "get": { - "tags": [ - "Events" - ], - "summary": "Get events by event handle", - "description": "This API uses the given account `address`, `eventHandle`, and `fieldName`\nto build a key that can globally identify an event types. It then uses this\nkey to return events emitted to the given account matching that event type.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Hex-encoded 32 byte Aptos account, with or without a `0x` prefix, for\nwhich events are queried. This refers to the account that events were\nemitted to, not the account hosting the move module that emits that\nevent type.", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "event_handle", - "schema": { - "$ref": "#/components/schemas/MoveStructTag" - }, - "in": "path", - "description": "Name of struct to lookup event handle e.g. `0x1::account::Account`", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "field_name", - "schema": { - "$ref": "#/components/schemas/IdentifierWrapper" - }, - "in": "path", - "description": "Name of field to lookup event handle e.g. `withdraw_events`", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "start", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Starting sequence number of events.\n\nIf unspecified, by default will retrieve the most recent", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "limit", - "schema": { - "type": "integer", - "format": "uint16" - }, - "in": "query", - "description": "Max number of events to retrieve.\n\nIf unspecified, defaults to default page size", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/VersionedEvent" - } - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_events_by_event_handle" - } - }, - "/": { - "get": { - "tags": [ - "General" - ], - "summary": "Get ledger info", - "description": "Get the latest ledger information, including data such as chain ID,\nrole type, ledger versions, epoch, etc.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndexResponse" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_ledger_info" - } - }, - "/accounts/{address}/resource/{resource_type}": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Get account resource", - "description": "Retrieves an individual resource from a given account and at a specific ledger version. If the\nledger version is not specified in the request, the latest ledger version is used.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf the requested ledger version has been pruned, the server responds with a 410.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Address of account with or without a `0x` prefix", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "resource_type", - "schema": { - "$ref": "#/components/schemas/MoveStructTag" - }, - "in": "path", - "description": "Name of struct to retrieve e.g. `0x1::account::Account`", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoveResource" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_account_resource" - } - }, - "/accounts/{address}/module/{module_name}": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Get account module", - "description": "Retrieves an individual module from a given account and at a specific ledger version. If the\nledger version is not specified in the request, the latest ledger version is used.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf the requested ledger version has been pruned, the server responds with a 410.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Address of account with or without a `0x` prefix", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "module_name", - "schema": { - "$ref": "#/components/schemas/IdentifierWrapper" - }, - "in": "path", - "description": "Name of module to retrieve e.g. `coin`", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoveModuleBytecode" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_account_module" - } - }, - "/tables/{table_handle}/item": { - "post": { - "tags": [ - "Tables" - ], - "summary": "Get table item", - "description": "Get a table item at a specific ledger version from the table identified by {table_handle}\nin the path and the \"key\" (TableItemRequest) provided in the request body.\n\nThis is a POST endpoint because the \"key\" for requesting a specific\ntable item (TableItemRequest) could be quite complex, as each of its\nfields could themselves be composed of other structs. This makes it\nimpractical to express using query params, meaning GET isn't an option.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf the requested ledger version has been pruned, the server responds with a 410.", - "parameters": [ - { - "name": "table_handle", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Table handle hex encoded 32-byte string", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableItemRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoveValue" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_table_item" - } - }, - "/tables/{table_handle}/raw_item": { - "post": { - "tags": [ - "Tables" - ], - "summary": "Get raw table item", - "description": "Get a table item at a specific ledger version from the table identified by {table_handle}\nin the path and the \"key\" (RawTableItemRequest) provided in the request body.\n\nThe `get_raw_table_item` requires only a serialized key comparing to the full move type information\ncomparing to the `get_table_item` api, and can only return the query in the bcs format.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf the requested ledger version has been pruned, the server responds with a 410.", - "parameters": [ - { - "name": "table_handle", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Table handle hex encoded 32-byte string", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RawTableItemRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MoveValue" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_raw_table_item" - } - }, - "/transactions": { - "get": { - "tags": [ - "Transactions" - ], - "summary": "Get transactions", - "description": "Retrieve on-chain committed transactions. The page size and start ledger version\ncan be provided to get a specific sequence of transactions.\n\nIf the version has been pruned, then a 410 will be returned.\n\nTo retrieve a pending transaction, use /transactions/by_hash.", - "parameters": [ - { - "name": "start", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to start list of transactions\n\nIf not provided, defaults to showing the latest transactions", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "limit", - "schema": { - "type": "integer", - "format": "uint16" - }, - "in": "query", - "description": "Max number of transactions to retrieve.\n\nIf not provided, defaults to default page size", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transaction" - } - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_transactions" - }, - "post": { - "tags": [ - "Transactions" - ], - "summary": "Submit transaction", - "description": "This endpoint accepts transaction submissions in two formats.\n\nTo submit a transaction as JSON, you must submit a SubmitTransactionRequest.\nTo build this request, do the following:\n\n1. Encode the transaction as BCS. If you are using a language that has\nnative BCS support, make sure of that library. If not, you may take\nadvantage of /transactions/encode_submission. When using this\nendpoint, make sure you trust the node you're talking to, as it is\npossible they could manipulate your request.\n2. Sign the encoded transaction and use it to create a TransactionSignature.\n3. Submit the request. Make sure to use the \"application/json\" Content-Type.\n\nTo submit a transaction as BCS, you must submit a SignedTransaction\nencoded as BCS. See SignedTransaction in types/src/transaction/mod.rs.\nMake sure to use the `application/x.aptos.signed_transaction+bcs` Content-Type.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubmitTransactionRequest" - } - }, - "application/x.aptos.signed_transaction+bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "required": true - }, - "responses": { - "202": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PendingTransaction" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "413": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "507": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "submit_transaction" - } - }, - "/transactions/by_hash/{txn_hash}": { - "get": { - "tags": [ - "Transactions" - ], - "summary": "Get transaction by hash", - "description": "Look up a transaction by its hash. This is the same hash that is returned\nby the API when submitting a transaction (see PendingTransaction).\n\nWhen given a transaction hash, the server first looks for the transaction\nin storage (on-chain, committed). If no on-chain transaction is found, it\nlooks the transaction up by hash in the mempool (pending, not yet committed).\n\nTo create a transaction hash by yourself, do the following:\n1. Hash message bytes: \"RawTransaction\" bytes + BCS bytes of [Transaction](https://aptos-labs.github.io/aptos-core/aptos_types/transaction/enum.Transaction.html).\n2. Apply hash algorithm `SHA3-256` to the hash message bytes.\n3. Hex-encode the hash bytes with `0x` prefix.", - "parameters": [ - { - "name": "txn_hash", - "schema": { - "$ref": "#/components/schemas/HashValue" - }, - "in": "path", - "description": "Hash of transaction to retrieve", - "required": true, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Transaction" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_transaction_by_hash" - } - }, - "/transactions/wait_by_hash/{txn_hash}": { - "get": { - "tags": [ - "Transactions" - ], - "summary": "Wait for transaction by hash", - "description": "Same as /transactions/by_hash, but will wait for a pending transaction to be committed. To be used as a long\npoll optimization by clients, to reduce latency caused by polling. The \"long\" poll is generally a second or\nless but dictated by the server; the client must deal with the result as if the request was a normal\n/transactions/by_hash request, e.g., by retrying if the transaction is pending.", - "parameters": [ - { - "name": "txn_hash", - "schema": { - "$ref": "#/components/schemas/HashValue" - }, - "in": "path", - "description": "Hash of transaction to retrieve", - "required": true, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Transaction" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "wait_transaction_by_hash" - } - }, - "/transactions/by_version/{txn_version}": { - "get": { - "tags": [ - "Transactions" - ], - "summary": "Get transaction by version", - "description": "Retrieves a transaction by a given version. If the version has been\npruned, a 410 will be returned.", - "parameters": [ - { - "name": "txn_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "path", - "description": "Version of transaction to retrieve", - "required": true, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Transaction" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_transaction_by_version" - } - }, - "/accounts/{address}/transactions": { - "get": { - "tags": [ - "Transactions" - ], - "summary": "Get account transactions", - "description": "Retrieves on-chain committed transactions from an account. If the start\nversion is too far in the past, a 410 will be returned.\n\nIf no start version is given, it will start at version 0.\n\nTo retrieve a pending transaction, use /transactions/by_hash.", - "parameters": [ - { - "name": "address", - "schema": { - "$ref": "#/components/schemas/Address" - }, - "in": "path", - "description": "Address of account with or without a `0x` prefix", - "required": true, - "deprecated": false, - "explode": true - }, - { - "name": "start", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Account sequence number to start list of transactions\n\nIf not provided, defaults to showing the latest transactions", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "limit", - "schema": { - "type": "integer", - "format": "uint16" - }, - "in": "query", - "description": "Max number of transactions to retrieve.\n\nIf not provided, defaults to default page size", - "required": false, - "deprecated": false, - "explode": true - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transaction" - } - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "get_account_transactions" - } - }, - "/transactions/batch": { - "post": { - "tags": [ - "Transactions" - ], - "summary": "Submit batch transactions", - "description": "This allows you to submit multiple transactions. The response has three outcomes:\n\n1. All transactions succeed, and it will return a 202\n2. Some transactions succeed, and it will return the failed transactions and a 206\n3. No transactions succeed, and it will also return the failed transactions and a 206\n\nTo submit a transaction as JSON, you must submit a SubmitTransactionRequest.\nTo build this request, do the following:\n\n1. Encode the transaction as BCS. If you are using a language that has\nnative BCS support, make sure to use that library. If not, you may take\nadvantage of /transactions/encode_submission. When using this\nendpoint, make sure you trust the node you're talking to, as it is\npossible they could manipulate your request.\n2. Sign the encoded transaction and use it to create a TransactionSignature.\n3. Submit the request. Make sure to use the \"application/json\" Content-Type.\n\nTo submit a transaction as BCS, you must submit a SignedTransaction\nencoded as BCS. See SignedTransaction in types/src/transaction/mod.rs.\nMake sure to use the `application/x.aptos.signed_transaction+bcs` Content-Type.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubmitTransactionRequest" - } - } - }, - "application/x.aptos.signed_transaction+bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "required": true - }, - "responses": { - "202": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionsBatchSubmissionResult" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "206": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionsBatchSubmissionResult" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "413": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "507": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "submit_batch_transactions" - } - }, - "/transactions/simulate": { - "post": { - "tags": [ - "Transactions" - ], - "summary": "Simulate transaction", - "description": "The output of the transaction will have the exact transaction outputs and events that running\nan actual signed transaction would have. However, it will not have the associated state\nhashes, as they are not updated in storage. This can be used to estimate the maximum gas\nunits for a submitted transaction.\n\nTo use this, you must:\n- Create a SignedTransaction with a zero-padded signature.\n- Submit a SubmitTransactionRequest containing a UserTransactionRequest containing that signature.\n\nTo use this endpoint with BCS, you must submit a SignedTransaction\nencoded as BCS. See SignedTransaction in types/src/transaction/mod.rs.", - "parameters": [ - { - "name": "estimate_max_gas_amount", - "schema": { - "type": "boolean" - }, - "in": "query", - "description": "If set to true, the max gas value in the transaction will be ignored\nand the maximum possible gas will be used", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "estimate_gas_unit_price", - "schema": { - "type": "boolean" - }, - "in": "query", - "description": "If set to true, the gas unit price in the transaction will be ignored\nand the estimated value will be used", - "required": false, - "deprecated": false, - "explode": true - }, - { - "name": "estimate_prioritized_gas_unit_price", - "schema": { - "type": "boolean" - }, - "in": "query", - "description": "If set to true, the transaction will use a higher price than the original\nestimate.", - "required": false, - "deprecated": false, - "explode": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubmitTransactionRequest" - } - }, - "application/x.aptos.signed_transaction+bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserTransaction" - } - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "413": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "507": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "simulate_transaction" - } - }, - "/transactions/encode_submission": { - "post": { - "tags": [ - "Transactions" - ], - "summary": "Encode submission", - "description": "This endpoint accepts an EncodeSubmissionRequest, which internally is a\nUserTransactionRequestInner (and optionally secondary signers) encoded\nas JSON, validates the request format, and then returns that request\nencoded in BCS. The client can then use this to create a transaction\nsignature to be used in a SubmitTransactionRequest, which it then\npasses to the /transactions POST endpoint.\n\nTo be clear, this endpoint makes it possible to submit transaction\nrequests to the API from languages that do not have library support for\nBCS. If you are using an SDK that has BCS support, such as the official\nRust, TypeScript, or Python SDKs, you do not need to use this endpoint.\n\nTo sign a message using the response from this endpoint:\n- Decode the hex encoded string in the response to bytes.\n- Sign the bytes to create the signature.\n- Use that as the signature field in something like Ed25519Signature, which you then use to build a TransactionSignature.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EncodeSubmissionRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "encode_submission" - } - }, - "/estimate_gas_price": { - "get": { - "tags": [ - "Transactions" - ], - "summary": "Estimate gas price", - "description": "Gives an estimate of the gas unit price required to get a transaction on chain in a\nreasonable amount of time. The gas unit price is the amount that each transaction commits to\npay for each unit of gas consumed in executing the transaction. The estimate is based on\nrecent history: it gives the minimum gas that would have been required to get into recent\nblocks, for blocks that were full. (When blocks are not full, the estimate will match the\nminimum gas unit price.)\n\nThe estimation is given in three values: de-prioritized (low), regular, and prioritized\n(aggressive). Using a more aggressive value increases the likelihood that the transaction\nwill make it into the next block; more aggressive values are computed with a larger history\nand higher percentile statistics. More details are in AIP-34.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GasEstimation" - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "estimate_gas_price" - } - }, - "/view": { - "post": { - "tags": [ - "View" - ], - "summary": "Execute view function of a module", - "description": "Execute the Move function with the given parameters and return its execution result.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf the requested ledger version has been pruned, the server responds with a 410.", - "parameters": [ - { - "name": "ledger_version", - "schema": { - "$ref": "#/components/schemas/U64" - }, - "in": "query", - "description": "Ledger version to get state of account\n\nIf not provided, it will be the latest version", - "required": false, - "deprecated": false, - "explode": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ViewRequest" - } - }, - "application/x.aptos.view_function+bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MoveValue" - } - } - }, - "application/x-bcs": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "required": true, - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-CURSOR": { - "description": "Cursor to be used for endpoints that support cursor-based\npagination. Pass this to the `start` field of the endpoint\non the next call to get the next page of results.", - "deprecated": false, - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "403": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "404": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "410": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "500": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - }, - "503": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AptosError" - } - } - }, - "headers": { - "X-APTOS-CHAIN-ID": { - "description": "Chain ID of the current chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint8" - } - }, - "X-APTOS-LEDGER-VERSION": { - "description": "Current ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-OLDEST-VERSION": { - "description": "Oldest non-pruned ledger version of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-LEDGER-TIMESTAMPUSEC": { - "description": "Current timestamp of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-EPOCH": { - "description": "Current epoch of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-BLOCK-HEIGHT": { - "description": "Current block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-OLDEST-BLOCK-HEIGHT": { - "description": "Oldest non-pruned block height of the chain", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - }, - "X-APTOS-GAS-USED": { - "description": "The cost of the call in terms of gas", - "deprecated": false, - "schema": { - "type": "integer", - "format": "uint64" - } - } - } - } - }, - "operationId": "view" - } - } - }, - "components": { - "schemas": { - "AbstractionSignature": { - "type": "object", - "required": [ - "function_info", - "auth_data" - ], - "properties": { - "function_info": { - "type": "string" - }, - "auth_data": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "AccountData": { - "type": "object", - "description": "Account data\n\nA simplified version of the onchain Account resource", - "required": [ - "sequence_number", - "authentication_key" - ], - "properties": { - "sequence_number": { - "$ref": "#/components/schemas/U64" - }, - "authentication_key": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "AccountSignature": { - "type": "object", - "description": "Account signature scheme\n\nThe account signature scheme allows you to have two types of accounts:\n\n1. A single Ed25519 key account, one private key\n2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction.\n3. A single Secp256k1Ecdsa key account, one private key", - "oneOf": [ - { - "$ref": "#/components/schemas/AccountSignature_Ed25519Signature" - }, - { - "$ref": "#/components/schemas/AccountSignature_MultiEd25519Signature" - }, - { - "$ref": "#/components/schemas/AccountSignature_SingleKeySignature" - }, - { - "$ref": "#/components/schemas/AccountSignature_MultiKeySignature" - }, - { - "$ref": "#/components/schemas/AccountSignature_NoAccountSignature" - }, - { - "$ref": "#/components/schemas/AccountSignature_AbstractionSignature" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "ed25519_signature": "#/components/schemas/AccountSignature_Ed25519Signature", - "multi_ed25519_signature": "#/components/schemas/AccountSignature_MultiEd25519Signature", - "single_key_signature": "#/components/schemas/AccountSignature_SingleKeySignature", - "multi_key_signature": "#/components/schemas/AccountSignature_MultiKeySignature", - "no_account_signature": "#/components/schemas/AccountSignature_NoAccountSignature", - "abstraction_signature": "#/components/schemas/AccountSignature_AbstractionSignature" - } - } - }, - "AccountSignature_AbstractionSignature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "abstraction_signature" - ], - "example": "abstraction_signature" - } - } - }, - { - "$ref": "#/components/schemas/AbstractionSignature" - } - ] - }, - "AccountSignature_Ed25519Signature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "ed25519_signature" - ], - "example": "ed25519_signature" - } - } - }, - { - "$ref": "#/components/schemas/Ed25519Signature" - } - ] - }, - "AccountSignature_MultiEd25519Signature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "multi_ed25519_signature" - ], - "example": "multi_ed25519_signature" - } - } - }, - { - "$ref": "#/components/schemas/MultiEd25519Signature" - } - ] - }, - "AccountSignature_MultiKeySignature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "multi_key_signature" - ], - "example": "multi_key_signature" - } - } - }, - { - "$ref": "#/components/schemas/MultiKeySignature" - } - ] - }, - "AccountSignature_NoAccountSignature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "no_account_signature" - ], - "example": "no_account_signature" - } - } - }, - { - "$ref": "#/components/schemas/NoAccountSignature" - } - ] - }, - "AccountSignature_SingleKeySignature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "single_key_signature" - ], - "example": "single_key_signature" - } - } - }, - { - "$ref": "#/components/schemas/SingleKeySignature" - } - ] - }, - "Address": { - "type": "string", - "format": "hex", - "description": "A hex encoded 32 byte Aptos account address.\n\nThis is represented in a string as a 64 character hex string, sometimes\nshortened by stripping leading 0s, and adding a 0x.\n\nFor example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.\n", - "example": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 " - }, - "AptosError": { - "type": "object", - "description": "This is the generic struct we use for all API errors, it contains a string\nmessage and an Aptos API specific error code.", - "required": [ - "message", - "error_code" - ], - "properties": { - "message": { - "type": "string", - "description": "A message describing the error" - }, - "error_code": { - "$ref": "#/components/schemas/AptosErrorCode" - }, - "vm_error_code": { - "type": "integer", - "format": "uint64", - "description": "A code providing VM error details when submitting transactions to the VM" - } - } - }, - "AptosErrorCode": { - "type": "string", - "description": "These codes provide more granular error information beyond just the HTTP\nstatus code of the response.", - "enum": [ - "account_not_found", - "resource_not_found", - "module_not_found", - "struct_field_not_found", - "version_not_found", - "transaction_not_found", - "table_item_not_found", - "block_not_found", - "state_value_not_found", - "version_pruned", - "block_pruned", - "invalid_input", - "invalid_transaction_update", - "sequence_number_too_old", - "vm_error", - "health_check_failed", - "mempool_is_full", - "internal_error", - "web_framework_error", - "bcs_not_supported", - "api_disabled" - ] - }, - "AssetType": { - "type": "string", - "format": "hex", - "description": "A hex encoded 32 byte Aptos account address or a struct tag.\n\nThis is represented in a string as a 64 character hex string, sometimes\nshortened by stripping leading 0s, and adding a 0x or\nFormat: `{address}::{module name}::{struct name}`\n", - "example": "0x1::aptos_coin::AptosCoin" - }, - "Block": { - "type": "object", - "description": "A Block with or without transactions\n\nThis contains the information about a transactions along with\nassociated transactions if requested", - "required": [ - "block_height", - "block_hash", - "block_timestamp", - "first_version", - "last_version" - ], - "properties": { - "block_height": { - "$ref": "#/components/schemas/U64" - }, - "block_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "block_timestamp": { - "$ref": "#/components/schemas/U64" - }, - "first_version": { - "$ref": "#/components/schemas/U64" - }, - "last_version": { - "$ref": "#/components/schemas/U64" - }, - "transactions": { - "type": "array", - "description": "The transactions in the block in sequential order", - "items": { - "$ref": "#/components/schemas/Transaction" - } - } - } - }, - "BlockEndInfo": { - "type": "object", - "required": [ - "block_gas_limit_reached", - "block_output_limit_reached", - "block_effective_block_gas_units", - "block_approx_output_size" - ], - "properties": { - "block_gas_limit_reached": { - "type": "boolean" - }, - "block_output_limit_reached": { - "type": "boolean" - }, - "block_effective_block_gas_units": { - "type": "integer", - "format": "uint64" - }, - "block_approx_output_size": { - "type": "integer", - "format": "uint64" - } - } - }, - "BlockEpilogueTransaction": { - "type": "object", - "description": "A block epilogue transaction", - "required": [ - "version", - "hash", - "state_change_hash", - "event_root_hash", - "gas_used", - "success", - "vm_status", - "accumulator_root_hash", - "changes", - "timestamp" - ], - "properties": { - "version": { - "$ref": "#/components/schemas/U64" - }, - "hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_change_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "event_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_checkpoint_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "gas_used": { - "$ref": "#/components/schemas/U64" - }, - "success": { - "type": "boolean", - "description": "Whether the transaction was successful" - }, - "vm_status": { - "type": "string", - "description": "The VM status of the transaction, can tell useful information in a failure" - }, - "accumulator_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "changes": { - "type": "array", - "description": "Final state of resources changed by the transaction", - "items": { - "$ref": "#/components/schemas/WriteSetChange" - } - }, - "timestamp": { - "$ref": "#/components/schemas/U64" - }, - "block_end_info": { - "$ref": "#/components/schemas/BlockEndInfo" - } - } - }, - "BlockMetadataExtension": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/BlockMetadataExtension_BlockMetadataExtensionEmpty" - }, - { - "$ref": "#/components/schemas/BlockMetadataExtension_BlockMetadataExtensionRandomness" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "v0": "#/components/schemas/BlockMetadataExtension_BlockMetadataExtensionEmpty", - "v1": "#/components/schemas/BlockMetadataExtension_BlockMetadataExtensionRandomness" - } - } - }, - "BlockMetadataExtensionEmpty": { - "type": "object" - }, - "BlockMetadataExtensionRandomness": { - "type": "object", - "properties": { - "randomness": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "BlockMetadataExtension_BlockMetadataExtensionEmpty": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "v0" - ], - "example": "v0" - } - } - }, - { - "$ref": "#/components/schemas/BlockMetadataExtensionEmpty" - } - ] - }, - "BlockMetadataExtension_BlockMetadataExtensionRandomness": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "v1" - ], - "example": "v1" - } - } - }, - { - "$ref": "#/components/schemas/BlockMetadataExtensionRandomness" - } - ] - }, - "BlockMetadataTransaction": { - "type": "object", - "description": "A block metadata transaction\n\nThis signifies the beginning of a block, and contains information\nabout the specific block", - "required": [ - "version", - "hash", - "state_change_hash", - "event_root_hash", - "gas_used", - "success", - "vm_status", - "accumulator_root_hash", - "changes", - "id", - "epoch", - "round", - "events", - "previous_block_votes_bitvec", - "proposer", - "failed_proposer_indices", - "timestamp" - ], - "properties": { - "version": { - "$ref": "#/components/schemas/U64" - }, - "hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_change_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "event_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_checkpoint_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "gas_used": { - "$ref": "#/components/schemas/U64" - }, - "success": { - "type": "boolean", - "description": "Whether the transaction was successful" - }, - "vm_status": { - "type": "string", - "description": "The VM status of the transaction, can tell useful information in a failure" - }, - "accumulator_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "changes": { - "type": "array", - "description": "Final state of resources changed by the transaction", - "items": { - "$ref": "#/components/schemas/WriteSetChange" - } - }, - "id": { - "$ref": "#/components/schemas/HashValue" - }, - "epoch": { - "$ref": "#/components/schemas/U64" - }, - "round": { - "$ref": "#/components/schemas/U64" - }, - "events": { - "type": "array", - "description": "The events emitted at the block creation", - "items": { - "$ref": "#/components/schemas/Event" - } - }, - "previous_block_votes_bitvec": { - "type": "array", - "description": "Previous block votes", - "items": { - "type": "integer", - "format": "uint8" - } - }, - "proposer": { - "$ref": "#/components/schemas/Address" - }, - "failed_proposer_indices": { - "type": "array", - "description": "The indices of the proposers who failed to propose", - "items": { - "type": "integer", - "format": "uint32" - } - }, - "timestamp": { - "$ref": "#/components/schemas/U64" - }, - "block_metadata_extension": { - "allOf": [ - { - "$ref": "#/components/schemas/BlockMetadataExtension" - }, - { - "description": "If some, it means the internal txn type is `aptos_types::transaction::Transaction::BlockMetadataExt`.\nOtherwise, it is `aptos_types::transaction::Transaction::BlockMetadata`.\n\nNOTE: we could have introduced a new APT txn type to represent the corresponding internal type,\nbut that is a breaking change to the ecosystem.\n\nNOTE: `oai` does not support `flatten` together with `skip_serializing_if`.", - "default": null - } - ] - } - } - }, - "DKGResultTransaction": { - "type": "object", - "required": [ - "version", - "hash", - "state_change_hash", - "event_root_hash", - "gas_used", - "success", - "vm_status", - "accumulator_root_hash", - "changes", - "events", - "timestamp", - "dkg_transcript" - ], - "properties": { - "version": { - "$ref": "#/components/schemas/U64" - }, - "hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_change_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "event_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_checkpoint_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "gas_used": { - "$ref": "#/components/schemas/U64" - }, - "success": { - "type": "boolean", - "description": "Whether the transaction was successful" - }, - "vm_status": { - "type": "string", - "description": "The VM status of the transaction, can tell useful information in a failure" - }, - "accumulator_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "changes": { - "type": "array", - "description": "Final state of resources changed by the transaction", - "items": { - "$ref": "#/components/schemas/WriteSetChange" - } - }, - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } - }, - "timestamp": { - "$ref": "#/components/schemas/U64" - }, - "dkg_transcript": { - "$ref": "#/components/schemas/ExportedDKGTranscript" - } - } - }, - "DecodedTableData": { - "type": "object", - "description": "Decoded table data", - "required": [ - "key", - "key_type", - "value", - "value_type" - ], - "properties": { - "key": { - "description": "Key of table in JSON" - }, - "key_type": { - "type": "string", - "description": "Type of key" - }, - "value": { - "description": "Value of table in JSON" - }, - "value_type": { - "type": "string", - "description": "Type of value" - } - } - }, - "DeleteModule": { - "type": "object", - "description": "Delete a module", - "required": [ - "address", - "state_key_hash", - "module" - ], - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "state_key_hash": { - "type": "string", - "description": "State key hash" - }, - "module": { - "$ref": "#/components/schemas/MoveModuleId" - } - } - }, - "DeleteResource": { - "type": "object", - "description": "Delete a resource", - "required": [ - "address", - "state_key_hash", - "resource" - ], - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "state_key_hash": { - "type": "string", - "description": "State key hash" - }, - "resource": { - "$ref": "#/components/schemas/MoveStructTag" - } - } - }, - "DeleteTableItem": { - "type": "object", - "description": "Delete a table item", - "required": [ - "state_key_hash", - "handle", - "key" - ], - "properties": { - "state_key_hash": { - "type": "string" - }, - "handle": { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - "key": { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - "data": { - "$ref": "#/components/schemas/DeletedTableData" - } - } - }, - "DeletedTableData": { - "type": "object", - "description": "Deleted table data", - "required": [ - "key", - "key_type" - ], - "properties": { - "key": { - "description": "Deleted key" - }, - "key_type": { - "type": "string", - "description": "Deleted key type" - } - } - }, - "DeprecatedModuleBundlePayload": { - "type": "object" - }, - "DirectWriteSet": { - "type": "object", - "required": [ - "changes", - "events" - ], - "properties": { - "changes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WriteSetChange" - } - }, - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } - } - } - }, - "Ed25519": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "Ed25519Signature": { - "type": "object", - "description": "A single Ed25519 signature", - "required": [ - "public_key", - "signature" - ], - "properties": { - "public_key": { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - "signature": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "EncodeSubmissionRequest": { - "type": "object", - "description": "Request to encode a submission", - "required": [ - "sender", - "sequence_number", - "max_gas_amount", - "gas_unit_price", - "expiration_timestamp_secs", - "payload" - ], - "properties": { - "sender": { - "$ref": "#/components/schemas/Address" - }, - "sequence_number": { - "$ref": "#/components/schemas/U64" - }, - "max_gas_amount": { - "$ref": "#/components/schemas/U64" - }, - "gas_unit_price": { - "$ref": "#/components/schemas/U64" - }, - "expiration_timestamp_secs": { - "$ref": "#/components/schemas/U64" - }, - "payload": { - "$ref": "#/components/schemas/TransactionPayload" - }, - "secondary_signers": { - "type": "array", - "description": "Secondary signer accounts of the request for Multi-agent", - "items": { - "$ref": "#/components/schemas/Address" - } - } - } - }, - "EntryFunctionId": { - "type": "string", - "description": "Entry function id is string representation of a entry function defined on-chain.\n\nFormat: `{address}::{module name}::{function name}`\n\nBoth `module name` and `function name` are case-sensitive.\n", - "example": "0x1::aptos_coin::transfer" - }, - "EntryFunctionPayload": { - "type": "object", - "description": "Payload which runs a single entry function", - "required": [ - "function", - "type_arguments", - "arguments" - ], - "properties": { - "function": { - "$ref": "#/components/schemas/EntryFunctionId" - }, - "type_arguments": { - "type": "array", - "description": "Type arguments of the function", - "items": { - "$ref": "#/components/schemas/MoveType" - } - }, - "arguments": { - "type": "array", - "description": "Arguments of the function", - "items": {} - } - } - }, - "Event": { - "type": "object", - "description": "An event from a transaction", - "required": [ - "guid", - "sequence_number", - "type", - "data" - ], - "properties": { - "guid": { - "$ref": "#/components/schemas/EventGuid" - }, - "sequence_number": { - "$ref": "#/components/schemas/U64" - }, - "type": { - "$ref": "#/components/schemas/MoveType" - }, - "data": { - "description": "The JSON representation of the event" - } - } - }, - "EventGuid": { - "type": "object", - "required": [ - "creation_number", - "account_address" - ], - "properties": { - "creation_number": { - "$ref": "#/components/schemas/U64" - }, - "account_address": { - "$ref": "#/components/schemas/Address" - } - } - }, - "ExportedAggregateSignature": { - "type": "object", - "description": "A more API-friendly representation of the on-chain `aptos_types::aggregate_signature::AggregateSignature`.", - "required": [ - "signer_indices" - ], - "properties": { - "signer_indices": { - "type": "array", - "items": { - "type": "integer", - "format": "uint64" - } - }, - "sig": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "ExportedDKGTranscript": { - "type": "object", - "required": [ - "epoch", - "author", - "payload" - ], - "properties": { - "epoch": { - "$ref": "#/components/schemas/U64" - }, - "author": { - "$ref": "#/components/schemas/Address" - }, - "payload": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "ExportedProviderJWKs": { - "type": "object", - "description": "A more API-friendly representation of the on-chain `aptos_types::jwks::ProviderJWKs`.", - "required": [ - "issuer", - "version", - "jwks" - ], - "properties": { - "issuer": { - "type": "string" - }, - "version": { - "type": "integer", - "format": "uint64" - }, - "jwks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/JWK" - } - } - } - }, - "ExportedQuorumCertifiedUpdate": { - "type": "object", - "description": "A more API-friendly representation of the on-chain `aptos_types::jwks::QuorumCertifiedUpdate`.", - "required": [ - "update", - "multi_sig" - ], - "properties": { - "update": { - "$ref": "#/components/schemas/ExportedProviderJWKs" - }, - "multi_sig": { - "$ref": "#/components/schemas/ExportedAggregateSignature" - } - } - }, - "FederatedKeyless": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "FeePayerSignature": { - "type": "object", - "description": "Fee payer signature for fee payer transactions\n\nThis allows you to have transactions across multiple accounts and with a fee payer", - "required": [ - "sender", - "secondary_signer_addresses", - "secondary_signers", - "fee_payer_address", - "fee_payer_signer" - ], - "properties": { - "sender": { - "$ref": "#/components/schemas/AccountSignature" - }, - "secondary_signer_addresses": { - "type": "array", - "description": "The other involved parties' addresses", - "items": { - "$ref": "#/components/schemas/Address" - } - }, - "secondary_signers": { - "type": "array", - "description": "The associated signatures, in the same order as the secondary addresses", - "items": { - "$ref": "#/components/schemas/AccountSignature" - } - }, - "fee_payer_address": { - "allOf": [ - { - "$ref": "#/components/schemas/Address" - }, - { - "description": "The address of the paying party" - } - ] - }, - "fee_payer_signer": { - "allOf": [ - { - "$ref": "#/components/schemas/AccountSignature" - }, - { - "description": "The signature of the fee payer" - } - ] - } - } - }, - "GasEstimation": { - "type": "object", - "description": "Struct holding the outputs of the estimate gas API", - "required": [ - "gas_estimate" - ], - "properties": { - "deprioritized_gas_estimate": { - "type": "integer", - "format": "uint64", - "description": "The deprioritized estimate for the gas unit price" - }, - "gas_estimate": { - "type": "integer", - "format": "uint64", - "description": "The current estimate for the gas unit price" - }, - "prioritized_gas_estimate": { - "type": "integer", - "format": "uint64", - "description": "The prioritized estimate for the gas unit price" - } - } - }, - "GenesisPayload": { - "type": "object", - "description": "The writeset payload of the Genesis transaction", - "oneOf": [ - { - "$ref": "#/components/schemas/GenesisPayload_WriteSetPayload" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "write_set_payload": "#/components/schemas/GenesisPayload_WriteSetPayload" - } - } - }, - "GenesisPayload_WriteSetPayload": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "write_set_payload" - ], - "example": "write_set_payload" - } - } - }, - { - "$ref": "#/components/schemas/WriteSetPayload" - } - ] - }, - "GenesisTransaction": { - "type": "object", - "description": "The genesis transaction\n\nThis only occurs at the genesis transaction (version 0)", - "required": [ - "version", - "hash", - "state_change_hash", - "event_root_hash", - "gas_used", - "success", - "vm_status", - "accumulator_root_hash", - "changes", - "payload", - "events" - ], - "properties": { - "version": { - "$ref": "#/components/schemas/U64" - }, - "hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_change_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "event_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_checkpoint_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "gas_used": { - "$ref": "#/components/schemas/U64" - }, - "success": { - "type": "boolean", - "description": "Whether the transaction was successful" - }, - "vm_status": { - "type": "string", - "description": "The VM status of the transaction, can tell useful information in a failure" - }, - "accumulator_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "changes": { - "type": "array", - "description": "Final state of resources changed by the transaction", - "items": { - "$ref": "#/components/schemas/WriteSetChange" - } - }, - "payload": { - "$ref": "#/components/schemas/GenesisPayload" - }, - "events": { - "type": "array", - "description": "Events emitted during genesis", - "items": { - "$ref": "#/components/schemas/Event" - } - } - } - }, - "HashValue": { - "type": "string" - }, - "HealthCheckSuccess": { - "type": "object", - "description": "Representation of a successful healthcheck", - "required": [ - "message" - ], - "properties": { - "message": { - "type": "string" - } - } - }, - "HexEncodedBytes": { - "type": "string", - "format": "hex", - "description": "All bytes (Vec) data is represented as hex-encoded string prefixed with `0x` and fulfilled with\ntwo hex digits per byte.\n\nUnlike the `Address` type, HexEncodedBytes will not trim any zeros.\n", - "example": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 " - }, - "IdentifierWrapper": { - "type": "string" - }, - "IndexResponse": { - "type": "object", - "description": "The struct holding all data returned to the client by the\nindex endpoint (i.e., GET \"/\"). Only for responding in JSON", - "required": [ - "chain_id", - "epoch", - "ledger_version", - "oldest_ledger_version", - "ledger_timestamp", - "node_role", - "oldest_block_height", - "block_height" - ], - "properties": { - "chain_id": { - "type": "integer", - "format": "uint8", - "description": "Chain ID of the current chain" - }, - "epoch": { - "$ref": "#/components/schemas/U64" - }, - "ledger_version": { - "$ref": "#/components/schemas/U64" - }, - "oldest_ledger_version": { - "$ref": "#/components/schemas/U64" - }, - "ledger_timestamp": { - "$ref": "#/components/schemas/U64" - }, - "node_role": { - "$ref": "#/components/schemas/RoleType" - }, - "oldest_block_height": { - "$ref": "#/components/schemas/U64" - }, - "block_height": { - "$ref": "#/components/schemas/U64" - }, - "git_hash": { - "type": "string", - "description": "Git hash of the build of the API endpoint. Can be used to determine the exact\nsoftware version used by the API endpoint." - } - } - }, - "IndexedSignature": { - "type": "object", - "required": [ - "index", - "signature" - ], - "properties": { - "index": { - "type": "integer", - "format": "uint8" - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - } - }, - "JWK": { - "type": "object", - "description": "The JWK type that can be converted from/to `JWKMoveStruct` but easier to use in rust.", - "anyOf": [ - { - "$ref": "#/components/schemas/RSA_JWK" - }, - { - "$ref": "#/components/schemas/UnsupportedJWK" - } - ] - }, - "JWKUpdateTransaction": { - "type": "object", - "required": [ - "version", - "hash", - "state_change_hash", - "event_root_hash", - "gas_used", - "success", - "vm_status", - "accumulator_root_hash", - "changes", - "events", - "timestamp", - "quorum_certified_update" - ], - "properties": { - "version": { - "$ref": "#/components/schemas/U64" - }, - "hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_change_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "event_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_checkpoint_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "gas_used": { - "$ref": "#/components/schemas/U64" - }, - "success": { - "type": "boolean", - "description": "Whether the transaction was successful" - }, - "vm_status": { - "type": "string", - "description": "The VM status of the transaction, can tell useful information in a failure" - }, - "accumulator_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "changes": { - "type": "array", - "description": "Final state of resources changed by the transaction", - "items": { - "$ref": "#/components/schemas/WriteSetChange" - } - }, - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - } - }, - "timestamp": { - "$ref": "#/components/schemas/U64" - }, - "quorum_certified_update": { - "$ref": "#/components/schemas/ExportedQuorumCertifiedUpdate" - } - } - }, - "Keyless": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "MoveAbility": { - "type": "string" - }, - "MoveFunction": { - "type": "object", - "description": "Move function", - "required": [ - "name", - "visibility", - "is_entry", - "is_view", - "generic_type_params", - "params", - "return" - ], - "properties": { - "name": { - "$ref": "#/components/schemas/IdentifierWrapper" - }, - "visibility": { - "$ref": "#/components/schemas/MoveFunctionVisibility" - }, - "is_entry": { - "type": "boolean", - "description": "Whether the function can be called as an entry function directly in a transaction" - }, - "is_view": { - "type": "boolean", - "description": "Whether the function is a view function or not" - }, - "generic_type_params": { - "type": "array", - "description": "Generic type params associated with the Move function", - "items": { - "$ref": "#/components/schemas/MoveFunctionGenericTypeParam" - } - }, - "params": { - "type": "array", - "description": "Parameters associated with the move function", - "items": { - "$ref": "#/components/schemas/MoveType" - } - }, - "return": { - "type": "array", - "description": "Return type of the function", - "items": { - "$ref": "#/components/schemas/MoveType" - } - } - } - }, - "MoveFunctionGenericTypeParam": { - "type": "object", - "description": "Move function generic type param", - "required": [ - "constraints" - ], - "properties": { - "constraints": { - "type": "array", - "description": "Move abilities tied to the generic type param and associated with the function that uses it", - "items": { - "$ref": "#/components/schemas/MoveAbility" - } - } - } - }, - "MoveFunctionVisibility": { - "type": "string", - "description": "Move function visibility", - "enum": [ - "private", - "public", - "friend" - ] - }, - "MoveModule": { - "type": "object", - "description": "A Move module", - "required": [ - "address", - "name", - "friends", - "exposed_functions", - "structs" - ], - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "name": { - "$ref": "#/components/schemas/IdentifierWrapper" - }, - "friends": { - "type": "array", - "description": "Friends of the module", - "items": { - "$ref": "#/components/schemas/MoveModuleId" - } - }, - "exposed_functions": { - "type": "array", - "description": "Public functions of the module", - "items": { - "$ref": "#/components/schemas/MoveFunction" - } - }, - "structs": { - "type": "array", - "description": "Structs of the module", - "items": { - "$ref": "#/components/schemas/MoveStruct" - } - } - } - }, - "MoveModuleBytecode": { - "type": "object", - "description": "Move module bytecode along with it's ABI", - "required": [ - "bytecode" - ], - "properties": { - "bytecode": { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - "abi": { - "$ref": "#/components/schemas/MoveModule" - } - } - }, - "MoveModuleId": { - "type": "string", - "description": "Move module id is a string representation of Move module.\n\nFormat: `{address}::{module name}`\n\n`address` should be hex-encoded 32 byte account address that is prefixed with `0x`.\n\nModule name is case-sensitive.\n", - "example": "0x1::aptos_coin" - }, - "MoveResource": { - "type": "object", - "description": "A parsed Move resource", - "required": [ - "type", - "data" - ], - "properties": { - "type": { - "$ref": "#/components/schemas/MoveStructTag" - }, - "data": { - "$ref": "#/components/schemas/MoveStructValue" - } - } - }, - "MoveScriptBytecode": { - "type": "object", - "description": "Move script bytecode", - "required": [ - "bytecode" - ], - "properties": { - "bytecode": { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - "abi": { - "$ref": "#/components/schemas/MoveFunction" - } - } - }, - "MoveStruct": { - "type": "object", - "description": "A move struct", - "required": [ - "name", - "is_native", - "is_event", - "abilities", - "generic_type_params", - "fields" - ], - "properties": { - "name": { - "$ref": "#/components/schemas/IdentifierWrapper" - }, - "is_native": { - "type": "boolean", - "description": "Whether the struct is a native struct of Move" - }, - "is_event": { - "type": "boolean", - "description": "Whether the struct is marked with the #[event] annotation" - }, - "abilities": { - "type": "array", - "description": "Abilities associated with the struct", - "items": { - "$ref": "#/components/schemas/MoveAbility" - } - }, - "generic_type_params": { - "type": "array", - "description": "Generic types associated with the struct", - "items": { - "$ref": "#/components/schemas/MoveStructGenericTypeParam" - } - }, - "fields": { - "type": "array", - "description": "Fields associated with the struct", - "items": { - "$ref": "#/components/schemas/MoveStructField" - } - } - } - }, - "MoveStructField": { - "type": "object", - "description": "Move struct field", - "required": [ - "name", - "type" - ], - "properties": { - "name": { - "$ref": "#/components/schemas/IdentifierWrapper" - }, - "type": { - "$ref": "#/components/schemas/MoveType" - } - } - }, - "MoveStructGenericTypeParam": { - "type": "object", - "description": "Move generic type param", - "required": [ - "constraints" - ], - "properties": { - "constraints": { - "type": "array", - "description": "Move abilities tied to the generic type param and associated with the type that uses it", - "items": { - "$ref": "#/components/schemas/MoveAbility" - } - } - } - }, - "MoveStructTag": { - "type": "string", - "description": "String representation of a MoveStructTag (on-chain Move struct type). This exists so you\ncan specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.\n\nIt is a combination of:\n 1. `move_module_address`, `module_name` and `struct_name`, all joined by `::`\n 2. `struct generic type parameters` joined by `, `\n\nExamples:\n * `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>`\n * `0x1::account::Account`\n\nNote:\n 1. Empty chars should be ignored when comparing 2 struct tag ids.\n 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).\n\nSee [doc](https://aptos.dev/concepts/accounts) for more details.\n", - "example": "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>", - "pattern": "^0x[0-9a-zA-Z:_<>]+$" - }, - "MoveStructValue": { - "type": "object", - "description": "This is a JSON representation of some data within an account resource. More specifically,\nit is a map of strings to arbitrary JSON values / objects, where the keys are top level\nfields within the given resource.\n\nTo clarify, you might query for 0x1::account::Account and see the example data.\n\nMove `bool` type value is serialized into `boolean`.\n\nMove `u8`, `u16` and `u32` type value is serialized into `integer`.\n\nMove `u64`, `u128` and `u256` type value is serialized into `string`.\n\nMove `address` type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.\nFor example:\n - `0x1`\n - `0x1668f6be25668c1a17cd8caf6b8d2f25`\n\nMove `vector` type value is serialized into `array`, except `vector` which is serialized into a\nHexEncodedBytes string with `0x` prefix.\nFor example:\n - `vector{255, 255}` => `[\"255\", \"255\"]`\n - `vector{255, 255}` => `0xffff`\n\nMove `struct` type value is serialized into `object` that looks like this (except some Move stdlib types, see the following section):\n ```json\n {\n field1_name: field1_value,\n field2_name: field2_value,\n ......\n }\n ```\n\nFor example:\n `{ \"created\": \"0xa550c18\", \"role_id\": \"0\" }`\n\n**Special serialization for Move stdlib types**:\n - [0x1::string::String](https://github.com/aptos-labs/aptos-core/blob/main/language/move-stdlib/docs/ascii.md)\n is serialized into `string`. For example, struct value `0x1::string::String{bytes: b\"Hello World!\"}`\n is serialized as `\"Hello World!\"` in JSON.\n", - "example": { - "authentication_key": "0x0000000000000000000000000000000000000000000000000000000000000001", - "coin_register_events": { - "counter": "0", - "guid": { - "id": { - "addr": "0x1", - "creation_num": "0" - } - } - }, - "self_address": "0x1", - "sequence_number": "0" - } - }, - "MoveType": { - "type": "string", - "description": "String representation of an on-chain Move type tag that is exposed in transaction payload.\n Values:\n - bool\n - u8\n - u16\n - u32\n - u64\n - u128\n - u256\n - address\n - signer\n - vector: `vector<{non-reference MoveTypeId}>`\n - struct: `{address}::{module_name}::{struct_name}::<{generic types}>`\n\n Vector type value examples:\n - `vector`\n - `vector>`\n - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`\n\n Struct type value examples:\n - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>\n - `0x1::account::Account`\n\n Note:\n 1. Empty chars should be ignored when comparing 2 struct tag ids.\n 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).\n", - "pattern": "^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$" - }, - "MoveValue": { - "type": "object", - "description": "An enum of the possible Move value types", - "anyOf": [ - { - "type": "integer", - "format": "uint8" - }, - { - "type": "integer", - "format": "uint16" - }, - { - "type": "integer", - "format": "uint32" - }, - { - "$ref": "#/components/schemas/U64" - }, - { - "$ref": "#/components/schemas/U128" - }, - { - "$ref": "#/components/schemas/U256" - }, - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/Address" - }, - { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - { - "$ref": "#/components/schemas/MoveStructValue" - }, - { - "type": "string" - } - ] - }, - "MultiAgentSignature": { - "type": "object", - "description": "Multi agent signature for multi agent transactions\n\nThis allows you to have transactions across multiple accounts", - "required": [ - "sender", - "secondary_signer_addresses", - "secondary_signers" - ], - "properties": { - "sender": { - "$ref": "#/components/schemas/AccountSignature" - }, - "secondary_signer_addresses": { - "type": "array", - "description": "The other involved parties' addresses", - "items": { - "$ref": "#/components/schemas/Address" - } - }, - "secondary_signers": { - "type": "array", - "description": "The associated signatures, in the same order as the secondary addresses", - "items": { - "$ref": "#/components/schemas/AccountSignature" - } - } - } - }, - "MultiEd25519Signature": { - "type": "object", - "description": "A Ed25519 multi-sig signature\n\nThis allows k-of-n signing for a transaction", - "required": [ - "public_keys", - "signatures", - "threshold", - "bitmap" - ], - "properties": { - "public_keys": { - "type": "array", - "description": "The public keys for the Ed25519 signature", - "items": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - }, - "signatures": { - "type": "array", - "description": "Signature associated with the public keys in the same order", - "items": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - }, - "threshold": { - "type": "integer", - "format": "uint8", - "description": "The number of signatures required for a successful transaction" - }, - "bitmap": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "MultiKeySignature": { - "type": "object", - "description": "A multi key signature", - "required": [ - "public_keys", - "signatures", - "signatures_required" - ], - "properties": { - "public_keys": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PublicKey" - } - }, - "signatures": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IndexedSignature" - } - }, - "signatures_required": { - "type": "integer", - "format": "uint8" - } - } - }, - "MultisigPayload": { - "type": "object", - "description": "A multisig transaction that allows an owner of a multisig account to execute a pre-approved\ntransaction as the multisig account.", - "required": [ - "multisig_address" - ], - "properties": { - "multisig_address": { - "$ref": "#/components/schemas/Address" - }, - "transaction_payload": { - "$ref": "#/components/schemas/MultisigTransactionPayload" - } - } - }, - "MultisigTransactionPayload": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/MultisigTransactionPayload_EntryFunctionPayload" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "entry_function_payload": "#/components/schemas/MultisigTransactionPayload_EntryFunctionPayload" - } - } - }, - "MultisigTransactionPayload_EntryFunctionPayload": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "entry_function_payload" - ], - "example": "entry_function_payload" - } - } - }, - { - "$ref": "#/components/schemas/EntryFunctionPayload" - } - ] - }, - "NoAccountSignature": { - "type": "object", - "description": "A placeholder to represent the absence of account signature" - }, - "PendingTransaction": { - "type": "object", - "description": "A transaction waiting in mempool", - "required": [ - "hash", - "sender", - "sequence_number", - "max_gas_amount", - "gas_unit_price", - "expiration_timestamp_secs", - "payload" - ], - "properties": { - "hash": { - "$ref": "#/components/schemas/HashValue" - }, - "sender": { - "$ref": "#/components/schemas/Address" - }, - "sequence_number": { - "$ref": "#/components/schemas/U64" - }, - "max_gas_amount": { - "$ref": "#/components/schemas/U64" - }, - "gas_unit_price": { - "$ref": "#/components/schemas/U64" - }, - "expiration_timestamp_secs": { - "$ref": "#/components/schemas/U64" - }, - "payload": { - "$ref": "#/components/schemas/TransactionPayload" - }, - "signature": { - "$ref": "#/components/schemas/TransactionSignature" - } - } - }, - "PublicKey": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/PublicKey_Ed25519" - }, - { - "$ref": "#/components/schemas/PublicKey_Secp256k1Ecdsa" - }, - { - "$ref": "#/components/schemas/PublicKey_Secp256r1Ecdsa" - }, - { - "$ref": "#/components/schemas/PublicKey_Keyless" - }, - { - "$ref": "#/components/schemas/PublicKey_FederatedKeyless" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "ed25519": "#/components/schemas/PublicKey_Ed25519", - "secp256k1_ecdsa": "#/components/schemas/PublicKey_Secp256k1Ecdsa", - "secp256r1_ecdsa": "#/components/schemas/PublicKey_Secp256r1Ecdsa", - "keyless": "#/components/schemas/PublicKey_Keyless", - "federated_keyless": "#/components/schemas/PublicKey_FederatedKeyless" - } - } - }, - "PublicKey_Ed25519": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "ed25519" - ], - "example": "ed25519" - } - } - }, - { - "$ref": "#/components/schemas/Ed25519" - } - ] - }, - "PublicKey_FederatedKeyless": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "federated_keyless" - ], - "example": "federated_keyless" - } - } - }, - { - "$ref": "#/components/schemas/FederatedKeyless" - } - ] - }, - "PublicKey_Keyless": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "keyless" - ], - "example": "keyless" - } - } - }, - { - "$ref": "#/components/schemas/Keyless" - } - ] - }, - "PublicKey_Secp256k1Ecdsa": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "secp256k1_ecdsa" - ], - "example": "secp256k1_ecdsa" - } - } - }, - { - "$ref": "#/components/schemas/Secp256k1Ecdsa" - } - ] - }, - "PublicKey_Secp256r1Ecdsa": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "secp256r1_ecdsa" - ], - "example": "secp256r1_ecdsa" - } - } - }, - { - "$ref": "#/components/schemas/Secp256r1Ecdsa" - } - ] - }, - "RSA_JWK": { - "type": "object", - "description": "Move type `0x1::jwks::RSA_JWK` in rust.\nSee its doc in Move for more details.", - "required": [ - "kid", - "kty", - "alg", - "e", - "n" - ], - "properties": { - "kid": { - "type": "string" - }, - "kty": { - "type": "string" - }, - "alg": { - "type": "string" - }, - "e": { - "type": "string" - }, - "n": { - "type": "string" - } - } - }, - "RawTableItemRequest": { - "type": "object", - "description": "Table Item request for the GetTableItemRaw API", - "required": [ - "key" - ], - "properties": { - "key": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "RoleType": { - "type": "string", - "enum": [ - "validator", - "full_node" - ] - }, - "ScriptPayload": { - "type": "object", - "description": "Payload which runs a script that can run multiple functions", - "required": [ - "code", - "type_arguments", - "arguments" - ], - "properties": { - "code": { - "$ref": "#/components/schemas/MoveScriptBytecode" - }, - "type_arguments": { - "type": "array", - "description": "Type arguments of the function", - "items": { - "$ref": "#/components/schemas/MoveType" - } - }, - "arguments": { - "type": "array", - "description": "Arguments of the function", - "items": {} - } - } - }, - "ScriptWriteSet": { - "type": "object", - "required": [ - "execute_as", - "script" - ], - "properties": { - "execute_as": { - "$ref": "#/components/schemas/Address" - }, - "script": { - "$ref": "#/components/schemas/ScriptPayload" - } - } - }, - "Secp256k1Ecdsa": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "Secp256r1Ecdsa": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "Signature": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/Signature_Ed25519" - }, - { - "$ref": "#/components/schemas/Signature_Secp256k1Ecdsa" - }, - { - "$ref": "#/components/schemas/Signature_WebAuthn" - }, - { - "$ref": "#/components/schemas/Signature_Keyless" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "ed25519": "#/components/schemas/Signature_Ed25519", - "secp256k1_ecdsa": "#/components/schemas/Signature_Secp256k1Ecdsa", - "web_authn": "#/components/schemas/Signature_WebAuthn", - "keyless": "#/components/schemas/Signature_Keyless" - } - } - }, - "Signature_Ed25519": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "ed25519" - ], - "example": "ed25519" - } - } - }, - { - "$ref": "#/components/schemas/Ed25519" - } - ] - }, - "Signature_Keyless": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "keyless" - ], - "example": "keyless" - } - } - }, - { - "$ref": "#/components/schemas/Keyless" - } - ] - }, - "Signature_Secp256k1Ecdsa": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "secp256k1_ecdsa" - ], - "example": "secp256k1_ecdsa" - } - } - }, - { - "$ref": "#/components/schemas/Secp256k1Ecdsa" - } - ] - }, - "Signature_WebAuthn": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "web_authn" - ], - "example": "web_authn" - } - } - }, - { - "$ref": "#/components/schemas/WebAuthn" - } - ] - }, - "SingleKeySignature": { - "type": "object", - "description": "A single key signature", - "required": [ - "public_key", - "signature" - ], - "properties": { - "public_key": { - "$ref": "#/components/schemas/PublicKey" - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - } - }, - "StateCheckpointTransaction": { - "type": "object", - "description": "A state checkpoint transaction", - "required": [ - "version", - "hash", - "state_change_hash", - "event_root_hash", - "gas_used", - "success", - "vm_status", - "accumulator_root_hash", - "changes", - "timestamp" - ], - "properties": { - "version": { - "$ref": "#/components/schemas/U64" - }, - "hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_change_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "event_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_checkpoint_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "gas_used": { - "$ref": "#/components/schemas/U64" - }, - "success": { - "type": "boolean", - "description": "Whether the transaction was successful" - }, - "vm_status": { - "type": "string", - "description": "The VM status of the transaction, can tell useful information in a failure" - }, - "accumulator_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "changes": { - "type": "array", - "description": "Final state of resources changed by the transaction", - "items": { - "$ref": "#/components/schemas/WriteSetChange" - } - }, - "timestamp": { - "$ref": "#/components/schemas/U64" - } - } - }, - "StateKeyWrapper": { - "type": "string", - "description": "Representation of a StateKey as a hex string. This is used for cursor based pagination.\n", - "example": "0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879" - }, - "SubmitTransactionRequest": { - "type": "object", - "description": "A request to submit a transaction\n\nThis requires a transaction and a signature of it", - "required": [ - "sender", - "sequence_number", - "max_gas_amount", - "gas_unit_price", - "expiration_timestamp_secs", - "payload", - "signature" - ], - "properties": { - "sender": { - "$ref": "#/components/schemas/Address" - }, - "sequence_number": { - "$ref": "#/components/schemas/U64" - }, - "max_gas_amount": { - "$ref": "#/components/schemas/U64" - }, - "gas_unit_price": { - "$ref": "#/components/schemas/U64" - }, - "expiration_timestamp_secs": { - "$ref": "#/components/schemas/U64" - }, - "payload": { - "$ref": "#/components/schemas/TransactionPayload" - }, - "signature": { - "$ref": "#/components/schemas/TransactionSignature" - } - } - }, - "TableItemRequest": { - "type": "object", - "description": "Table Item request for the GetTableItem API", - "required": [ - "key_type", - "value_type", - "key" - ], - "properties": { - "key_type": { - "$ref": "#/components/schemas/MoveType" - }, - "value_type": { - "$ref": "#/components/schemas/MoveType" - }, - "key": { - "description": "The value of the table item's key" - } - } - }, - "Transaction": { - "type": "object", - "description": "Enum of the different types of transactions in Aptos", - "oneOf": [ - { - "$ref": "#/components/schemas/Transaction_PendingTransaction" - }, - { - "$ref": "#/components/schemas/Transaction_UserTransaction" - }, - { - "$ref": "#/components/schemas/Transaction_GenesisTransaction" - }, - { - "$ref": "#/components/schemas/Transaction_BlockMetadataTransaction" - }, - { - "$ref": "#/components/schemas/Transaction_StateCheckpointTransaction" - }, - { - "$ref": "#/components/schemas/Transaction_BlockEpilogueTransaction" - }, - { - "$ref": "#/components/schemas/Transaction_ValidatorTransaction" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "pending_transaction": "#/components/schemas/Transaction_PendingTransaction", - "user_transaction": "#/components/schemas/Transaction_UserTransaction", - "genesis_transaction": "#/components/schemas/Transaction_GenesisTransaction", - "block_metadata_transaction": "#/components/schemas/Transaction_BlockMetadataTransaction", - "state_checkpoint_transaction": "#/components/schemas/Transaction_StateCheckpointTransaction", - "block_epilogue_transaction": "#/components/schemas/Transaction_BlockEpilogueTransaction", - "validator_transaction": "#/components/schemas/Transaction_ValidatorTransaction" - } - } - }, - "TransactionPayload": { - "type": "object", - "description": "An enum of the possible transaction payloads", - "oneOf": [ - { - "$ref": "#/components/schemas/TransactionPayload_EntryFunctionPayload" - }, - { - "$ref": "#/components/schemas/TransactionPayload_ScriptPayload" - }, - { - "$ref": "#/components/schemas/TransactionPayload_DeprecatedModuleBundlePayload" - }, - { - "$ref": "#/components/schemas/TransactionPayload_MultisigPayload" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "entry_function_payload": "#/components/schemas/TransactionPayload_EntryFunctionPayload", - "script_payload": "#/components/schemas/TransactionPayload_ScriptPayload", - "module_bundle_payload": "#/components/schemas/TransactionPayload_DeprecatedModuleBundlePayload", - "multisig_payload": "#/components/schemas/TransactionPayload_MultisigPayload" - } - } - }, - "TransactionPayload_DeprecatedModuleBundlePayload": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "module_bundle_payload" - ], - "example": "module_bundle_payload" - } - } - }, - { - "$ref": "#/components/schemas/DeprecatedModuleBundlePayload" - } - ] - }, - "TransactionPayload_EntryFunctionPayload": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "entry_function_payload" - ], - "example": "entry_function_payload" - } - } - }, - { - "$ref": "#/components/schemas/EntryFunctionPayload" - } - ] - }, - "TransactionPayload_MultisigPayload": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "multisig_payload" - ], - "example": "multisig_payload" - } - } - }, - { - "$ref": "#/components/schemas/MultisigPayload" - } - ] - }, - "TransactionPayload_ScriptPayload": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "script_payload" - ], - "example": "script_payload" - } - } - }, - { - "$ref": "#/components/schemas/ScriptPayload" - } - ] - }, - "TransactionSignature": { - "type": "object", - "description": "An enum representing the different transaction signatures available", - "oneOf": [ - { - "$ref": "#/components/schemas/TransactionSignature_Ed25519Signature" - }, - { - "$ref": "#/components/schemas/TransactionSignature_MultiEd25519Signature" - }, - { - "$ref": "#/components/schemas/TransactionSignature_MultiAgentSignature" - }, - { - "$ref": "#/components/schemas/TransactionSignature_FeePayerSignature" - }, - { - "$ref": "#/components/schemas/TransactionSignature_AccountSignature" - }, - { - "$ref": "#/components/schemas/TransactionSignature_NoAccountSignature" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "ed25519_signature": "#/components/schemas/TransactionSignature_Ed25519Signature", - "multi_ed25519_signature": "#/components/schemas/TransactionSignature_MultiEd25519Signature", - "multi_agent_signature": "#/components/schemas/TransactionSignature_MultiAgentSignature", - "fee_payer_signature": "#/components/schemas/TransactionSignature_FeePayerSignature", - "single_sender": "#/components/schemas/TransactionSignature_AccountSignature", - "no_account_signature": "#/components/schemas/TransactionSignature_NoAccountSignature" - } - } - }, - "TransactionSignature_AccountSignature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "single_sender" - ], - "example": "single_sender" - } - } - }, - { - "$ref": "#/components/schemas/AccountSignature" - } - ] - }, - "TransactionSignature_Ed25519Signature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "ed25519_signature" - ], - "example": "ed25519_signature" - } - } - }, - { - "$ref": "#/components/schemas/Ed25519Signature" - } - ] - }, - "TransactionSignature_FeePayerSignature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "fee_payer_signature" - ], - "example": "fee_payer_signature" - } - } - }, - { - "$ref": "#/components/schemas/FeePayerSignature" - } - ] - }, - "TransactionSignature_MultiAgentSignature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "multi_agent_signature" - ], - "example": "multi_agent_signature" - } - } - }, - { - "$ref": "#/components/schemas/MultiAgentSignature" - } - ] - }, - "TransactionSignature_MultiEd25519Signature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "multi_ed25519_signature" - ], - "example": "multi_ed25519_signature" - } - } - }, - { - "$ref": "#/components/schemas/MultiEd25519Signature" - } - ] - }, - "TransactionSignature_NoAccountSignature": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "no_account_signature" - ], - "example": "no_account_signature" - } - } - }, - { - "$ref": "#/components/schemas/NoAccountSignature" - } - ] - }, - "Transaction_BlockEpilogueTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "block_epilogue_transaction" - ], - "example": "block_epilogue_transaction" - } - } - }, - { - "$ref": "#/components/schemas/BlockEpilogueTransaction" - } - ] - }, - "Transaction_BlockMetadataTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "block_metadata_transaction" - ], - "example": "block_metadata_transaction" - } - } - }, - { - "$ref": "#/components/schemas/BlockMetadataTransaction" - } - ] - }, - "Transaction_GenesisTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "genesis_transaction" - ], - "example": "genesis_transaction" - } - } - }, - { - "$ref": "#/components/schemas/GenesisTransaction" - } - ] - }, - "Transaction_PendingTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pending_transaction" - ], - "example": "pending_transaction" - } - } - }, - { - "$ref": "#/components/schemas/PendingTransaction" - } - ] - }, - "Transaction_StateCheckpointTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "state_checkpoint_transaction" - ], - "example": "state_checkpoint_transaction" - } - } - }, - { - "$ref": "#/components/schemas/StateCheckpointTransaction" - } - ] - }, - "Transaction_UserTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "user_transaction" - ], - "example": "user_transaction" - } - } - }, - { - "$ref": "#/components/schemas/UserTransaction" - } - ] - }, - "Transaction_ValidatorTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "validator_transaction" - ], - "example": "validator_transaction" - } - } - }, - { - "$ref": "#/components/schemas/ValidatorTransaction" - } - ] - }, - "TransactionsBatchSingleSubmissionFailure": { - "type": "object", - "description": "Information telling which batch submission transactions failed", - "required": [ - "error", - "transaction_index" - ], - "properties": { - "error": { - "$ref": "#/components/schemas/AptosError" - }, - "transaction_index": { - "type": "integer", - "format": "uint64", - "description": "The index of which transaction failed, same as submission order" - } - } - }, - "TransactionsBatchSubmissionResult": { - "type": "object", - "description": "Batch transaction submission result\n\nTells which transactions failed", - "required": [ - "transaction_failures" - ], - "properties": { - "transaction_failures": { - "type": "array", - "description": "Summary of the failed transactions", - "items": { - "$ref": "#/components/schemas/TransactionsBatchSingleSubmissionFailure" - } - } - } - }, - "U128": { - "type": "string", - "format": "uint128", - "description": "A string containing a 128-bit unsigned integer.\n\nWe represent u128 values as a string to ensure compatibility with languages such\nas JavaScript that do not parse u128s in JSON natively.\n", - "example": "340282366920938463463374607431768211454" - }, - "U256": { - "type": "string", - "format": "uint256", - "description": "A string containing a 256-bit unsigned integer.\n\nWe represent u256 values as a string to ensure compatibility with languages such\nas JavaScript that do not parse u256s in JSON natively.\n", - "example": "340282366920938463463374607431768211454" - }, - "U64": { - "type": "string", - "format": "uint64", - "description": "A string containing a 64-bit unsigned integer.\n\nWe represent u64 values as a string to ensure compatibility with languages such\nas JavaScript that do not parse u64s in JSON natively.\n", - "example": "32425224034" - }, - "UnsupportedJWK": { - "type": "object", - "description": "Move type `0x1::jwks::UnsupportedJWK` in rust.\nSee its doc in Move for more details.", - "required": [ - "id", - "payload" - ], - "properties": { - "id": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - }, - "payload": { - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - } - } - }, - "UserTransaction": { - "type": "object", - "description": "A transaction submitted by a user to change the state of the blockchain", - "required": [ - "version", - "hash", - "state_change_hash", - "event_root_hash", - "gas_used", - "success", - "vm_status", - "accumulator_root_hash", - "changes", - "sender", - "sequence_number", - "max_gas_amount", - "gas_unit_price", - "expiration_timestamp_secs", - "payload", - "events", - "timestamp" - ], - "properties": { - "version": { - "$ref": "#/components/schemas/U64" - }, - "hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_change_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "event_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "state_checkpoint_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "gas_used": { - "$ref": "#/components/schemas/U64" - }, - "success": { - "type": "boolean", - "description": "Whether the transaction was successful" - }, - "vm_status": { - "type": "string", - "description": "The VM status of the transaction, can tell useful information in a failure" - }, - "accumulator_root_hash": { - "$ref": "#/components/schemas/HashValue" - }, - "changes": { - "type": "array", - "description": "Final state of resources changed by the transaction", - "items": { - "$ref": "#/components/schemas/WriteSetChange" - } - }, - "sender": { - "$ref": "#/components/schemas/Address" - }, - "sequence_number": { - "$ref": "#/components/schemas/U64" - }, - "max_gas_amount": { - "$ref": "#/components/schemas/U64" - }, - "gas_unit_price": { - "$ref": "#/components/schemas/U64" - }, - "expiration_timestamp_secs": { - "$ref": "#/components/schemas/U64" - }, - "payload": { - "$ref": "#/components/schemas/TransactionPayload" - }, - "signature": { - "$ref": "#/components/schemas/TransactionSignature" - }, - "events": { - "type": "array", - "description": "Events generated by the transaction", - "items": { - "$ref": "#/components/schemas/Event" - } - }, - "timestamp": { - "$ref": "#/components/schemas/U64" - } - } - }, - "ValidatorTransaction": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/ValidatorTransaction_JWKUpdateTransaction" - }, - { - "$ref": "#/components/schemas/ValidatorTransaction_DKGResultTransaction" - } - ], - "discriminator": { - "propertyName": "validator_transaction_type", - "mapping": { - "observed_jwk_update": "#/components/schemas/ValidatorTransaction_JWKUpdateTransaction", - "dkg_result": "#/components/schemas/ValidatorTransaction_DKGResultTransaction" - } - } - }, - "ValidatorTransaction_DKGResultTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "validator_transaction_type" - ], - "properties": { - "validator_transaction_type": { - "type": "string", - "enum": [ - "dkg_result" - ], - "example": "dkg_result" - } - } - }, - { - "$ref": "#/components/schemas/DKGResultTransaction" - } - ] - }, - "ValidatorTransaction_JWKUpdateTransaction": { - "allOf": [ - { - "type": "object", - "required": [ - "validator_transaction_type" - ], - "properties": { - "validator_transaction_type": { - "type": "string", - "enum": [ - "observed_jwk_update" - ], - "example": "observed_jwk_update" - } - } - }, - { - "$ref": "#/components/schemas/JWKUpdateTransaction" - } - ] - }, - "VersionedEvent": { - "type": "object", - "description": "An event from a transaction with a version", - "required": [ - "version", - "guid", - "sequence_number", - "type", - "data" - ], - "properties": { - "version": { - "$ref": "#/components/schemas/U64" - }, - "guid": { - "$ref": "#/components/schemas/EventGuid" - }, - "sequence_number": { - "$ref": "#/components/schemas/U64" - }, - "type": { - "$ref": "#/components/schemas/MoveType" - }, - "data": { - "description": "The JSON representation of the event" - } - } - }, - "ViewRequest": { - "type": "object", - "description": "View request for the Move View Function API", - "required": [ - "function", - "type_arguments", - "arguments" - ], - "properties": { - "function": { - "$ref": "#/components/schemas/EntryFunctionId" - }, - "type_arguments": { - "type": "array", - "description": "Type arguments of the function", - "items": { - "$ref": "#/components/schemas/MoveType" - } - }, - "arguments": { - "type": "array", - "description": "Arguments of the function", - "items": {} - } - } - }, - "WebAuthn": { - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "$ref": "#/components/schemas/HexEncodedBytes" - } - } - }, - "WriteModule": { - "type": "object", - "description": "Write a new module or update an existing one", - "required": [ - "address", - "state_key_hash", - "data" - ], - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "state_key_hash": { - "type": "string", - "description": "State key hash" - }, - "data": { - "$ref": "#/components/schemas/MoveModuleBytecode" - } - } - }, - "WriteResource": { - "type": "object", - "description": "Write a resource or update an existing one", - "required": [ - "address", - "state_key_hash", - "data" - ], - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "state_key_hash": { - "type": "string", - "description": "State key hash" - }, - "data": { - "$ref": "#/components/schemas/MoveResource" - } - } - }, - "WriteSet": { - "type": "object", - "description": "The associated writeset with a payload", - "oneOf": [ - { - "$ref": "#/components/schemas/WriteSet_ScriptWriteSet" - }, - { - "$ref": "#/components/schemas/WriteSet_DirectWriteSet" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "script_write_set": "#/components/schemas/WriteSet_ScriptWriteSet", - "direct_write_set": "#/components/schemas/WriteSet_DirectWriteSet" - } - } - }, - "WriteSetChange": { - "type": "object", - "description": "A final state change of a transaction on a resource or module", - "oneOf": [ - { - "$ref": "#/components/schemas/WriteSetChange_DeleteModule" - }, - { - "$ref": "#/components/schemas/WriteSetChange_DeleteResource" - }, - { - "$ref": "#/components/schemas/WriteSetChange_DeleteTableItem" - }, - { - "$ref": "#/components/schemas/WriteSetChange_WriteModule" - }, - { - "$ref": "#/components/schemas/WriteSetChange_WriteResource" - }, - { - "$ref": "#/components/schemas/WriteSetChange_WriteTableItem" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "delete_module": "#/components/schemas/WriteSetChange_DeleteModule", - "delete_resource": "#/components/schemas/WriteSetChange_DeleteResource", - "delete_table_item": "#/components/schemas/WriteSetChange_DeleteTableItem", - "write_module": "#/components/schemas/WriteSetChange_WriteModule", - "write_resource": "#/components/schemas/WriteSetChange_WriteResource", - "write_table_item": "#/components/schemas/WriteSetChange_WriteTableItem" - } - } - }, - "WriteSetChange_DeleteModule": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "delete_module" - ], - "example": "delete_module" - } - } - }, - { - "$ref": "#/components/schemas/DeleteModule" - } - ] - }, - "WriteSetChange_DeleteResource": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "delete_resource" - ], - "example": "delete_resource" - } - } - }, - { - "$ref": "#/components/schemas/DeleteResource" - } - ] - }, - "WriteSetChange_DeleteTableItem": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "delete_table_item" - ], - "example": "delete_table_item" - } - } - }, - { - "$ref": "#/components/schemas/DeleteTableItem" - } - ] - }, - "WriteSetChange_WriteModule": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "write_module" - ], - "example": "write_module" - } - } - }, - { - "$ref": "#/components/schemas/WriteModule" - } - ] - }, - "WriteSetChange_WriteResource": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "write_resource" - ], - "example": "write_resource" - } - } - }, - { - "$ref": "#/components/schemas/WriteResource" - } - ] - }, - "WriteSetChange_WriteTableItem": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "write_table_item" - ], - "example": "write_table_item" - } - } - }, - { - "$ref": "#/components/schemas/WriteTableItem" - } - ] - }, - "WriteSetPayload": { - "type": "object", - "description": "A writeset payload, used only for genesis", - "required": [ - "write_set" - ], - "properties": { - "write_set": { - "$ref": "#/components/schemas/WriteSet" - } - } - }, - "WriteSet_DirectWriteSet": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "direct_write_set" - ], - "example": "direct_write_set" - } - } - }, - { - "$ref": "#/components/schemas/DirectWriteSet" - } - ] - }, - "WriteSet_ScriptWriteSet": { - "allOf": [ - { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "script_write_set" - ], - "example": "script_write_set" - } - } - }, - { - "$ref": "#/components/schemas/ScriptWriteSet" - } - ] - }, - "WriteTableItem": { - "type": "object", - "description": "Change set to write a table item", - "required": [ - "state_key_hash", - "handle", - "key", - "value" - ], - "properties": { - "state_key_hash": { - "type": "string" - }, - "handle": { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - "key": { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - "value": { - "$ref": "#/components/schemas/HexEncodedBytes" - }, - "data": { - "$ref": "#/components/schemas/DecodedTableData" - } - } - } - } - }, - "externalDocs": { - "url": "https://github.com/aptos-labs/aptos-core" - } -} \ No newline at end of file diff --git a/src/components/OpenAPI/operation/OperationExamples/OperationScalarModal.astro b/src/components/OpenAPI/operation/OperationExamples/OperationScalarModal.astro index e7c665e5..e16aae79 100644 --- a/src/components/OpenAPI/operation/OperationExamples/OperationScalarModal.astro +++ b/src/components/OpenAPI/operation/OperationExamples/OperationScalarModal.astro @@ -56,7 +56,7 @@ import "@scalar/api-client/style.css"; const { open } = await createApiClientModal({ el: scalarContainer, configuration: { - url: "/aptos-spec.json", + url: "https://raw.githubusercontent.com/aptos-labs/aptos-core/refs/heads/main/api/doc/spec.json", servers, showSidebar: false, hideClientButton: true, diff --git a/src/components/OpenAPI/schema/SchemaObject.astro b/src/components/OpenAPI/schema/SchemaObject.astro index 882deaa9..b74f017a 100644 --- a/src/components/OpenAPI/schema/SchemaObject.astro +++ b/src/components/OpenAPI/schema/SchemaObject.astro @@ -33,7 +33,13 @@ const hasMany = schemaObjects !== undefined; { hasMany ? ( - + ) : isSchemaObject(schemaObject.not) ? ( ) : ( diff --git a/src/components/OpenAPI/schema/SchemaObjectAllOf.astro b/src/components/OpenAPI/schema/SchemaObjectAllOf.astro index 34613029..718c3798 100644 --- a/src/components/OpenAPI/schema/SchemaObjectAllOf.astro +++ b/src/components/OpenAPI/schema/SchemaObjectAllOf.astro @@ -30,6 +30,7 @@ const { nested, schemaObject, parents = [] } = Astro.props; return ( = { anyOf: "Any of", oneOf: "One of", }; + +function isCircularArrayItem(item: SchemaObjectType, parents: SchemaObjectType[] = []): boolean { + if (parents.some((parent) => parent === item)) { + return true; + } + + if ( + item.type !== "array" || + !item.items || + "$ref" in item.items || + item.items.type !== "object" + ) { + return false; + } + + const nestedSchemaObjects = getSchemaObjects(item.items); + + return ( + nestedSchemaObjects?.schemaObjects.some((nestedSchemaObject) => + isCircularArrayItem(nestedSchemaObject, [...parents, item]), + ) ?? false + ); +} ---
@@ -46,7 +71,11 @@ const humanReadableType: Record = { { schemaObjects.map((schemaObject) => ( - + {isCircularArrayItem(schemaObject) ? ( + "Self reference" + ) : ( + + )} )) }