Created
July 22, 2022 04:02
-
-
Save banool/c9bc0659d4b155d7dd9584480378b8fc to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| 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: 0.2.1 | |
| 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: [] | |
| tags: | |
| - name: General | |
| description: General information. | |
| paths: | |
| "/accounts/{address}": | |
| get: | |
| tags: | |
| - General | |
| summary: Get account | |
| description: Return high level information about an account such as its sequence number. | |
| parameters: | |
| - name: address | |
| schema: | |
| type: string | |
| format: Address | |
| in: path | |
| required: true | |
| deprecated: false | |
| - name: ledger_version | |
| schema: | |
| type: integer | |
| format: uint64 | |
| in: query | |
| required: false | |
| deprecated: false | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AccountData" | |
| application/x-bcs: | |
| schema: | |
| $ref: "#/components/schemas/AccountData" | |
| headers: | |
| X-APTOS-CHAIN-ID: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint16 | |
| X-APTOS-LEDGER-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-OLDEST-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-TIMESTAMPUSEC: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-EPOCH: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| "400": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "404": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "500": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| operationId: get_account | |
| "/accounts/{address}/resources": | |
| get: | |
| tags: | |
| - General | |
| summary: Get account resources | |
| description: "This API returns account resources for a specific ledger version (AKA transaction version).\nIf not present, the latest version is used. <---- TODO Update this comment\nThe Aptos nodes prune account state history, via a configurable time window (link).\nIf the requested data has been pruned, the server responds with a 404" | |
| parameters: | |
| - name: address | |
| schema: | |
| type: string | |
| format: Address | |
| in: path | |
| required: true | |
| deprecated: false | |
| - name: ledger_version | |
| schema: | |
| type: integer | |
| format: uint64 | |
| in: query | |
| required: false | |
| deprecated: false | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveResource" | |
| application/x-bcs: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveResource" | |
| headers: | |
| X-APTOS-CHAIN-ID: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint16 | |
| X-APTOS-LEDGER-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-OLDEST-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-TIMESTAMPUSEC: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-EPOCH: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| "400": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "404": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "500": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| operationId: get_account_resources | |
| "/accounts/{address}/modules": | |
| get: | |
| tags: | |
| - General | |
| summary: Get account modules | |
| description: "This API returns account resources for a specific ledger version (AKA transaction version).\nIf not present, the latest version is used. <---- TODO Update this comment\nThe Aptos nodes prune account state history, via a configurable time window (link).\nIf the requested data has been pruned, the server responds with a 404" | |
| parameters: | |
| - name: address | |
| schema: | |
| type: string | |
| format: Address | |
| in: path | |
| required: true | |
| deprecated: false | |
| - name: ledger_version | |
| schema: | |
| type: integer | |
| format: uint64 | |
| in: query | |
| required: false | |
| deprecated: false | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveModuleBytecode" | |
| application/x-bcs: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveModuleBytecode" | |
| headers: | |
| X-APTOS-CHAIN-ID: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint16 | |
| X-APTOS-LEDGER-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-OLDEST-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-TIMESTAMPUSEC: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-EPOCH: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| "400": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "404": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "500": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| 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 retrieve the API directly at `/openapi.yaml` and `/openapi.json`." | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| text/html: | |
| schema: | |
| type: string | |
| operationId: openapi | |
| "/events/{event_key}": | |
| get: | |
| tags: | |
| - General | |
| summary: Get events by event key | |
| description: todo | |
| parameters: | |
| - name: event_key | |
| schema: | |
| type: string | |
| format: EventKey | |
| in: path | |
| required: true | |
| deprecated: false | |
| - name: start | |
| schema: | |
| type: integer | |
| format: uint64 | |
| in: query | |
| required: false | |
| deprecated: false | |
| - name: limit | |
| schema: | |
| type: integer | |
| format: uint16 | |
| in: query | |
| required: false | |
| deprecated: false | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Event" | |
| application/x-bcs: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Event" | |
| headers: | |
| X-APTOS-CHAIN-ID: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint16 | |
| X-APTOS-LEDGER-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-OLDEST-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-TIMESTAMPUSEC: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-EPOCH: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| "400": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "404": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "500": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| operationId: get_events_by_event_key | |
| "/accounts/{address}/events/{event_handle}/{field_name}": | |
| get: | |
| tags: | |
| - General | |
| summary: Get events by event handle | |
| description: "This API extracts event key from the account resource identified\nby the `event_handle_struct` and `field_name`, then returns\nevents identified by the event key." | |
| parameters: | |
| - name: address | |
| schema: | |
| type: string | |
| format: Address | |
| in: path | |
| required: true | |
| deprecated: false | |
| - name: event_handle | |
| schema: | |
| type: string | |
| format: MoveStructTagWrapper | |
| in: path | |
| required: true | |
| deprecated: false | |
| - name: field_name | |
| schema: | |
| type: string | |
| format: IdentifierWrapper | |
| in: path | |
| required: true | |
| deprecated: false | |
| - name: start | |
| schema: | |
| type: integer | |
| format: uint64 | |
| in: query | |
| required: false | |
| deprecated: false | |
| - name: limit | |
| schema: | |
| type: integer | |
| format: uint16 | |
| in: query | |
| required: false | |
| deprecated: false | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Event" | |
| application/x-bcs: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Event" | |
| headers: | |
| X-APTOS-CHAIN-ID: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint16 | |
| X-APTOS-LEDGER-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-OLDEST-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-TIMESTAMPUSEC: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-EPOCH: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| "400": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "404": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "500": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| 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, role type, ledger versions, epoch, etc." | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/IndexResponse" | |
| application/x-bcs: | |
| schema: | |
| $ref: "#/components/schemas/IndexResponse" | |
| headers: | |
| X-APTOS-CHAIN-ID: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint16 | |
| X-APTOS-LEDGER-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-OLDEST-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-TIMESTAMPUSEC: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-EPOCH: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| "400": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "500": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| operationId: get_ledger_info | |
| /transactions: | |
| get: | |
| tags: | |
| - General | |
| summary: Get transactions | |
| description: todo | |
| parameters: | |
| - name: start | |
| schema: | |
| type: integer | |
| format: uint64 | |
| in: query | |
| required: false | |
| deprecated: false | |
| - name: limit | |
| schema: | |
| type: integer | |
| format: uint16 | |
| in: query | |
| required: false | |
| deprecated: false | |
| responses: | |
| "200": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Transaction" | |
| application/x-bcs: | |
| schema: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Transaction" | |
| headers: | |
| X-APTOS-CHAIN-ID: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint16 | |
| X-APTOS-LEDGER-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-OLDEST-VERSION: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-LEDGER-TIMESTAMPUSEC: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| X-APTOS-EPOCH: | |
| required: true | |
| deprecated: false | |
| schema: | |
| type: integer | |
| format: uint64 | |
| "400": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "404": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| "500": | |
| description: "" | |
| content: | |
| application/json: | |
| schema: | |
| $ref: "#/components/schemas/AptosError" | |
| operationId: get_transactions | |
| components: | |
| schemas: | |
| AccountData: | |
| type: object | |
| required: | |
| - sequence_number | |
| - authentication_key | |
| properties: | |
| sequence_number: | |
| type: integer | |
| format: uint64 | |
| authentication_key: | |
| type: string | |
| format: HexEncodedBytes | |
| AccountSignature: | |
| type: object | |
| oneOf: | |
| - $ref: "#/components/schemas/Ed25519Signature" | |
| - $ref: "#/components/schemas/MultiEd25519Signature" | |
| 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 | |
| properties: | |
| message: | |
| type: string | |
| error_code: | |
| $ref: "#/components/schemas/AptosErrorCode" | |
| aptos_ledger_version: | |
| type: integer | |
| format: uint64 | |
| AptosErrorCode: | |
| type: string | |
| description: "These codes provide more granular error information beyond just the HTTP\nstatus code of the response." | |
| enum: | |
| - UnsupportedAcceptType | |
| - ReadFromStorageError | |
| - InvalidBcsInStorageError | |
| - BcsSerializationError | |
| - InvalidStartParam | |
| - InvalidLimitParam | |
| BlockMetadataTransaction: | |
| type: object | |
| required: | |
| - version | |
| - hash | |
| - state_root_hash | |
| - event_root_hash | |
| - gas_used | |
| - success | |
| - vm_status | |
| - accumulator_root_hash | |
| - changes | |
| - id | |
| - epoch | |
| - round | |
| - events | |
| - previous_block_votes | |
| - proposer | |
| - failed_proposer_indices | |
| - timestamp | |
| properties: | |
| version: | |
| type: integer | |
| format: uint64 | |
| hash: | |
| type: string | |
| format: HashValue | |
| state_root_hash: | |
| type: string | |
| format: HashValue | |
| event_root_hash: | |
| type: string | |
| format: HashValue | |
| gas_used: | |
| type: integer | |
| format: uint64 | |
| success: | |
| type: boolean | |
| vm_status: | |
| type: string | |
| accumulator_root_hash: | |
| type: string | |
| format: HashValue | |
| changes: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/WriteSetChange" | |
| id: | |
| type: string | |
| format: HashValue | |
| epoch: | |
| type: integer | |
| format: uint64 | |
| round: | |
| type: integer | |
| format: uint64 | |
| events: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Event" | |
| previous_block_votes: | |
| type: array | |
| items: | |
| type: boolean | |
| proposer: | |
| type: string | |
| format: Address | |
| failed_proposer_indices: | |
| type: array | |
| items: | |
| type: integer | |
| format: uint32 | |
| timestamp: | |
| type: integer | |
| format: uint64 | |
| DeleteModule: | |
| type: object | |
| required: | |
| - address | |
| - state_key_hash | |
| - module | |
| properties: | |
| address: | |
| type: string | |
| format: Address | |
| state_key_hash: | |
| type: string | |
| module: | |
| $ref: "#/components/schemas/MoveModuleId" | |
| DeleteResource: | |
| type: object | |
| required: | |
| - address | |
| - state_key_hash | |
| - resource | |
| properties: | |
| address: | |
| type: string | |
| format: Address | |
| state_key_hash: | |
| type: string | |
| resource: | |
| $ref: "#/components/schemas/MoveStructTag" | |
| DeleteTableItem: | |
| type: object | |
| required: | |
| - state_key_hash | |
| - handle | |
| - key | |
| properties: | |
| state_key_hash: | |
| type: string | |
| handle: | |
| type: string | |
| format: HexEncodedBytes | |
| key: | |
| type: string | |
| format: HexEncodedBytes | |
| DirectWriteSet: | |
| type: object | |
| required: | |
| - changes | |
| - events | |
| properties: | |
| changes: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/WriteSetChange" | |
| events: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Event" | |
| Ed25519Signature: | |
| type: object | |
| required: | |
| - public_key | |
| - signature | |
| properties: | |
| public_key: | |
| type: string | |
| format: HexEncodedBytes | |
| signature: | |
| type: string | |
| format: HexEncodedBytes | |
| Event: | |
| type: object | |
| required: | |
| - key | |
| - sequence_number | |
| - type | |
| - data | |
| properties: | |
| key: | |
| type: string | |
| format: EventKey | |
| sequence_number: | |
| type: integer | |
| format: uint64 | |
| type: | |
| type: string | |
| format: MoveType | |
| data: {} | |
| GenesisPayload: | |
| type: object | |
| oneOf: | |
| - $ref: "#/components/schemas/WriteSetPayload" | |
| GenesisTransaction: | |
| type: object | |
| required: | |
| - version | |
| - hash | |
| - state_root_hash | |
| - event_root_hash | |
| - gas_used | |
| - success | |
| - vm_status | |
| - accumulator_root_hash | |
| - changes | |
| - payload | |
| - events | |
| properties: | |
| version: | |
| type: integer | |
| format: uint64 | |
| hash: | |
| type: string | |
| format: HashValue | |
| state_root_hash: | |
| type: string | |
| format: HashValue | |
| event_root_hash: | |
| type: string | |
| format: HashValue | |
| gas_used: | |
| type: integer | |
| format: uint64 | |
| success: | |
| type: boolean | |
| vm_status: | |
| type: string | |
| accumulator_root_hash: | |
| type: string | |
| format: HashValue | |
| changes: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/WriteSetChange" | |
| payload: | |
| $ref: "#/components/schemas/GenesisPayload" | |
| events: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Event" | |
| IndexResponse: | |
| type: object | |
| description: "The struct holding all data returned to the client by the\nindex endpoint (i.e., GET \"/\")." | |
| required: | |
| - chain_id | |
| - epoch | |
| - ledger_version | |
| - oldest_ledger_version | |
| - ledger_timestamp | |
| - node_role | |
| properties: | |
| chain_id: | |
| type: integer | |
| format: uint8 | |
| epoch: | |
| type: integer | |
| format: uint64 | |
| ledger_version: | |
| type: integer | |
| format: uint64 | |
| oldest_ledger_version: | |
| type: integer | |
| format: uint64 | |
| ledger_timestamp: | |
| type: integer | |
| format: uint64 | |
| node_role: | |
| $ref: "#/components/schemas/RoleType" | |
| ModuleBundlePayload: | |
| type: object | |
| required: | |
| - modules | |
| properties: | |
| modules: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveModuleBytecode" | |
| MoveFunction: | |
| type: object | |
| required: | |
| - name | |
| - visibility | |
| - is_entry | |
| - generic_type_params | |
| - params | |
| - return | |
| properties: | |
| name: | |
| type: string | |
| format: IdentifierWrapper | |
| visibility: | |
| $ref: "#/components/schemas/MoveFunctionVisibility" | |
| is_entry: | |
| type: boolean | |
| generic_type_params: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveFunctionGenericTypeParam" | |
| params: | |
| type: array | |
| items: | |
| type: string | |
| format: MoveType | |
| return: | |
| type: array | |
| items: | |
| type: string | |
| format: MoveType | |
| MoveFunctionGenericTypeParam: | |
| type: object | |
| required: | |
| - constraints | |
| properties: | |
| constraints: | |
| type: array | |
| items: | |
| type: string | |
| format: MoveAbility | |
| MoveFunctionVisibility: | |
| type: string | |
| enum: | |
| - Private | |
| - Public | |
| - Friend | |
| MoveModule: | |
| type: object | |
| required: | |
| - address | |
| - name | |
| - friends | |
| - exposed_functions | |
| - structs | |
| properties: | |
| address: | |
| type: string | |
| format: Address | |
| name: | |
| type: string | |
| format: IdentifierWrapper | |
| friends: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveModuleId" | |
| exposed_functions: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveFunction" | |
| structs: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveStruct" | |
| MoveModuleBytecode: | |
| type: object | |
| required: | |
| - bytecode | |
| properties: | |
| bytecode: | |
| type: string | |
| format: HexEncodedBytes | |
| abi: | |
| $ref: "#/components/schemas/MoveModule" | |
| MoveModuleId: | |
| type: object | |
| required: | |
| - address | |
| - name | |
| properties: | |
| address: | |
| type: string | |
| format: Address | |
| name: | |
| type: string | |
| format: IdentifierWrapper | |
| MoveResource: | |
| type: object | |
| required: | |
| - type | |
| - data | |
| properties: | |
| type: | |
| $ref: "#/components/schemas/MoveStructTag" | |
| data: | |
| type: string | |
| format: MoveStructValue | |
| MoveScriptBytecode: | |
| type: object | |
| required: | |
| - bytecode | |
| properties: | |
| bytecode: | |
| type: string | |
| format: HexEncodedBytes | |
| abi: | |
| $ref: "#/components/schemas/MoveFunction" | |
| MoveStruct: | |
| type: object | |
| required: | |
| - name | |
| - is_native | |
| - abilities | |
| - generic_type_params | |
| - fields | |
| properties: | |
| name: | |
| type: string | |
| format: IdentifierWrapper | |
| is_native: | |
| type: boolean | |
| abilities: | |
| type: array | |
| items: | |
| type: string | |
| format: MoveAbility | |
| generic_type_params: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveStructGenericTypeParam" | |
| fields: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/MoveStructField" | |
| MoveStructField: | |
| type: object | |
| required: | |
| - name | |
| - type | |
| properties: | |
| name: | |
| type: string | |
| format: IdentifierWrapper | |
| type: | |
| type: string | |
| format: MoveType | |
| MoveStructGenericTypeParam: | |
| type: object | |
| required: | |
| - constraints | |
| - is_phantom | |
| properties: | |
| constraints: | |
| type: array | |
| items: | |
| type: string | |
| format: MoveAbility | |
| is_phantom: | |
| type: boolean | |
| MoveStructTag: | |
| type: object | |
| required: | |
| - address | |
| - module | |
| - name | |
| - generic_type_params | |
| properties: | |
| address: | |
| type: string | |
| format: Address | |
| module: | |
| type: string | |
| format: IdentifierWrapper | |
| name: | |
| type: string | |
| format: IdentifierWrapper | |
| generic_type_params: | |
| type: array | |
| items: | |
| type: string | |
| format: MoveType | |
| MultiAgentSignature: | |
| type: object | |
| required: | |
| - sender | |
| - secondary_signer_addresses | |
| - secondary_signers | |
| properties: | |
| sender: | |
| $ref: "#/components/schemas/AccountSignature" | |
| secondary_signer_addresses: | |
| type: array | |
| items: | |
| type: string | |
| format: Address | |
| secondary_signers: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/AccountSignature" | |
| MultiEd25519Signature: | |
| type: object | |
| required: | |
| - public_keys | |
| - signatures | |
| - threshold | |
| - bitmap | |
| properties: | |
| public_keys: | |
| type: array | |
| items: | |
| type: string | |
| format: HexEncodedBytes | |
| signatures: | |
| type: array | |
| items: | |
| type: string | |
| format: HexEncodedBytes | |
| threshold: | |
| type: integer | |
| format: uint8 | |
| bitmap: | |
| type: string | |
| format: HexEncodedBytes | |
| PendingTransaction: | |
| type: object | |
| required: | |
| - hash | |
| - sender | |
| - sequence_number | |
| - max_gas_amount | |
| - gas_unit_price | |
| - expiration_timestamp_secs | |
| - payload | |
| properties: | |
| hash: | |
| type: string | |
| format: HashValue | |
| sender: | |
| type: string | |
| format: Address | |
| sequence_number: | |
| type: integer | |
| format: uint64 | |
| max_gas_amount: | |
| type: integer | |
| format: uint64 | |
| gas_unit_price: | |
| type: integer | |
| format: uint64 | |
| expiration_timestamp_secs: | |
| type: integer | |
| format: uint64 | |
| payload: | |
| $ref: "#/components/schemas/TransactionPayload" | |
| signature: | |
| $ref: "#/components/schemas/TransactionSignature" | |
| RoleType: | |
| type: string | |
| enum: | |
| - Validator | |
| - FullNode | |
| ScriptFunctionId: | |
| type: object | |
| required: | |
| - module | |
| - name | |
| properties: | |
| module: | |
| $ref: "#/components/schemas/MoveModuleId" | |
| name: | |
| type: string | |
| format: IdentifierWrapper | |
| ScriptFunctionPayload: | |
| type: object | |
| required: | |
| - function | |
| - type_arguments | |
| - arguments | |
| properties: | |
| function: | |
| $ref: "#/components/schemas/ScriptFunctionId" | |
| type_arguments: | |
| type: array | |
| items: | |
| type: string | |
| format: MoveType | |
| arguments: | |
| type: array | |
| items: {} | |
| ScriptPayload: | |
| type: object | |
| required: | |
| - code | |
| - type_arguments | |
| - arguments | |
| properties: | |
| code: | |
| $ref: "#/components/schemas/MoveScriptBytecode" | |
| type_arguments: | |
| type: array | |
| items: | |
| type: string | |
| format: MoveType | |
| arguments: | |
| type: array | |
| items: {} | |
| ScriptWriteSet: | |
| type: object | |
| required: | |
| - execute_as | |
| - script | |
| properties: | |
| execute_as: | |
| type: string | |
| format: Address | |
| script: | |
| $ref: "#/components/schemas/ScriptPayload" | |
| StateCheckpointTransaction: | |
| type: object | |
| required: | |
| - version | |
| - hash | |
| - state_root_hash | |
| - event_root_hash | |
| - gas_used | |
| - success | |
| - vm_status | |
| - accumulator_root_hash | |
| - changes | |
| - timestamp | |
| properties: | |
| version: | |
| type: integer | |
| format: uint64 | |
| hash: | |
| type: string | |
| format: HashValue | |
| state_root_hash: | |
| type: string | |
| format: HashValue | |
| event_root_hash: | |
| type: string | |
| format: HashValue | |
| gas_used: | |
| type: integer | |
| format: uint64 | |
| success: | |
| type: boolean | |
| vm_status: | |
| type: string | |
| accumulator_root_hash: | |
| type: string | |
| format: HashValue | |
| changes: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/WriteSetChange" | |
| timestamp: | |
| type: integer | |
| format: uint64 | |
| Transaction: | |
| type: object | |
| oneOf: | |
| - $ref: "#/components/schemas/PendingTransaction" | |
| - $ref: "#/components/schemas/UserTransaction" | |
| - $ref: "#/components/schemas/GenesisTransaction" | |
| - $ref: "#/components/schemas/BlockMetadataTransaction" | |
| - $ref: "#/components/schemas/StateCheckpointTransaction" | |
| TransactionPayload: | |
| type: object | |
| oneOf: | |
| - $ref: "#/components/schemas/ScriptFunctionPayload" | |
| - $ref: "#/components/schemas/ScriptPayload" | |
| - $ref: "#/components/schemas/ModuleBundlePayload" | |
| - $ref: "#/components/schemas/WriteSetPayload" | |
| TransactionSignature: | |
| type: object | |
| oneOf: | |
| - $ref: "#/components/schemas/Ed25519Signature" | |
| - $ref: "#/components/schemas/MultiEd25519Signature" | |
| - $ref: "#/components/schemas/MultiAgentSignature" | |
| UserTransaction: | |
| type: object | |
| required: | |
| - version | |
| - hash | |
| - state_root_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: | |
| type: integer | |
| format: uint64 | |
| hash: | |
| type: string | |
| format: HashValue | |
| state_root_hash: | |
| type: string | |
| format: HashValue | |
| event_root_hash: | |
| type: string | |
| format: HashValue | |
| gas_used: | |
| type: integer | |
| format: uint64 | |
| success: | |
| type: boolean | |
| vm_status: | |
| type: string | |
| accumulator_root_hash: | |
| type: string | |
| format: HashValue | |
| changes: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/WriteSetChange" | |
| sender: | |
| type: string | |
| format: Address | |
| sequence_number: | |
| type: integer | |
| format: uint64 | |
| max_gas_amount: | |
| type: integer | |
| format: uint64 | |
| gas_unit_price: | |
| type: integer | |
| format: uint64 | |
| expiration_timestamp_secs: | |
| type: integer | |
| format: uint64 | |
| payload: | |
| $ref: "#/components/schemas/TransactionPayload" | |
| signature: | |
| $ref: "#/components/schemas/TransactionSignature" | |
| events: | |
| type: array | |
| items: | |
| $ref: "#/components/schemas/Event" | |
| timestamp: | |
| type: integer | |
| format: uint64 | |
| WriteModule: | |
| type: object | |
| required: | |
| - address | |
| - state_key_hash | |
| - data | |
| properties: | |
| address: | |
| type: string | |
| format: Address | |
| state_key_hash: | |
| type: string | |
| data: | |
| $ref: "#/components/schemas/MoveModuleBytecode" | |
| WriteResource: | |
| type: object | |
| required: | |
| - address | |
| - state_key_hash | |
| - data | |
| properties: | |
| address: | |
| type: string | |
| format: Address | |
| state_key_hash: | |
| type: string | |
| data: | |
| $ref: "#/components/schemas/MoveResource" | |
| WriteSet: | |
| type: object | |
| oneOf: | |
| - $ref: "#/components/schemas/ScriptWriteSet" | |
| - $ref: "#/components/schemas/DirectWriteSet" | |
| WriteSetChange: | |
| type: object | |
| oneOf: | |
| - $ref: "#/components/schemas/DeleteModule" | |
| - $ref: "#/components/schemas/DeleteResource" | |
| - $ref: "#/components/schemas/DeleteTableItem" | |
| - $ref: "#/components/schemas/WriteModule" | |
| - $ref: "#/components/schemas/WriteResource" | |
| - $ref: "#/components/schemas/WriteTableItem" | |
| WriteSetPayload: | |
| type: object | |
| required: | |
| - write_set | |
| properties: | |
| write_set: | |
| $ref: "#/components/schemas/WriteSet" | |
| WriteTableItem: | |
| type: object | |
| required: | |
| - state_key_hash | |
| - handle | |
| - key | |
| - value | |
| properties: | |
| state_key_hash: | |
| type: string | |
| handle: | |
| type: string | |
| format: HexEncodedBytes | |
| key: | |
| type: string | |
| format: HexEncodedBytes | |
| value: | |
| type: string | |
| format: HexEncodedBytes | |
| externalDocs: | |
| url: "https://github.com/aptos-labs/aptos-core" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment