diff --git a/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml b/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml index dc9c34f7..1f17ec31 100644 --- a/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml +++ b/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml @@ -21,44 +21,28 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: alchemy_requestGasAndPaymasterAndData - description: Requests gas and coverage for a `UserOperation`. Returns `paymasterAndData` and gas parameters if approved, errors if not. Optionally accepts fee parameter overrides to be used in the `UserOperation`. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: alchemy_requestGasAndPaymasterAndData + description: Requests gas and coverage for a `UserOperation`. Returns `paymasterAndData` and gas parameters if approved, errors if not. Optionally accepts fee parameter overrides to be used in the `UserOperation`. + operationId: alchemy-requestGasAndPaymasterAndData + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + required: true + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - required: true + $ref: ../evm_body.yaml#/alchemy_requestGasAndPaymasterAndData + responses: + '200': + description: Successful response content: application/json: schema: - $ref: ../evm_body.yaml#/alchemy_requestGasAndPaymasterAndData - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/alchemy_requestGasAndPaymasterAndData - operationId: alchemy-requestGasAndPaymasterAndData + $ref: ../evm_responses.yaml#/alchemy_requestGasAndPaymasterAndData + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/account-abstraction/alchemy_requestPaymasterAndData.yaml b/account-abstraction/alchemy_requestPaymasterAndData.yaml index 6b11be61..05863cc9 100644 --- a/account-abstraction/alchemy_requestPaymasterAndData.yaml +++ b/account-abstraction/alchemy_requestPaymasterAndData.yaml @@ -21,44 +21,28 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: alchemy_requestPaymasterAndData - description: Requests coverage for a `UserOperation`. Returns `paymasterAndData` if approved, errors if not. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: alchemy_requestPaymasterAndData + description: Requests coverage for a `UserOperation`. Returns `paymasterAndData` if approved, errors if not. + operationId: alchemy-requestPaymasterAndData + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + required: true + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - required: true + $ref: ../evm_body.yaml#/alchemy_requestPaymasterAndData + responses: + '200': + description: Successful response content: application/json: schema: - $ref: ../evm_body.yaml#/alchemy_requestPaymasterAndData - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/alchemy_requestPaymasterAndData - operationId: alchemy-requestPaymasterAndData + $ref: ../evm_responses.yaml#/alchemy_requestPaymasterAndData + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/account-abstraction/eth_estimateUserOperationGas.yaml b/account-abstraction/eth_estimateUserOperationGas.yaml index 6b74ff62..79f41d57 100644 --- a/account-abstraction/eth_estimateUserOperationGas.yaml +++ b/account-abstraction/eth_estimateUserOperationGas.yaml @@ -21,44 +21,28 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_estimateUserOperationGas - description: Estimates the gas values for a `UserOperation`. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_estimateUserOperationGas + description: Estimates the gas values for a `UserOperation`. + operationId: eth-estimateUserOperationGas + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + required: true + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - required: true + $ref: ../evm_body.yaml#/eth_estimateUserOperationGas + responses: + '200': + description: Successful response content: application/json: schema: - $ref: ../evm_body.yaml#/eth_estimateUserOperationGas - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_estimateUserOperationGas - operationId: eth-estimateUserOperationGas + $ref: ../evm_responses.yaml#/eth_estimateUserOperationGas + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/account-abstraction/eth_getUserOperationByHash.yaml b/account-abstraction/eth_getUserOperationByHash.yaml index b516c946..4e273f58 100644 --- a/account-abstraction/eth_getUserOperationByHash.yaml +++ b/account-abstraction/eth_getUserOperationByHash.yaml @@ -21,44 +21,28 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getUserOperationByHash - description: Return a `UserOperation` based on a hash (`userOpHash`). - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getUserOperationByHash + description: Return a `UserOperation` based on a hash (`userOpHash`). + operationId: eth-getUserOperationByHash + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + required: true + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - required: true + $ref: ../evm_body.yaml#/eth_getUserOperationByHash + responses: + '200': + description: Successful response content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getUserOperationByHash - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_getUserOperationByHash - operationId: eth-getUserOperationByHash + $ref: ../evm_responses.yaml#/eth_getUserOperationByHash + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/account-abstraction/eth_getUserOperationReceipt.yaml b/account-abstraction/eth_getUserOperationReceipt.yaml index f27674cb..462274a8 100644 --- a/account-abstraction/eth_getUserOperationReceipt.yaml +++ b/account-abstraction/eth_getUserOperationReceipt.yaml @@ -21,44 +21,28 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getUserOperationReceipt - description: Get the `UserOperationReceipt` based on the `userOpHash` value. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getUserOperationReceipt + description: Get the `UserOperationReceipt` based on the `userOpHash` value. + operationId: eth-getUserOperationReceipt + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + required: true + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - required: true + $ref: ../evm_body.yaml#/eth_getUserOperationReceipt + responses: + '200': + description: Successful response content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getUserOperationReceipt - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_getUserOperationReceipt - operationId: eth-getUserOperationReceipt + $ref: ../evm_responses.yaml#/eth_getUserOperationReceipt + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/account-abstraction/eth_sendUserOperation.yaml b/account-abstraction/eth_sendUserOperation.yaml index 371adcc1..0caa1fdc 100644 --- a/account-abstraction/eth_sendUserOperation.yaml +++ b/account-abstraction/eth_sendUserOperation.yaml @@ -21,44 +21,28 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_sendUserOperation - description: Sends a user operation to the given EVM network. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_sendUserOperation + description: Sends a user operation to the given EVM network. + operationId: eth-sendUserOperation + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + required: true + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - required: true + $ref: ../evm_body.yaml#/eth_sendUserOperation + responses: + '200': + description: Successful response content: application/json: schema: - $ref: ../evm_body.yaml#/eth_sendUserOperation - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_sendUserOperation - operationId: eth-sendUserOperation + $ref: ../evm_responses.yaml#/eth_sendUserOperation + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/account-abstraction/eth_supportedEntryPoints.yaml b/account-abstraction/eth_supportedEntryPoints.yaml index 50bd739d..925fd417 100644 --- a/account-abstraction/eth_supportedEntryPoints.yaml +++ b/account-abstraction/eth_supportedEntryPoints.yaml @@ -21,44 +21,28 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_supportedEntryPoints - description: Returns an array of the `entryPoint` addresses supported by the client. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_supportedEntryPoints + description: Returns an array of the `entryPoint` addresses supported by the client. + operationId: eth-supportedEntryPoints + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + required: true + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - required: true + $ref: ../evm_body.yaml#/eth_supportedEntryPoints + responses: + '200': + description: Successful response content: application/json: schema: - $ref: ../evm_body.yaml#/eth_supportedEntryPoints - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_supportedEntryPoints - operationId: eth-supportedEntryPoints + $ref: ../evm_responses.yaml#/eth_supportedEntryPoints + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/account-abstraction/rundler_maxPriorityFeePerGas.yaml b/account-abstraction/rundler_maxPriorityFeePerGas.yaml index c5080896..1780830f 100644 --- a/account-abstraction/rundler_maxPriorityFeePerGas.yaml +++ b/account-abstraction/rundler_maxPriorityFeePerGas.yaml @@ -22,23 +22,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: rundler_maxPriorityFeePerGas description: 'Returns a fee per gas that is an estimate of how much users should set as a priority fee in UOs for Rundler endpoints.' - tags: [] + operationId: rundler-maxPriorityFeePerGas parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -51,4 +40,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/string_result_response - operationId: rundler-maxPriorityFeePerGas diff --git a/arbitrum/eth_chainId.yaml b/arbitrum/eth_chainId.yaml index c278f8ca..46543ee9 100644 --- a/arbitrum/eth_chainId.yaml +++ b/arbitrum/eth_chainId.yaml @@ -14,5 +14,5 @@ paths: /{apiKey}: post: summary: eth_chainId - Arbitrum - operationId: eth-chainid-arbitrum $ref: ../ethereum/eth_chainId.yaml#/components/pathItems/path/post + operationId: eth-chainid-arbitrum diff --git a/arbitrum/eth_createAccessList.yaml b/arbitrum/eth_createAccessList.yaml index 467fb0e3..39e225cc 100644 --- a/arbitrum/eth_createAccessList.yaml +++ b/arbitrum/eth_createAccessList.yaml @@ -15,20 +15,9 @@ paths: post: summary: eth_createAccessList - Arbitrum description: 'Arbitrum API - Creates an EIP2930 type `accessList` based on a given Transaction object. Returns list of addresses and storage keys that are read and written by the transaction (except the sender account and precompiles), plus the estimated gas consumed when the access list is added.' + operationId: eth-createaccesslist-arbitrum parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -41,4 +30,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/eth_createAccessList - operationId: eth-createaccesslist-arbitrum diff --git a/arbitrum/eth_feeHistory.yaml b/arbitrum/eth_feeHistory.yaml index 6e4491fc..077b1143 100644 --- a/arbitrum/eth_feeHistory.yaml +++ b/arbitrum/eth_feeHistory.yaml @@ -16,6 +16,9 @@ paths: summary: eth_feeHistory - Arbitrum operationId: eth-feehistory-arbitrum $ref: ../ethereum/eth_feeHistory.yaml#/components/pathItems/path/post + responses: + '200': + description: 'Returns latest block and gas fee details.' x-readme: samples-languages: - curl @@ -44,6 +47,3 @@ paths: ]); console.log(res); - responses: - '200': - description: 'Returns latest block and gas fee details.' diff --git a/arbitrum/eth_getBlockByHash.yaml b/arbitrum/eth_getBlockByHash.yaml index b2aacfeb..736255e1 100644 --- a/arbitrum/eth_getBlockByHash.yaml +++ b/arbitrum/eth_getBlockByHash.yaml @@ -13,62 +13,46 @@ servers: default: arb-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getBlockByHash - Arbitrum - operationId: eth-getBlockByHash-arbitrum - description: Returns information about a block by block hash on the Arbitrum network. - parameters: - - name: apiKey - in: path + post: + summary: eth_getBlockByHash - Arbitrum + description: Returns information about a block by block hash on the Arbitrum network. + operationId: eth-getBlockByHash-arbitrum + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getBlockByHash + responses: + '200': + description: 'Returns a block object with the following fields, or null when no block was found.' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getBlockByHash - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - import { Alchemy, Network } from "alchemy-sdk"; + $ref: ../evm_responses.yaml#/arb_block + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + import { Alchemy, Network } from "alchemy-sdk"; - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.ARB_MAINNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.ARB_MAINNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - alchemy.core - .getBlock( - "0x92fc42b9642023f2ee2e88094df80ce87e15d91afa812fef383e6e5cd96e2ed3" - ) - .then(console.log); - responses: - '200': - description: 'Returns a block object with the following fields, or null when no block was found.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/arb_block + alchemy.core + .getBlock( + "0x92fc42b9642023f2ee2e88094df80ce87e15d91afa812fef383e6e5cd96e2ed3" + ) + .then(console.log); diff --git a/arbitrum/eth_getBlockByNumber.yaml b/arbitrum/eth_getBlockByNumber.yaml index 88d5aa33..a18668cb 100644 --- a/arbitrum/eth_getBlockByNumber.yaml +++ b/arbitrum/eth_getBlockByNumber.yaml @@ -13,59 +13,43 @@ servers: default: arb-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: eth-getBlockByNumber-arbitrum - summary: eth_getBlockByNumber - Arbitrum - description: Returns information about a block by block number on the Arbitrum network. - parameters: - - name: apiKey - in: path + post: + summary: eth_getBlockByNumber - Arbitrum + description: Returns information about a block by block number on the Arbitrum network. + operationId: eth-getBlockByNumber-arbitrum + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getBlockByNumber + responses: + '200': + description: 'Returns a block object with the following fields, or null when no block was found.' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getBlockByNumber - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - import { Network, Alchemy } from "alchemy-sdk"; + $ref: ../evm_responses.yaml#/arb_block + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + import { Network, Alchemy } from "alchemy-sdk"; - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.ARB_MAINNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.ARB_MAINNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - alchemy.core.getBlock(15221026).then(console.log); - responses: - '200': - description: 'Returns a block object with the following fields, or null when no block was found.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/arb_block + alchemy.core.getBlock(15221026).then(console.log); diff --git a/arbitrum/eth_getProof.yaml b/arbitrum/eth_getProof.yaml index 44a8f015..ac2fbc92 100644 --- a/arbitrum/eth_getProof.yaml +++ b/arbitrum/eth_getProof.yaml @@ -12,66 +12,50 @@ servers: default: arb-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getProof - Arbitrum - description: Returns the account and storage values of the specified account including the Merkle-proof on Arbitrum. This call can be used to verify that the data you are pulling from is not tampered with. - parameters: - - name: apiKey - in: path + post: + summary: eth_getProof - Arbitrum + description: Returns the account and storage values of the specified account including the Merkle-proof on Arbitrum. This call can be used to verify that the data you are pulling from is not tampered with. + operationId: eth-getProof-arbitrum + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getProof + responses: + '200': + description: 'Returns the account and storage values of the specified account.' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getProof - responses: - '200': - description: 'Returns the account and storage values of the specified account.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_getProof - operationId: eth-getProof-arbitrum - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - import { Network, Alchemy } from "alchemy-sdk"; + $ref: ../evm_responses.yaml#/eth_getProof + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + import { Network, Alchemy } from "alchemy-sdk"; - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.ETH_MAINNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.ETH_MAINNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - // Using send method from alchemy-sdk with specific transaction details - const res = await alchemy.core.send('eth_getProof', [ - '0x7F0d15C7FAae65896648C8273B6d7E43f58Fa842', - ["0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"], - "latest", - ]); + // Using send method from alchemy-sdk with specific transaction details + const res = await alchemy.core.send('eth_getProof', [ + '0x7F0d15C7FAae65896648C8273B6d7E43f58Fa842', + ["0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"], + "latest", + ]); - console.log(res); + console.log(res); diff --git a/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml b/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml index 2b1f031a..d341f0f6 100644 --- a/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml +++ b/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml @@ -12,44 +12,28 @@ servers: default: arb-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getTransactionByBlockHashAndIndex - Arbitrum - description: Returns information about a transaction by block hash and transaction index position in Arbitrum network. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getTransactionByBlockHashAndIndex - Arbitrum + description: Returns information about a transaction by block hash and transaction index position in Arbitrum network. + operationId: eth-gettransactionbyblockhashandindex-arbitrum + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: '../evm_body.yaml#/eth_getTransactionByBlockHashAndIndex' + default: + params: + [ + '0x5810f30816609df1f460b17510a1bad3745464e63d84d8eabef11c59da658d9a', + '0x1', + ] + responses: + '200': + description: '' content: application/json: schema: - $ref: '../evm_body.yaml#/eth_getTransactionByBlockHashAndIndex' - default: - params: - [ - '0x5810f30816609df1f460b17510a1bad3745464e63d84d8eabef11c59da658d9a', - '0x1', - ] - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: '../evm_responses.yaml#/eth_getTransactionByHash_arb' - operationId: eth-gettransactionbyblockhashandindex-arbitrum + $ref: '../evm_responses.yaml#/eth_getTransactionByHash_arb' diff --git a/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml b/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml index 3d318a8d..65e004bf 100644 --- a/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_getTransactionByBlockNumberAndIndex - Arbitrum description: Returns information about a transaction by block number and transaction index position. - tags: [] + operationId: eth-getTransactionByBlockNumberAndIndex-arbitrum parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -44,4 +33,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/eth_getTransactionByHash_arb - operationId: eth-getTransactionByBlockNumberAndIndex-arbitrum diff --git a/arbitrum/eth_getTransactionByHash.yaml b/arbitrum/eth_getTransactionByHash.yaml index 18472f7b..d65e23a3 100644 --- a/arbitrum/eth_getTransactionByHash.yaml +++ b/arbitrum/eth_getTransactionByHash.yaml @@ -17,23 +17,12 @@ components: pathItems: path: post: + tags: [] summary: eth_getTransactionByHash - Arbitrum description: 'Returns the information about a transaction requested by transaction hash. In the response object, `blockHash`, `blockNumber`, and `transactionIndex` are `null` when the transaction is pending.' - tags: [] + operationId: eth-getTransactionByHash-arbitrum parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -44,6 +33,13 @@ components: [ '0x2d6da6ea7d7d7d1ca72576dc457a2b6f59fb798566fb97492b3f2835b0a59178', ] + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/eth_getTransactionByHash_arb x-readme: samples-languages: - curl @@ -69,11 +65,3 @@ components: "0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b" ) .then(console.log); - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_getTransactionByHash_arb - operationId: eth-getTransactionByHash-arbitrum diff --git a/arbitrum/eth_getTransactionReceipt.yaml b/arbitrum/eth_getTransactionReceipt.yaml index f56ce9d3..c07b5f20 100644 --- a/arbitrum/eth_getTransactionReceipt.yaml +++ b/arbitrum/eth_getTransactionReceipt.yaml @@ -12,68 +12,52 @@ servers: default: arb-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getTransactionReceipt - Arbitrum - description: Returns the receipt of a transaction by transaction hash. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getTransactionReceipt - Arbitrum + description: Returns the receipt of a transaction by transaction hash. + operationId: eth-getTransactionReceipt-arbitrum + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getTransactionReceipt + default: + params: + [ + '0x0f332c74582e9277344c33ad989b1a1854a6cd78710b262e1165b52c26afec74', + ] + responses: + '200': + description: '' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getTransactionReceipt - default: - params: - [ - '0x0f332c74582e9277344c33ad989b1a1854a6cd78710b262e1165b52c26afec74', - ] - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - import { Network, Alchemy } from "alchemy-sdk"; + $ref: ../evm_responses.yaml#/eth_getTransactionReceipt_arb + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + import { Network, Alchemy } from "alchemy-sdk"; - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.ARB_MAINNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.ARB_MAINNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - alchemy.core - .getTransactionReceipt( - "0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b" - ) - .then(console.log); - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_getTransactionReceipt_arb - operationId: eth-getTransactionReceipt-arbitrum + alchemy.core + .getTransactionReceipt( + "0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b" + ) + .then(console.log); diff --git a/arbitrum/eth_maxPriorityFeePerGas.yaml b/arbitrum/eth_maxPriorityFeePerGas.yaml index 101b8164..60fa8d9a 100644 --- a/arbitrum/eth_maxPriorityFeePerGas.yaml +++ b/arbitrum/eth_maxPriorityFeePerGas.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_maxPriorityFeePerGas - Arbitrum description: "Returns a fee per gas that is an estimate of how much you can pay as a priority fee, or 'tip', to get a transaction included in the current block." - tags: [] + operationId: eth-maxpriorityfeepergas-arbitrum parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-maxpriorityfeepergas-arbitrum diff --git a/astar/eth_maxPriorityFeePerGas.yaml b/astar/eth_maxPriorityFeePerGas.yaml index 7965a638..6e836a2f 100644 --- a/astar/eth_maxPriorityFeePerGas.yaml +++ b/astar/eth_maxPriorityFeePerGas.yaml @@ -7,23 +7,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_maxPriorityFeePerGas - Astar description: "Returns a fee per gas that is an estimate of how much you can pay as a priority fee, or 'tip', to get a transaction included in the current block." - tags: [] + operationId: eth-maxPriorityFeePerGas-astar parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -36,4 +25,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-maxPriorityFeePerGas-astar diff --git a/base/eth_feeHistory.yaml b/base/eth_feeHistory.yaml index 91527e41..cb118077 100644 --- a/base/eth_feeHistory.yaml +++ b/base/eth_feeHistory.yaml @@ -12,43 +12,27 @@ servers: default: base-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_feeHistory - Base - description: Returns a collection of historical gas information. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_feeHistory - Base + description: Returns a collection of historical gas information. + operationId: eth-feeHistory-base + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_feeHistory + responses: + '200': + description: '' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_feeHistory - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_feeHistory - operationId: eth-feeHistory-base - x-readme: - samples-languages: - - curl - - javascript - - python + $ref: ../evm_responses.yaml#/eth_feeHistory + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/base/eth_getBlockByNumber.yaml b/base/eth_getBlockByNumber.yaml index 1ed2bae2..963457a9 100644 --- a/base/eth_getBlockByNumber.yaml +++ b/base/eth_getBlockByNumber.yaml @@ -16,11 +16,6 @@ paths: summary: eth_getBlockByNumber - Base $ref: ../ethereum/eth_getBlockByNumber.yaml#/components/pathItems/path/post operationId: eth-getblockbynumber-base - x-readme: - samples-languages: - - curl - - javascript - - python responses: '200': description: 'Returns a block object with the following fields, or null when no block was found.' @@ -104,3 +99,8 @@ paths: items: type: string description: Array of uncle hashes. + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/base/eth_getProof.yaml b/base/eth_getProof.yaml index 4aa9eeb0..23b28f88 100644 --- a/base/eth_getProof.yaml +++ b/base/eth_getProof.yaml @@ -12,43 +12,27 @@ servers: default: base-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getProof - Base - description: Returns the account and storage values of the specified account including the Merkle-proof on Base. This call can be used to verify that the data you are pulling from is not tampered with. - parameters: - - name: apiKey - in: path + post: + summary: eth_getProof - Base + description: Returns the account and storage values of the specified account including the Merkle-proof on Base. This call can be used to verify that the data you are pulling from is not tampered with. + operationId: eth-getProof-base + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getProof + responses: + '200': + description: 'Returns the account and storage values of the specified account.' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getProof - responses: - '200': - description: 'Returns the account and storage values of the specified account.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_getProof - operationId: eth-getProof-base - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python + $ref: ../evm_responses.yaml#/eth_getProof + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/base/eth_maxPriorityFeePerGas.yaml b/base/eth_maxPriorityFeePerGas.yaml index 8c8c01d6..93b8a487 100644 --- a/base/eth_maxPriorityFeePerGas.yaml +++ b/base/eth_maxPriorityFeePerGas.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_maxPriorityFeePerGas - Base description: "Returns a fee per gas that is an estimate of how much you can pay as a priority fee, or 'tip', to get a transaction included in the current block." - tags: [] + operationId: eth-maxpriorityfeepergas-base parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-maxpriorityfeepergas-base diff --git a/base/eth_syncing.yaml b/base/eth_syncing.yaml index 7a4dd48e..8774f777 100644 --- a/base/eth_syncing.yaml +++ b/base/eth_syncing.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_syncing - Base description: Returns a list of addresses owned by client. - tags: [] + operationId: eth-syncing-base parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: @@ -43,4 +32,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/eth_syncing - operationId: eth-syncing-base diff --git a/components/parameters.yaml b/components/parameters.yaml index 36f65129..bf43601e 100644 --- a/components/parameters.yaml +++ b/components/parameters.yaml @@ -3,7 +3,13 @@ ApiKey: name: apiKey in: path # TODO: should we link to /signup directly? - description: For higher throughput, **[create your own API key](https://alchemy.com/?a=docs-demo)**. + description: | + + For higher throughput, create your own API key required: true schema: type: string diff --git a/debug/debug_traceBlockByHash.yaml b/debug/debug_traceBlockByHash.yaml index 38d42ebb..4ae2d7fe 100644 --- a/debug/debug_traceBlockByHash.yaml +++ b/debug/debug_traceBlockByHash.yaml @@ -19,28 +19,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: debug_traceBlockByHash description: Replays the block that is already present in the database. - tags: [] + operationId: debug-traceblockbyhash parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/debug_traceBlockByHash + responses: + '200': + description: 'Returns - array of block traces' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/debug_traceBlockByHash x-readme: explorer-enabled: false samples-languages: @@ -86,11 +82,3 @@ paths: -H "Content-Type: application/json" \ --data '{"method":"debug_traceBlockByHash","params":["0x97b49e43632ac70c46b4003434058b18db0ad809617bd29f3448d46ca9085576", {"tracer": "callTracer"}],"id":1,"jsonrpc":"2.0"}' name: cURL - responses: - '200': - description: 'Returns - array of block traces' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/debug_traceBlockByHash - operationId: debug-traceblockbyhash diff --git a/debug/debug_traceBlockByNumber.yaml b/debug/debug_traceBlockByNumber.yaml index 4bb8038e..53a5256e 100644 --- a/debug/debug_traceBlockByNumber.yaml +++ b/debug/debug_traceBlockByNumber.yaml @@ -19,23 +19,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: debug_traceBlockByNumber description: Replays the block that is already present in the database. - tags: [] + operationId: debug-traceblockbynumber parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + $ref: ../evm_body.yaml#/debug_traceBlockByNumber + responses: + '200': + description: 'Returns - array of block traces' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/debug_traceBlockByNumber x-readme: explorer-enabled: false samples-languages: @@ -81,16 +82,3 @@ paths: -H "Content-Type: application/json" \ --data '{"method":"debug_traceBlockByNumber","params":["0xccde12", {"tracer": "callTracer"}],"id":1,"jsonrpc":"2.0"}' name: cURL - requestBody: - content: - application/json: - schema: - $ref: ../evm_body.yaml#/debug_traceBlockByNumber - responses: - '200': - description: 'Returns - array of block traces' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/debug_traceBlockByNumber - operationId: debug-traceblockbynumber diff --git a/debug/debug_traceCall.yaml b/debug/debug_traceCall.yaml index 87957792..ca1f0d94 100644 --- a/debug/debug_traceCall.yaml +++ b/debug/debug_traceCall.yaml @@ -19,28 +19,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: debug_traceCall description: Runs an eth_call within the context of the given block execution using the final state of parent block as the base. - tags: [] + operationId: debug-tracecall parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/debug_traceCall + responses: + '200': + description: 'Returns - Array of block traces' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/debug_traceCall x-readme: explorer-enabled: false samples-languages: @@ -90,11 +86,3 @@ paths: -H "Content-Type: application/json" \ --data '{"method":"debug_traceCall","params":[{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest"],"id":1,"jsonrpc":"2.0"}' name: cURL - responses: - '200': - description: 'Returns - Array of block traces' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/debug_traceCall - operationId: debug-tracecall diff --git a/debug/debug_traceTransaction.yaml b/debug/debug_traceTransaction.yaml index 4b95f499..3a6ca102 100644 --- a/debug/debug_traceTransaction.yaml +++ b/debug/debug_traceTransaction.yaml @@ -19,28 +19,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: debug_traceTransaction description: Attempts to run the transaction in the exact same manner as it was executed on the network. It will replay any transaction that may have been executed prior to this one before it and will then attempt to execute the transaction that corresponds to the given hash. - tags: [] + operationId: debug-tracetransaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/debug_traceTransaction + responses: + '200': + description: 'Returns - transaction trace' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/debug_traceTransaction x-readme: explorer-enabled: false samples-languages: @@ -87,11 +83,3 @@ paths: -H "Content-Type: application/json" \ --data '{"method":"debug_traceTransaction","params":["0x9e63085271890a141297039b3b711913699f1ee4db1acb667ad7ce304772036b", {"tracer": "callTracer"}], "id":1,"jsonrpc":"2.0"}' name: cURL - responses: - '200': - description: 'Returns - transaction trace' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/debug_traceTransaction - operationId: debug-tracetransaction diff --git a/ethereum/eth_accounts.yaml b/ethereum/eth_accounts.yaml index 1d32a40f..13d4ff81 100644 --- a/ethereum/eth_accounts.yaml +++ b/ethereum/eth_accounts.yaml @@ -22,19 +22,7 @@ components: description: Returns a list of addresses owned by client. Since Alchemy does not store keys, this will always return empty. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_blockNumber.yaml b/ethereum/eth_blockNumber.yaml index 9aeb81be..f28fcc19 100644 --- a/ethereum/eth_blockNumber.yaml +++ b/ethereum/eth_blockNumber.yaml @@ -23,19 +23,7 @@ components: operationId: eth-blocknumber description: Returns the number of the most recent block. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: diff --git a/ethereum/eth_call.yaml b/ethereum/eth_call.yaml index cdc9b4a5..cc9eb373 100644 --- a/ethereum/eth_call.yaml +++ b/ethereum/eth_call.yaml @@ -23,19 +23,7 @@ components: summary: eth_call - Ethereum description: Executes a new message call immediately without creating a transaction on the block chain. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts the transaction call object, state overrides and the block number / block hash / block tag to execute the call on. content: diff --git a/ethereum/eth_chainId.yaml b/ethereum/eth_chainId.yaml index dc81053b..0aafa640 100644 --- a/ethereum/eth_chainId.yaml +++ b/ethereum/eth_chainId.yaml @@ -22,19 +22,7 @@ components: description: 'Returns the currently configured chain ID, a value used in replay-protected transaction signing as introduced by EIP-155.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_createAccessList.yaml b/ethereum/eth_createAccessList.yaml index a1b03796..18b9d917 100644 --- a/ethereum/eth_createAccessList.yaml +++ b/ethereum/eth_createAccessList.yaml @@ -21,19 +21,7 @@ components: summary: eth_createAccessList - Ethereum description: 'Ethereum API - Creates an EIP2930 type `accessList` based on a given Transaction object. Returns list of addresses and storage keys that are read and written by the transaction (except the sender account and precompiles), plus the estimated gas consumed when the access list is added.' parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_estimateGas.yaml b/ethereum/eth_estimateGas.yaml index 71f1b084..18774558 100644 --- a/ethereum/eth_estimateGas.yaml +++ b/ethereum/eth_estimateGas.yaml @@ -22,19 +22,7 @@ components: description: Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_feeHistory.yaml b/ethereum/eth_feeHistory.yaml index 5a030190..9b6e393b 100644 --- a/ethereum/eth_feeHistory.yaml +++ b/ethereum/eth_feeHistory.yaml @@ -22,19 +22,7 @@ components: description: Returns a collection of historical gas information. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_gasPrice.yaml b/ethereum/eth_gasPrice.yaml index 2aefbc34..eded3bba 100644 --- a/ethereum/eth_gasPrice.yaml +++ b/ethereum/eth_gasPrice.yaml @@ -22,19 +22,7 @@ components: description: Returns the current price per gas in wei. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getBalance.yaml b/ethereum/eth_getBalance.yaml index 92f84304..f371fc75 100644 --- a/ethereum/eth_getBalance.yaml +++ b/ethereum/eth_getBalance.yaml @@ -22,19 +22,7 @@ components: description: Returns the balance of the account of a given address. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getBlockByHash.yaml b/ethereum/eth_getBlockByHash.yaml index 67e5531d..1ae8ea88 100644 --- a/ethereum/eth_getBlockByHash.yaml +++ b/ethereum/eth_getBlockByHash.yaml @@ -23,19 +23,7 @@ components: summary: eth_getBlockByHash - Ethereum description: Returns information about a block by block hash. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getBlockByNumber.yaml b/ethereum/eth_getBlockByNumber.yaml index d16fce45..7cf1672a 100644 --- a/ethereum/eth_getBlockByNumber.yaml +++ b/ethereum/eth_getBlockByNumber.yaml @@ -23,19 +23,7 @@ components: summary: eth_getBlockByNumber - Ethereum description: Returns information about a block by block number. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getBlockReceipts.yaml b/ethereum/eth_getBlockReceipts.yaml index da0bfb8c..d1cf470e 100644 --- a/ethereum/eth_getBlockReceipts.yaml +++ b/ethereum/eth_getBlockReceipts.yaml @@ -18,19 +18,7 @@ paths: description: Get all transaction receipts for a given block on Ethereum. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getBlockTransactionCountByHash.yaml b/ethereum/eth_getBlockTransactionCountByHash.yaml index 8b739c2c..209b8070 100644 --- a/ethereum/eth_getBlockTransactionCountByHash.yaml +++ b/ethereum/eth_getBlockTransactionCountByHash.yaml @@ -22,19 +22,7 @@ components: description: Returns the number of transactions in a block matching the given block hash. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getBlockTransactionCountByNumber.yaml b/ethereum/eth_getBlockTransactionCountByNumber.yaml index 7cfb0378..5db0f727 100644 --- a/ethereum/eth_getBlockTransactionCountByNumber.yaml +++ b/ethereum/eth_getBlockTransactionCountByNumber.yaml @@ -22,19 +22,7 @@ components: description: Returns the number of transactions in a block matching the given block number. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getCode.yaml b/ethereum/eth_getCode.yaml index 2a52af73..4e0cc92e 100644 --- a/ethereum/eth_getCode.yaml +++ b/ethereum/eth_getCode.yaml @@ -22,19 +22,7 @@ components: description: Returns code at a given address. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getFilterChanges.yaml b/ethereum/eth_getFilterChanges.yaml index fd1e24b2..64dbc4cf 100644 --- a/ethereum/eth_getFilterChanges.yaml +++ b/ethereum/eth_getFilterChanges.yaml @@ -23,19 +23,7 @@ components: description: 'Polling method for a filter, which returns an array of logs which occurred since last poll.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getFilterLogs.yaml b/ethereum/eth_getFilterLogs.yaml index d0eb7bdd..249ae8bf 100644 --- a/ethereum/eth_getFilterLogs.yaml +++ b/ethereum/eth_getFilterLogs.yaml @@ -23,19 +23,7 @@ components: description: Returns an array of all logs matching filter with given id. Can compute the same results with an eth_getLogs call. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getLogs.yaml b/ethereum/eth_getLogs.yaml index 90399dc0..fe383433 100644 --- a/ethereum/eth_getLogs.yaml +++ b/ethereum/eth_getLogs.yaml @@ -24,19 +24,7 @@ components: description: | Returns an array of all logs matching a given filter object. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getProof.yaml b/ethereum/eth_getProof.yaml index 30f6a7eb..47abe104 100644 --- a/ethereum/eth_getProof.yaml +++ b/ethereum/eth_getProof.yaml @@ -21,19 +21,7 @@ components: summary: eth_getProof - Ethereum description: Returns the account and storage values of the specified account including the Merkle-proof. This call can be used to verify that the data you are pulling from is not tampered with. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getStorageAt.yaml b/ethereum/eth_getStorageAt.yaml index 56f3b4ee..fb97f7fa 100644 --- a/ethereum/eth_getStorageAt.yaml +++ b/ethereum/eth_getStorageAt.yaml @@ -22,19 +22,7 @@ components: description: "Returns the value from a storage position at a given address, or in other words, returns the state of the contract's storage, which may not be exposed via the contract's methods." tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getTransactionByBlockHashAndIndex.yaml b/ethereum/eth_getTransactionByBlockHashAndIndex.yaml index faf1cefe..84dc598b 100644 --- a/ethereum/eth_getTransactionByBlockHashAndIndex.yaml +++ b/ethereum/eth_getTransactionByBlockHashAndIndex.yaml @@ -22,19 +22,7 @@ components: description: Returns information about a transaction by block hash and transaction index position. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getTransactionByBlockNumberAndIndex.yaml b/ethereum/eth_getTransactionByBlockNumberAndIndex.yaml index 1f2f5907..ffd5997b 100644 --- a/ethereum/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/ethereum/eth_getTransactionByBlockNumberAndIndex.yaml @@ -22,19 +22,7 @@ components: description: Returns information about a transaction by block number and transaction index position. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getTransactionByHash.yaml b/ethereum/eth_getTransactionByHash.yaml index b476f42b..5f595cbc 100644 --- a/ethereum/eth_getTransactionByHash.yaml +++ b/ethereum/eth_getTransactionByHash.yaml @@ -22,19 +22,7 @@ components: description: 'Returns the information about a transaction requested by transaction hash. In the response object, `blockHash`, `blockNumber`, and `transactionIndex` are `null` when the transaction is pending.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getTransactionCount.yaml b/ethereum/eth_getTransactionCount.yaml index 81081ac5..0702bb24 100644 --- a/ethereum/eth_getTransactionCount.yaml +++ b/ethereum/eth_getTransactionCount.yaml @@ -22,19 +22,7 @@ components: description: Returns the number of transactions sent from an address. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getTransactionReceipt.yaml b/ethereum/eth_getTransactionReceipt.yaml index 99945c1a..c4e3e5dd 100644 --- a/ethereum/eth_getTransactionReceipt.yaml +++ b/ethereum/eth_getTransactionReceipt.yaml @@ -22,19 +22,7 @@ components: description: Returns the receipt of a transaction by transaction hash. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getUncleByBlockHashAndIndex.yaml b/ethereum/eth_getUncleByBlockHashAndIndex.yaml index 08e1d530..627e27b6 100644 --- a/ethereum/eth_getUncleByBlockHashAndIndex.yaml +++ b/ethereum/eth_getUncleByBlockHashAndIndex.yaml @@ -22,19 +22,7 @@ components: description: Returns information about an uncle of a block by hash and uncle index position. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getUncleByBlockNumberAndIndex.yaml b/ethereum/eth_getUncleByBlockNumberAndIndex.yaml index f367dad5..d3eb213b 100644 --- a/ethereum/eth_getUncleByBlockNumberAndIndex.yaml +++ b/ethereum/eth_getUncleByBlockNumberAndIndex.yaml @@ -22,19 +22,7 @@ components: description: Returns information about an uncle of a block by number and uncle index position. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getUncleCountByBlockHash.yaml b/ethereum/eth_getUncleCountByBlockHash.yaml index 66954b48..abff3384 100644 --- a/ethereum/eth_getUncleCountByBlockHash.yaml +++ b/ethereum/eth_getUncleCountByBlockHash.yaml @@ -22,19 +22,7 @@ components: description: Returns the number of uncles in a block matching the given block hash. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_getUncleCountByBlockNumber.yaml b/ethereum/eth_getUncleCountByBlockNumber.yaml index 18ab8d83..28108d6e 100644 --- a/ethereum/eth_getUncleCountByBlockNumber.yaml +++ b/ethereum/eth_getUncleCountByBlockNumber.yaml @@ -22,19 +22,7 @@ components: description: Returns the number of uncles in a block matching the given block number. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_maxPriorityFeePerGas.yaml b/ethereum/eth_maxPriorityFeePerGas.yaml index 7f52e098..05eb2722 100644 --- a/ethereum/eth_maxPriorityFeePerGas.yaml +++ b/ethereum/eth_maxPriorityFeePerGas.yaml @@ -18,19 +18,7 @@ paths: description: "Returns a fee per gas that is an estimate of how much you can pay as a priority fee, or 'tip', to get a transaction included in the current block." tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_newBlockFilter.yaml b/ethereum/eth_newBlockFilter.yaml index 415da798..7c2b4464 100644 --- a/ethereum/eth_newBlockFilter.yaml +++ b/ethereum/eth_newBlockFilter.yaml @@ -23,19 +23,7 @@ components: description: 'Creates a filter in the node, to notify when a new block arrives.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: diff --git a/ethereum/eth_newFilter.yaml b/ethereum/eth_newFilter.yaml index 6ed0d185..cf054718 100644 --- a/ethereum/eth_newFilter.yaml +++ b/ethereum/eth_newFilter.yaml @@ -23,19 +23,7 @@ components: description: 'Creates a filter object, based on filter options, to notify when the state changes (logs).' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_newPendingTransactionFilter.yaml b/ethereum/eth_newPendingTransactionFilter.yaml index 119cc617..69077b51 100644 --- a/ethereum/eth_newPendingTransactionFilter.yaml +++ b/ethereum/eth_newPendingTransactionFilter.yaml @@ -23,19 +23,7 @@ components: description: 'Creates a filter in the node, to notify when new pending transactions arrive. To check if the state has changed, call eth_getFilterChanges.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: diff --git a/ethereum/eth_protocolVersion.yaml b/ethereum/eth_protocolVersion.yaml index 5f77f6ef..d9d83710 100644 --- a/ethereum/eth_protocolVersion.yaml +++ b/ethereum/eth_protocolVersion.yaml @@ -22,19 +22,7 @@ components: description: Returns the current ethereum protocol version. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_sendRawTransaction.yaml b/ethereum/eth_sendRawTransaction.yaml index 991b6b97..6f364729 100644 --- a/ethereum/eth_sendRawTransaction.yaml +++ b/ethereum/eth_sendRawTransaction.yaml @@ -22,19 +22,7 @@ components: description: Creates a new message call transaction or a contract creation for signed transactions. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/eth_uninstallFilter.yaml b/ethereum/eth_uninstallFilter.yaml index 143696bc..328e716e 100644 --- a/ethereum/eth_uninstallFilter.yaml +++ b/ethereum/eth_uninstallFilter.yaml @@ -23,19 +23,7 @@ components: description: 'Uninstalls a filter with given id. Should always be called when watch is no longer needed. Additionally, Filters timeout when they aren’t requested with eth_getFilterChangesfor a period of time.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/net_listening.yaml b/ethereum/net_listening.yaml index 8b68d8f8..f9539a6d 100644 --- a/ethereum/net_listening.yaml +++ b/ethereum/net_listening.yaml @@ -22,19 +22,7 @@ components: description: Returns true if client is actively listening for network connections. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/net_version.yaml b/ethereum/net_version.yaml index 1f1c0d3b..32ed4c08 100644 --- a/ethereum/net_version.yaml +++ b/ethereum/net_version.yaml @@ -22,19 +22,7 @@ components: description: Returns the current network id. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/web3_clientVersion.yaml b/ethereum/web3_clientVersion.yaml index 98d7e658..af73beb2 100644 --- a/ethereum/web3_clientVersion.yaml +++ b/ethereum/web3_clientVersion.yaml @@ -22,19 +22,7 @@ components: description: Returns the current client version. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/ethereum/web3_sha3.yaml b/ethereum/web3_sha3.yaml index de0e1d51..e1261e42 100644 --- a/ethereum/web3_sha3.yaml +++ b/ethereum/web3_sha3.yaml @@ -22,19 +22,7 @@ components: description: Returns Keccak-256 (not the standardized SHA3-256) of the given data. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/nft/nfts.yaml b/nft/nfts.yaml index b03748aa..778ef4db 100644 --- a/nft/nfts.yaml +++ b/nft/nfts.yaml @@ -25,9 +25,10 @@ paths: ## '/v2/{apiKey}/getNFTs': get: + tags: ['Ownership & Token Gating'] summary: getNFTs description: Gets all NFTs currently owned by a given address. - tags: ['Ownership & Token Gating'] + operationId: getNFTs parameters: - $ref: '#/components/schemas/owner' - $ref: '#/components/schemas/contractAddresses' @@ -40,30 +41,6 @@ paths: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/pageKey' - $ref: '#/components/schemas/pageSize' - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - import { Network, Alchemy } from "alchemy-sdk"; - - // Optional Config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: demo, // Replace with your Alchemy API Key. - network: Network.ETH_MAINNET, // Replace with your network. - - }; - - const alchemy = new Alchemy(settings); - - // Print all NFTs returned in the response: - alchemy.nft.getNftsForOwner("vitalik.eth").then(console.log); responses: '200': description: 'Returns the list of all NFTs owned by the given address and satisfying the given input parameters.' @@ -92,12 +69,36 @@ paths: $ref: '#/components/schemas/withContractFiltering_response' withPagination: $ref: '#/components/schemas/withPagination_response' - operationId: getNFTs + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + import { Network, Alchemy } from "alchemy-sdk"; + + // Optional Config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: demo, // Replace with your Alchemy API Key. + network: Network.ETH_MAINNET, // Replace with your network. + + }; + + const alchemy = new Alchemy(settings); + + // Print all NFTs returned in the response: + alchemy.nft.getNftsForOwner("vitalik.eth").then(console.log); '/v2/{apiKey}/getNFTMetadata': get: + tags: ['NFT Metadata Access'] summary: getNFTMetadata description: Gets the metadata associated with a given NFT. - tags: ['NFT Metadata Access'] + operationId: getNFTMetadata parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/contractAddress' @@ -107,6 +108,13 @@ paths: - $ref: '#/components/schemas/tokenType' - $ref: '#/components/schemas/tokenUriTimeoutInMs' - $ref: '#/components/schemas/refreshCache' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ownedNFT' x-readme: samples-languages: - curl @@ -133,19 +141,12 @@ paths: "0x5180db8F5c931aaE63c74266b211F580155ecac8", "1590" ).then(console.log); - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/ownedNFT' - operationId: getNFTMetadata '/v2/{apiKey}/getNFTMetadataBatch': post: + tags: ['NFT Metadata Access'] summary: getNFTMetadataBatch description: Gets the metadata associated with up to 100 given NFT contracts. - tags: ['NFT Metadata Access'] + operationId: getNFTMetadataBatch parameters: - $ref: '#/components/schemas/apiKey' requestBody: @@ -173,6 +174,15 @@ paths: $ref: '#/components/schemas/refreshCache' type: boolean default: false + responses: + '200': + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ownedNFT' x-readme: samples-languages: - curl @@ -199,25 +209,29 @@ paths: "0x5180db8F5c931aaE63c74266b211F580155ecac8", "1590" ).then(console.log); - responses: - '200': - description: '' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ownedNFT' - operationId: getNFTMetadataBatch '/v2/{apiKey}/getContractMetadata': get: + tags: ['NFT Metadata Access'] summary: getContractMetadata description: Queries NFT high-level collection/contract level information. - tags: ['NFT Metadata Access'] + operationId: getContractMetadata parameters: - $ref: '#/components/schemas/apiKey' - $ref: '#/components/schemas/contractAddress' required: true + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + address: + type: string + description: 'String - Contract address for the queried NFT collection' + contractMetadata: + $ref: '#/components/schemas/contractMetadata' x-readme: samples-languages: - curl @@ -242,20 +256,7 @@ paths: alchemy.nft .getContractMetadata("0x61fce80d72363b731425c3a2a46a1a5fed9814b2") .then(console.log); - responses: - '200': - description: '' - content: - application/json: - schema: - type: object - properties: - address: - type: string - description: 'String - Contract address for the queried NFT collection' - contractMetadata: - $ref: '#/components/schemas/contractMetadata' - operationId: getContractMetadata + '/v2/{apiKey}/getContractMetadataBatch': post: summary: getContractMetadataBatch diff --git a/notify/notify.yaml b/notify/notify.yaml index 69dfb7a5..623d29b9 100644 --- a/notify/notify.yaml +++ b/notify/notify.yaml @@ -7,12 +7,26 @@ servers: paths: /graphql/variables/{variable}: get: + tags: ['Custom Webhook API Methods'] summary: Read Variable Elements description: This endpoint allows you to read the values within a Custom Webhook variable - tags: ['Custom Webhook API Methods'] + operationId: read-custom-webhook-variable parameters: - $ref: '#/components/schemas/X-Alchemy-Token' - $ref: '#/components/schemas/variable' + responses: + '200': + description: OK- Successful query of Custom Webhook variable + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/custom_webhook_object_response' + '404': + description: Not found- The requested resource could not be found + '500': + description: Internal Server Error- Try again x-readme: samples-languages: - curl @@ -35,24 +49,11 @@ paths: const alchemy = new Alchemy(settings); alchemy.notify.getAllWebhooks().then(console.log); - responses: - '200': - description: OK- Successful query of Custom Webhook variable - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/custom_webhook_object_response' - '404': - description: Not found- The requested resource could not be found - '500': - description: Internal Server Error- Try again - operationId: read-custom-webhook-variable post: + tags: ['Custom Webhook API Methods'] summary: Create a Variable description: This endpoint allows you to create a variable that can be inserted into a Custom Webhook GraphQL statement - tags: ['Custom Webhook API Methods'] + operationId: create-custom-webhook-variable parameters: - $ref: '#/components/schemas/X-Alchemy-Token' - $ref: '#/components/schemas/variable' @@ -61,6 +62,13 @@ paths: application/json: schema: $ref: '#/components/schemas/create_custom_webhook' + responses: + '201': + description: OK- Successful PUT creation of a Custom Webhook variable + '400': + description: Bad Request- The server cannot understand the request sent by the client, due to a malformed syntax or missing information + '500': + description: Internal Server Error- Try again x-readme: samples-languages: - curl @@ -83,21 +91,21 @@ paths: const alchemy = new Alchemy(settings); alchemy.notify.getAllWebhooks().then(console.log); - responses: - '201': - description: OK- Successful PUT creation of a Custom Webhook variable - '400': - description: Bad Request- The server cannot understand the request sent by the client, due to a malformed syntax or missing information - '500': - description: Internal Server Error- Try again - operationId: create-custom-webhook-variable delete: + tags: ['Custom Webhook API Methods'] summary: Delete a Variable description: This endpoint allows you to delete a Custom Webhook variable - tags: ['Custom Webhook API Methods'] + operationId: delete-custom-webhook-variable parameters: - $ref: '#/components/schemas/X-Alchemy-Token' - $ref: '#/components/schemas/variable' + responses: + '201': + description: OK- Successful deletion of a Custom Webhook variable + '404': + description: Not found- The requested resource could not be found + '500': + description: Internal Server Error- Try again x-readme: samples-languages: - curl @@ -120,18 +128,11 @@ paths: const alchemy = new Alchemy(settings); alchemy.notify.getAllWebhooks().then(console.log); - responses: - '201': - description: OK- Successful deletion of a Custom Webhook variable - '404': - description: Not found- The requested resource could not be found - '500': - description: Internal Server Error- Try again - operationId: delete-custom-webhook-variable patch: + tags: ['Custom Webhook API Methods'] summary: Update a Variable description: 'Add and remove elements within a Custom Webhook variable' - tags: ['Custom Webhook API Methods'] + operationId: update-custom-webhook-variable parameters: - $ref: '#/components/schemas/X-Alchemy-Token' - $ref: '#/components/schemas/variable' @@ -140,6 +141,15 @@ paths: application/json: schema: $ref: '#/components/schemas/update_custom_webhook_variable' + responses: + '200': + description: OK- Successful update to Custom Webhook variable + '400': + description: Bad Request- The server cannot understand the request sent by the client, due to a malformed syntax or missing information + '401': + description: Unauthorized- missing or invalid authentication credentials + '500': + description: Internal Server Error- Try again x-readme: samples-languages: - curl @@ -176,23 +186,23 @@ paths: }, ], }); - responses: - '200': - description: OK- Successful update to Custom Webhook variable - '400': - description: Bad Request- The server cannot understand the request sent by the client, due to a malformed syntax or missing information - '401': - description: Unauthorized- missing or invalid authentication credentials - '500': - description: Internal Server Error- Try again - operationId: update-custom-webhook-variable /team-webhooks: get: + tags: ['Notify API Methods'] summary: Get all webhooks description: This endpoint allows you to get all webhooks on your team. - tags: ['Notify API Methods'] + operationId: team-webhooks parameters: - $ref: '#/components/schemas/X-Alchemy-Token' + responses: + '200': + description: Returns list of webhook objects. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/webhook_object_response' x-readme: samples-languages: - curl @@ -216,26 +226,26 @@ paths: const alchemy = new Alchemy(settings); alchemy.notify.getAllWebhooks().then(console.log); - responses: - '200': - description: Returns list of webhook objects. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/webhook_object_response' - operationId: team-webhooks /webhook-addresses: get: + tags: ['Notify API Methods'] summary: Get all addresses for an Address Activity webhook description: Paginated endpoint to list all of the addresses a given Address Activity webhook is subscribed to. - tags: ['Notify API Methods'] + operationId: webhook-addresses parameters: - $ref: '#/components/schemas/X-Alchemy-Token' - $ref: '#/components/schemas/webhook_id' - $ref: '#/components/schemas/limit' - $ref: '#/components/schemas/after' + responses: + '200': + description: 'List of addresses and pagination info.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/webhook_addresses_response' x-readme: explorer-enabled: false samples-languages: @@ -267,21 +277,12 @@ paths: hooks.webhooks[3], { limit: 3, pageKey: 1 } ); - responses: - '200': - description: 'List of addresses and pagination info.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/webhook_addresses_response' - operationId: webhook-addresses /create-webhook: post: + tags: ['Notify API Methods'] summary: Create webhook description: 'This endpoint allows you to create a webhook.' - tags: ['Notify API Methods'] + operationId: create-webhook parameters: - $ref: '#/components/schemas/X-Alchemy-Token' requestBody: @@ -289,6 +290,13 @@ paths: application/json: schema: $ref: '#/components/schemas/create_webhook' + responses: + '200': + description: 'Returns webhook creation data.' + content: + application/json: + schema: + $ref: '#/components/schemas/create_webhook_response' x-readme: samples-languages: - curl @@ -345,21 +353,14 @@ paths: network: Network.ETH_MAINNET, } ); - responses: - '200': - description: 'Returns webhook creation data.' - content: - application/json: - schema: - $ref: '#/components/schemas/create_webhook_response' - operationId: create-webhook /update-webhook-addresses: patch: + tags: ['Notify API Methods'] summary: Add and remove webhook addresses description: | Add or remove addresses from a specific webhook. *This webhook endpoint is idempotent, meaning that identical requests can be made once or several times in a row with the same effect* - tags: ['Notify API Methods'] + operationId: update-webhook-addresses parameters: - $ref: '#/components/schemas/X-Alchemy-Token' requestBody: @@ -367,6 +368,13 @@ paths: application/json: schema: $ref: '#/components/schemas/update_webhook_addresses' + responses: + '200': + description: 'Returns empty object.' + content: + application/json: + schema: + type: object x-readme: samples-languages: - curl @@ -397,18 +405,11 @@ paths: ], removeAddresses: ["0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96043"], }); - responses: - '200': - description: 'Returns empty object.' - content: - application/json: - schema: - type: object - operationId: update-webhook-addresses put: + tags: ['Notify API Methods'] summary: Replace webhook addresses description: 'Replace entire list of addresses tracked in a given webhook.' - tags: ['Notify API Methods'] + operationId: replace-webhook-addresses parameters: - $ref: '#/components/schemas/X-Alchemy-Token' requestBody: @@ -416,6 +417,13 @@ paths: application/json: schema: $ref: '#/components/schemas/replace_webhook_addresses' + responses: + '200': + description: 'Returns empty object.' + content: + application/json: + schema: + type: object x-readme: samples-languages: - curl @@ -442,19 +450,12 @@ paths: await alchemy.notify.updateWebhook("wh_qv16bt12wbj9kax4", { newAddresses: ["0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96010"], }); - responses: - '200': - description: 'Returns empty object.' - content: - application/json: - schema: - type: object - operationId: replace-webhook-addresses /update-webhook: put: + tags: ['Notify API Methods'] summary: Update webhook status description: 'Allows you to set status of webhooks to active or inactive.' - tags: ['Notify API Methods'] + operationId: update-webhook parameters: - $ref: '#/components/schemas/X-Alchemy-Token' requestBody: @@ -462,6 +463,13 @@ paths: application/json: schema: $ref: '#/components/schemas/update_webhook' + responses: + '200': + description: 'Returns updated webhook status.' + content: + application/json: + schema: + $ref: '#/components/schemas/update_webhook_response' x-readme: samples-languages: - curl @@ -485,19 +493,12 @@ paths: const alchemy = new Alchemy(settings); await alchemy.notify.updateWebhook("wh_qv16bt12wbj9kax4", { isActive: false }); - responses: - '200': - description: 'Returns updated webhook status.' - content: - application/json: - schema: - $ref: '#/components/schemas/update_webhook_response' - operationId: update-webhook /update-webhook-nft-filters: patch: + tags: ['Notify API Methods'] summary: Update webhook NFT filters description: 'Add and remove webhook NFT filters' - tags: ['Notify API Methods'] + operationId: update-webhook-nft-filters parameters: - $ref: '#/components/schemas/X-Alchemy-Token' requestBody: @@ -505,6 +506,13 @@ paths: application/json: schema: $ref: '#/components/schemas/update_webhook_nft_filters' + responses: + '200': + description: 'Returns empty object.' + content: + application/json: + schema: + type: object x-readme: samples-languages: - curl @@ -542,19 +550,12 @@ paths: }, ], }); - responses: - '200': - description: 'Returns empty object.' - content: - application/json: - schema: - type: object - operationId: update-webhook-nft-filters /update-webhook-nft-metadata-filters: patch: + tags: ['Notify API Methods'] summary: Update NFT metadata webhook filters description: 'Add and remove NFT metadata webhook filters' - tags: ['Notify API Methods'] + operationId: update-webhook-nft-metadata-filters parameters: - $ref: '#/components/schemas/X-Alchemy-Token' requestBody: @@ -569,18 +570,27 @@ paths: application/json: schema: type: object - operationId: update-webhook-nft-metadata-filters /webhook-nft-filters: get: + tags: ['Notify API Methods'] summary: Get all webhook NFT filters description: Paginated endpoint to list all of the NFT filter objects a given webhook is subscribed to. - tags: ['Notify API Methods'] + operationId: webhook-nft-filters parameters: - $ref: '#/components/schemas/X-Alchemy-Token' - $ref: '#/components/schemas/webhook_id' - $ref: '#/components/schemas/limit' - $ref: '#/components/schemas/after' + responses: + '200': + description: Returns a list of nft filter objects. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/webhook_nft_filters_response' x-readme: samples-languages: - curl @@ -610,25 +620,23 @@ paths: }); const nftsByWebhook = await alchemy.notify.getNftFilters(hooks.webhooks[1]); - responses: - '200': - description: Returns a list of nft filter objects. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/webhook_nft_filters_response' - operationId: webhook-nft-filters /delete-webhook: delete: + tags: ['Notify API Methods'] summary: Delete webhook description: 'Allows you to delete a webhook.' - tags: ['Notify API Methods'] + operationId: delete-webhook parameters: - $ref: '#/components/schemas/X-Alchemy-Token' - $ref: '#/components/schemas/webhook_id' + responses: + '200': + description: 'Returns empty object.' + content: + application/json: + schema: + type: object x-readme: samples-languages: - curl @@ -659,14 +667,6 @@ paths: await alchemy.notify.deleteWebhook("wh_qv16bt12wbj9ksss"); await alchemy.notify.deleteWebhook(minedTxWebhook); - responses: - '200': - description: 'Returns empty object.' - content: - application/json: - schema: - type: object - operationId: delete-webhook components: schemas: diff --git a/optimism/eth_feeHistory.yaml b/optimism/eth_feeHistory.yaml index ec1c62cb..635040d5 100644 --- a/optimism/eth_feeHistory.yaml +++ b/optimism/eth_feeHistory.yaml @@ -6,67 +6,51 @@ servers: - url: 'https://opt-mainnet.g.alchemy.com/v2 ' paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_feeHistory - Optimism - description: Returns a collection of historical gas information. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_feeHistory - Optimism + description: Returns a collection of historical gas information. + operationId: eth-feeHistory + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_feeHistory + responses: + '200': + description: '' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_feeHistory - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_feeHistory - operationId: eth-feeHistory - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - import { Network, Alchemy } from "alchemy-sdk"; + $ref: ../evm_responses.yaml#/eth_feeHistory + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + import { Network, Alchemy } from "alchemy-sdk"; - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.ETH_MAINNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.ETH_MAINNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - // Using send method from alchemy-sdk with specific transaction details - const res = await alchemy.core.send('eth_feeHistory', [ - '0x5', - 'latest', - [] - ]); + // Using send method from alchemy-sdk with specific transaction details + const res = await alchemy.core.send('eth_feeHistory', [ + '0x5', + 'latest', + [] + ]); - console.log(res); + console.log(res); diff --git a/optimism/eth_getProof.yaml b/optimism/eth_getProof.yaml index 3fff17d1..a0ac805e 100644 --- a/optimism/eth_getProof.yaml +++ b/optimism/eth_getProof.yaml @@ -12,66 +12,50 @@ servers: default: opt-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getProof - Optimism - description: Returns the account and storage values of the specified account including the Merkle-proof on Optimism. This call can be used to verify that the data you are pulling from is not tampered with. - parameters: - - name: apiKey - in: path + post: + summary: eth_getProof - Optimism + description: Returns the account and storage values of the specified account including the Merkle-proof on Optimism. This call can be used to verify that the data you are pulling from is not tampered with. + operationId: eth-getProof-optimism + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getProof + responses: + '200': + description: 'Returns the account and storage values of the specified account.' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getProof - responses: - '200': - description: 'Returns the account and storage values of the specified account.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_getProof - operationId: eth-getProof-optimism - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - import { Network, Alchemy } from "alchemy-sdk"; + $ref: ../evm_responses.yaml#/eth_getProof + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + import { Network, Alchemy } from "alchemy-sdk"; - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.ETH_MAINNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.ETH_MAINNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - // Using send method from alchemy-sdk with specific transaction details - const res = await alchemy.core.send('eth_getProof', [ - '0x7F0d15C7FAae65896648C8273B6d7E43f58Fa842', - ["0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"], - "latest", - ]); + // Using send method from alchemy-sdk with specific transaction details + const res = await alchemy.core.send('eth_getProof', [ + '0x7F0d15C7FAae65896648C8273B6d7E43f58Fa842', + ["0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"], + "latest", + ]); - console.log(res); + console.log(res); diff --git a/optimism/eth_maxPriorityFeePerGas.yaml b/optimism/eth_maxPriorityFeePerGas.yaml index 8e447198..0d11c954 100644 --- a/optimism/eth_maxPriorityFeePerGas.yaml +++ b/optimism/eth_maxPriorityFeePerGas.yaml @@ -13,23 +13,11 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_maxPriorityFeePerGas - Optimism description: "Returns a fee per gas that is an estimate of how much you can pay as a priority fee, or 'tip', to get a transaction included in the current block." - tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/optimism/eth_syncing.yaml b/optimism/eth_syncing.yaml index 5f30d94e..6ca5ccc7 100644 --- a/optimism/eth_syncing.yaml +++ b/optimism/eth_syncing.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_syncing - Optimism description: Returns a list of addresses owned by client. - tags: [] + operationId: eth-syncing-optimism parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: @@ -43,4 +32,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/eth_syncing - operationId: eth-syncing-optimism diff --git a/polygon-pos/bor_getAuthor.yaml b/polygon-pos/bor_getAuthor.yaml index f3d24502..9a7d7936 100644 --- a/polygon-pos/bor_getAuthor.yaml +++ b/polygon-pos/bor_getAuthor.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: bor_getAuthor - Polygon PoS description: 'Returns address of Author on Polygon.' - tags: [] + operationId: bor-getauthor-polygon parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: 'Block number (in hexadecimal format).' content: @@ -43,4 +32,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/bor_getAuthor - operationId: bor-getauthor-polygon diff --git a/polygon-pos/bor_getCurrentProposer.yaml b/polygon-pos/bor_getCurrentProposer.yaml index 4d9ea4e1..39f7ae12 100644 --- a/polygon-pos/bor_getCurrentProposer.yaml +++ b/polygon-pos/bor_getCurrentProposer.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: bor_getCurrentProposer - Polygon PoS description: "Returns current proposer's address on Polygon." - tags: [] + operationId: bor-getcurrentproposer-polygon parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/bor_getCurrentProposer - operationId: bor-getcurrentproposer-polygon diff --git a/polygon-pos/bor_getCurrentValidators.yaml b/polygon-pos/bor_getCurrentValidators.yaml index 166d4958..e8a33e1c 100644 --- a/polygon-pos/bor_getCurrentValidators.yaml +++ b/polygon-pos/bor_getCurrentValidators.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: bor_getCurrentValidators - Polygon PoS description: 'Returns current validators for Polygon.' - tags: [] + operationId: bor-getCurrentValidators-polygon parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/bor_getCurrentValidators - operationId: bor-getCurrentValidators-polygon diff --git a/polygon-pos/bor_getRootHash.yaml b/polygon-pos/bor_getRootHash.yaml index 87ea60a2..2a52e25b 100644 --- a/polygon-pos/bor_getRootHash.yaml +++ b/polygon-pos/bor_getRootHash.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: bor_getRootHash - Polygon PoS description: 'Polygon API - Returns the root hash given a block range.' - tags: [] + operationId: bor-getRootHash-polygon parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/bor_getRootHash - operationId: bor-getRootHash-polygon diff --git a/polygon-pos/bor_getSignersAtHash.yaml b/polygon-pos/bor_getSignersAtHash.yaml index 998f6de1..095aa5b5 100644 --- a/polygon-pos/bor_getSignersAtHash.yaml +++ b/polygon-pos/bor_getSignersAtHash.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: bor_getSignersAtHash - Polygon PoS description: 'Polygon API - Returns all the signers of the block matching the specified block hash.' - tags: [] + operationId: bor-getSignersAtHash-polygon parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/bor_getSignersAtHash - operationId: bor-getSignersAtHash-polygon diff --git a/polygon-pos/eth_blockNumber.yaml b/polygon-pos/eth_blockNumber.yaml index 40d0d8b9..25b752c3 100644 --- a/polygon-pos/eth_blockNumber.yaml +++ b/polygon-pos/eth_blockNumber.yaml @@ -15,6 +15,7 @@ paths: post: summary: eth_blockNumber - Polygon PoS description: Returns the number of the most recent block on Polygon. + operationId: eth-blocknumber-polygon $ref: ../ethereum/eth_blockNumber.yaml#/components/pathItems/path/post x-readme: samples-languages: @@ -38,4 +39,3 @@ paths: // Get the latest block number alchemy.core.getBlockNumber().then(console.log); - operationId: eth-blocknumber-polygon diff --git a/polygon-pos/eth_feeHistory.yaml b/polygon-pos/eth_feeHistory.yaml index 00299656..7458be74 100644 --- a/polygon-pos/eth_feeHistory.yaml +++ b/polygon-pos/eth_feeHistory.yaml @@ -6,67 +6,51 @@ servers: - url: 'https://polygon-mainnet.g.alchemy.com/v2 ' paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_feeHistory - Polygon PoS - description: Returns a collection of historical gas information. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_feeHistory - Polygon PoS + description: Returns a collection of historical gas information. + operationId: eth-feeHistory + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_feeHistory + responses: + '200': + description: '' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_feeHistory - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_feeHistory - operationId: eth-feeHistory - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - import { Network, Alchemy } from "alchemy-sdk"; + $ref: ../evm_responses.yaml#/eth_feeHistory + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + import { Network, Alchemy } from "alchemy-sdk"; - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.ETH_MAINNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.ETH_MAINNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - // Using send method from alchemy-sdk with specific transaction details - const res = await alchemy.core.send('eth_feeHistory', [ - '0x5', - 'latest', - [] - ]); + // Using send method from alchemy-sdk with specific transaction details + const res = await alchemy.core.send('eth_feeHistory', [ + '0x5', + 'latest', + [] + ]); - console.log(res); + console.log(res); diff --git a/polygon-pos/eth_getProof.yaml b/polygon-pos/eth_getProof.yaml index cc862418..f5e26d47 100644 --- a/polygon-pos/eth_getProof.yaml +++ b/polygon-pos/eth_getProof.yaml @@ -20,19 +20,7 @@ components: summary: eth_getProof - Polygon PoS description: Returns the account and storage values of the specified account including the Merkle-proof on Polygon. This call can be used to verify that the data you are pulling from is not tampered with. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-pos/eth_getRootHash.yaml b/polygon-pos/eth_getRootHash.yaml index 466f1292..0dde51ed 100644 --- a/polygon-pos/eth_getRootHash.yaml +++ b/polygon-pos/eth_getRootHash.yaml @@ -13,23 +13,11 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_getRootHash - Polygon PoS description: 'Returns the root hash given a block range on Polygon.' - tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-pos/eth_getSignersAtHash.yaml b/polygon-pos/eth_getSignersAtHash.yaml index 93adc292..d81fe0ec 100644 --- a/polygon-pos/eth_getSignersAtHash.yaml +++ b/polygon-pos/eth_getSignersAtHash.yaml @@ -13,23 +13,11 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_getSignersAtHash - Polygon PoS description: 'Polygon API - Returns all signs given a blockhash.' - tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-pos/eth_getTransactionReceiptsByBlock.yaml b/polygon-pos/eth_getTransactionReceiptsByBlock.yaml index 70a6a956..ceff2a7a 100644 --- a/polygon-pos/eth_getTransactionReceiptsByBlock.yaml +++ b/polygon-pos/eth_getTransactionReceiptsByBlock.yaml @@ -13,23 +13,11 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_getTransactionReceiptsByBlock - Polygon PoS description: 'Polygon API - Returns all transaction receipts for the given block number or hash.' - tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-pos/eth_sendRawTransaction.yaml b/polygon-pos/eth_sendRawTransaction.yaml index ac56e86f..bb6e3d1c 100644 --- a/polygon-pos/eth_sendRawTransaction.yaml +++ b/polygon-pos/eth_sendRawTransaction.yaml @@ -13,30 +13,26 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_sendRawTransaction - Polygon PoS description: | Creates a new message call transaction or a contract creation for signed transactions.
Note: Due to network constraints, transactions on Polygon Mainnet must be submitted with a minimum gasPrice of 30 gwei. - tags: [] + operationId: eth-sendRawTransaction-polygon parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/eth_sendRawTransaction + responses: + '200': + description: 'Returns 32 Bytes - the transaction hash, or the zero hash if the transaction is not yet available.' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response x-readme: samples-languages: - curl @@ -73,11 +69,3 @@ paths: const rawTransaction = await wallet.signTransaction(transaction); await alchemy.transact.sendTransaction(rawTransaction); - responses: - '200': - description: 'Returns 32 Bytes - the transaction hash, or the zero hash if the transaction is not yet available.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-sendRawTransaction-polygon diff --git a/polygon-zkevm/eth_call.yaml b/polygon-zkevm/eth_call.yaml index c9eae6d7..e19e6834 100644 --- a/polygon-zkevm/eth_call.yaml +++ b/polygon-zkevm/eth_call.yaml @@ -13,65 +13,49 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: eth-call-polygon-zkevm - summary: eth_call - Polygon zkEVM - description: Executes a new message call immediately without creating a transaction on the blockchain. - parameters: - - name: apiKey - in: path + post: + operationId: eth-call-polygon-zkevm + summary: eth_call - Polygon zkEVM + description: Executes a new message call immediately without creating a transaction on the blockchain. + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Accepts the transaction call object and the block number / block hash / block tag to execute the call on. + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Accepts the transaction call object and the block number / block hash / block tag to execute the call on. + $ref: ../evm_body.yaml#/eth_call_polygon_zkevm + responses: + '200': + description: The result of the call. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_call_polygon_zkevm - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - const { Network, Alchemy } = require ("alchemy-sdk"); + $ref: ../evm_responses.yaml#/eth_call + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + const { Network, Alchemy } = require ("alchemy-sdk"); - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - // Make a sample eth_call - alchemy.core - .call({ - to: "0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41", - data: "0x3b3b57debf074faa138b72c65adbdcfb329847e4f2c04bde7f7dd7fcad5a52d2f395a558", - }) - .then(console.log); - responses: - '200': - description: The result of the call. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_call + // Make a sample eth_call + alchemy.core + .call({ + to: "0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41", + data: "0x3b3b57debf074faa138b72c65adbdcfb329847e4f2c04bde7f7dd7fcad5a52d2f395a558", + }) + .then(console.log); diff --git a/polygon-zkevm/eth_estimateGas.yaml b/polygon-zkevm/eth_estimateGas.yaml index dcccb536..609e4df1 100644 --- a/polygon-zkevm/eth_estimateGas.yaml +++ b/polygon-zkevm/eth_estimateGas.yaml @@ -12,64 +12,48 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_estimateGas - Polygon zkEVM - description: Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_estimateGas - Polygon zkEVM + description: Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. + operationId: eth-estimateGas-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_estimateGas_polygon_zkEVM + responses: + '200': + description: Returns the amount of gas used. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_estimateGas_polygon_zkEVM - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - const { Network, Alchemy } = require("alchemy-sdk"); + $ref: ../evm_responses.yaml#/string_result_response + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + const { Network, Alchemy } = require("alchemy-sdk"); - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - alchemy.core - .estimateGas({ - to: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", - data: "0xd0e30db0", - }) - .then(console.log); - responses: - '200': - description: Returns the amount of gas used. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-estimateGas-polygon-zkevm + alchemy.core + .estimateGas({ + to: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", + data: "0xd0e30db0", + }) + .then(console.log); diff --git a/polygon-zkevm/eth_getBalance.yaml b/polygon-zkevm/eth_getBalance.yaml index bfae0753..b497a467 100644 --- a/polygon-zkevm/eth_getBalance.yaml +++ b/polygon-zkevm/eth_getBalance.yaml @@ -17,28 +17,24 @@ components: pathItems: path: post: + tags: [] summary: eth_getBalance - Polygon zkEVM description: Returns the balance of the account of a given address on Polygon zkEVM. - tags: [] + operationId: eth-getBalance-polygon-zkevm parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/eth_getBalance_polygon_zkevm + responses: + '200': + description: 'Returns hex value of the current ETH balance for the given address, measured in wei.' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response x-readme: samples-languages: - curl @@ -60,11 +56,3 @@ components: const alchemy = new Alchemy(settings); alchemy.core.getBalance("0xbed9dA8f130aCC29F2580df183F3995eff78fb4D", "latest").then(console.log); - responses: - '200': - description: 'Returns hex value of the current ETH balance for the given address, measured in wei.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-getBalance-polygon-zkevm diff --git a/polygon-zkevm/eth_getCode.yaml b/polygon-zkevm/eth_getCode.yaml index b5ecc6ed..1843b4fd 100644 --- a/polygon-zkevm/eth_getCode.yaml +++ b/polygon-zkevm/eth_getCode.yaml @@ -12,59 +12,43 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getCode - Polygon zkEVM - description: Returns code at a given address on the Polygon zkEVM network. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getCode - Polygon zkEVM + description: Returns code at a given address on the Polygon zkEVM network. + operationId: eth-getCode-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getCode_polygon_zkevm + responses: + '200': + description: Returns the code from the given address. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getCode_polygon_zkevm - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - const { Alchemy, Network } = require("alchemy-sdk"); + $ref: ../evm_responses.yaml#/string_result_response + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + const { Alchemy, Network } = require("alchemy-sdk"); - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - alchemy.core.getCode("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2").then(console.log); - responses: - '200': - description: Returns the code from the given address. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-getCode-polygon-zkevm + alchemy.core.getCode("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2").then(console.log); diff --git a/polygon-zkevm/eth_getCompilers.yaml b/polygon-zkevm/eth_getCompilers.yaml index d5b4ffac..f79f9d0a 100644 --- a/polygon-zkevm/eth_getCompilers.yaml +++ b/polygon-zkevm/eth_getCompilers.yaml @@ -17,23 +17,12 @@ components: pathItems: path: post: + tags: [] summary: eth_getCompilers - Polygon zkEVM description: Returns a list of installed compilers (Deprecated). Response is always empty in Polygon zkEVM. - tags: [] + operationId: eth-getCompilers-polygon-zkevm parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: @@ -48,11 +37,6 @@ components: method: $ref: ../components/schemas.yaml#/Method default: eth_getCompilers - x-readme: - samples-languages: - - curl - - javascript - - python responses: '200': description: Response is always empty. @@ -74,4 +58,8 @@ components: items: type: string example: [] - operationId: eth-getCompilers-polygon-zkevm + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/eth_getStorageAt.yaml b/polygon-zkevm/eth_getStorageAt.yaml index c44eb147..cbce8b80 100644 --- a/polygon-zkevm/eth_getStorageAt.yaml +++ b/polygon-zkevm/eth_getStorageAt.yaml @@ -12,59 +12,43 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getStorageAt - Polygon zkEVM - description: "Returns the value from a storage position at a given address on the Polygon zkEVM network, or in other words, returns the state of the contract's storage, which may not be exposed via the contract's methods." - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getStorageAt - Polygon zkEVM + description: "Returns the value from a storage position at a given address on the Polygon zkEVM network, or in other words, returns the state of the contract's storage, which may not be exposed via the contract's methods." + operationId: eth-getStorageAt-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getStorageAt_polygon_zkevm + responses: + '200': + description: Returns the value at this storage position. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getStorageAt_polygon_zkevm - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - const { Alchemy, Network } = require("alchemy-sdk"); + $ref: ../evm_responses.yaml#/string_result_response + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + const { Alchemy, Network } = require("alchemy-sdk"); - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - alchemy.core.getStorageAt("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", 0).then(console.log); - responses: - '200': - description: Returns the value at this storage position. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-getStorageAt-polygon-zkevm + alchemy.core.getStorageAt("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", 0).then(console.log); diff --git a/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml b/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml index 89d8c3a5..a76ec8c2 100644 --- a/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml @@ -12,43 +12,27 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getTransactionByBlockNumberAndIndex - Polygon zkEVM - description: Returns information about a transaction by block number and transaction index position. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getTransactionByBlockNumberAndIndex - Polygon zkEVM + description: Returns information about a transaction by block number and transaction index position. + operationId: eth-getTransactionByBlockNumberAndIndex-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getTransactionByBlockNumberAndIndex_polygon_zkevm + responses: + '200': + description: '' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getTransactionByBlockNumberAndIndex_polygon_zkevm - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_block - operationId: eth-getTransactionByBlockNumberAndIndex-polygon-zkevm + $ref: ../evm_responses.yaml#/eth_block + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/eth_getTransactionReceipt.yaml b/polygon-zkevm/eth_getTransactionReceipt.yaml index 137f97e6..d9636dd3 100644 --- a/polygon-zkevm/eth_getTransactionReceipt.yaml +++ b/polygon-zkevm/eth_getTransactionReceipt.yaml @@ -12,63 +12,47 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getTransactionReceipt - Polygon zkEVM - description: Returns the receipt of a transaction by transaction hash on Polygon zkEVM. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getTransactionReceipt - Polygon zkEVM + description: Returns the receipt of a transaction by transaction hash on Polygon zkEVM. + operationId: eth-getTransactionReceipt-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getTransactionReceipt + responses: + '200': + description: '' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getTransactionReceipt - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Setup: npm install alchemy-sdk - // Github: https://github.com/alchemyplatform/alchemy-sdk-js - const { Alchemy, Network } = require("alchemy-sdk"); + $ref: ../evm_responses.yaml#/eth_getTransactionReceipt_zkevm + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Setup: npm install alchemy-sdk + // Github: https://github.com/alchemyplatform/alchemy-sdk-js + const { Alchemy, Network } = require("alchemy-sdk"); - // Optional config object, but defaults to demo api-key and eth-mainnet. - const settings = { - apiKey: "demo", // Replace with your Alchemy API Key. - network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. - }; - const alchemy = new Alchemy(settings); + // Optional config object, but defaults to demo api-key and eth-mainnet. + const settings = { + apiKey: "demo", // Replace with your Alchemy API Key. + network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. + }; + const alchemy = new Alchemy(settings); - alchemy.core - .getTransactionReceipt( - "0x60b66de803f7bd34e40a122c30526b74914154ccba03f1f770958cccc9b59038" - ) - .then(console.log); - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_getTransactionReceipt_zkevm - operationId: eth-getTransactionReceipt-zkevm + alchemy.core + .getTransactionReceipt( + "0x60b66de803f7bd34e40a122c30526b74914154ccba03f1f770958cccc9b59038" + ) + .then(console.log); diff --git a/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml b/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml index 6d55da4b..090d3a59 100644 --- a/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml +++ b/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml @@ -12,52 +12,36 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getUncleByBlockHashAndIndex - Polygon zkEVM - description: Returns information about an uncle block by block hash and uncle index position. Response for this method is always empty on Polygon zkEVM. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getUncleByBlockHashAndIndex - Polygon zkEVM + description: Returns information about an uncle block by block hash and uncle index position. Response for this method is always empty on Polygon zkEVM. + operationId: eth-getUncleByBlockHashAndIndex-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getUncleByBlockHashAndIndex + responses: + '200': + description: Response is always empty. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getUncleByBlockHashAndIndex - responses: - '200': - description: Response is always empty. - content: - application/json: - schema: - type: object - required: - - id - - jsonrpc - - result - properties: - id: - $ref: ../components/schemas.yaml#/Id - jsonrpc: - $ref: ../components/schemas.yaml#/JsonRpc - result: - type: array - items: - type: string - example: [] - operationId: eth-getUncleByBlockHashAndIndex-polygon-zkevm + type: object + required: + - id + - jsonrpc + - result + properties: + id: + $ref: ../components/schemas.yaml#/Id + jsonrpc: + $ref: ../components/schemas.yaml#/JsonRpc + result: + type: array + items: + type: string + example: [] diff --git a/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml b/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml index ab329e73..8e1ac8d3 100644 --- a/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml +++ b/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml @@ -12,52 +12,36 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getUncleByBlockNumberAndIndex - Polygon zkEVM - description: Returns information about an uncle block by block number and uncle index position. Response for this method is always empty on Polygon zkEVM. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getUncleByBlockNumberAndIndex - Polygon zkEVM + description: Returns information about an uncle block by block number and uncle index position. Response for this method is always empty on Polygon zkEVM. + operationId: eth-getUncleByBlockNumberAndIndex-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getUncleByBlockNumberAndIndex + responses: + '200': + description: Response is always empty. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getUncleByBlockNumberAndIndex - responses: - '200': - description: Response is always empty. - content: - application/json: - schema: - type: object - required: - - id - - jsonrpc - - result - properties: - id: - $ref: ../components/schemas.yaml#/Id - jsonrpc: - $ref: ../components/schemas.yaml#/JsonRpc - result: - type: array - items: - type: string - example: [] - operationId: eth-getUncleByBlockNumberAndIndex-polygon-zkevm + type: object + required: + - id + - jsonrpc + - result + properties: + id: + $ref: ../components/schemas.yaml#/Id + jsonrpc: + $ref: ../components/schemas.yaml#/JsonRpc + result: + type: array + items: + type: string + example: [] diff --git a/polygon-zkevm/eth_getUncleCountByBlockHash.yaml b/polygon-zkevm/eth_getUncleCountByBlockHash.yaml index 840aa92c..b9812dad 100644 --- a/polygon-zkevm/eth_getUncleCountByBlockHash.yaml +++ b/polygon-zkevm/eth_getUncleCountByBlockHash.yaml @@ -12,55 +12,39 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getUncleCountByBlockHash - Polygon zkEVM - description: Returns the number of uncles in a block specified by block hash. Response for this method is always 0 on Polygon zkEVM. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getUncleCountByBlockHash - Polygon zkEVM + description: Returns the number of uncles in a block specified by block hash. Response for this method is always 0 on Polygon zkEVM. + operationId: eth-getUncleCountByBlockHash-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getUncleCountByBlockHash + responses: + '200': + description: Response is always 0. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getUncleCountByBlockHash - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Response is always 0. - content: - application/json: - schema: - type: object - required: - - id - - jsonrpc - - result - properties: - id: - $ref: ../components/schemas.yaml#/Id - jsonrpc: - $ref: ../components/schemas.yaml#/JsonRpc - result: - type: integer - example: 0 - operationId: eth-getUncleCountByBlockHash-polygon-zkevm + type: object + required: + - id + - jsonrpc + - result + properties: + id: + $ref: ../components/schemas.yaml#/Id + jsonrpc: + $ref: ../components/schemas.yaml#/JsonRpc + result: + type: integer + example: 0 + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml b/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml index d3f07240..80ec464d 100644 --- a/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml +++ b/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml @@ -12,55 +12,39 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_getUncleCountByBlockNumber - Polygon zkEVM - description: Returns the number of uncles in a block specified by block number. Response for this method is always 0 on Polygon zkEVM. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_getUncleCountByBlockNumber - Polygon zkEVM + description: Returns the number of uncles in a block specified by block number. Response for this method is always 0 on Polygon zkEVM. + operationId: eth-getUncleCountByBlockNumber-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_getUncleCountByBlockNumber + responses: + '200': + description: Response is always 0. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_getUncleCountByBlockNumber - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Response is always 0. - content: - application/json: - schema: - type: object - required: - - id - - jsonrpc - - result - properties: - id: - $ref: ../components/schemas.yaml#/Id - jsonrpc: - $ref: ../components/schemas.yaml#/JsonRpc - result: - type: integer - example: 0 - operationId: eth-getUncleCountByBlockNumber-polygon-zkevm + type: object + required: + - id + - jsonrpc + - result + properties: + id: + $ref: ../components/schemas.yaml#/Id + jsonrpc: + $ref: ../components/schemas.yaml#/JsonRpc + result: + type: integer + example: 0 + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/eth_protocolVersion.yaml b/polygon-zkevm/eth_protocolVersion.yaml index c816df4f..1524ab83 100644 --- a/polygon-zkevm/eth_protocolVersion.yaml +++ b/polygon-zkevm/eth_protocolVersion.yaml @@ -12,55 +12,39 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_protocolVersion - Polygon zkEVM - description: Returns the current network protocol version as a string. Response for this method is always 0 on Polygon zkEVM. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_protocolVersion - Polygon zkEVM + description: Returns the current network protocol version as a string. Response for this method is always 0 on Polygon zkEVM. + operationId: eth-protocolVersion-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_protocolVersion + responses: + '200': + description: Response is always 0. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_protocolVersion - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Response is always 0. - content: - application/json: - schema: - type: object - required: - - id - - jsonrpc - - result - properties: - id: - $ref: ../components/schemas.yaml#/Id - jsonrpc: - $ref: ../components/schemas.yaml#/JsonRpc - result: - type: integer - example: 0 - operationId: eth-protocolVersion-polygon-zkevm + type: object + required: + - id + - jsonrpc + - result + properties: + id: + $ref: ../components/schemas.yaml#/Id + jsonrpc: + $ref: ../components/schemas.yaml#/JsonRpc + result: + type: integer + example: 0 + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/eth_sendRawTransaction.yaml b/polygon-zkevm/eth_sendRawTransaction.yaml index 6d2b71f4..adfd9ff5 100644 --- a/polygon-zkevm/eth_sendRawTransaction.yaml +++ b/polygon-zkevm/eth_sendRawTransaction.yaml @@ -12,93 +12,77 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_sendRawTransaction - Polygon zkEVM - description: Creates a new message call transaction or a contract creation for signed transactions on the Polygon zkEVM network. - tags: [] - parameters: - - name: apiKey - in: path + post: + tags: [] + summary: eth_sendRawTransaction - Polygon zkEVM + description: Creates a new message call transaction or a contract creation for signed transactions on the Polygon zkEVM network. + operationId: eth-sendRawTransaction-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/eth_sendRawTransaction + responses: + '200': + description: 'Returns 32 Bytes - the transaction hash, or the zero hash if the transaction is not yet available.' content: application/json: schema: - $ref: ../evm_body.yaml#/eth_sendRawTransaction - x-readme: - samples-languages: - - curl - - javascript - - python - code-samples: - - language: javascript - name: Alchemy SDK - code: | - // Import the Alchemy SDK - const { Network, Alchemy, Wallet, Utils } = require("alchemy-sdk"); + $ref: ../evm_responses.yaml#/string_result_response + x-readme: + samples-languages: + - curl + - javascript + - python + code-samples: + - language: javascript + name: Alchemy SDK + code: | + // Import the Alchemy SDK + const { Network, Alchemy, Wallet, Utils } = require("alchemy-sdk"); - const API_KEY = "demo" // Replace with your Alchemy API key + const API_KEY = "demo" // Replace with your Alchemy API key - // Replace with your Private Key - const PRIVATE_KEY = "ae43266e69d4bcc923fe66083fe8f027be148af839a70b2f11cad554a6f0798b" + // Replace with your Private Key + const PRIVATE_KEY = "ae43266e69d4bcc923fe66083fe8f027be148af839a70b2f11cad554a6f0798b" - // NOTE: A demo private key is given in this case but never use it for real transactions as it's now public. + // NOTE: A demo private key is given in this case but never use it for real transactions as it's now public. - // Configuring the Alchemy SDK - const settings = { - apiKey: API_KEY, - network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. - }; + // Configuring the Alchemy SDK + const settings = { + apiKey: API_KEY, + network: Network.POLYGONZKEVM_TESTNET, // Replace with your network. + }; - // Creating a new alchemy instance - const alchemy = new Alchemy(settings); + // Creating a new alchemy instance + const alchemy = new Alchemy(settings); - async function main() { - // Creating a new wallet instance - const wallet = new Wallet(PRIVATE_KEY); + async function main() { + // Creating a new wallet instance + const wallet = new Wallet(PRIVATE_KEY); - // creating the transaction object - const transaction = { - to: "0xbed9dA8f130aCC29F2580df183F3995eff78fb4D", - value: Utils.parseEther("0.001"), - gasLimit: "21000", - maxPriorityFeePerGas: Utils.parseUnits("5", "gwei"), - maxFeePerGas: Utils.parseUnits("20", "gwei"), - nonce: await alchemy.core.getTransactionCount(wallet.getAddress()), - type: 2, - chainId: 1442, - }; + // creating the transaction object + const transaction = { + to: "0xbed9dA8f130aCC29F2580df183F3995eff78fb4D", + value: Utils.parseEther("0.001"), + gasLimit: "21000", + maxPriorityFeePerGas: Utils.parseUnits("5", "gwei"), + maxFeePerGas: Utils.parseUnits("20", "gwei"), + nonce: await alchemy.core.getTransactionCount(wallet.getAddress()), + type: 2, + chainId: 1442, + }; - // signing the transaction - const rawTransaction = await wallet.signTransaction(transaction); + // signing the transaction + const rawTransaction = await wallet.signTransaction(transaction); - // sending the transaction - let sentTx = await alchemy.transact.sendTransaction(rawTransaction); + // sending the transaction + let sentTx = await alchemy.transact.sendTransaction(rawTransaction); - // Logging the sent tx object - console.log(sentTx); - } + // Logging the sent tx object + console.log(sentTx); + } - main(); - responses: - '200': - description: 'Returns 32 Bytes - the transaction hash, or the zero hash if the transaction is not yet available.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-sendRawTransaction-polygon-zkevm + main(); diff --git a/polygon-zkevm/zkevm_batchNumber.yaml b/polygon-zkevm/zkevm_batchNumber.yaml index 04446569..f9b4b892 100644 --- a/polygon-zkevm/zkevm_batchNumber.yaml +++ b/polygon-zkevm/zkevm_batchNumber.yaml @@ -13,42 +13,26 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-batchNumber-polygon-zkevm - summary: zkevm_batchNumber - Polygon zkEVM - description: Returns the latest batch number. - parameters: - - name: apiKey - in: path + post: + summary: zkevm_batchNumber - Polygon zkEVM + description: Returns the latest batch number. + operationId: zkevm-batchNumber-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: '../evm_body.yaml#/zkevm_batchNumber' + responses: + '200': + description: Returns the latest batch number. content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_batchNumber' - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Returns the latest batch number. - content: - application/json: - schema: - $ref: '../evm_responses.yaml#/zkevm_batchNumber' + $ref: '../evm_responses.yaml#/zkevm_batchNumber' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml b/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml index d5d44b4b..81576cc1 100644 --- a/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml +++ b/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml @@ -13,42 +13,26 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-batchNumberByBlockNumber-polygon-zkevm - summary: zkevm_batchNumberByBlockNumber - Polygon zkEVM - description: Returns the batch number of the batch connected to the block. - parameters: - - name: apiKey - in: path + post: + summary: zkevm_batchNumberByBlockNumber - Polygon zkEVM + description: Returns the batch number of the batch connected to the block. + operationId: zkevm-batchNumberByBlockNumber-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: '../evm_body.yaml#/zkevm_batchNumberByBlockNumber' + responses: + '200': + description: Returns the batch number of the batch connected to the block. content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_batchNumberByBlockNumber' - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Returns the batch number of the batch connected to the block. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/zkevm_batchNumberByBlockNumber + $ref: ../evm_responses.yaml#/zkevm_batchNumberByBlockNumber + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml b/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml index 93d09b56..5c3e419e 100644 --- a/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml +++ b/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml @@ -13,43 +13,27 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-consolidatedBlockNumber-polygon-zkevm - summary: zkevm_consolidatedBlockNumber - Polygon zkEVM - description: Returns the latest block number that is connected to the latest batch verified. - parameters: - - name: apiKey - in: path + post: + summary: zkevm_consolidatedBlockNumber - Polygon zkEVM + description: Returns the latest block number that is connected to the latest batch verified. + operationId: zkevm-consolidatedBlockNumber-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Accepts no parameters. + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Accepts no parameters. + $ref: ../evm_body.yaml#/zkevm_consolidatedBlockNumber + responses: + '200': + description: The latest block number that is connected to the latest batch verified. content: application/json: schema: - $ref: ../evm_body.yaml#/zkevm_consolidatedBlockNumber - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The latest block number that is connected to the latest batch verified. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/zkevm_consolidatedBlockNumber + $ref: ../evm_responses.yaml#/zkevm_consolidatedBlockNumber + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/zkevm_getBatchByNumber.yaml b/polygon-zkevm/zkevm_getBatchByNumber.yaml index 5da0d3a6..e641510b 100644 --- a/polygon-zkevm/zkevm_getBatchByNumber.yaml +++ b/polygon-zkevm/zkevm_getBatchByNumber.yaml @@ -13,42 +13,26 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-getBatchByNumber-polygon-zkevm - summary: zkevm_getBatchByNumber - Polygon zkEVM - description: Returns information about the batch identified by the provided batch number or tag. - parameters: - - name: apiKey - in: path + post: + summary: zkevm_getBatchByNumber - Polygon zkEVM + description: Returns information about the batch identified by the provided batch number or tag. + operationId: zkevm-getBatchByNumber-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: '../evm_body.yaml#/zkevm_getBatchByNumber' + responses: + '200': + description: Returns information about the batch identified by the provided batch number or tag. content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_getBatchByNumber' - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Returns information about the batch identified by the provided batch number or tag. - content: - application/json: - schema: - $ref: '../evm_responses.yaml#/zkevm_getBatchByNumber' + $ref: '../evm_responses.yaml#/zkevm_getBatchByNumber' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/zkevm_getBroadcastURI.yaml b/polygon-zkevm/zkevm_getBroadcastURI.yaml index 07b13740..4bd329c9 100644 --- a/polygon-zkevm/zkevm_getBroadcastURI.yaml +++ b/polygon-zkevm/zkevm_getBroadcastURI.yaml @@ -13,43 +13,27 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-getBroadcastURI-polygon-zkevm - summary: zkevm_getBroadcastURI - Polygon zkEVM + post: + summary: zkevm_getBroadcastURI - Polygon zkEVM + description: Returns the configured Broadcast URL of the Trusted Sequencer. + operationId: zkevm-getBroadcastURI-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: description: Returns the configured Broadcast URL of the Trusted Sequencer. - parameters: - - name: apiKey - in: path + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: '../evm_body.yaml#/zkevm_getBroadcastURI' + responses: + '200': description: Returns the configured Broadcast URL of the Trusted Sequencer. content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_getBroadcastURI' - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Returns the configured Broadcast URL of the Trusted Sequencer. - content: - application/json: - schema: - $ref: '../evm_responses.yaml#/zkevm_getBroadcastURI' + $ref: '../evm_responses.yaml#/zkevm_getBroadcastURI' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/zkevm_isBlockConsolidated.yaml b/polygon-zkevm/zkevm_isBlockConsolidated.yaml index 80a27813..cc85991a 100644 --- a/polygon-zkevm/zkevm_isBlockConsolidated.yaml +++ b/polygon-zkevm/zkevm_isBlockConsolidated.yaml @@ -13,43 +13,27 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-isBlockConsolidated-polygon-zkevm - summary: zkevm_isBlockConsolidated - Polygon zkEVM + post: + summary: zkevm_isBlockConsolidated - Polygon zkEVM + description: Returns true if the provided block number is already connected to a batch that was already verified, otherwise false. + operationId: zkevm-isBlockConsolidated-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: description: Returns true if the provided block number is already connected to a batch that was already verified, otherwise false. - parameters: - - name: apiKey - in: path + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/zkevm_isBlockConsolidated + responses: + '200': description: Returns true if the provided block number is already connected to a batch that was already verified, otherwise false. content: application/json: schema: - $ref: ../evm_body.yaml#/zkevm_isBlockConsolidated - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Returns true if the provided block number is already connected to a batch that was already verified, otherwise false. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/zkevm_isBlockConsolidated + $ref: ../evm_responses.yaml#/zkevm_isBlockConsolidated + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/zkevm_isBlockVirtualized.yaml b/polygon-zkevm/zkevm_isBlockVirtualized.yaml index a7e2a3dc..b4b245d3 100644 --- a/polygon-zkevm/zkevm_isBlockVirtualized.yaml +++ b/polygon-zkevm/zkevm_isBlockVirtualized.yaml @@ -13,43 +13,27 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-isBlockVirtualized-polygon-zkevm - summary: zkevm_isBlockVirtualized - Polygon zkEVM + post: + summary: zkevm_isBlockVirtualized - Polygon zkEVM + description: Returns true if the provided block number is already connected to a batch that was already virtualized, otherwise false. + operationId: zkevm-isBlockVirtualized-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: description: Returns true if the provided block number is already connected to a batch that was already virtualized, otherwise false. - parameters: - - name: apiKey - in: path + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: ../evm_body.yaml#/zkevm_isBlockVirtualized + responses: + '200': description: Returns true if the provided block number is already connected to a batch that was already virtualized, otherwise false. content: application/json: schema: - $ref: ../evm_body.yaml#/zkevm_isBlockVirtualized - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Returns true if the provided block number is already connected to a batch that was already virtualized, otherwise false. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/zkevm_isBlockVirtualized + $ref: ../evm_responses.yaml#/zkevm_isBlockVirtualized + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/zkevm_verifiedBatchNumber.yaml b/polygon-zkevm/zkevm_verifiedBatchNumber.yaml index 1ddbcc8c..59996e17 100644 --- a/polygon-zkevm/zkevm_verifiedBatchNumber.yaml +++ b/polygon-zkevm/zkevm_verifiedBatchNumber.yaml @@ -13,42 +13,26 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-verifiedBatchNumber-polygon-zkevm - summary: zkevm_verifiedBatchNumber - Polygon zkEVM - description: Returns the latest verified batch number. - parameters: - - name: apiKey - in: path + post: + summary: zkevm_verifiedBatchNumber - Polygon zkEVM + description: Returns the latest verified batch number. + operationId: zkevm-verifiedBatchNumber-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: '../evm_body.yaml#/zkevm_verifiedBatchNumber' + responses: + '200': + description: Returns the latest verified batch number. content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_verifiedBatchNumber' - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Returns the latest verified batch number. - content: - application/json: - schema: - $ref: '../evm_responses.yaml#/zkevm_verifiedBatchNumber' + $ref: '../evm_responses.yaml#/zkevm_verifiedBatchNumber' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/zkevm_virtualBatchNumber.yaml b/polygon-zkevm/zkevm_virtualBatchNumber.yaml index 246f8251..3e6daedc 100644 --- a/polygon-zkevm/zkevm_virtualBatchNumber.yaml +++ b/polygon-zkevm/zkevm_virtualBatchNumber.yaml @@ -13,42 +13,26 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: zkevm-virtualBatchNumber-polygon-zkevm - summary: zkevm_virtualBatchNumber - Polygon zkEVM - description: Returns the latest virtual batch number. - parameters: - - name: apiKey - in: path + post: + summary: zkevm_virtualBatchNumber - Polygon zkEVM + description: Returns the latest virtual batch number. + operationId: zkevm-virtualBatchNumber-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: + $ref: '../evm_body.yaml#/zkevm_virtualBatchNumber' + responses: + '200': + description: Returns the latest virtual batch number. content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_virtualBatchNumber' - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: Returns the latest virtual batch number. - content: - application/json: - schema: - $ref: '../evm_responses.yaml#/zkevm_virtualBatchNumber' + $ref: '../evm_responses.yaml#/zkevm_virtualBatchNumber' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/solana/getAccountInfo.yaml b/solana/getAccountInfo.yaml index de626167..d3220ee5 100644 --- a/solana/getAccountInfo.yaml +++ b/solana/getAccountInfo.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getAccountInfo description: Returns all information associated with the account of provided Pubkey. - tags: [] + operationId: getAccountInfo parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getAccountInfo - operationId: getAccountInfo x-readme: explorer-enabled: false diff --git a/solana/getBalance.yaml b/solana/getBalance.yaml index 6b1e0526..f4042da9 100644 --- a/solana/getBalance.yaml +++ b/solana/getBalance.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBalance description: Returns the balance of the account of provided Pubkey. - tags: [] + operationId: getBalance parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getBalance - operationId: getBalance x-readme: explorer-enabled: false diff --git a/solana/getBlock.yaml b/solana/getBlock.yaml index 24e6211d..221042f7 100644 --- a/solana/getBlock.yaml +++ b/solana/getBlock.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlock description: Returns identity and transaction information about a confirmed block in the ledger. - tags: [] + operationId: getBlock parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getBlock - operationId: getBlock x-readme: explorer-enabled: false diff --git a/solana/getBlockCommitment.yaml b/solana/getBlockCommitment.yaml index 46f02ba2..57c145f4 100644 --- a/solana/getBlockCommitment.yaml +++ b/solana/getBlockCommitment.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlockCommitment description: Returns commitment for particular block. - tags: [] + operationId: getBlockCommitment parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getBlockCommitment - operationId: getBlockCommitment diff --git a/solana/getBlockHeight.yaml b/solana/getBlockHeight.yaml index ae61a191..8fd0852a 100644 --- a/solana/getBlockHeight.yaml +++ b/solana/getBlockHeight.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlockHeight description: Returns the current block height of the node. - tags: [] + operationId: getBlockHeight parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getBlockHeight - operationId: getBlockHeight diff --git a/solana/getBlockProduction.yaml b/solana/getBlockProduction.yaml index 78a898c3..e8633992 100644 --- a/solana/getBlockProduction.yaml +++ b/solana/getBlockProduction.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlockProduction description: Returns recent block production information from the current or previous epoch. - tags: [] + operationId: getBlockProduction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getBlockProduction - operationId: getBlockProduction diff --git a/solana/getBlockTime.yaml b/solana/getBlockTime.yaml index e3594476..9c0fa381 100644 --- a/solana/getBlockTime.yaml +++ b/solana/getBlockTime.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlockTime description: Returns the estimated production time of a block. - tags: [] + operationId: getBlockTime parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getBlockTime - operationId: getBlockTime diff --git a/solana/getBlocks.yaml b/solana/getBlocks.yaml index 65d2e570..f0a22d81 100644 --- a/solana/getBlocks.yaml +++ b/solana/getBlocks.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlocks description: Returns a list of confirmed blocks between two slots. - tags: [] + operationId: getBlocks parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getBlocks - operationId: getBlocks x-readme: explorer-enabled: false diff --git a/solana/getBlocksWithLimit.yaml b/solana/getBlocksWithLimit.yaml index 6038aa5c..5e1970c3 100644 --- a/solana/getBlocksWithLimit.yaml +++ b/solana/getBlocksWithLimit.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlocksWithLimit description: Returns a list of confirmed blocks starting at the given slot. - tags: [] + operationId: getBlocksWithLimit parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getBlocks - operationId: getBlocksWithLimit x-readme: explorer-enabled: false diff --git a/solana/getClusterNodes.yaml b/solana/getClusterNodes.yaml index 3ac1693f..8d561e38 100644 --- a/solana/getClusterNodes.yaml +++ b/solana/getClusterNodes.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getClusterNodes description: Returns information about all the nodes participating in the cluster. - tags: [] + operationId: getClusterNodes parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getClusterNodes - operationId: getClusterNodes diff --git a/solana/getEpochInfo.yaml b/solana/getEpochInfo.yaml index 5e1354d0..85815d52 100644 --- a/solana/getEpochInfo.yaml +++ b/solana/getEpochInfo.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getEpochInfo description: Returns information about the current epoch. - tags: [] + operationId: getEpochInfo parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getEpochInfo - operationId: getEpochInfo diff --git a/solana/getEpochSchedule.yaml b/solana/getEpochSchedule.yaml index 06487471..c8c3f4c4 100644 --- a/solana/getEpochSchedule.yaml +++ b/solana/getEpochSchedule.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getEpochSchedule description: Returns epoch schedule information from this cluster's genesis config. - tags: [] + operationId: getEpochSchedule parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getEpochSchedule - operationId: getEpochSchedule diff --git a/solana/getFeeForMessage.yaml b/solana/getFeeForMessage.yaml index 433f73f9..96127e43 100644 --- a/solana/getFeeForMessage.yaml +++ b/solana/getFeeForMessage.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getFeeForMessage description: Get the fee the network will charge for a particular message. - tags: [] + operationId: getFeeForMessage parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getFeeForMessage - operationId: getFeeForMessage x-readme: explorer-enabled: false diff --git a/solana/getFirstAvailableBlock.yaml b/solana/getFirstAvailableBlock.yaml index 25918a3f..6cc4369a 100644 --- a/solana/getFirstAvailableBlock.yaml +++ b/solana/getFirstAvailableBlock.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getFirstAvailableBlock description: Get the fee the network will charge for a particular message. - tags: [] + operationId: getFirstAvailableBlock parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getFirstAvailableBlock - operationId: getFirstAvailableBlock diff --git a/solana/getGenesisHash.yaml b/solana/getGenesisHash.yaml index 869c8b3e..9429f2b0 100644 --- a/solana/getGenesisHash.yaml +++ b/solana/getGenesisHash.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getGenesisHash description: Returns the genesis hash. - tags: [] + operationId: getGenesisHash parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getGenesisHash - operationId: getGenesisHash diff --git a/solana/getHealth.yaml b/solana/getHealth.yaml index d70410dd..bd8165a3 100644 --- a/solana/getHealth.yaml +++ b/solana/getHealth.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getHealth description: Returns the current health of the node. - tags: [] + operationId: getHealth parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getHealth - operationId: getHealth diff --git a/solana/getHighestSnapshotSlot.yaml b/solana/getHighestSnapshotSlot.yaml index 8918a2db..86d1f034 100644 --- a/solana/getHighestSnapshotSlot.yaml +++ b/solana/getHighestSnapshotSlot.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getHighestSnapshotSlot description: Returns the highest slot information that the node has snapshots for. - tags: [] + operationId: getHighestSnapshotSlot parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getHighestSnapshotSlot - operationId: getHighestSnapshotSlot diff --git a/solana/getIdentity.yaml b/solana/getIdentity.yaml index 064a780e..798fb682 100644 --- a/solana/getIdentity.yaml +++ b/solana/getIdentity.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getIdentity description: Returns the identity pubkey for the current node. - tags: [] + operationId: getIdentity parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getIdentity - operationId: getIdentity diff --git a/solana/getInflationGovernor.yaml b/solana/getInflationGovernor.yaml index 3452bb01..f1a363fb 100644 --- a/solana/getInflationGovernor.yaml +++ b/solana/getInflationGovernor.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getInflationGovernor description: Returns the current inflation governor. - tags: [] + operationId: getInflationGovernor parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getInflationGovernor - operationId: getInflationGovernor diff --git a/solana/getInflationRate.yaml b/solana/getInflationRate.yaml index 0321495e..3e07f74c 100644 --- a/solana/getInflationRate.yaml +++ b/solana/getInflationRate.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getInflationRate description: Returns the specific inflation values for the current epoch. - tags: [] + operationId: getInflationRate parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getInflationRate - operationId: getInflationRate diff --git a/solana/getInflationReward.yaml b/solana/getInflationReward.yaml index ee5bc599..78987d2b 100644 --- a/solana/getInflationReward.yaml +++ b/solana/getInflationReward.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getInflationReward description: Returns the inflation / staking reward for a list of addresses for an epoch. - tags: [] + operationId: getInflationReward parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getInflationReward - operationId: getInflationReward x-readme: explorer-enabled: false diff --git a/solana/getLargestAccounts.yaml b/solana/getLargestAccounts.yaml index 7e9a5e7a..60490994 100644 --- a/solana/getLargestAccounts.yaml +++ b/solana/getLargestAccounts.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getLargestAccounts description: Returns the 20 largest accounts, by lamport balance (results may be cached up to two hours). - tags: [] + operationId: getLargestAccounts parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getLargestAccounts - operationId: getLargestAccounts diff --git a/solana/getMaxRetransmitSlot.yaml b/solana/getMaxRetransmitSlot.yaml index 8a703f9c..0a75f4e2 100644 --- a/solana/getMaxRetransmitSlot.yaml +++ b/solana/getMaxRetransmitSlot.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getMaxRetransmitSlot description: Get the max slot seen from retransmit stage. - tags: [] + operationId: getMaxRetransmitSlot parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getMaxRetransmitSlot - operationId: getMaxRetransmitSlot diff --git a/solana/getMaxShredInsertSlot.yaml b/solana/getMaxShredInsertSlot.yaml index e2c1bd58..6cad4285 100644 --- a/solana/getMaxShredInsertSlot.yaml +++ b/solana/getMaxShredInsertSlot.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getMaxShredInsertSlot description: Get the max slot seen from after shred insert.. - tags: [] + operationId: getMaxShredInsertSlot parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getMaxRetransmitSlot - operationId: getMaxShredInsertSlot diff --git a/solana/getMinimumBalanceForRentExemption.yaml b/solana/getMinimumBalanceForRentExemption.yaml index b74d5a28..7e271c7c 100644 --- a/solana/getMinimumBalanceForRentExemption.yaml +++ b/solana/getMinimumBalanceForRentExemption.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getMinimumBalanceForRentExemption description: Returns minimum balance required to make account rent exempt. - tags: [] + operationId: getMinimumBalanceForRentExemption parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getMinimumBalanceForRentExemption - operationId: getMinimumBalanceForRentExemption x-readme: explorer-enabled: false diff --git a/solana/getMultipleAccounts.yaml b/solana/getMultipleAccounts.yaml index d606c90a..c8c63d3f 100644 --- a/solana/getMultipleAccounts.yaml +++ b/solana/getMultipleAccounts.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getMultipleAccounts description: Returns the account information for a list of Pubkeys. - tags: [] + operationId: getMultipleAccounts parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getMultipleAccounts - operationId: getMultipleAccounts x-readme: explorer-enabled: false diff --git a/solana/getProgramAccounts.yaml b/solana/getProgramAccounts.yaml index b5578801..606cd97c 100644 --- a/solana/getProgramAccounts.yaml +++ b/solana/getProgramAccounts.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getProgramAccounts description: Returns all accounts owned by the provided program Pubkey. - tags: [] + operationId: getProgramAccounts parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getProgramAccounts - operationId: getProgramAccounts x-readme: explorer-enabled: false diff --git a/solana/getRecentPerformanceSamples.yaml b/solana/getRecentPerformanceSamples.yaml index 4cf44903..73f10b4e 100644 --- a/solana/getRecentPerformanceSamples.yaml +++ b/solana/getRecentPerformanceSamples.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getRecentPerformanceSamples description: Returns a list of recent performance samples, in reverse slot order. Performance samples are taken every 60 seconds and include the number of transactions and slots that occur in a given time window. - tags: [] + operationId: getRecentPerformanceSamples parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getRecentPerformanceSamples - operationId: getRecentPerformanceSamples diff --git a/solana/getSignatureStatuses.yaml b/solana/getSignatureStatuses.yaml index db37d7fd..9c1ec6ad 100644 --- a/solana/getSignatureStatuses.yaml +++ b/solana/getSignatureStatuses.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSignatureStatuses description: Returns the statuses of a list of signatures. - tags: [] + operationId: getSignatureStatuses parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getSignatureStatuses - operationId: getSignatureStatuses x-readme: explorer-enabled: false diff --git a/solana/getSignaturesForAddress.yaml b/solana/getSignaturesForAddress.yaml index 57c1631f..227e97c5 100644 --- a/solana/getSignaturesForAddress.yaml +++ b/solana/getSignaturesForAddress.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSignaturesForAddress description: Returns signatures for confirmed transactions that include the given address in their accountKeys list. Returns signatures backwards in time from the provided signature or most recent confirmed block. - tags: [] + operationId: getSignaturesForAddress parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getSignaturesForAddress - operationId: getSignaturesForAddress x-readme: explorer-enabled: false diff --git a/solana/getSlot.yaml b/solana/getSlot.yaml index 2489cabc..7474d162 100644 --- a/solana/getSlot.yaml +++ b/solana/getSlot.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSlot description: Returns the slot that has reached the given or default commitment level. - tags: [] + operationId: getSlot parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getSlot - operationId: getSlot diff --git a/solana/getSlotLeader.yaml b/solana/getSlotLeader.yaml index 508cc453..823712cb 100644 --- a/solana/getSlotLeader.yaml +++ b/solana/getSlotLeader.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSlotLeader description: Returns the current slot leader. - tags: [] + operationId: getSlotLeader parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getSlotLeader - operationId: getSlotLeader diff --git a/solana/getSlotLeaders.yaml b/solana/getSlotLeaders.yaml index 7e2ccf15..43404b2b 100644 --- a/solana/getSlotLeaders.yaml +++ b/solana/getSlotLeaders.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSlotLeaders description: Returns the slot leaders for a given slot range. - tags: [] + operationId: getSlotLeaders parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getSlotLeaders - operationId: getSlotLeaders diff --git a/solana/getSupply.yaml b/solana/getSupply.yaml index 6c37fc35..588ec41e 100644 --- a/solana/getSupply.yaml +++ b/solana/getSupply.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSupply description: Returns information about the current supply. - tags: [] + operationId: getSupply parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getSupply - operationId: getSupply diff --git a/solana/getTokenAccountBalance.yaml b/solana/getTokenAccountBalance.yaml index 1aabba72..ab7bf298 100644 --- a/solana/getTokenAccountBalance.yaml +++ b/solana/getTokenAccountBalance.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getTokenAccountBalance description: Returns the token balance of an SPL Token account.. - tags: [] + operationId: getTokenAccountBalance parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getTokenAccountBalance - operationId: getTokenAccountBalance x-readme: explorer-enabled: false diff --git a/solana/getTokenAccountsByOwner.yaml b/solana/getTokenAccountsByOwner.yaml index 9abc491f..eb482877 100644 --- a/solana/getTokenAccountsByOwner.yaml +++ b/solana/getTokenAccountsByOwner.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getTokenAccountsByOwner description: Returns all SPL Token accounts by token owner. - tags: [] + operationId: getTokenAccountsByOwner parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getTokenAccountsByOwner - operationId: getTokenAccountsByOwner x-readme: explorer-enabled: false diff --git a/solana/getTokenSupply.yaml b/solana/getTokenSupply.yaml index e672b706..f320de32 100644 --- a/solana/getTokenSupply.yaml +++ b/solana/getTokenSupply.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getTokenSupply description: Returns the total supply of an SPL Token type. - tags: [] + operationId: getTokenSupply parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getTokenSupply - operationId: getTokenSupply x-readme: explorer-enabled: false diff --git a/solana/getTransaction.yaml b/solana/getTransaction.yaml index 6ca6155d..c5f8624d 100644 --- a/solana/getTransaction.yaml +++ b/solana/getTransaction.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getTransaction description: Returns transaction details for a confirmed transaction. - tags: [] + operationId: getTransaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getTransaction - operationId: getTransaction x-readme: explorer-enabled: false diff --git a/solana/getVersion.yaml b/solana/getVersion.yaml index df4cd6cc..6dc56d31 100644 --- a/solana/getVersion.yaml +++ b/solana/getVersion.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getVersion description: Returns the current solana versions running on the node. - tags: [] + operationId: getVersion parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getVersion - operationId: getVersion diff --git a/solana/getVoteAccounts.yaml b/solana/getVoteAccounts.yaml index 181f7e12..0b70fd31 100644 --- a/solana/getVoteAccounts.yaml +++ b/solana/getVoteAccounts.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getVoteAccounts description: Returns the account info and associated stake for all the voting accounts in the current bank. - tags: [] + operationId: getVoteAccounts parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/getVoteAccounts - operationId: getVoteAccounts diff --git a/solana/isBlockhashValid.yaml b/solana/isBlockhashValid.yaml index c7b86f1f..121af008 100644 --- a/solana/isBlockhashValid.yaml +++ b/solana/isBlockhashValid.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: isBlockhashValid description: Returns whether a blockhash is still valid or not. - tags: [] + operationId: isBlockhashValid parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/isBlockhashValid - operationId: isBlockhashValid x-readme: explorer-enabled: false diff --git a/solana/minimumLedgerSlot.yaml b/solana/minimumLedgerSlot.yaml index 6a768eac..cbc72883 100644 --- a/solana/minimumLedgerSlot.yaml +++ b/solana/minimumLedgerSlot.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: minimumLedgerSlot description: Returns the lowest slot that the node has information about in its ledger. This value may increase over time if the node is configured to purge older ledger data. - tags: [] + operationId: minimumLedgerSlot parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: solana_responses.yaml#/minimumLedgerSlot - operationId: minimumLedgerSlot diff --git a/solana/requestAirdrop.yaml b/solana/requestAirdrop.yaml index 6707b267..376bb126 100644 --- a/solana/requestAirdrop.yaml +++ b/solana/requestAirdrop.yaml @@ -13,34 +13,17 @@ servers: paths: /{apiKey}: post: + tags: [] summary: requestAirdrop description: Requests an airdrop of lamports to a Pubkey - tags: [] + operationId: requestAirdrop parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: solana_body.yaml#/requestAirdrop - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python code-samples: - language: shell name: cURL @@ -61,4 +44,9 @@ paths: application/json: schema: $ref: solana_responses.yaml#/requestAirdrop - operationId: requestAirdrop + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/solana/sendTransaction.yaml b/solana/sendTransaction.yaml index 9da58efe..ead370e5 100644 --- a/solana/sendTransaction.yaml +++ b/solana/sendTransaction.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: sendTransaction description: Submits a signed transaction to the cluster for processing. - tags: [] + operationId: sendTransaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/sendTransaction - operationId: sendTransaction x-readme: explorer-enabled: false diff --git a/solana/simulateTransaction.yaml b/solana/simulateTransaction.yaml index 8f64b103..c4716549 100644 --- a/solana/simulateTransaction.yaml +++ b/solana/simulateTransaction.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: simulateTransaction description: Simulate sending a transaction. - tags: [] + operationId: simulateTransaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/simulateTransaction - operationId: simulateTransaction x-readme: explorer-enabled: false diff --git a/starknet/starknet_addDeclareTransaction.yaml b/starknet/starknet_addDeclareTransaction.yaml index d1eb88c0..aa054573 100644 --- a/starknet/starknet_addDeclareTransaction.yaml +++ b/starknet/starknet_addDeclareTransaction.yaml @@ -13,71 +13,55 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-addDeclareTransaction - summary: starknet_addDeclareTransaction - description: Submit a new class declaration transaction - parameters: - - name: apiKey - in: path + post: + summary: starknet_addDeclareTransaction + description: Submit a new class declaration transaction + operationId: starknet-addDeclareTransaction + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: 'evm_body.yaml#/common_request_fields' # path only works with gh actions for command line add ../ in the beginning + - type: object + properties: + method: + $ref: components/schemas.yaml#/Method # path only works with gh actions for command line add ../ in the beginning + default: starknet_addDeclareTransaction + params: + type: array + title: declare_transaction + items: + $ref: 'components/starknet/schemas.yaml#/BroadcastedDeclareTxn' # path only works with gh actions for command line add ../ in the beginning + description: The declaration transaction to be submitted + minItems: 1 + maxItems: 1 + responses: + '200': + description: The result of the transaction submission content: application/json: schema: allOf: - - $ref: 'evm_body.yaml#/common_request_fields' # path only works with gh actions for command line add ../ in the beginning + - $ref: 'evm_responses.yaml#/common_response_fields' # path only works with gh actions for command line add ../ in the beginning - type: object properties: - method: - $ref: components/schemas.yaml#/Method # path only works with gh actions for command line add ../ in the beginning - default: starknet_addDeclareTransaction - params: - type: array - title: declare_transaction - items: - $ref: 'components/starknet/schemas.yaml#/BroadcastedDeclareTxn' # path only works with gh actions for command line add ../ in the beginning - description: The declaration transaction to be submitted - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The result of the transaction submission - content: - application/json: - schema: - allOf: - - $ref: 'evm_responses.yaml#/common_response_fields' # path only works with gh actions for command line add ../ in the beginning - - type: object - properties: - result: - type: object - properties: - transactionHash: - title: The hash of the declare transaction - $ref: 'components/starknet/schemas.yaml#/TxnHash' # path only works with gh actions for command line add ../ in the beginning - classHash: - title: The hash of the declared class - $ref: 'components/starknet/schemas.yaml#/Felt' # path only works with gh actions for command line add ../ in the beginning - example: - $ref: 'components/starknet/examples.yaml#/starknet_addDeclareTransaction' # path only works with gh actions for command line add ../ in the beginning + result: + type: object + properties: + transactionHash: + title: The hash of the declare transaction + $ref: 'components/starknet/schemas.yaml#/TxnHash' # path only works with gh actions for command line add ../ in the beginning + classHash: + title: The hash of the declared class + $ref: 'components/starknet/schemas.yaml#/Felt' # path only works with gh actions for command line add ../ in the beginning + example: + $ref: 'components/starknet/examples.yaml#/starknet_addDeclareTransaction' # path only works with gh actions for command line add ../ in the beginning + x-readme: + samples-languages: + - curl + - javascript + - python \ No newline at end of file diff --git a/starknet/starknet_addDeployAccountTransaction.yaml b/starknet/starknet_addDeployAccountTransaction.yaml index eb56b1c6..ce387585 100644 --- a/starknet/starknet_addDeployAccountTransaction.yaml +++ b/starknet/starknet_addDeployAccountTransaction.yaml @@ -13,71 +13,55 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-addDeployAccountTransaction - summary: starknet_addDeployAccountTransaction - description: Submit a new deploy account transaction - parameters: - - name: apiKey - in: path + post: + summary: starknet_addDeployAccountTransaction + description: Submit a new deploy account transaction + operationId: starknet-addDeployAccountTransaction + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_addDeployAccountTransaction + params: + type: array + title: deploy_account_transaction + items: + $ref: '../components/starknet/schemas.yaml#/BroadcastedDeployAccountTxn' + description: The deploy account transaction + minItems: 1 + maxItems: 1 + responses: + '200': + description: The result of the transaction submission content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_addDeployAccountTransaction - params: - type: array - title: deploy_account_transaction - items: - $ref: '../components/starknet/schemas.yaml#/BroadcastedDeployAccountTxn' - description: The deploy account transaction - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The result of the transaction submission - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - type: object - properties: - transactionHash: - title: The hash of the deploy transaction - $ref: '../components/starknet/schemas.yaml#/TxnHash' - contractAddress: - title: The address of the new contract - $ref: '../components/starknet/schemas.yaml#/Felt' - example: - $ref: '../components/starknet/examples.yaml#/starknet_addDeployAccountTransaction' + result: + type: object + properties: + transactionHash: + title: The hash of the deploy transaction + $ref: '../components/starknet/schemas.yaml#/TxnHash' + contractAddress: + title: The address of the new contract + $ref: '../components/starknet/schemas.yaml#/Felt' + example: + $ref: '../components/starknet/examples.yaml#/starknet_addDeployAccountTransaction' + x-readme: + samples-languages: + - curl + - javascript + - python \ No newline at end of file diff --git a/starknet/starknet_addInvokeTransaction.yaml b/starknet/starknet_addInvokeTransaction.yaml index ee357ded..ac203ec7 100644 --- a/starknet/starknet_addInvokeTransaction.yaml +++ b/starknet/starknet_addInvokeTransaction.yaml @@ -13,70 +13,54 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-addInvokeTransaction - summary: starknet_addInvokeTransaction - description: Submit a new transaction to be added to the chain - parameters: - - name: apiKey - in: path + post: + summary: starknet_addInvokeTransaction + description: Submit a new transaction to be added to the chain + operationId: starknet-addInvokeTransaction + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_addInvokeTransaction + params: + type: array + title: Parameters + items: + $ref: '../components/starknet/schemas.yaml#/BroadcastedInvokeTxn' + title: invoke_transaction + description: The information needed to invoke the function (or account, for version 1 transactions) + minItems: 1 + maxItems: 1 + responses: + '200': + description: The result of the transaction submission content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_addInvokeTransaction - params: - type: array - title: Parameters - items: - $ref: '../components/starknet/schemas.yaml#/BroadcastedInvokeTxn' - title: invoke_transaction - description: The information needed to invoke the function (or account, for version 1 transactions) - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The result of the transaction submission - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - type: object - properties: - transaction_hash: - $ref: '../components/starknet/schemas.yaml#/TxnHash' - title: The hash of the invoke transaction - description: The hash of the invoke transaction - example: - $ref: '../components/starknet/examples.yaml#/starknet_addInvokeTransaction' + result: + type: object + properties: + transaction_hash: + $ref: '../components/starknet/schemas.yaml#/TxnHash' + title: The hash of the invoke transaction + description: The hash of the invoke transaction + example: + $ref: '../components/starknet/examples.yaml#/starknet_addInvokeTransaction' + x-readme: + samples-languages: + - curl + - javascript + - python \ No newline at end of file diff --git a/starknet/starknet_blockHashAndNumber.yaml b/starknet/starknet_blockHashAndNumber.yaml index 6e56481f..b10f81d5 100644 --- a/starknet/starknet_blockHashAndNumber.yaml +++ b/starknet/starknet_blockHashAndNumber.yaml @@ -13,66 +13,50 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-blockHashAndNumber - summary: starknet_blockHashAndNumber - description: Get the most recent accepted block hash and number - parameters: - - name: apiKey - in: path + post: + summary: starknet_blockHashAndNumber + description: Get the most recent accepted block hash and number + operationId: starknet-blockHashAndNumber + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_blockHashAndNumber + params: + type: array + title: No parameters required + description: This method does not require any parameters + responses: + '200': + description: The latest block hash and number content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_blockHashAndNumber - params: - type: array - title: No parameters required - description: This method does not require any parameters - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The latest block hash and number - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BlockHash' - title: Block hash - description: The hash of the most recent accepted block - - $ref: '../components/starknet/schemas.yaml#/BlockNumber' - title: Block number - description: The number of the most recent accepted block - example: - $ref: '../components/starknet/examples.yaml#/starknet_blockHashAndNumber' + result: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BlockHash' + title: Block hash + description: The hash of the most recent accepted block + - $ref: '../components/starknet/schemas.yaml#/BlockNumber' + title: Block number + description: The number of the most recent accepted block + example: + $ref: '../components/starknet/examples.yaml#/starknet_blockHashAndNumber' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_blockNumber.yaml b/starknet/starknet_blockNumber.yaml index b4daab03..6536a4de 100644 --- a/starknet/starknet_blockNumber.yaml +++ b/starknet/starknet_blockNumber.yaml @@ -13,60 +13,44 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-blockNumber - summary: starknet_blockNumber - description: Get the most recent accepted block number - parameters: - - name: apiKey - in: path + post: + summary: starknet_blockNumber + description: Get the most recent accepted block number + operationId: starknet-blockNumber + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_blockNumber + params: + type: array + title: params + description: The method takes no parameters + responses: + '200': + description: The latest block number content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_blockNumber - params: - type: array - title: params - description: The method takes no parameters - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The latest block number - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - $ref: '../components/starknet/schemas.yaml#/BlockNumber' - example: - $ref: '../components/starknet/examples.yaml#/starknet_blockNumber' + result: + $ref: '../components/starknet/schemas.yaml#/BlockNumber' + example: + $ref: '../components/starknet/examples.yaml#/starknet_blockNumber' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_call.yaml b/starknet/starknet_call.yaml index be52a615..e3d812b1 100644 --- a/starknet/starknet_call.yaml +++ b/starknet/starknet_call.yaml @@ -13,78 +13,62 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-call - summary: starknet_call - description: Calls a function in a contract and returns the return value. Using this call will not create a transaction; hence, will not change the state. - parameters: - - name: apiKey - in: path + post: + summary: starknet_call + description: Calls a function in a contract and returns the return value. Using this call will not create a transaction; hence, will not change the state. + operationId: starknet-call + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_call + params: + type: array + default: + [ + { + 'contract_address': '0x049E0cCb70e1F1684F43116e9E42e60D0f64d3D254Be8D8A1143dba43dEad733', + 'calldata': + ['0xbfc2ea1a458d7cac752a4a688dbb8e0cff399e1b'], + 'entry_point_selector': '0x12ead94ae9d3f9d2bdb6b847cf255f1f398193a1f88884a0ae8e18f24a037b6', + }, + 'latest', + ] + title: Params + items: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/FunctionCall' + - $ref: '../components/starknet/schemas.yaml#/BlockId' + description: The details of the function call and the block_id for the block referencing the state or call the transaction on. + minItems: 2 + maxItems: 2 + responses: + '200': + description: The function's return value content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_call - params: + result: type: array - default: - [ - { - 'contract_address': '0x049E0cCb70e1F1684F43116e9E42e60D0f64d3D254Be8D8A1143dba43dEad733', - 'calldata': - ['0xbfc2ea1a458d7cac752a4a688dbb8e0cff399e1b'], - 'entry_point_selector': '0x12ead94ae9d3f9d2bdb6b847cf255f1f398193a1f88884a0ae8e18f24a037b6', - }, - 'latest', - ] - title: Params items: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/FunctionCall' - - $ref: '../components/starknet/schemas.yaml#/BlockId' - description: The details of the function call and the block_id for the block referencing the state or call the transaction on. - minItems: 2 - maxItems: 2 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The function's return value - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - type: array - items: - $ref: '../components/starknet/schemas.yaml#/Felt' - example: - $ref: '../components/starknet/examples.yaml#/starknet_call' + $ref: '../components/starknet/schemas.yaml#/Felt' + example: + $ref: '../components/starknet/examples.yaml#/starknet_call' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_chainId.yaml b/starknet/starknet_chainId.yaml index d932eb0a..beac812b 100644 --- a/starknet/starknet_chainId.yaml +++ b/starknet/starknet_chainId.yaml @@ -13,62 +13,46 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-chainId - summary: starknet_chainId - description: Return the currently configured StarkNet chain id - parameters: - - name: apiKey - in: path + post: + summary: starknet_chainId + description: Return the currently configured StarkNet chain id + operationId: starknet-chainId + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_chainId + params: + type: array + title: No parameters required + description: This method does not require any parameters + responses: + '200': + description: The chain id this node is connected to content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_chainId - params: - type: array - title: No parameters required - description: This method does not require any parameters - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The chain id this node is connected to - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - $ref: '../components/starknet/schemas.yaml#/ChainId' - title: Chain id - description: The chain id this node is connected to - example: - $ref: '../components/starknet/examples.yaml#/starknet_chainId' + result: + $ref: '../components/starknet/schemas.yaml#/ChainId' + title: Chain id + description: The chain id this node is connected to + example: + $ref: '../components/starknet/examples.yaml#/starknet_chainId' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_estimateFee.yaml b/starknet/starknet_estimateFee.yaml index 37c24561..228af719 100644 --- a/starknet/starknet_estimateFee.yaml +++ b/starknet/starknet_estimateFee.yaml @@ -13,70 +13,54 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-estimateFee - summary: starknet_estimateFee - description: Estimates the resources required by transactions when applied on a given state. - parameters: - - name: apiKey - in: path + post: + summary: starknet_estimateFee + description: Estimates the resources required by transactions when applied on a given state. + operationId: starknet-estimateFee + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_estimateFee + params: + type: array + title: Params + items: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BroadcastedTxn' + - $ref: '../components/starknet/schemas.yaml#/BlockId' + description: The transaction to estimate and the block_id for the block referencing the state or call the transaction on. + maxItems: 1 + minItems: 1 + responses: + '200': + description: The fee estimations content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_estimateFee - params: + result: type: array - title: Params + description: A sequence of fee estimates where the i'th estimate corresponds to the i'th transaction. items: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BroadcastedTxn' - - $ref: '../components/starknet/schemas.yaml#/BlockId' - description: The transaction to estimate and the block_id for the block referencing the state or call the transaction on. - maxItems: 1 - minItems: 1 - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The fee estimations - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - type: array - description: A sequence of fee estimates where the i'th estimate corresponds to the i'th transaction. - items: - $ref: '../components/starknet/schemas.yaml#/FeeEstimate' - example: - $ref: '../components/starknet/examples.yaml#/starknet_estimateFee' + $ref: '../components/starknet/schemas.yaml#/FeeEstimate' + example: + $ref: '../components/starknet/examples.yaml#/starknet_estimateFee' + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_estimateMessageFee.yaml b/starknet/starknet_estimateMessageFee.yaml index becbe9c3..9b6f521f 100644 --- a/starknet/starknet_estimateMessageFee.yaml +++ b/starknet/starknet_estimateMessageFee.yaml @@ -14,23 +14,11 @@ servers: paths: /{apiKey}: post: - operationId: starknet-estimateMessageFee summary: starknet_estimateMessageFee description: Estimates the resources required by the l1_handler transaction induced by the message + operationId: starknet-estimateMessageFee parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: @@ -58,3 +46,9 @@ paths: application/json: schema: $ref: '../components/starknet/schemas.yaml#/FeeEstimate' + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getBlockTransactionCount.yaml b/starknet/starknet_getBlockTransactionCount.yaml index 41efd3e0..829dd215 100644 --- a/starknet/starknet_getBlockTransactionCount.yaml +++ b/starknet/starknet_getBlockTransactionCount.yaml @@ -13,66 +13,51 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getBlockTransactionCount - summary: starknet_getBlockTransactionCount - description: Returns the number of transactions in the designated block. - parameters: - - name: apiKey - in: path + post: + summary: starknet_getBlockTransactionCount + description: Returns the number of transactions in the designated block. + operationId: starknet-getBlockTransactionCount + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_getBlockTransactionCount + params: + type: array + default: ['latest'] + title: Params + items: + - $ref: '../components/starknet/schemas.yaml#/BlockId' + description: The hash of the requested block, or number (height) of the requested block, or a block tag + minItems: 1 + maxItems: 1 + responses: + '200': + description: The number of transactions in the designated block content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_getBlockTransactionCount - params: - type: array - default: ['latest'] - title: Params - items: - - $ref: '../components/starknet/schemas.yaml#/BlockId' - description: The hash of the requested block, or number (height) of the requested block, or a block tag - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The number of transactions in the designated block - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - type: integer - minimum: 0 - example: - $ref: '../components/starknet/examples.yaml#/starknet_getBlockTransactionCount' + result: + type: integer + minimum: 0 + example: + $ref: '../components/starknet/examples.yaml#/starknet_getBlockTransactionCount' + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getBlockWithTxHashes.yaml b/starknet/starknet_getBlockWithTxHashes.yaml index ea8557a2..a2339fbf 100644 --- a/starknet/starknet_getBlockWithTxHashes.yaml +++ b/starknet/starknet_getBlockWithTxHashes.yaml @@ -13,66 +13,51 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getBlockWithTxHashes - summary: starknet_getBlockWithTxHashes - description: Get block information with transaction hashes given the block id - parameters: - - name: apiKey - in: path + post: + summary: starknet_getBlockWithTxHashes + description: Get block information with transaction hashes given the block id + operationId: starknet-getBlockWithTxHashes + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getBlockWithTxHashes + params: + type: array + title: block_id + items: + $ref: '../components/starknet/schemas.yaml#/BlockId' + description: The hash of the requested block, or number (height) of the requested block, or a block tag + minItems: 1 + maxItems: 1 + responses: + '200': + description: The resulting block information with transaction hashes content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getBlockWithTxHashes - params: - type: array - title: block_id - items: - $ref: '../components/starknet/schemas.yaml#/BlockId' - description: The hash of the requested block, or number (height) of the requested block, or a block tag - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The resulting block information with transaction hashes - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BlockWithTxHashes' - - $ref: '../components/starknet/schemas.yaml#/PendingBlockWithTxHashes' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getBlockWithTxHashes' + result: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BlockWithTxHashes' + - $ref: '../components/starknet/schemas.yaml#/PendingBlockWithTxHashes' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getBlockWithTxHashes' + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getBlockWithTxs.yaml b/starknet/starknet_getBlockWithTxs.yaml index 67871d77..d198880a 100644 --- a/starknet/starknet_getBlockWithTxs.yaml +++ b/starknet/starknet_getBlockWithTxs.yaml @@ -13,66 +13,51 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getBlockWithTxs - summary: starknet_getBlockWithTxs - description: Get block information with full transactions given the block id - parameters: - - name: apiKey - in: path + post: + summary: starknet_getBlockWithTxs + description: Get block information with full transactions given the block id + operationId: starknet-getBlockWithTxs + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getBlockWithTxs + params: + type: array + title: block_id + items: + $ref: '../components/starknet/schemas.yaml#/BlockId' + description: The hash of the requested block, or number (height) of the requested block, or a block tag + minItems: 1 + maxItems: 1 + responses: + '200': + description: The resulting block information with full transactions content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getBlockWithTxs - params: - type: array - title: block_id - items: - $ref: '../components/starknet/schemas.yaml#/BlockId' - description: The hash of the requested block, or number (height) of the requested block, or a block tag - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The resulting block information with full transactions - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BlockWithTxs' - - $ref: '../components/starknet/schemas.yaml#/PendingBlockWithTxs' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getBlockWithTxs' + result: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BlockWithTxs' + - $ref: '../components/starknet/schemas.yaml#/PendingBlockWithTxs' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getBlockWithTxs' + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getClass.yaml b/starknet/starknet_getClass.yaml index 3d7ebbab..738c6203 100644 --- a/starknet/starknet_getClass.yaml +++ b/starknet/starknet_getClass.yaml @@ -13,69 +13,54 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getClass - summary: starknet_getClass - description: Get the contract class definition in the given block associated with the given hash - parameters: - - name: apiKey - in: path + post: + summary: starknet_getClass + description: Get the contract class definition in the given block associated with the given hash + operationId: starknet-getClass + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getClass + params: + type: array + title: Params + items: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BlockId' + - $ref: '../components/starknet/schemas.yaml#/Felt' + default: '0x601407cf04ab1fbab155f913db64891dc749f4343bc9e535bd012234a46dc61' + description: The block id of the requested block and the hash of the requested contract class + minItems: 2 + maxItems: 2 + responses: + '200': + description: The contract class, if found content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getClass - params: - type: array - title: Params - items: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BlockId' - - $ref: '../components/starknet/schemas.yaml#/Felt' - default: '0x601407cf04ab1fbab155f913db64891dc749f4343bc9e535bd012234a46dc61' - description: The block id of the requested block and the hash of the requested contract class - minItems: 2 - maxItems: 2 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The contract class, if found - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/DeprecatedContractClass' - - $ref: '../components/starknet/schemas.yaml#/ContractClass' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getClass' + result: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/DeprecatedContractClass' + - $ref: '../components/starknet/schemas.yaml#/ContractClass' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getClass' + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getClassAt.yaml b/starknet/starknet_getClassAt.yaml index cfb2c32f..888f89bd 100644 --- a/starknet/starknet_getClassAt.yaml +++ b/starknet/starknet_getClassAt.yaml @@ -13,68 +13,53 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getClassAt - summary: starknet_getClassAt - description: Get the contract class definition in the given block at the given address - parameters: - - name: apiKey - in: path + post: + summary: starknet_getClassAt + description: Get the contract class definition in the given block at the given address + operationId: starknet-getClassAt + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_getClassAt + params: + type: array + title: Params + items: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BlockId' + - $ref: '../components/starknet/schemas.yaml#/Address' + description: The hash of the requested block and the address of the contract whose class definition will be returned + minItems: 2 + maxItems: 2 + responses: + '200': + description: The contract class content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_getClassAt - params: - type: array - title: Params - items: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BlockId' - - $ref: '../components/starknet/schemas.yaml#/Address' - description: The hash of the requested block and the address of the contract whose class definition will be returned - minItems: 2 - maxItems: 2 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The contract class - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/DeprecatedContractClass' - - $ref: '../components/starknet/schemas.yaml#/ContractClass' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getClassAt' + result: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/DeprecatedContractClass' + - $ref: '../components/starknet/schemas.yaml#/ContractClass' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getClassAt' + x-readme: + explorer-enabled: false + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getClassHashAt.yaml b/starknet/starknet_getClassHashAt.yaml index 5a1b1dce..8060ca09 100644 --- a/starknet/starknet_getClassHashAt.yaml +++ b/starknet/starknet_getClassHashAt.yaml @@ -13,66 +13,50 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getClassHashAt - summary: starknet_getClassHashAt - description: Get the contract class hash in the given block for the contract deployed at the given address - parameters: - - name: apiKey - in: path + post: + summary: starknet_getClassHashAt + description: Get the contract class hash in the given block for the contract deployed at the given address + operationId: starknet-getClassHashAt + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getClassHashAt + params: + type: array + title: Params + items: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BlockId' + - $ref: '../components/starknet/schemas.yaml#/Address' + description: The hash of the requested block and the address of the contract whose class hash will be returned + minItems: 2 + maxItems: 2 + responses: + '200': + description: The class hash of the given contract content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getClassHashAt - params: - type: array - title: Params - items: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BlockId' - - $ref: '../components/starknet/schemas.yaml#/Address' - description: The hash of the requested block and the address of the contract whose class hash will be returned - minItems: 2 - maxItems: 2 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The class hash of the given contract - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - $ref: '../components/starknet/schemas.yaml#/Felt' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getClassHashAt' + result: + $ref: '../components/starknet/schemas.yaml#/Felt' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getClassHashAt' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getEvents.yaml b/starknet/starknet_getEvents.yaml index c77476c5..a8de3fe4 100644 --- a/starknet/starknet_getEvents.yaml +++ b/starknet/starknet_getEvents.yaml @@ -13,77 +13,61 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getEvents - summary: starknet_getEvents - description: Returns all event objects matching the conditions in the provided filter - parameters: - - name: apiKey - in: path + post: + summary: starknet_getEvents + description: Returns all event objects matching the conditions in the provided filter + operationId: starknet-getEvents + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_getEvents + params: + type: array + default: + [ + { + 'from_block': 'latest', + 'to_block': 'latest', + 'address': '0x044e5b3f0471a26bc749ffa1d8dd8e43640e05f1b33cf05cef6adee6f5b1b4cf', + 'chunk_size': 10, + }, + ] + title: filter + items: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/EventFilter' + - $ref: '../components/starknet/schemas.yaml#/ResultPageRequest' + description: The conditions used to filter the returned events + minItems: 1 + maxItems: 1 + responses: + '200': + description: All the event objects matching the filter content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_getEvents - params: - type: array - default: - [ - { - 'from_block': 'latest', - 'to_block': 'latest', - 'address': '0x044e5b3f0471a26bc749ffa1d8dd8e43640e05f1b33cf05cef6adee6f5b1b4cf', - 'chunk_size': 10, - }, - ] - title: filter - items: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/EventFilter' - - $ref: '../components/starknet/schemas.yaml#/ResultPageRequest' - description: The conditions used to filter the returned events - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: All the event objects matching the filter - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - $ref: '../components/starknet/schemas.yaml#/EventsChunk' - title: events - description: All the event objects matching the filter - example: - $ref: '../components/starknet/examples.yaml#/starknet_getEvents' + result: + $ref: '../components/starknet/schemas.yaml#/EventsChunk' + title: events + description: All the event objects matching the filter + example: + $ref: '../components/starknet/examples.yaml#/starknet_getEvents' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getNonce.yaml b/starknet/starknet_getNonce.yaml index f9578d70..c5f2bf57 100644 --- a/starknet/starknet_getNonce.yaml +++ b/starknet/starknet_getNonce.yaml @@ -13,71 +13,55 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getNonce - summary: starknet_getNonce - description: Get the nonce associated with the given address in the given block - parameters: - - name: apiKey - in: path + post: + summary: starknet_getNonce + description: Get the nonce associated with the given address in the given block + operationId: starknet-getNonce + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_getNonce + params: + type: array + title: Parameters + items: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BlockId' + title: block_id + description: The hash of the requested block, or number (height) of the requested block, or a block tag + - $ref: '../components/starknet/schemas.yaml#/Address' + title: contract_address + description: The address of the contract whose nonce we're seeking + minItems: 2 + maxItems: 2 + responses: + '200': + description: The last nonce used for the given contract content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_getNonce - params: - type: array - title: Parameters - items: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BlockId' - title: block_id - description: The hash of the requested block, or number (height) of the requested block, or a block tag - - $ref: '../components/starknet/schemas.yaml#/Address' - title: contract_address - description: The address of the contract whose nonce we're seeking - minItems: 2 - maxItems: 2 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The last nonce used for the given contract - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - $ref: '../components/starknet/schemas.yaml#/Felt' - title: result - description: The last nonce used for the given contract - example: - $ref: '../components/starknet/examples.yaml#/starknet_getNonce' + result: + $ref: '../components/starknet/schemas.yaml#/Felt' + title: result + description: The last nonce used for the given contract + example: + $ref: '../components/starknet/examples.yaml#/starknet_getNonce' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getStateUpdate.yaml b/starknet/starknet_getStateUpdate.yaml index 7dcce27b..8cf3a8ac 100644 --- a/starknet/starknet_getStateUpdate.yaml +++ b/starknet/starknet_getStateUpdate.yaml @@ -13,66 +13,50 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getStateUpdate - summary: starknet_getStateUpdate - description: Get the information about the result of executing the requested block - parameters: - - name: apiKey - in: path + post: + summary: starknet_getStateUpdate + description: Get the information about the result of executing the requested block + operationId: starknet-getStateUpdate + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getStateUpdate + params: + type: array + title: block_id + items: + $ref: '../components/starknet/schemas.yaml#/BlockId' + description: The hash of the requested block, or number (height) of the requested block, or a block tag + minItems: 1 + maxItems: 1 + responses: + '200': + description: The information about the state update of the requested block content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getStateUpdate - params: - type: array - title: block_id - items: - $ref: '../components/starknet/schemas.yaml#/BlockId' - description: The hash of the requested block, or number (height) of the requested block, or a block tag - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The information about the state update of the requested block - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/StateUpdate' - - $ref: '../components/starknet/schemas.yaml#/PendingStateUpdate' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getStateUpdate' + result: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/StateUpdate' + - $ref: '../components/starknet/schemas.yaml#/PendingStateUpdate' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getStateUpdate' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getStorageAt.yaml b/starknet/starknet_getStorageAt.yaml index ced9c443..3224f528 100644 --- a/starknet/starknet_getStorageAt.yaml +++ b/starknet/starknet_getStorageAt.yaml @@ -13,72 +13,56 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getStorageAt - summary: starknet_getStorageAt - description: Get the value of the storage at the given address and key - parameters: - - name: apiKey - in: path + post: + summary: starknet_getStorageAt + description: Get the value of the storage at the given address and key + operationId: starknet-getStorageAt + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getStorageAt + params: + type: array + title: Params + items: + - $ref: '../components/starknet/schemas.yaml#/Address' + - $ref: '../components/starknet/schemas.yaml#/StorageKey' + - $ref: '../components/starknet/schemas.yaml#/BlockId' + description: The contract address, key, and block_id + minItems: 3 + maxItems: 3 + default: + [ + '0x044e5b3f0471a26bc749ffa1d8dd8e43640e05f1b33cf05cef6adee6f5b1b4cf', + '0x0000000000000000000000000000000000000000000000000000000000000001', + 'latest', + ] + responses: + '200': + description: The value at the given key for the given contract. 0 if no value is found content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getStorageAt - params: - type: array - title: Params - items: - - $ref: '../components/starknet/schemas.yaml#/Address' - - $ref: '../components/starknet/schemas.yaml#/StorageKey' - - $ref: '../components/starknet/schemas.yaml#/BlockId' - description: The contract address, key, and block_id - minItems: 3 - maxItems: 3 - default: - [ - '0x044e5b3f0471a26bc749ffa1d8dd8e43640e05f1b33cf05cef6adee6f5b1b4cf', - '0x0000000000000000000000000000000000000000000000000000000000000001', - 'latest', - ] - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The value at the given key for the given contract. 0 if no value is found - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - $ref: '../components/starknet/schemas.yaml#/Felt' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getStorageAt' + result: + $ref: '../components/starknet/schemas.yaml#/Felt' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getStorageAt' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getTransactionByBlockIdAndIndex.yaml b/starknet/starknet_getTransactionByBlockIdAndIndex.yaml index a48edc5c..2ff6cb66 100644 --- a/starknet/starknet_getTransactionByBlockIdAndIndex.yaml +++ b/starknet/starknet_getTransactionByBlockIdAndIndex.yaml @@ -13,68 +13,52 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getTransactionByBlockIdAndIndex - summary: starknet_getTransactionByBlockIdAndIndex - description: Get the details of the transaction given by the identified block and index in that block. If no transaction is found, null is returned. - parameters: - - name: apiKey - in: path + post: + summary: starknet_getTransactionByBlockIdAndIndex + description: Get the details of the transaction given by the identified block and index in that block. If no transaction is found, null is returned. + operationId: starknet-getTransactionByBlockIdAndIndex + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getTransactionByBlockIdAndIndex + params: + type: array + title: Params + items: + oneOf: + - $ref: '../components/starknet/schemas.yaml#/BlockId' + - type: integer + minimum: 0 + default: 1 + description: The block_id and index of the requested transaction + minItems: 2 + maxItems: 2 + responses: + '200': + description: The details of the transaction given by the identified block and index in that block content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getTransactionByBlockIdAndIndex - params: - type: array - title: Params - items: - oneOf: - - $ref: '../components/starknet/schemas.yaml#/BlockId' - - type: integer - minimum: 0 - default: 1 - description: The block_id and index of the requested transaction - minItems: 2 - maxItems: 2 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The details of the transaction given by the identified block and index in that block - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - transactionResult: - $ref: '../components/starknet/schemas.yaml#/Txn' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getTransactionByBlockIdAndIndex' + transactionResult: + $ref: '../components/starknet/schemas.yaml#/Txn' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getTransactionByBlockIdAndIndex' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getTransactionByHash.yaml b/starknet/starknet_getTransactionByHash.yaml index 5ba4cb92..3d3c3df3 100644 --- a/starknet/starknet_getTransactionByHash.yaml +++ b/starknet/starknet_getTransactionByHash.yaml @@ -13,68 +13,52 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getTransactionByHash - summary: starknet_getTransactionByHash - description: Get the details and status of a submitted transaction - parameters: - - name: apiKey - in: path + post: + summary: starknet_getTransactionByHash + description: Get the details and status of a submitted transaction + operationId: starknet-getTransactionByHash + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getTransactionByHash + params: + type: array + title: Params + default: + [ + '0x019041241b3e0924636b94fd780eca8ed82149299a5fd2f9c90aaeabe5da8728', + ] + items: + - $ref: '../components/starknet/schemas.yaml#/TxnHash' + description: The transaction hash of the requested transaction + minItems: 1 + maxItems: 1 + responses: + '200': + description: The details and status of a submitted transaction content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getTransactionByHash - params: - type: array - title: Params - default: - [ - '0x019041241b3e0924636b94fd780eca8ed82149299a5fd2f9c90aaeabe5da8728', - ] - items: - - $ref: '../components/starknet/schemas.yaml#/TxnHash' - description: The transaction hash of the requested transaction - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The details and status of a submitted transaction - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - $ref: '../components/starknet/schemas.yaml#/Txn' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getTransactionByHash' + result: + $ref: '../components/starknet/schemas.yaml#/Txn' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getTransactionByHash' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_getTransactionReceipt.yaml b/starknet/starknet_getTransactionReceipt.yaml index 776598a8..0674ec54 100644 --- a/starknet/starknet_getTransactionReceipt.yaml +++ b/starknet/starknet_getTransactionReceipt.yaml @@ -13,68 +13,52 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-getTransactionReceipt - summary: starknet_getTransactionReceipt - description: Get the transaction receipt by the transaction hash - parameters: - - name: apiKey - in: path + post: + summary: starknet_getTransactionReceipt + description: Get the transaction receipt by the transaction hash + operationId: starknet-getTransactionReceipt + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: ../components/schemas.yaml#/Method + default: starknet_getTransactionReceipt + params: + type: array + default: + [ + '0x019041241b3e0924636b94fd780eca8ed82149299a5fd2f9c90aaeabe5da8728', + ] + title: Params + items: + - $ref: '../components/starknet/schemas.yaml#/TxnHash' + description: The transaction hash of the requested transaction + minItems: 1 + maxItems: 1 + responses: + '200': + description: The transaction receipt by the transaction hash content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: ../components/schemas.yaml#/Method - default: starknet_getTransactionReceipt - params: - type: array - default: - [ - '0x019041241b3e0924636b94fd780eca8ed82149299a5fd2f9c90aaeabe5da8728', - ] - title: Params - items: - - $ref: '../components/starknet/schemas.yaml#/TxnHash' - description: The transaction hash of the requested transaction - minItems: 1 - maxItems: 1 - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The transaction receipt by the transaction hash - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - $ref: '../components/starknet/schemas.yaml#/TxnReceipt' - example: - $ref: '../components/starknet/examples.yaml#/starknet_getTransactionReceipt' + result: + $ref: '../components/starknet/schemas.yaml#/TxnReceipt' + example: + $ref: '../components/starknet/examples.yaml#/starknet_getTransactionReceipt' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_pendingTransactions.yaml b/starknet/starknet_pendingTransactions.yaml index cf895d25..2c81969f 100644 --- a/starknet/starknet_pendingTransactions.yaml +++ b/starknet/starknet_pendingTransactions.yaml @@ -13,63 +13,47 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-pendingTransactions - summary: starknet_pendingTransactions - description: Returns the transactions in the transaction pool, recognized by this sequencer - parameters: - - name: apiKey - in: path + post: + summary: starknet_pendingTransactions + description: Returns the transactions in the transaction pool, recognized by this sequencer + operationId: starknet-pendingTransactions + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_pendingTransactions + params: + type: array + title: No parameters required + description: This method does not require any parameters + responses: + '200': + description: The transactions in the transaction pool, recognized by this sequencer content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_pendingTransactions - params: + result: type: array - title: No parameters required - description: This method does not require any parameters - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The transactions in the transaction pool, recognized by this sequencer - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - type: array - title: Pending Transactions - items: - $ref: '../components/starknet/schemas.yaml#/Txn' - example: - $ref: '../components/starknet/examples.yaml#/starknet_pendingTransactions' + title: Pending Transactions + items: + $ref: '../components/starknet/schemas.yaml#/Txn' + example: + $ref: '../components/starknet/examples.yaml#/starknet_pendingTransactions' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/starknet/starknet_syncing.yaml b/starknet/starknet_syncing.yaml index 087f7c1f..586a4a5b 100644 --- a/starknet/starknet_syncing.yaml +++ b/starknet/starknet_syncing.yaml @@ -13,66 +13,50 @@ servers: default: starknet-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: starknet-syncing - summary: starknet_syncing - description: Returns an object about the sync status, or false if the node is not synching - parameters: - - name: apiKey - in: path + post: + summary: starknet_syncing + description: Returns an object about the sync status, or false if the node is not synching + operationId: starknet-syncing + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Request Body + content: + application/json: schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - description: Request Body + allOf: + - $ref: '../evm_body.yaml#/common_request_fields' + - type: object + properties: + method: + $ref: '../components/schemas.yaml#/Method' + default: starknet_syncing + params: + type: array + title: No parameters required + description: This method does not require any parameters + responses: + '200': + description: The state of the synchronization, or false if the node is not synchronizing content: application/json: schema: allOf: - - $ref: '../evm_body.yaml#/common_request_fields' + - $ref: '../evm_responses.yaml#/common_response_fields' - type: object properties: - method: - $ref: '../components/schemas.yaml#/Method' - default: starknet_syncing - params: - type: array - title: No parameters required - description: This method does not require any parameters - x-readme: - samples-languages: - - curl - - javascript - - python - responses: - '200': - description: The state of the synchronization, or false if the node is not synchronizing - content: - application/json: - schema: - allOf: - - $ref: '../evm_responses.yaml#/common_response_fields' - - type: object - properties: - result: - oneOf: - - type: boolean - title: Not synchronizing - description: only legal value is FALSE here - - $ref: '../components/starknet/schemas.yaml#/SyncStatus' - title: Sync status - description: The status of the node, if it is currently synchronizing state - example: - $ref: '../components/starknet/examples.yaml#/starknet_syncing' + result: + oneOf: + - type: boolean + title: Not synchronizing + description: only legal value is FALSE here + - $ref: '../components/starknet/schemas.yaml#/SyncStatus' + title: Sync status + description: The status of the node, if it is currently synchronizing state + example: + $ref: '../components/starknet/examples.yaml#/starknet_syncing' + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/token/alchemy_getTokenAllowance.yaml b/token/alchemy_getTokenAllowance.yaml index fe8b43e0..09624387 100644 --- a/token/alchemy_getTokenAllowance.yaml +++ b/token/alchemy_getTokenAllowance.yaml @@ -19,23 +19,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: alchemy_getTokenAllowance description: 'Returns the amount which the spender is allowed to withdraw from the owner.' - tags: [] + operationId: alchemy-getTokenAllowance parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -48,4 +37,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/alchemy_getTokenAllowance - operationId: alchemy-getTokenAllowance diff --git a/token/alchemy_getTokenBalances.yaml b/token/alchemy_getTokenBalances.yaml index e99d28b6..0d0f91e3 100644 --- a/token/alchemy_getTokenBalances.yaml +++ b/token/alchemy_getTokenBalances.yaml @@ -21,28 +21,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: alchemy_getTokenBalances description: 'Returns ERC20 token balances for all tokens the given address has ever transacted in with. Optionally accepts a list of contracts.' - tags: [] + operationId: alchemy-getTokenBalances parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/alchemy_getTokenBalances + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/alchemy_getTokenBalances x-readme: samples-languages: - curl @@ -68,11 +64,3 @@ paths: // Print token balances of USDC in Vitalik's address alchemy.core.getTokenBalances(vitalikAddress, [usdcContract]).then(console.log); - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/alchemy_getTokenBalances - operationId: alchemy-getTokenBalances diff --git a/token/alchemy_getTokenMetadata.yaml b/token/alchemy_getTokenMetadata.yaml index 6b9f2b87..750b491d 100644 --- a/token/alchemy_getTokenMetadata.yaml +++ b/token/alchemy_getTokenMetadata.yaml @@ -21,28 +21,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: alchemy_getTokenMetadata description: 'Returns metadata (name, symbol, decimals, logo) for a given token contract address.' - tags: [] + operationId: alchemy-getTokenMetadata parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/alchemy_getTokenMetadata + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/alchemy_getTokenMetadata x-readme: samples-languages: - curl @@ -66,11 +62,3 @@ paths: // Print token metadata of USDC const usdcContract = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"; alchemy.core.getTokenMetadata(usdcContract).then(console.log); - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/alchemy_getTokenMetadata - operationId: alchemy-getTokenMetadata diff --git a/trace/trace_block.yaml b/trace/trace_block.yaml index 552262dc..3b9f12a6 100644 --- a/trace/trace_block.yaml +++ b/trace/trace_block.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_block description: Returns traces created at given block. - tags: [] + operationId: trace-block parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/trace_block - operationId: trace-block diff --git a/trace/trace_call.yaml b/trace/trace_call.yaml index 47b75722..4a52f2b7 100644 --- a/trace/trace_call.yaml +++ b/trace/trace_call.yaml @@ -13,28 +13,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_call description: Executes the given call and returns a number of possible traces for it. - tags: [] + operationId: trace-call parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/trace_call + responses: + '200': + description: 'Returns - Array of Block traces' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/trace_call x-readme: explorer-enabled: false samples-languages: @@ -56,12 +52,4 @@ paths: "data": "0xa67a6a45000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000"}, ["trace"]], "id":1, - "jsonrpc":"2.0"}' - responses: - '200': - description: 'Returns - Array of Block traces' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/trace_call - operationId: trace-call + "jsonrpc":"2.0"}' \ No newline at end of file diff --git a/trace/trace_filter.yaml b/trace/trace_filter.yaml index f72c1ff7..448f64ae 100644 --- a/trace/trace_filter.yaml +++ b/trace/trace_filter.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_filter description: Returns traces matching given filter. - tags: [] + operationId: trace-filter parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/trace_filter - operationId: trace-filter diff --git a/trace/trace_get.yaml b/trace/trace_get.yaml index 6a8ff550..71cf592c 100644 --- a/trace/trace_get.yaml +++ b/trace/trace_get.yaml @@ -13,28 +13,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_get description: Returns trace at given position. - tags: [] + operationId: trace-get parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/trace_get + responses: + '200': + description: 'Returns - Trace object.' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/trace_get x-readme: explorer-enabled: false samples-languages: @@ -49,11 +45,3 @@ paths: -X POST \ -H "Content-Type: application/json" \ -d '{"method":"trace_get","params":["0x17104ac9d3312d8c136b7f44d4b8b47852618065ebfa534bd2d3b5ef218ca1f3",["0x0"]],"id":1,"jsonrpc":"2.0"}' - responses: - '200': - description: 'Returns - Trace object.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/trace_get - operationId: trace-get diff --git a/trace/trace_rawTransaction.yaml b/trace/trace_rawTransaction.yaml index 9fe5a38b..09b7deb5 100644 --- a/trace/trace_rawTransaction.yaml +++ b/trace/trace_rawTransaction.yaml @@ -13,28 +13,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_rawTransaction description: Traces a call to eth_sendRawTransaction without making the call, returning the traces. - tags: [] + operationId: trace-rawTransaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/trace_rawTransaction + responses: + '200': + description: 'Returns - Block traces' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/trace_call x-readme: explorer-enabled: false samples-languages: @@ -49,11 +45,3 @@ paths: -X POST \ -H "Content-Type: application/json" \ -d '{"method":"trace_rawTransaction","params":["0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",["trace"]],"id":1,"jsonrpc":"2.0"}' - responses: - '200': - description: 'Returns - Block traces' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/trace_call - operationId: trace-rawTransaction diff --git a/trace/trace_replayBlockTransactions.yaml b/trace/trace_replayBlockTransactions.yaml index 8644047f..32658891 100644 --- a/trace/trace_replayBlockTransactions.yaml +++ b/trace/trace_replayBlockTransactions.yaml @@ -13,28 +13,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_replayBlockTransactions description: Replays all transactions in a block returning the requested traces for each transaction. - tags: [] + operationId: trace-replayBlockTransactions parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/trace_replayBlockTransactions + responses: + '200': + description: 'Returns - Array of block transactions traces.' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/trace_replayBlockTransactions x-readme: explorer-enabled: false samples-languages: @@ -49,11 +45,3 @@ paths: -X POST \ -H "Content-Type: application/json" \ -d '{"method":"trace_replayBlockTransactions","params":["0x2ed119",["trace"]],"id":1,"jsonrpc":"2.0"}' - responses: - '200': - description: 'Returns - Array of block transactions traces.' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/trace_replayBlockTransactions - operationId: trace-replayBlockTransactions diff --git a/trace/trace_replayTransaction.yaml b/trace/trace_replayTransaction.yaml index d5093844..590c8da3 100644 --- a/trace/trace_replayTransaction.yaml +++ b/trace/trace_replayTransaction.yaml @@ -13,28 +13,24 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_replayTransaction description: Traces a call to eth_sendRawTransaction without making the call, returning the traces. - tags: [] + operationId: trace-replayTransaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: ../evm_body.yaml#/trace_replayTransaction + responses: + '200': + description: 'Returns - Block traces' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/trace_call x-readme: explorer-enabled: false samples-languages: @@ -49,11 +45,3 @@ paths: -X POST \ -H "Content-Type: application/json" \ -d '{"method":"trace_replayTransaction","params":["0x02d4a872e096445e80d05276ee756cefef7f3b376bcec14246469c0cd97dad8f",["trace"]],"id":1,"jsonrpc":"2.0"}' - responses: - '200': - description: 'Returns - Block traces' - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/trace_call - operationId: trace-replayTransaction diff --git a/trace/trace_transaction.yaml b/trace/trace_transaction.yaml index c0e0b31e..bc456466 100644 --- a/trace/trace_transaction.yaml +++ b/trace/trace_transaction.yaml @@ -13,23 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_transaction description: Returns all traces of given transaction. - tags: [] + operationId: trace-transaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: @@ -42,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/trace_transaction - operationId: trace-transaction diff --git a/transaction-receipts/alchemy_getTransactionReceipts.yaml b/transaction-receipts/alchemy_getTransactionReceipts.yaml index d6cdaaf0..b5cb565c 100644 --- a/transaction-receipts/alchemy_getTransactionReceipts.yaml +++ b/transaction-receipts/alchemy_getTransactionReceipts.yaml @@ -17,10 +17,24 @@ servers: paths: /{apiKey}: post: + tags: ['Transaction Receipts Endpoints'] summary: alchemy_getTransactionReceipts description: 'An enhanced API that gets all transaction receipts for a given block by number or block hash. Supported on all networks for Ethereum, Polygon, and Arbitrum.' - tags: ['Transaction Receipts Endpoints'] operationId: alchemy-getTransactionReceipts + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + $ref: ../evm_body.yaml#/alchemy_getTransactionReceipts_param + responses: + '200': + description: A list of transaction receipts for each transaction in this block. + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/transaction_receipt x-readme: explorer-enabled: false samples-languages: @@ -58,29 +72,3 @@ paths: }; main(); - parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true - requestBody: - content: - application/json: - schema: - $ref: ../evm_body.yaml#/alchemy_getTransactionReceipts_param - responses: - '200': - description: A list of transaction receipts for each transaction in this block. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/transaction_receipt diff --git a/transfers/alchemy_getAssetTransfers.yaml b/transfers/alchemy_getAssetTransfers.yaml index 4bace8c4..129b87a1 100644 --- a/transfers/alchemy_getAssetTransfers.yaml +++ b/transfers/alchemy_getAssetTransfers.yaml @@ -19,28 +19,24 @@ servers: paths: /{apiKey}: post: + tags: ['Transfers API Endpoints'] summary: alchemy_getAssetTransfers description: 'The Transfers API allows you to easily fetch historical transactions for any address across Ethereum and supported L2s including Polygon, Arbitrum, and Optimism.' - tags: ['Transfers API Endpoints'] + operationId: alchemy-getAssetTransfers parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - - For higher throughput, create your own API key - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: schema: $ref: evm_body.yaml#/alchemy_getAssetTransfers # path for using github actions to update, to update from CLI using rdme change to ../evm_body.yaml#/alchemy_getAssetTransfers + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: evm_responses.yaml#/alchemy_getAssetTransfers # path for using github actions to update, to update from CLI using rdme change to ../evm_responses.yaml#/alchemy_getAssetTransfers x-readme: samples-languages: - curl @@ -71,11 +67,3 @@ paths: }); console.log(res); - responses: - '200': - description: '' - content: - application/json: - schema: - $ref: evm_responses.yaml#/alchemy_getAssetTransfers # path for using github actions to update, to update from CLI using rdme change to ../evm_responses.yaml#/alchemy_getAssetTransfers - operationId: alchemy-getAssetTransfers