From 98fa0e5700f2fb9af61727d1e4bad790a49def02 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:37:51 +0200 Subject: [PATCH 01/47] Add custom styling --- components/parameters.yaml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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: | + <style> + .custom-style { + color: #048FF4; + } + </style> + For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> required: true schema: type: string From 55dd694a68f1c72dfe66dff368079f5536961baf Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:46:40 +0200 Subject: [PATCH 02/47] Use ApiKey for account abstraction specs --- .../alchemy_requestGasAndPaymasterAndData.yaml | 14 +------------- .../alchemy_requestPaymasterAndData.yaml | 14 +------------- .../eth_estimateUserOperationGas.yaml | 14 +------------- .../eth_getUserOperationByHash.yaml | 14 +------------- .../eth_getUserOperationReceipt.yaml | 14 +------------- account-abstraction/eth_sendUserOperation.yaml | 14 +------------- account-abstraction/eth_supportedEntryPoints.yaml | 14 +------------- .../rundler_maxPriorityFeePerGas.yaml | 14 +------------- 8 files changed, 8 insertions(+), 104 deletions(-) diff --git a/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml b/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml index dc9c34f7..0bf00459 100644 --- a/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml +++ b/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml @@ -30,19 +30,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: required: true content: diff --git a/account-abstraction/alchemy_requestPaymasterAndData.yaml b/account-abstraction/alchemy_requestPaymasterAndData.yaml index 6b11be61..16d7b0a3 100644 --- a/account-abstraction/alchemy_requestPaymasterAndData.yaml +++ b/account-abstraction/alchemy_requestPaymasterAndData.yaml @@ -30,19 +30,7 @@ components: description: Requests coverage for a `UserOperation`. Returns `paymasterAndData` if approved, errors if not. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: required: true content: diff --git a/account-abstraction/eth_estimateUserOperationGas.yaml b/account-abstraction/eth_estimateUserOperationGas.yaml index 6b74ff62..b9ef1873 100644 --- a/account-abstraction/eth_estimateUserOperationGas.yaml +++ b/account-abstraction/eth_estimateUserOperationGas.yaml @@ -30,19 +30,7 @@ components: description: Estimates the gas values for a `UserOperation`. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: required: true content: diff --git a/account-abstraction/eth_getUserOperationByHash.yaml b/account-abstraction/eth_getUserOperationByHash.yaml index b516c946..db1a458a 100644 --- a/account-abstraction/eth_getUserOperationByHash.yaml +++ b/account-abstraction/eth_getUserOperationByHash.yaml @@ -30,19 +30,7 @@ components: description: Return a `UserOperation` based on a hash (`userOpHash`). tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: required: true content: diff --git a/account-abstraction/eth_getUserOperationReceipt.yaml b/account-abstraction/eth_getUserOperationReceipt.yaml index f27674cb..693324e6 100644 --- a/account-abstraction/eth_getUserOperationReceipt.yaml +++ b/account-abstraction/eth_getUserOperationReceipt.yaml @@ -30,19 +30,7 @@ components: description: Get the `UserOperationReceipt` based on the `userOpHash` value. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: required: true content: diff --git a/account-abstraction/eth_sendUserOperation.yaml b/account-abstraction/eth_sendUserOperation.yaml index 371adcc1..dd6cb9d0 100644 --- a/account-abstraction/eth_sendUserOperation.yaml +++ b/account-abstraction/eth_sendUserOperation.yaml @@ -30,19 +30,7 @@ components: description: Sends a user operation to the given EVM network. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: required: true content: diff --git a/account-abstraction/eth_supportedEntryPoints.yaml b/account-abstraction/eth_supportedEntryPoints.yaml index 50bd739d..ff253a33 100644 --- a/account-abstraction/eth_supportedEntryPoints.yaml +++ b/account-abstraction/eth_supportedEntryPoints.yaml @@ -30,19 +30,7 @@ components: description: Returns an array of the `entryPoint` addresses supported by the client. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: required: true content: diff --git a/account-abstraction/rundler_maxPriorityFeePerGas.yaml b/account-abstraction/rundler_maxPriorityFeePerGas.yaml index c5080896..d314aaa0 100644 --- a/account-abstraction/rundler_maxPriorityFeePerGas.yaml +++ b/account-abstraction/rundler_maxPriorityFeePerGas.yaml @@ -26,19 +26,7 @@ paths: 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: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From fbe7c0916e289a35162d5d53c0710f3b24243808 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:46:50 +0200 Subject: [PATCH 03/47] Use ApiKey for Arbitrum specs --- arbitrum/eth_createAccessList.yaml | 14 +------------- arbitrum/eth_getBlockByHash.yaml | 14 +------------- arbitrum/eth_getBlockByNumber.yaml | 14 +------------- arbitrum/eth_getProof.yaml | 14 +------------- .../eth_getTransactionByBlockHashAndIndex.yaml | 14 +------------- .../eth_getTransactionByBlockNumberAndIndex.yaml | 14 +------------- arbitrum/eth_getTransactionByHash.yaml | 14 +------------- arbitrum/eth_getTransactionReceipt.yaml | 14 +------------- arbitrum/eth_maxPriorityFeePerGas.yaml | 14 +------------- 9 files changed, 9 insertions(+), 117 deletions(-) diff --git a/arbitrum/eth_createAccessList.yaml b/arbitrum/eth_createAccessList.yaml index 467fb0e3..c256e1a8 100644 --- a/arbitrum/eth_createAccessList.yaml +++ b/arbitrum/eth_createAccessList.yaml @@ -16,19 +16,7 @@ paths: 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.' parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/arbitrum/eth_getBlockByHash.yaml b/arbitrum/eth_getBlockByHash.yaml index b2aacfeb..c2843267 100644 --- a/arbitrum/eth_getBlockByHash.yaml +++ b/arbitrum/eth_getBlockByHash.yaml @@ -22,19 +22,7 @@ components: operationId: eth-getBlockByHash-arbitrum description: Returns information about a block by block hash on the Arbitrum network. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/arbitrum/eth_getBlockByNumber.yaml b/arbitrum/eth_getBlockByNumber.yaml index 88d5aa33..c063e8bf 100644 --- a/arbitrum/eth_getBlockByNumber.yaml +++ b/arbitrum/eth_getBlockByNumber.yaml @@ -22,19 +22,7 @@ components: summary: eth_getBlockByNumber - Arbitrum description: Returns information about a block by block number on the Arbitrum network. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/arbitrum/eth_getProof.yaml b/arbitrum/eth_getProof.yaml index 44a8f015..5adcdc00 100644 --- a/arbitrum/eth_getProof.yaml +++ b/arbitrum/eth_getProof.yaml @@ -20,19 +20,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml b/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml index 2b1f031a..936cb0f7 100644 --- a/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml +++ b/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml @@ -21,19 +21,7 @@ components: description: Returns information about a transaction by block hash and transaction index position in Arbitrum network. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml b/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml index 3d318a8d..626ce9a5 100644 --- a/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml @@ -17,19 +17,7 @@ paths: 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/arbitrum/eth_getTransactionByHash.yaml b/arbitrum/eth_getTransactionByHash.yaml index 18472f7b..f1506ed6 100644 --- a/arbitrum/eth_getTransactionByHash.yaml +++ b/arbitrum/eth_getTransactionByHash.yaml @@ -21,19 +21,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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/arbitrum/eth_getTransactionReceipt.yaml b/arbitrum/eth_getTransactionReceipt.yaml index f56ce9d3..de65ab94 100644 --- a/arbitrum/eth_getTransactionReceipt.yaml +++ b/arbitrum/eth_getTransactionReceipt.yaml @@ -21,19 +21,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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/arbitrum/eth_maxPriorityFeePerGas.yaml b/arbitrum/eth_maxPriorityFeePerGas.yaml index 101b8164..b0d023d5 100644 --- a/arbitrum/eth_maxPriorityFeePerGas.yaml +++ b/arbitrum/eth_maxPriorityFeePerGas.yaml @@ -17,19 +17,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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 05f1b8ba5d03efca1c9265aab56117b30217cd7f Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:47:09 +0200 Subject: [PATCH 04/47] Use ApiKey for Astar spec --- astar/eth_maxPriorityFeePerGas.yaml | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/astar/eth_maxPriorityFeePerGas.yaml b/astar/eth_maxPriorityFeePerGas.yaml index 7965a638..b5e4132e 100644 --- a/astar/eth_maxPriorityFeePerGas.yaml +++ b/astar/eth_maxPriorityFeePerGas.yaml @@ -11,19 +11,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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 23475b6c09313aac0eca21712d334f7a040db60b Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:47:21 +0200 Subject: [PATCH 05/47] Use ApiKey for Base specs --- base/eth_feeHistory.yaml | 14 +------------- base/eth_getProof.yaml | 14 +------------- base/eth_maxPriorityFeePerGas.yaml | 14 +------------- base/eth_syncing.yaml | 14 +------------- 4 files changed, 4 insertions(+), 52 deletions(-) diff --git a/base/eth_feeHistory.yaml b/base/eth_feeHistory.yaml index 91527e41..52b5848b 100644 --- a/base/eth_feeHistory.yaml +++ b/base/eth_feeHistory.yaml @@ -21,19 +21,7 @@ components: description: Returns a collection of historical gas information. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/base/eth_getProof.yaml b/base/eth_getProof.yaml index 4aa9eeb0..12708aae 100644 --- a/base/eth_getProof.yaml +++ b/base/eth_getProof.yaml @@ -20,19 +20,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/base/eth_maxPriorityFeePerGas.yaml b/base/eth_maxPriorityFeePerGas.yaml index 8c8c01d6..0b216b14 100644 --- a/base/eth_maxPriorityFeePerGas.yaml +++ b/base/eth_maxPriorityFeePerGas.yaml @@ -17,19 +17,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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/base/eth_syncing.yaml b/base/eth_syncing.yaml index 7a4dd48e..f298c299 100644 --- a/base/eth_syncing.yaml +++ b/base/eth_syncing.yaml @@ -17,19 +17,7 @@ paths: description: Returns a list of addresses owned by client. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: From c443516fecfe5b1af2ee7f316a225682337ef5d9 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:47:32 +0200 Subject: [PATCH 06/47] Use ApiKey for debug specs --- debug/debug_traceBlockByHash.yaml | 14 +------------- debug/debug_traceBlockByNumber.yaml | 14 +------------- debug/debug_traceCall.yaml | 14 +------------- debug/debug_traceTransaction.yaml | 14 +------------- 4 files changed, 4 insertions(+), 52 deletions(-) diff --git a/debug/debug_traceBlockByHash.yaml b/debug/debug_traceBlockByHash.yaml index 38d42ebb..4a70d387 100644 --- a/debug/debug_traceBlockByHash.yaml +++ b/debug/debug_traceBlockByHash.yaml @@ -23,19 +23,7 @@ paths: description: Replays the block that is already present in the database. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/debug/debug_traceBlockByNumber.yaml b/debug/debug_traceBlockByNumber.yaml index 4bb8038e..e25b8020 100644 --- a/debug/debug_traceBlockByNumber.yaml +++ b/debug/debug_traceBlockByNumber.yaml @@ -23,19 +23,7 @@ paths: description: Replays the block that is already present in the database. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey x-readme: explorer-enabled: false samples-languages: diff --git a/debug/debug_traceCall.yaml b/debug/debug_traceCall.yaml index 87957792..540e9186 100644 --- a/debug/debug_traceCall.yaml +++ b/debug/debug_traceCall.yaml @@ -23,19 +23,7 @@ paths: description: Runs an eth_call within the context of the given block execution using the final state of parent block as the base. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/debug/debug_traceTransaction.yaml b/debug/debug_traceTransaction.yaml index 4b95f499..ee37f965 100644 --- a/debug/debug_traceTransaction.yaml +++ b/debug/debug_traceTransaction.yaml @@ -23,19 +23,7 @@ paths: 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: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 223401322c7ba5839546d7bd9af732ea3e44f516 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:47:47 +0200 Subject: [PATCH 07/47] Use ApiKey for Ethereum specs --- ethereum/eth_accounts.yaml | 14 +------------- ethereum/eth_blockNumber.yaml | 14 +------------- ethereum/eth_call.yaml | 14 +------------- ethereum/eth_chainId.yaml | 14 +------------- ethereum/eth_createAccessList.yaml | 14 +------------- ethereum/eth_estimateGas.yaml | 14 +------------- ethereum/eth_feeHistory.yaml | 14 +------------- ethereum/eth_gasPrice.yaml | 14 +------------- ethereum/eth_getBalance.yaml | 14 +------------- ethereum/eth_getBlockByHash.yaml | 14 +------------- ethereum/eth_getBlockByNumber.yaml | 14 +------------- ethereum/eth_getBlockReceipts.yaml | 14 +------------- ethereum/eth_getBlockTransactionCountByHash.yaml | 14 +------------- ethereum/eth_getBlockTransactionCountByNumber.yaml | 14 +------------- ethereum/eth_getCode.yaml | 14 +------------- ethereum/eth_getFilterChanges.yaml | 14 +------------- ethereum/eth_getFilterLogs.yaml | 14 +------------- ethereum/eth_getLogs.yaml | 14 +------------- ethereum/eth_getProof.yaml | 14 +------------- ethereum/eth_getStorageAt.yaml | 14 +------------- .../eth_getTransactionByBlockHashAndIndex.yaml | 14 +------------- .../eth_getTransactionByBlockNumberAndIndex.yaml | 14 +------------- ethereum/eth_getTransactionByHash.yaml | 14 +------------- ethereum/eth_getTransactionCount.yaml | 14 +------------- ethereum/eth_getTransactionReceipt.yaml | 14 +------------- ethereum/eth_getUncleByBlockHashAndIndex.yaml | 14 +------------- ethereum/eth_getUncleByBlockNumberAndIndex.yaml | 14 +------------- ethereum/eth_getUncleCountByBlockHash.yaml | 14 +------------- ethereum/eth_getUncleCountByBlockNumber.yaml | 14 +------------- ethereum/eth_maxPriorityFeePerGas.yaml | 14 +------------- ethereum/eth_newBlockFilter.yaml | 14 +------------- ethereum/eth_newFilter.yaml | 14 +------------- ethereum/eth_newPendingTransactionFilter.yaml | 14 +------------- ethereum/eth_protocolVersion.yaml | 14 +------------- ethereum/eth_sendRawTransaction.yaml | 14 +------------- ethereum/eth_uninstallFilter.yaml | 14 +------------- ethereum/net_listening.yaml | 14 +------------- ethereum/net_version.yaml | 14 +------------- ethereum/web3_clientVersion.yaml | 14 +------------- ethereum/web3_sha3.yaml | 14 +------------- 40 files changed, 40 insertions(+), 520 deletions(-) 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 71ee02169c33337f53beb3bbc4eff10d46690762 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:47:55 +0200 Subject: [PATCH 08/47] Use ApiKey for Optimism specs --- optimism/eth_feeHistory.yaml | 14 +------------- optimism/eth_getProof.yaml | 14 +------------- optimism/eth_maxPriorityFeePerGas.yaml | 14 +------------- optimism/eth_syncing.yaml | 14 +------------- 4 files changed, 4 insertions(+), 52 deletions(-) diff --git a/optimism/eth_feeHistory.yaml b/optimism/eth_feeHistory.yaml index ec1c62cb..d065b8ee 100644 --- a/optimism/eth_feeHistory.yaml +++ b/optimism/eth_feeHistory.yaml @@ -15,19 +15,7 @@ components: description: Returns a collection of historical gas information. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/optimism/eth_getProof.yaml b/optimism/eth_getProof.yaml index 3fff17d1..49fd8cf2 100644 --- a/optimism/eth_getProof.yaml +++ b/optimism/eth_getProof.yaml @@ -20,19 +20,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/optimism/eth_maxPriorityFeePerGas.yaml b/optimism/eth_maxPriorityFeePerGas.yaml index 8e447198..07b8a8d4 100644 --- a/optimism/eth_maxPriorityFeePerGas.yaml +++ b/optimism/eth_maxPriorityFeePerGas.yaml @@ -17,19 +17,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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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..ccc9ac60 100644 --- a/optimism/eth_syncing.yaml +++ b/optimism/eth_syncing.yaml @@ -17,19 +17,7 @@ paths: description: Returns a list of addresses owned by client. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: From c5fb765f55414c24953257d1e1fc8e7d27ba6181 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:48:14 +0200 Subject: [PATCH 09/47] Use ApiKey for Polygon PoS specs --- polygon-pos/bor_getAuthor.yaml | 14 +------------- polygon-pos/bor_getCurrentProposer.yaml | 14 +------------- polygon-pos/bor_getCurrentValidators.yaml | 14 +------------- polygon-pos/bor_getRootHash.yaml | 14 +------------- polygon-pos/bor_getSignersAtHash.yaml | 14 +------------- polygon-pos/eth_feeHistory.yaml | 14 +------------- polygon-pos/eth_getProof.yaml | 14 +------------- polygon-pos/eth_getRootHash.yaml | 14 +------------- polygon-pos/eth_getSignersAtHash.yaml | 14 +------------- polygon-pos/eth_getTransactionReceiptsByBlock.yaml | 14 +------------- polygon-pos/eth_sendRawTransaction.yaml | 14 +------------- 11 files changed, 11 insertions(+), 143 deletions(-) diff --git a/polygon-pos/bor_getAuthor.yaml b/polygon-pos/bor_getAuthor.yaml index f3d24502..d41b544e 100644 --- a/polygon-pos/bor_getAuthor.yaml +++ b/polygon-pos/bor_getAuthor.yaml @@ -17,19 +17,7 @@ paths: description: 'Returns address of Author on Polygon.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: 'Block number (in hexadecimal format).' content: diff --git a/polygon-pos/bor_getCurrentProposer.yaml b/polygon-pos/bor_getCurrentProposer.yaml index 4d9ea4e1..3ea05afe 100644 --- a/polygon-pos/bor_getCurrentProposer.yaml +++ b/polygon-pos/bor_getCurrentProposer.yaml @@ -17,19 +17,7 @@ paths: description: "Returns current proposer's address on Polygon." tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-pos/bor_getCurrentValidators.yaml b/polygon-pos/bor_getCurrentValidators.yaml index 166d4958..58c129b2 100644 --- a/polygon-pos/bor_getCurrentValidators.yaml +++ b/polygon-pos/bor_getCurrentValidators.yaml @@ -17,19 +17,7 @@ paths: description: 'Returns current validators for Polygon.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-pos/bor_getRootHash.yaml b/polygon-pos/bor_getRootHash.yaml index 87ea60a2..853de125 100644 --- a/polygon-pos/bor_getRootHash.yaml +++ b/polygon-pos/bor_getRootHash.yaml @@ -17,19 +17,7 @@ paths: description: 'Polygon API - Returns the root hash given a block range.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-pos/bor_getSignersAtHash.yaml b/polygon-pos/bor_getSignersAtHash.yaml index 998f6de1..a6390944 100644 --- a/polygon-pos/bor_getSignersAtHash.yaml +++ b/polygon-pos/bor_getSignersAtHash.yaml @@ -17,19 +17,7 @@ paths: description: 'Polygon API - Returns all the signers of the block matching the specified block hash.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-pos/eth_feeHistory.yaml b/polygon-pos/eth_feeHistory.yaml index 00299656..9a8cedf8 100644 --- a/polygon-pos/eth_feeHistory.yaml +++ b/polygon-pos/eth_feeHistory.yaml @@ -15,19 +15,7 @@ components: description: Returns a collection of historical gas information. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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..d83cd96c 100644 --- a/polygon-pos/eth_getRootHash.yaml +++ b/polygon-pos/eth_getRootHash.yaml @@ -17,19 +17,7 @@ paths: description: 'Returns the root hash given a block range on Polygon.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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..1b19f271 100644 --- a/polygon-pos/eth_getSignersAtHash.yaml +++ b/polygon-pos/eth_getSignersAtHash.yaml @@ -17,19 +17,7 @@ paths: description: 'Polygon API - Returns all signs given a blockhash.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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..de78004b 100644 --- a/polygon-pos/eth_getTransactionReceiptsByBlock.yaml +++ b/polygon-pos/eth_getTransactionReceiptsByBlock.yaml @@ -17,19 +17,7 @@ paths: 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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..918a8a0e 100644 --- a/polygon-pos/eth_sendRawTransaction.yaml +++ b/polygon-pos/eth_sendRawTransaction.yaml @@ -19,19 +19,7 @@ paths: </br><strong> Note: </strong> Due to network constraints, transactions on Polygon Mainnet must be submitted with a minimum gasPrice of 30 gwei. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From cbdee96791011de6379d34ddac448d96822fea91 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:48:27 +0200 Subject: [PATCH 10/47] Use ApiKey for Polygon zkEVM specs --- polygon-zkevm/eth_call.yaml | 14 +------------- polygon-zkevm/eth_estimateGas.yaml | 14 +------------- polygon-zkevm/eth_getBalance.yaml | 14 +------------- polygon-zkevm/eth_getCode.yaml | 14 +------------- polygon-zkevm/eth_getCompilers.yaml | 14 +------------- polygon-zkevm/eth_getStorageAt.yaml | 14 +------------- .../eth_getTransactionByBlockNumberAndIndex.yaml | 14 +------------- polygon-zkevm/eth_getTransactionReceipt.yaml | 14 +------------- polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml | 14 +------------- .../eth_getUncleByBlockNumberAndIndex.yaml | 14 +------------- polygon-zkevm/eth_getUncleCountByBlockHash.yaml | 14 +------------- polygon-zkevm/eth_getUncleCountByBlockNumber.yaml | 14 +------------- polygon-zkevm/eth_protocolVersion.yaml | 14 +------------- polygon-zkevm/eth_sendRawTransaction.yaml | 14 +------------- polygon-zkevm/zkevm_batchNumber.yaml | 14 +------------- polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml | 14 +------------- polygon-zkevm/zkevm_consolidatedBlockNumber.yaml | 14 +------------- polygon-zkevm/zkevm_getBatchByNumber.yaml | 14 +------------- polygon-zkevm/zkevm_getBroadcastURI.yaml | 14 +------------- polygon-zkevm/zkevm_isBlockConsolidated.yaml | 14 +------------- polygon-zkevm/zkevm_isBlockVirtualized.yaml | 14 +------------- polygon-zkevm/zkevm_verifiedBatchNumber.yaml | 14 +------------- polygon-zkevm/zkevm_virtualBatchNumber.yaml | 14 +------------- 23 files changed, 23 insertions(+), 299 deletions(-) diff --git a/polygon-zkevm/eth_call.yaml b/polygon-zkevm/eth_call.yaml index c9eae6d7..7ff645dd 100644 --- a/polygon-zkevm/eth_call.yaml +++ b/polygon-zkevm/eth_call.yaml @@ -22,19 +22,7 @@ components: summary: eth_call - Polygon zkEVM description: Executes a new message call immediately without creating a transaction on the blockchain. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $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: diff --git a/polygon-zkevm/eth_estimateGas.yaml b/polygon-zkevm/eth_estimateGas.yaml index dcccb536..9590209c 100644 --- a/polygon-zkevm/eth_estimateGas.yaml +++ b/polygon-zkevm/eth_estimateGas.yaml @@ -21,19 +21,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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getBalance.yaml b/polygon-zkevm/eth_getBalance.yaml index bfae0753..36313e12 100644 --- a/polygon-zkevm/eth_getBalance.yaml +++ b/polygon-zkevm/eth_getBalance.yaml @@ -21,19 +21,7 @@ components: description: Returns the balance of the account of a given address on Polygon zkEVM. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getCode.yaml b/polygon-zkevm/eth_getCode.yaml index b5ecc6ed..f72c33d7 100644 --- a/polygon-zkevm/eth_getCode.yaml +++ b/polygon-zkevm/eth_getCode.yaml @@ -21,19 +21,7 @@ components: description: Returns code at a given address on the Polygon zkEVM network. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getCompilers.yaml b/polygon-zkevm/eth_getCompilers.yaml index d5b4ffac..e6528707 100644 --- a/polygon-zkevm/eth_getCompilers.yaml +++ b/polygon-zkevm/eth_getCompilers.yaml @@ -21,19 +21,7 @@ components: description: Returns a list of installed compilers (Deprecated). Response is always empty in Polygon zkEVM. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts nothing. content: diff --git a/polygon-zkevm/eth_getStorageAt.yaml b/polygon-zkevm/eth_getStorageAt.yaml index c44eb147..d0ebd7c8 100644 --- a/polygon-zkevm/eth_getStorageAt.yaml +++ b/polygon-zkevm/eth_getStorageAt.yaml @@ -21,19 +21,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml b/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml index 89d8c3a5..8c9d3b56 100644 --- a/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml @@ -21,19 +21,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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getTransactionReceipt.yaml b/polygon-zkevm/eth_getTransactionReceipt.yaml index 137f97e6..679970bd 100644 --- a/polygon-zkevm/eth_getTransactionReceipt.yaml +++ b/polygon-zkevm/eth_getTransactionReceipt.yaml @@ -21,19 +21,7 @@ components: description: Returns the receipt of a transaction by transaction hash on Polygon zkEVM. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml b/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml index 6d55da4b..77d3d18d 100644 --- a/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml +++ b/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml @@ -21,19 +21,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml b/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml index ab329e73..85acb91a 100644 --- a/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml +++ b/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml @@ -21,19 +21,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getUncleCountByBlockHash.yaml b/polygon-zkevm/eth_getUncleCountByBlockHash.yaml index 840aa92c..140ed944 100644 --- a/polygon-zkevm/eth_getUncleCountByBlockHash.yaml +++ b/polygon-zkevm/eth_getUncleCountByBlockHash.yaml @@ -21,19 +21,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml b/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml index d3f07240..931c0b00 100644 --- a/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml +++ b/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml @@ -21,19 +21,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_protocolVersion.yaml b/polygon-zkevm/eth_protocolVersion.yaml index c816df4f..5f455962 100644 --- a/polygon-zkevm/eth_protocolVersion.yaml +++ b/polygon-zkevm/eth_protocolVersion.yaml @@ -21,19 +21,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/eth_sendRawTransaction.yaml b/polygon-zkevm/eth_sendRawTransaction.yaml index 6d2b71f4..3d620799 100644 --- a/polygon-zkevm/eth_sendRawTransaction.yaml +++ b/polygon-zkevm/eth_sendRawTransaction.yaml @@ -21,19 +21,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/zkevm_batchNumber.yaml b/polygon-zkevm/zkevm_batchNumber.yaml index 04446569..94fdf443 100644 --- a/polygon-zkevm/zkevm_batchNumber.yaml +++ b/polygon-zkevm/zkevm_batchNumber.yaml @@ -22,19 +22,7 @@ components: summary: zkevm_batchNumber - Polygon zkEVM description: Returns the latest batch number. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml b/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml index d5d44b4b..792664fe 100644 --- a/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml +++ b/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml @@ -22,19 +22,7 @@ components: summary: zkevm_batchNumberByBlockNumber - Polygon zkEVM description: Returns the batch number of the batch connected to the block. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml b/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml index 93d09b56..bcd0d651 100644 --- a/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml +++ b/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml @@ -22,19 +22,7 @@ components: summary: zkevm_consolidatedBlockNumber - Polygon zkEVM description: Returns the latest block number that is connected to the latest batch verified. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Accepts no parameters. content: diff --git a/polygon-zkevm/zkevm_getBatchByNumber.yaml b/polygon-zkevm/zkevm_getBatchByNumber.yaml index 5da0d3a6..dff90c35 100644 --- a/polygon-zkevm/zkevm_getBatchByNumber.yaml +++ b/polygon-zkevm/zkevm_getBatchByNumber.yaml @@ -22,19 +22,7 @@ components: summary: zkevm_getBatchByNumber - Polygon zkEVM description: Returns information about the batch identified by the provided batch number or tag. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/zkevm_getBroadcastURI.yaml b/polygon-zkevm/zkevm_getBroadcastURI.yaml index 07b13740..7957ff7f 100644 --- a/polygon-zkevm/zkevm_getBroadcastURI.yaml +++ b/polygon-zkevm/zkevm_getBroadcastURI.yaml @@ -22,19 +22,7 @@ components: summary: zkevm_getBroadcastURI - Polygon zkEVM description: Returns the configured Broadcast URL of the Trusted Sequencer. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Returns the configured Broadcast URL of the Trusted Sequencer. content: diff --git a/polygon-zkevm/zkevm_isBlockConsolidated.yaml b/polygon-zkevm/zkevm_isBlockConsolidated.yaml index 80a27813..bb87d6cd 100644 --- a/polygon-zkevm/zkevm_isBlockConsolidated.yaml +++ b/polygon-zkevm/zkevm_isBlockConsolidated.yaml @@ -22,19 +22,7 @@ components: 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. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $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. content: diff --git a/polygon-zkevm/zkevm_isBlockVirtualized.yaml b/polygon-zkevm/zkevm_isBlockVirtualized.yaml index a7e2a3dc..62ec0e02 100644 --- a/polygon-zkevm/zkevm_isBlockVirtualized.yaml +++ b/polygon-zkevm/zkevm_isBlockVirtualized.yaml @@ -22,19 +22,7 @@ components: 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. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $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. content: diff --git a/polygon-zkevm/zkevm_verifiedBatchNumber.yaml b/polygon-zkevm/zkevm_verifiedBatchNumber.yaml index 1ddbcc8c..5e95d149 100644 --- a/polygon-zkevm/zkevm_verifiedBatchNumber.yaml +++ b/polygon-zkevm/zkevm_verifiedBatchNumber.yaml @@ -22,19 +22,7 @@ components: summary: zkevm_verifiedBatchNumber - Polygon zkEVM description: Returns the latest verified batch number. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/polygon-zkevm/zkevm_virtualBatchNumber.yaml b/polygon-zkevm/zkevm_virtualBatchNumber.yaml index 246f8251..924f058e 100644 --- a/polygon-zkevm/zkevm_virtualBatchNumber.yaml +++ b/polygon-zkevm/zkevm_virtualBatchNumber.yaml @@ -22,19 +22,7 @@ components: summary: zkevm_virtualBatchNumber - Polygon zkEVM description: Returns the latest virtual batch number. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 1fd837f78233182a3319ad2677579614c3266f9a Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:48:42 +0200 Subject: [PATCH 11/47] Use ApiKey for Solana specs --- solana/getAccountInfo.yaml | 14 +------------- solana/getBalance.yaml | 14 +------------- solana/getBlock.yaml | 14 +------------- solana/getBlockCommitment.yaml | 14 +------------- solana/getBlockHeight.yaml | 14 +------------- solana/getBlockProduction.yaml | 14 +------------- solana/getBlockTime.yaml | 14 +------------- solana/getBlocks.yaml | 14 +------------- solana/getBlocksWithLimit.yaml | 14 +------------- solana/getClusterNodes.yaml | 14 +------------- solana/getEpochInfo.yaml | 14 +------------- solana/getEpochSchedule.yaml | 14 +------------- solana/getFeeForMessage.yaml | 14 +------------- solana/getFirstAvailableBlock.yaml | 14 +------------- solana/getGenesisHash.yaml | 14 +------------- solana/getHealth.yaml | 14 +------------- solana/getHighestSnapshotSlot.yaml | 14 +------------- solana/getIdentity.yaml | 14 +------------- solana/getInflationGovernor.yaml | 14 +------------- solana/getInflationRate.yaml | 14 +------------- solana/getInflationReward.yaml | 14 +------------- solana/getLargestAccounts.yaml | 14 +------------- solana/getMaxRetransmitSlot.yaml | 14 +------------- solana/getMaxShredInsertSlot.yaml | 14 +------------- solana/getMinimumBalanceForRentExemption.yaml | 14 +------------- solana/getMultipleAccounts.yaml | 14 +------------- solana/getProgramAccounts.yaml | 14 +------------- solana/getRecentPerformanceSamples.yaml | 14 +------------- solana/getSignatureStatuses.yaml | 14 +------------- solana/getSignaturesForAddress.yaml | 14 +------------- solana/getSlot.yaml | 14 +------------- solana/getSlotLeader.yaml | 14 +------------- solana/getSlotLeaders.yaml | 14 +------------- solana/getSupply.yaml | 14 +------------- solana/getTokenAccountBalance.yaml | 14 +------------- solana/getTokenAccountsByOwner.yaml | 14 +------------- solana/getTokenSupply.yaml | 14 +------------- solana/getTransaction.yaml | 14 +------------- solana/getVersion.yaml | 14 +------------- solana/getVoteAccounts.yaml | 14 +------------- solana/isBlockhashValid.yaml | 14 +------------- solana/minimumLedgerSlot.yaml | 14 +------------- solana/requestAirdrop.yaml | 14 +------------- solana/sendTransaction.yaml | 14 +------------- solana/simulateTransaction.yaml | 14 +------------- 45 files changed, 45 insertions(+), 585 deletions(-) diff --git a/solana/getAccountInfo.yaml b/solana/getAccountInfo.yaml index de626167..4a8ef4e0 100644 --- a/solana/getAccountInfo.yaml +++ b/solana/getAccountInfo.yaml @@ -17,19 +17,7 @@ paths: description: Returns all information associated with the account of provided Pubkey. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getBalance.yaml b/solana/getBalance.yaml index 6b1e0526..70fb05d9 100644 --- a/solana/getBalance.yaml +++ b/solana/getBalance.yaml @@ -17,19 +17,7 @@ paths: description: Returns the balance of the account of provided Pubkey. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getBlock.yaml b/solana/getBlock.yaml index 24e6211d..2bf788c9 100644 --- a/solana/getBlock.yaml +++ b/solana/getBlock.yaml @@ -17,19 +17,7 @@ paths: description: Returns identity and transaction information about a confirmed block in the ledger. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getBlockCommitment.yaml b/solana/getBlockCommitment.yaml index 46f02ba2..9e2d9458 100644 --- a/solana/getBlockCommitment.yaml +++ b/solana/getBlockCommitment.yaml @@ -17,19 +17,7 @@ paths: description: Returns commitment for particular block. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getBlockHeight.yaml b/solana/getBlockHeight.yaml index ae61a191..61c0c530 100644 --- a/solana/getBlockHeight.yaml +++ b/solana/getBlockHeight.yaml @@ -17,19 +17,7 @@ paths: description: Returns the current block height of the node. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getBlockProduction.yaml b/solana/getBlockProduction.yaml index 78a898c3..355a8443 100644 --- a/solana/getBlockProduction.yaml +++ b/solana/getBlockProduction.yaml @@ -17,19 +17,7 @@ paths: description: Returns recent block production information from the current or previous epoch. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getBlockTime.yaml b/solana/getBlockTime.yaml index e3594476..d752ba19 100644 --- a/solana/getBlockTime.yaml +++ b/solana/getBlockTime.yaml @@ -17,19 +17,7 @@ paths: description: Returns the estimated production time of a block. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getBlocks.yaml b/solana/getBlocks.yaml index 65d2e570..3a68fd4c 100644 --- a/solana/getBlocks.yaml +++ b/solana/getBlocks.yaml @@ -17,19 +17,7 @@ paths: description: Returns a list of confirmed blocks between two slots. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getBlocksWithLimit.yaml b/solana/getBlocksWithLimit.yaml index 6038aa5c..2445b6ff 100644 --- a/solana/getBlocksWithLimit.yaml +++ b/solana/getBlocksWithLimit.yaml @@ -17,19 +17,7 @@ paths: description: Returns a list of confirmed blocks starting at the given slot. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getClusterNodes.yaml b/solana/getClusterNodes.yaml index 3ac1693f..565cf8bf 100644 --- a/solana/getClusterNodes.yaml +++ b/solana/getClusterNodes.yaml @@ -17,19 +17,7 @@ paths: description: Returns information about all the nodes participating in the cluster. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getEpochInfo.yaml b/solana/getEpochInfo.yaml index 5e1354d0..353c38fa 100644 --- a/solana/getEpochInfo.yaml +++ b/solana/getEpochInfo.yaml @@ -17,19 +17,7 @@ paths: description: Returns information about the current epoch. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getEpochSchedule.yaml b/solana/getEpochSchedule.yaml index 06487471..72734226 100644 --- a/solana/getEpochSchedule.yaml +++ b/solana/getEpochSchedule.yaml @@ -17,19 +17,7 @@ paths: description: Returns epoch schedule information from this cluster's genesis config. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getFeeForMessage.yaml b/solana/getFeeForMessage.yaml index 433f73f9..11f4fbcd 100644 --- a/solana/getFeeForMessage.yaml +++ b/solana/getFeeForMessage.yaml @@ -17,19 +17,7 @@ paths: description: Get the fee the network will charge for a particular message. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getFirstAvailableBlock.yaml b/solana/getFirstAvailableBlock.yaml index 25918a3f..c25b082a 100644 --- a/solana/getFirstAvailableBlock.yaml +++ b/solana/getFirstAvailableBlock.yaml @@ -17,19 +17,7 @@ paths: description: Get the fee the network will charge for a particular message. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getGenesisHash.yaml b/solana/getGenesisHash.yaml index 869c8b3e..9d00c28c 100644 --- a/solana/getGenesisHash.yaml +++ b/solana/getGenesisHash.yaml @@ -17,19 +17,7 @@ paths: description: Returns the genesis hash. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getHealth.yaml b/solana/getHealth.yaml index d70410dd..49cbc0ef 100644 --- a/solana/getHealth.yaml +++ b/solana/getHealth.yaml @@ -17,19 +17,7 @@ paths: description: Returns the current health of the node. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getHighestSnapshotSlot.yaml b/solana/getHighestSnapshotSlot.yaml index 8918a2db..a5353db8 100644 --- a/solana/getHighestSnapshotSlot.yaml +++ b/solana/getHighestSnapshotSlot.yaml @@ -17,19 +17,7 @@ paths: description: Returns the highest slot information that the node has snapshots for. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getIdentity.yaml b/solana/getIdentity.yaml index 064a780e..7aa18d37 100644 --- a/solana/getIdentity.yaml +++ b/solana/getIdentity.yaml @@ -17,19 +17,7 @@ paths: description: Returns the identity pubkey for the current node. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getInflationGovernor.yaml b/solana/getInflationGovernor.yaml index 3452bb01..3060bddb 100644 --- a/solana/getInflationGovernor.yaml +++ b/solana/getInflationGovernor.yaml @@ -17,19 +17,7 @@ paths: description: Returns the current inflation governor. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getInflationRate.yaml b/solana/getInflationRate.yaml index 0321495e..497d757a 100644 --- a/solana/getInflationRate.yaml +++ b/solana/getInflationRate.yaml @@ -17,19 +17,7 @@ paths: description: Returns the specific inflation values for the current epoch. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getInflationReward.yaml b/solana/getInflationReward.yaml index ee5bc599..e556355b 100644 --- a/solana/getInflationReward.yaml +++ b/solana/getInflationReward.yaml @@ -17,19 +17,7 @@ paths: description: Returns the inflation / staking reward for a list of addresses for an epoch. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getLargestAccounts.yaml b/solana/getLargestAccounts.yaml index 7e9a5e7a..29e5f1d4 100644 --- a/solana/getLargestAccounts.yaml +++ b/solana/getLargestAccounts.yaml @@ -17,19 +17,7 @@ paths: description: Returns the 20 largest accounts, by lamport balance (results may be cached up to two hours). tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getMaxRetransmitSlot.yaml b/solana/getMaxRetransmitSlot.yaml index 8a703f9c..1a368340 100644 --- a/solana/getMaxRetransmitSlot.yaml +++ b/solana/getMaxRetransmitSlot.yaml @@ -17,19 +17,7 @@ paths: description: Get the max slot seen from retransmit stage. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getMaxShredInsertSlot.yaml b/solana/getMaxShredInsertSlot.yaml index e2c1bd58..3b211d7f 100644 --- a/solana/getMaxShredInsertSlot.yaml +++ b/solana/getMaxShredInsertSlot.yaml @@ -17,19 +17,7 @@ paths: description: Get the max slot seen from after shred insert.. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getMinimumBalanceForRentExemption.yaml b/solana/getMinimumBalanceForRentExemption.yaml index b74d5a28..a95ac23f 100644 --- a/solana/getMinimumBalanceForRentExemption.yaml +++ b/solana/getMinimumBalanceForRentExemption.yaml @@ -17,19 +17,7 @@ paths: description: Returns minimum balance required to make account rent exempt. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getMultipleAccounts.yaml b/solana/getMultipleAccounts.yaml index d606c90a..55a49dc0 100644 --- a/solana/getMultipleAccounts.yaml +++ b/solana/getMultipleAccounts.yaml @@ -17,19 +17,7 @@ paths: description: Returns the account information for a list of Pubkeys. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getProgramAccounts.yaml b/solana/getProgramAccounts.yaml index b5578801..da3f3a67 100644 --- a/solana/getProgramAccounts.yaml +++ b/solana/getProgramAccounts.yaml @@ -17,19 +17,7 @@ paths: description: Returns all accounts owned by the provided program Pubkey. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getRecentPerformanceSamples.yaml b/solana/getRecentPerformanceSamples.yaml index 4cf44903..aaf403ad 100644 --- a/solana/getRecentPerformanceSamples.yaml +++ b/solana/getRecentPerformanceSamples.yaml @@ -17,19 +17,7 @@ paths: 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: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getSignatureStatuses.yaml b/solana/getSignatureStatuses.yaml index db37d7fd..42c92c2b 100644 --- a/solana/getSignatureStatuses.yaml +++ b/solana/getSignatureStatuses.yaml @@ -17,19 +17,7 @@ paths: description: Returns the statuses of a list of signatures. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getSignaturesForAddress.yaml b/solana/getSignaturesForAddress.yaml index 57c1631f..e53eebe9 100644 --- a/solana/getSignaturesForAddress.yaml +++ b/solana/getSignaturesForAddress.yaml @@ -17,19 +17,7 @@ paths: 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: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getSlot.yaml b/solana/getSlot.yaml index 2489cabc..4be890ed 100644 --- a/solana/getSlot.yaml +++ b/solana/getSlot.yaml @@ -17,19 +17,7 @@ paths: description: Returns the slot that has reached the given or default commitment level. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getSlotLeader.yaml b/solana/getSlotLeader.yaml index 508cc453..1931e1ff 100644 --- a/solana/getSlotLeader.yaml +++ b/solana/getSlotLeader.yaml @@ -17,19 +17,7 @@ paths: description: Returns the current slot leader. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getSlotLeaders.yaml b/solana/getSlotLeaders.yaml index 7e2ccf15..f48fef31 100644 --- a/solana/getSlotLeaders.yaml +++ b/solana/getSlotLeaders.yaml @@ -17,19 +17,7 @@ paths: description: Returns the slot leaders for a given slot range. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getSupply.yaml b/solana/getSupply.yaml index 6c37fc35..ba19a466 100644 --- a/solana/getSupply.yaml +++ b/solana/getSupply.yaml @@ -17,19 +17,7 @@ paths: description: Returns information about the current supply. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getTokenAccountBalance.yaml b/solana/getTokenAccountBalance.yaml index 1aabba72..94ea2f79 100644 --- a/solana/getTokenAccountBalance.yaml +++ b/solana/getTokenAccountBalance.yaml @@ -17,19 +17,7 @@ paths: description: Returns the token balance of an SPL Token account.. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getTokenAccountsByOwner.yaml b/solana/getTokenAccountsByOwner.yaml index 9abc491f..757dbabf 100644 --- a/solana/getTokenAccountsByOwner.yaml +++ b/solana/getTokenAccountsByOwner.yaml @@ -17,19 +17,7 @@ paths: description: Returns all SPL Token accounts by token owner. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getTokenSupply.yaml b/solana/getTokenSupply.yaml index e672b706..677a72c1 100644 --- a/solana/getTokenSupply.yaml +++ b/solana/getTokenSupply.yaml @@ -17,19 +17,7 @@ paths: description: Returns the total supply of an SPL Token type. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getTransaction.yaml b/solana/getTransaction.yaml index 6ca6155d..74273a28 100644 --- a/solana/getTransaction.yaml +++ b/solana/getTransaction.yaml @@ -17,19 +17,7 @@ paths: description: Returns transaction details for a confirmed transaction. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getVersion.yaml b/solana/getVersion.yaml index df4cd6cc..47d2c428 100644 --- a/solana/getVersion.yaml +++ b/solana/getVersion.yaml @@ -17,19 +17,7 @@ paths: description: Returns the current solana versions running on the node. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/getVoteAccounts.yaml b/solana/getVoteAccounts.yaml index 181f7e12..c15fef74 100644 --- a/solana/getVoteAccounts.yaml +++ b/solana/getVoteAccounts.yaml @@ -17,19 +17,7 @@ paths: description: Returns the account info and associated stake for all the voting accounts in the current bank. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/isBlockhashValid.yaml b/solana/isBlockhashValid.yaml index c7b86f1f..151c07a1 100644 --- a/solana/isBlockhashValid.yaml +++ b/solana/isBlockhashValid.yaml @@ -17,19 +17,7 @@ paths: description: Returns whether a blockhash is still valid or not. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/minimumLedgerSlot.yaml b/solana/minimumLedgerSlot.yaml index 6a768eac..b7cf0c7a 100644 --- a/solana/minimumLedgerSlot.yaml +++ b/solana/minimumLedgerSlot.yaml @@ -17,19 +17,7 @@ paths: 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: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/requestAirdrop.yaml b/solana/requestAirdrop.yaml index 6707b267..cd5b60ce 100644 --- a/solana/requestAirdrop.yaml +++ b/solana/requestAirdrop.yaml @@ -17,19 +17,7 @@ paths: description: Requests an airdrop of lamports to a Pubkey tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/sendTransaction.yaml b/solana/sendTransaction.yaml index 9da58efe..ca8f854b 100644 --- a/solana/sendTransaction.yaml +++ b/solana/sendTransaction.yaml @@ -17,19 +17,7 @@ paths: description: Submits a signed transaction to the cluster for processing. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/solana/simulateTransaction.yaml b/solana/simulateTransaction.yaml index 8f64b103..5c3b8d45 100644 --- a/solana/simulateTransaction.yaml +++ b/solana/simulateTransaction.yaml @@ -17,19 +17,7 @@ paths: description: Simulate sending a transaction. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From b6a4af8e39d1a5de5c1cb7add0bd8b30806e63c2 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:48:53 +0200 Subject: [PATCH 12/47] Use ApiKey for Starknet specs --- starknet/starknet_addDeclareTransaction.yaml | 14 +------------- starknet/starknet_addDeployAccountTransaction.yaml | 14 +------------- starknet/starknet_addInvokeTransaction.yaml | 14 +------------- starknet/starknet_blockHashAndNumber.yaml | 14 +------------- starknet/starknet_blockNumber.yaml | 14 +------------- starknet/starknet_call.yaml | 14 +------------- starknet/starknet_chainId.yaml | 14 +------------- starknet/starknet_estimateFee.yaml | 14 +------------- starknet/starknet_getBlockTransactionCount.yaml | 14 +------------- starknet/starknet_getBlockWithTxHashes.yaml | 14 +------------- starknet/starknet_getBlockWithTxs.yaml | 14 +------------- starknet/starknet_getClass.yaml | 14 +------------- starknet/starknet_getClassAt.yaml | 14 +------------- starknet/starknet_getClassHashAt.yaml | 14 +------------- starknet/starknet_getEvents.yaml | 14 +------------- starknet/starknet_getNonce.yaml | 14 +------------- starknet/starknet_getStateUpdate.yaml | 14 +------------- starknet/starknet_getStorageAt.yaml | 14 +------------- .../starknet_getTransactionByBlockIdAndIndex.yaml | 14 +------------- starknet/starknet_getTransactionByHash.yaml | 14 +------------- starknet/starknet_getTransactionReceipt.yaml | 14 +------------- starknet/starknet_pendingTransactions.yaml | 14 +------------- starknet/starknet_syncing.yaml | 14 +------------- 23 files changed, 23 insertions(+), 299 deletions(-) diff --git a/starknet/starknet_addDeclareTransaction.yaml b/starknet/starknet_addDeclareTransaction.yaml index d1eb88c0..6ce89d43 100644 --- a/starknet/starknet_addDeclareTransaction.yaml +++ b/starknet/starknet_addDeclareTransaction.yaml @@ -22,19 +22,7 @@ components: summary: starknet_addDeclareTransaction description: Submit a new class declaration transaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_addDeployAccountTransaction.yaml b/starknet/starknet_addDeployAccountTransaction.yaml index eb56b1c6..90a38bd4 100644 --- a/starknet/starknet_addDeployAccountTransaction.yaml +++ b/starknet/starknet_addDeployAccountTransaction.yaml @@ -22,19 +22,7 @@ components: summary: starknet_addDeployAccountTransaction description: Submit a new deploy account transaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_addInvokeTransaction.yaml b/starknet/starknet_addInvokeTransaction.yaml index ee357ded..87b7a054 100644 --- a/starknet/starknet_addInvokeTransaction.yaml +++ b/starknet/starknet_addInvokeTransaction.yaml @@ -22,19 +22,7 @@ components: summary: starknet_addInvokeTransaction description: Submit a new transaction to be added to the chain parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_blockHashAndNumber.yaml b/starknet/starknet_blockHashAndNumber.yaml index 6e56481f..0036258f 100644 --- a/starknet/starknet_blockHashAndNumber.yaml +++ b/starknet/starknet_blockHashAndNumber.yaml @@ -22,19 +22,7 @@ components: summary: starknet_blockHashAndNumber description: Get the most recent accepted block hash and number parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_blockNumber.yaml b/starknet/starknet_blockNumber.yaml index b4daab03..f06f8935 100644 --- a/starknet/starknet_blockNumber.yaml +++ b/starknet/starknet_blockNumber.yaml @@ -22,19 +22,7 @@ components: summary: starknet_blockNumber description: Get the most recent accepted block number parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_call.yaml b/starknet/starknet_call.yaml index be52a615..db01692d 100644 --- a/starknet/starknet_call.yaml +++ b/starknet/starknet_call.yaml @@ -22,19 +22,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_chainId.yaml b/starknet/starknet_chainId.yaml index d932eb0a..1a5f962e 100644 --- a/starknet/starknet_chainId.yaml +++ b/starknet/starknet_chainId.yaml @@ -22,19 +22,7 @@ components: summary: starknet_chainId description: Return the currently configured StarkNet chain id parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_estimateFee.yaml b/starknet/starknet_estimateFee.yaml index 37c24561..3435c177 100644 --- a/starknet/starknet_estimateFee.yaml +++ b/starknet/starknet_estimateFee.yaml @@ -22,19 +22,7 @@ components: summary: starknet_estimateFee description: Estimates the resources required by transactions when applied on a given state. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getBlockTransactionCount.yaml b/starknet/starknet_getBlockTransactionCount.yaml index 41efd3e0..e9af3119 100644 --- a/starknet/starknet_getBlockTransactionCount.yaml +++ b/starknet/starknet_getBlockTransactionCount.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getBlockTransactionCount description: Returns the number of transactions in the designated block. parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getBlockWithTxHashes.yaml b/starknet/starknet_getBlockWithTxHashes.yaml index ea8557a2..471c8d72 100644 --- a/starknet/starknet_getBlockWithTxHashes.yaml +++ b/starknet/starknet_getBlockWithTxHashes.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getBlockWithTxHashes description: Get block information with transaction hashes given the block id parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getBlockWithTxs.yaml b/starknet/starknet_getBlockWithTxs.yaml index 67871d77..2bb645de 100644 --- a/starknet/starknet_getBlockWithTxs.yaml +++ b/starknet/starknet_getBlockWithTxs.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getBlockWithTxs description: Get block information with full transactions given the block id parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getClass.yaml b/starknet/starknet_getClass.yaml index 3d7ebbab..b6e3dc62 100644 --- a/starknet/starknet_getClass.yaml +++ b/starknet/starknet_getClass.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getClass description: Get the contract class definition in the given block associated with the given hash parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getClassAt.yaml b/starknet/starknet_getClassAt.yaml index cfb2c32f..dba2af98 100644 --- a/starknet/starknet_getClassAt.yaml +++ b/starknet/starknet_getClassAt.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getClassAt description: Get the contract class definition in the given block at the given address parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getClassHashAt.yaml b/starknet/starknet_getClassHashAt.yaml index 5a1b1dce..eeb3ef4f 100644 --- a/starknet/starknet_getClassHashAt.yaml +++ b/starknet/starknet_getClassHashAt.yaml @@ -22,19 +22,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getEvents.yaml b/starknet/starknet_getEvents.yaml index c77476c5..5118d27e 100644 --- a/starknet/starknet_getEvents.yaml +++ b/starknet/starknet_getEvents.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getEvents description: Returns all event objects matching the conditions in the provided filter parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getNonce.yaml b/starknet/starknet_getNonce.yaml index f9578d70..df47941c 100644 --- a/starknet/starknet_getNonce.yaml +++ b/starknet/starknet_getNonce.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getNonce description: Get the nonce associated with the given address in the given block parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getStateUpdate.yaml b/starknet/starknet_getStateUpdate.yaml index 7dcce27b..ff9dccd1 100644 --- a/starknet/starknet_getStateUpdate.yaml +++ b/starknet/starknet_getStateUpdate.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getStateUpdate description: Get the information about the result of executing the requested block parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getStorageAt.yaml b/starknet/starknet_getStorageAt.yaml index ced9c443..7c948989 100644 --- a/starknet/starknet_getStorageAt.yaml +++ b/starknet/starknet_getStorageAt.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getStorageAt description: Get the value of the storage at the given address and key parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getTransactionByBlockIdAndIndex.yaml b/starknet/starknet_getTransactionByBlockIdAndIndex.yaml index a48edc5c..b53a2c8c 100644 --- a/starknet/starknet_getTransactionByBlockIdAndIndex.yaml +++ b/starknet/starknet_getTransactionByBlockIdAndIndex.yaml @@ -22,19 +22,7 @@ components: 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 - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getTransactionByHash.yaml b/starknet/starknet_getTransactionByHash.yaml index 5ba4cb92..0a6f0ddf 100644 --- a/starknet/starknet_getTransactionByHash.yaml +++ b/starknet/starknet_getTransactionByHash.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getTransactionByHash description: Get the details and status of a submitted transaction parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_getTransactionReceipt.yaml b/starknet/starknet_getTransactionReceipt.yaml index 776598a8..90b20429 100644 --- a/starknet/starknet_getTransactionReceipt.yaml +++ b/starknet/starknet_getTransactionReceipt.yaml @@ -22,19 +22,7 @@ components: summary: starknet_getTransactionReceipt description: Get the transaction receipt by the transaction hash parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_pendingTransactions.yaml b/starknet/starknet_pendingTransactions.yaml index cf895d25..3dbba6d2 100644 --- a/starknet/starknet_pendingTransactions.yaml +++ b/starknet/starknet_pendingTransactions.yaml @@ -22,19 +22,7 @@ components: summary: starknet_pendingTransactions description: Returns the transactions in the transaction pool, recognized by this sequencer parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: diff --git a/starknet/starknet_syncing.yaml b/starknet/starknet_syncing.yaml index 087f7c1f..7fed438e 100644 --- a/starknet/starknet_syncing.yaml +++ b/starknet/starknet_syncing.yaml @@ -22,19 +22,7 @@ components: summary: starknet_syncing description: Returns an object about the sync status, or false if the node is not synching parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: description: Request Body content: From 1af5073495fda5b0da9fe6726128c2646548dba7 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:49:04 +0200 Subject: [PATCH 13/47] Use ApiKey for Token API specs --- token/alchemy_getTokenAllowance.yaml | 14 +------------- token/alchemy_getTokenBalances.yaml | 14 +------------- token/alchemy_getTokenMetadata.yaml | 14 +------------- 3 files changed, 3 insertions(+), 39 deletions(-) diff --git a/token/alchemy_getTokenAllowance.yaml b/token/alchemy_getTokenAllowance.yaml index fe8b43e0..d997c03e 100644 --- a/token/alchemy_getTokenAllowance.yaml +++ b/token/alchemy_getTokenAllowance.yaml @@ -23,19 +23,7 @@ paths: description: 'Returns the amount which the spender is allowed to withdraw from the owner.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/token/alchemy_getTokenBalances.yaml b/token/alchemy_getTokenBalances.yaml index e99d28b6..bc7fb64a 100644 --- a/token/alchemy_getTokenBalances.yaml +++ b/token/alchemy_getTokenBalances.yaml @@ -25,19 +25,7 @@ paths: description: 'Returns ERC20 token balances for all tokens the given address has ever transacted in with. Optionally accepts a list of contracts.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/token/alchemy_getTokenMetadata.yaml b/token/alchemy_getTokenMetadata.yaml index 6b9f2b87..d5b57343 100644 --- a/token/alchemy_getTokenMetadata.yaml +++ b/token/alchemy_getTokenMetadata.yaml @@ -25,19 +25,7 @@ paths: description: 'Returns metadata (name, symbol, decimals, logo) for a given token contract address.' tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 91391c039385c9f2dca7245951874022588e474e Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:49:24 +0200 Subject: [PATCH 14/47] Use ApiKey for trace specs --- trace/trace_block.yaml | 14 +------------- trace/trace_call.yaml | 14 +------------- trace/trace_filter.yaml | 14 +------------- trace/trace_get.yaml | 14 +------------- trace/trace_rawTransaction.yaml | 14 +------------- trace/trace_replayBlockTransactions.yaml | 14 +------------- trace/trace_replayTransaction.yaml | 14 +------------- trace/trace_transaction.yaml | 14 +------------- 8 files changed, 8 insertions(+), 104 deletions(-) diff --git a/trace/trace_block.yaml b/trace/trace_block.yaml index 552262dc..3c0a8b26 100644 --- a/trace/trace_block.yaml +++ b/trace/trace_block.yaml @@ -17,19 +17,7 @@ paths: description: Returns traces created at given block. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/trace/trace_call.yaml b/trace/trace_call.yaml index 47b75722..fa2fa1c0 100644 --- a/trace/trace_call.yaml +++ b/trace/trace_call.yaml @@ -17,19 +17,7 @@ paths: description: Executes the given call and returns a number of possible traces for it. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/trace/trace_filter.yaml b/trace/trace_filter.yaml index f72c1ff7..2e6a405b 100644 --- a/trace/trace_filter.yaml +++ b/trace/trace_filter.yaml @@ -17,19 +17,7 @@ paths: description: Returns traces matching given filter. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/trace/trace_get.yaml b/trace/trace_get.yaml index 6a8ff550..8595a7ff 100644 --- a/trace/trace_get.yaml +++ b/trace/trace_get.yaml @@ -17,19 +17,7 @@ paths: description: Returns trace at given position. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/trace/trace_rawTransaction.yaml b/trace/trace_rawTransaction.yaml index 9fe5a38b..46800213 100644 --- a/trace/trace_rawTransaction.yaml +++ b/trace/trace_rawTransaction.yaml @@ -17,19 +17,7 @@ paths: description: Traces a call to eth_sendRawTransaction without making the call, returning the traces. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/trace/trace_replayBlockTransactions.yaml b/trace/trace_replayBlockTransactions.yaml index 8644047f..e6793875 100644 --- a/trace/trace_replayBlockTransactions.yaml +++ b/trace/trace_replayBlockTransactions.yaml @@ -17,19 +17,7 @@ paths: description: Replays all transactions in a block returning the requested traces for each transaction. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/trace/trace_replayTransaction.yaml b/trace/trace_replayTransaction.yaml index d5093844..26352dd1 100644 --- a/trace/trace_replayTransaction.yaml +++ b/trace/trace_replayTransaction.yaml @@ -17,19 +17,7 @@ paths: description: Traces a call to eth_sendRawTransaction without making the call, returning the traces. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: diff --git a/trace/trace_transaction.yaml b/trace/trace_transaction.yaml index c0e0b31e..7e7b6373 100644 --- a/trace/trace_transaction.yaml +++ b/trace/trace_transaction.yaml @@ -17,19 +17,7 @@ paths: description: Returns all traces of given transaction. tags: [] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 9138edcdb8edf8687f5f34e0be8660e7d7ef1fdc Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:49:31 +0200 Subject: [PATCH 15/47] Use ApiKey for transaction receipts specs --- .../alchemy_getTransactionReceipts.yaml | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/transaction-receipts/alchemy_getTransactionReceipts.yaml b/transaction-receipts/alchemy_getTransactionReceipts.yaml index d6cdaaf0..8484bb3a 100644 --- a/transaction-receipts/alchemy_getTransactionReceipts.yaml +++ b/transaction-receipts/alchemy_getTransactionReceipts.yaml @@ -59,19 +59,7 @@ paths: main(); parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 452c5c15a962e3d9cce818bfd4b9f494a91fd045 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 02:49:42 +0200 Subject: [PATCH 16/47] Use ApiKey for Transfers API spec --- transfers/alchemy_getAssetTransfers.yaml | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/transfers/alchemy_getAssetTransfers.yaml b/transfers/alchemy_getAssetTransfers.yaml index 4bace8c4..85ee324c 100644 --- a/transfers/alchemy_getAssetTransfers.yaml +++ b/transfers/alchemy_getAssetTransfers.yaml @@ -23,19 +23,7 @@ paths: 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'] parameters: - - name: apiKey - in: path - schema: - type: string - default: docs-demo - description: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - required: true + - $ref: ../components/parameters.yaml#/ApiKey requestBody: content: application/json: From 4cd0435b54ec95a1376abd1f07206cbe187a47c7 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 03:38:55 +0200 Subject: [PATCH 17/47] Reorder Starknet specs --- starknet/starknet_addDeclareTransaction.yaml | 96 ++++++++-------- .../starknet_addDeployAccountTransaction.yaml | 96 ++++++++-------- starknet/starknet_addInvokeTransaction.yaml | 94 ++++++++------- starknet/starknet_blockHashAndNumber.yaml | 86 +++++++------- starknet/starknet_blockNumber.yaml | 74 ++++++------ starknet/starknet_call.yaml | 106 +++++++++-------- starknet/starknet_chainId.yaml | 78 ++++++------- starknet/starknet_estimateFee.yaml | 90 +++++++-------- starknet/starknet_estimateMessageFee.yaml | 22 ++-- .../starknet_getBlockTransactionCount.yaml | 87 +++++++------- starknet/starknet_getBlockWithTxHashes.yaml | 87 +++++++------- starknet/starknet_getBlockWithTxs.yaml | 87 +++++++------- starknet/starknet_getClass.yaml | 93 ++++++++------- starknet/starknet_getClassAt.yaml | 91 +++++++-------- starknet/starknet_getClassHashAt.yaml | 86 +++++++------- starknet/starknet_getEvents.yaml | 108 +++++++++--------- starknet/starknet_getNonce.yaml | 96 ++++++++-------- starknet/starknet_getStateUpdate.yaml | 86 +++++++------- starknet/starknet_getStorageAt.yaml | 98 ++++++++-------- ...rknet_getTransactionByBlockIdAndIndex.yaml | 90 +++++++-------- starknet/starknet_getTransactionByHash.yaml | 90 +++++++-------- starknet/starknet_getTransactionReceipt.yaml | 90 +++++++-------- starknet/starknet_pendingTransactions.yaml | 78 ++++++------- starknet/starknet_syncing.yaml | 86 +++++++------- 24 files changed, 1001 insertions(+), 1094 deletions(-) diff --git a/starknet/starknet_addDeclareTransaction.yaml b/starknet/starknet_addDeclareTransaction.yaml index 6ce89d43..aa054573 100644 --- a/starknet/starknet_addDeclareTransaction.yaml +++ b/starknet/starknet_addDeclareTransaction.yaml @@ -13,59 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 90a38bd4..ce387585 100644 --- a/starknet/starknet_addDeployAccountTransaction.yaml +++ b/starknet/starknet_addDeployAccountTransaction.yaml @@ -13,59 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 87b7a054..ac203ec7 100644 --- a/starknet/starknet_addInvokeTransaction.yaml +++ b/starknet/starknet_addInvokeTransaction.yaml @@ -13,58 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 0036258f..b10f81d5 100644 --- a/starknet/starknet_blockHashAndNumber.yaml +++ b/starknet/starknet_blockHashAndNumber.yaml @@ -13,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 f06f8935..6536a4de 100644 --- a/starknet/starknet_blockNumber.yaml +++ b/starknet/starknet_blockNumber.yaml @@ -13,48 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 db01692d..e3d812b1 100644 --- a/starknet/starknet_call.yaml +++ b/starknet/starknet_call.yaml @@ -13,66 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 1a5f962e..beac812b 100644 --- a/starknet/starknet_chainId.yaml +++ b/starknet/starknet_chainId.yaml @@ -13,50 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 3435c177..228af719 100644 --- a/starknet/starknet_estimateFee.yaml +++ b/starknet/starknet_estimateFee.yaml @@ -13,58 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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: | - <style> - .custom-style { - color: #048FF4; - } - </style> - For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span> - 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 e9af3119..829dd215 100644 --- a/starknet/starknet_getBlockTransactionCount.yaml +++ b/starknet/starknet_getBlockTransactionCount.yaml @@ -13,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 471c8d72..a2339fbf 100644 --- a/starknet/starknet_getBlockWithTxHashes.yaml +++ b/starknet/starknet_getBlockWithTxHashes.yaml @@ -13,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 2bb645de..d198880a 100644 --- a/starknet/starknet_getBlockWithTxs.yaml +++ b/starknet/starknet_getBlockWithTxs.yaml @@ -13,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 b6e3dc62..738c6203 100644 --- a/starknet/starknet_getClass.yaml +++ b/starknet/starknet_getClass.yaml @@ -13,57 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 dba2af98..888f89bd 100644 --- a/starknet/starknet_getClassAt.yaml +++ b/starknet/starknet_getClassAt.yaml @@ -13,56 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 eeb3ef4f..8060ca09 100644 --- a/starknet/starknet_getClassHashAt.yaml +++ b/starknet/starknet_getClassHashAt.yaml @@ -13,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 5118d27e..a8de3fe4 100644 --- a/starknet/starknet_getEvents.yaml +++ b/starknet/starknet_getEvents.yaml @@ -13,65 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 df47941c..c5f2bf57 100644 --- a/starknet/starknet_getNonce.yaml +++ b/starknet/starknet_getNonce.yaml @@ -13,59 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 ff9dccd1..8cf3a8ac 100644 --- a/starknet/starknet_getStateUpdate.yaml +++ b/starknet/starknet_getStateUpdate.yaml @@ -13,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 7c948989..3224f528 100644 --- a/starknet/starknet_getStorageAt.yaml +++ b/starknet/starknet_getStorageAt.yaml @@ -13,60 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 b53a2c8c..2ff6cb66 100644 --- a/starknet/starknet_getTransactionByBlockIdAndIndex.yaml +++ b/starknet/starknet_getTransactionByBlockIdAndIndex.yaml @@ -13,56 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 0a6f0ddf..3d3c3df3 100644 --- a/starknet/starknet_getTransactionByHash.yaml +++ b/starknet/starknet_getTransactionByHash.yaml @@ -13,56 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 90b20429..0674ec54 100644 --- a/starknet/starknet_getTransactionReceipt.yaml +++ b/starknet/starknet_getTransactionReceipt.yaml @@ -13,56 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 3dbba6d2..2c81969f 100644 --- a/starknet/starknet_pendingTransactions.yaml +++ b/starknet/starknet_pendingTransactions.yaml @@ -13,51 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 7fed438e..586a4a5b 100644 --- a/starknet/starknet_syncing.yaml +++ b/starknet/starknet_syncing.yaml @@ -13,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Request Body + 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: + 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 From 80215074c2efa2ef353ae7d7e204ce74941fc566 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 03:39:12 +0200 Subject: [PATCH 18/47] Reorder trace specs --- trace/trace_block.yaml | 4 ++-- trace/trace_call.yaml | 20 ++++++++++---------- trace/trace_filter.yaml | 4 ++-- trace/trace_get.yaml | 18 +++++++++--------- trace/trace_rawTransaction.yaml | 18 +++++++++--------- trace/trace_replayBlockTransactions.yaml | 18 +++++++++--------- trace/trace_replayTransaction.yaml | 18 +++++++++--------- trace/trace_transaction.yaml | 4 ++-- 8 files changed, 52 insertions(+), 52 deletions(-) diff --git a/trace/trace_block.yaml b/trace/trace_block.yaml index 3c0a8b26..3b9f12a6 100644 --- a/trace/trace_block.yaml +++ b/trace/trace_block.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_block description: Returns traces created at given block. - tags: [] + operationId: trace-block parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 fa2fa1c0..4a52f2b7 100644 --- a/trace/trace_call.yaml +++ b/trace/trace_call.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -23,6 +24,13 @@ paths: 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: @@ -44,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 2e6a405b..448f64ae 100644 --- a/trace/trace_filter.yaml +++ b/trace/trace_filter.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_filter description: Returns traces matching given filter. - tags: [] + operationId: trace-filter parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 8595a7ff..71cf592c 100644 --- a/trace/trace_get.yaml +++ b/trace/trace_get.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_get description: Returns trace at given position. - tags: [] + operationId: trace-get parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -23,6 +24,13 @@ paths: 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: @@ -37,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 46800213..09b7deb5 100644 --- a/trace/trace_rawTransaction.yaml +++ b/trace/trace_rawTransaction.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -23,6 +24,13 @@ paths: 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: @@ -37,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 e6793875..32658891 100644 --- a/trace/trace_replayBlockTransactions.yaml +++ b/trace/trace_replayBlockTransactions.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -23,6 +24,13 @@ paths: 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: @@ -37,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 26352dd1..590c8da3 100644 --- a/trace/trace_replayTransaction.yaml +++ b/trace/trace_replayTransaction.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -23,6 +24,13 @@ paths: 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: @@ -37,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 7e7b6373..bc456466 100644 --- a/trace/trace_transaction.yaml +++ b/trace/trace_transaction.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: trace_transaction description: Returns all traces of given transaction. - tags: [] + operationId: trace-transaction parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/trace_transaction - operationId: trace-transaction From f06fd94389b40808e0b45eb9bf73943a5ed3ba80 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 03:39:22 +0200 Subject: [PATCH 19/47] Reorder Token API specs --- token/alchemy_getTokenAllowance.yaml | 4 ++-- token/alchemy_getTokenBalances.yaml | 18 +++++++++--------- token/alchemy_getTokenMetadata.yaml | 18 +++++++++--------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/token/alchemy_getTokenAllowance.yaml b/token/alchemy_getTokenAllowance.yaml index d997c03e..09624387 100644 --- a/token/alchemy_getTokenAllowance.yaml +++ b/token/alchemy_getTokenAllowance.yaml @@ -19,9 +19,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -36,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 bc7fb64a..0d0f91e3 100644 --- a/token/alchemy_getTokenBalances.yaml +++ b/token/alchemy_getTokenBalances.yaml @@ -21,9 +21,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -31,6 +32,13 @@ paths: 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 @@ -56,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 d5b57343..750b491d 100644 --- a/token/alchemy_getTokenMetadata.yaml +++ b/token/alchemy_getTokenMetadata.yaml @@ -21,9 +21,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -31,6 +32,13 @@ paths: 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 @@ -54,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 From 7ad1e23ffe060fae52ae5155a6a9a52371e1bb88 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 03:39:31 +0200 Subject: [PATCH 20/47] Reorder tx receipt spec --- .../alchemy_getTransactionReceipts.yaml | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/transaction-receipts/alchemy_getTransactionReceipts.yaml b/transaction-receipts/alchemy_getTransactionReceipts.yaml index 8484bb3a..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,17 +72,3 @@ paths: }; main(); - 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 From 155f7890e9aa0619c9c09fea3e722c1eecdf3cf7 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 03:39:41 +0200 Subject: [PATCH 21/47] Reorder Transfers API spec --- transfers/alchemy_getAssetTransfers.yaml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/transfers/alchemy_getAssetTransfers.yaml b/transfers/alchemy_getAssetTransfers.yaml index 85ee324c..129b87a1 100644 --- a/transfers/alchemy_getAssetTransfers.yaml +++ b/transfers/alchemy_getAssetTransfers.yaml @@ -19,9 +19,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -29,6 +30,13 @@ paths: 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 @@ -59,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 From 6329ce83df21152ee61d63667c0aec7ba97f0e8b Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 03:53:58 +0200 Subject: [PATCH 22/47] Reorder Solana spec fields --- solana/getAccountInfo.yaml | 4 ++-- solana/getBalance.yaml | 4 ++-- solana/getBlock.yaml | 4 ++-- solana/getBlockCommitment.yaml | 4 ++-- solana/getBlockHeight.yaml | 4 ++-- solana/getBlockProduction.yaml | 4 ++-- solana/getBlockTime.yaml | 4 ++-- solana/getBlocks.yaml | 4 ++-- solana/getBlocksWithLimit.yaml | 4 ++-- solana/getClusterNodes.yaml | 4 ++-- solana/getEpochInfo.yaml | 4 ++-- solana/getEpochSchedule.yaml | 4 ++-- solana/getFeeForMessage.yaml | 4 ++-- solana/getFirstAvailableBlock.yaml | 4 ++-- solana/getGenesisHash.yaml | 4 ++-- solana/getHealth.yaml | 4 ++-- solana/getHighestSnapshotSlot.yaml | 4 ++-- solana/getIdentity.yaml | 4 ++-- solana/getInflationGovernor.yaml | 4 ++-- solana/getInflationRate.yaml | 4 ++-- solana/getInflationReward.yaml | 4 ++-- solana/getLargestAccounts.yaml | 4 ++-- solana/getMaxRetransmitSlot.yaml | 4 ++-- solana/getMaxShredInsertSlot.yaml | 4 ++-- solana/getMinimumBalanceForRentExemption.yaml | 4 ++-- solana/getMultipleAccounts.yaml | 4 ++-- solana/getProgramAccounts.yaml | 4 ++-- solana/getRecentPerformanceSamples.yaml | 4 ++-- solana/getSignatureStatuses.yaml | 4 ++-- solana/getSignaturesForAddress.yaml | 4 ++-- solana/getSlot.yaml | 4 ++-- solana/getSlotLeader.yaml | 4 ++-- solana/getSlotLeaders.yaml | 4 ++-- solana/getSupply.yaml | 4 ++-- solana/getTokenAccountBalance.yaml | 4 ++-- solana/getTokenAccountsByOwner.yaml | 4 ++-- solana/getTokenSupply.yaml | 4 ++-- solana/getTransaction.yaml | 4 ++-- solana/getVersion.yaml | 4 ++-- solana/getVoteAccounts.yaml | 4 ++-- solana/isBlockhashValid.yaml | 4 ++-- solana/minimumLedgerSlot.yaml | 4 ++-- solana/requestAirdrop.yaml | 16 ++++++++-------- solana/sendTransaction.yaml | 4 ++-- solana/simulateTransaction.yaml | 4 ++-- 45 files changed, 96 insertions(+), 96 deletions(-) diff --git a/solana/getAccountInfo.yaml b/solana/getAccountInfo.yaml index 4a8ef4e0..d3220ee5 100644 --- a/solana/getAccountInfo.yaml +++ b/solana/getAccountInfo.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getAccountInfo description: Returns all information associated with the account of provided Pubkey. - tags: [] + operationId: getAccountInfo parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 70fb05d9..f4042da9 100644 --- a/solana/getBalance.yaml +++ b/solana/getBalance.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBalance description: Returns the balance of the account of provided Pubkey. - tags: [] + operationId: getBalance parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 2bf788c9..221042f7 100644 --- a/solana/getBlock.yaml +++ b/solana/getBlock.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlock description: Returns identity and transaction information about a confirmed block in the ledger. - tags: [] + operationId: getBlock parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 9e2d9458..57c145f4 100644 --- a/solana/getBlockCommitment.yaml +++ b/solana/getBlockCommitment.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlockCommitment description: Returns commitment for particular block. - tags: [] + operationId: getBlockCommitment parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 61c0c530..8fd0852a 100644 --- a/solana/getBlockHeight.yaml +++ b/solana/getBlockHeight.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlockHeight description: Returns the current block height of the node. - tags: [] + operationId: getBlockHeight parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 355a8443..e8633992 100644 --- a/solana/getBlockProduction.yaml +++ b/solana/getBlockProduction.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlockProduction description: Returns recent block production information from the current or previous epoch. - tags: [] + operationId: getBlockProduction parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 d752ba19..9c0fa381 100644 --- a/solana/getBlockTime.yaml +++ b/solana/getBlockTime.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlockTime description: Returns the estimated production time of a block. - tags: [] + operationId: getBlockTime parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 3a68fd4c..f0a22d81 100644 --- a/solana/getBlocks.yaml +++ b/solana/getBlocks.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlocks description: Returns a list of confirmed blocks between two slots. - tags: [] + operationId: getBlocks parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 2445b6ff..5e1970c3 100644 --- a/solana/getBlocksWithLimit.yaml +++ b/solana/getBlocksWithLimit.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getBlocksWithLimit description: Returns a list of confirmed blocks starting at the given slot. - tags: [] + operationId: getBlocksWithLimit parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 565cf8bf..8d561e38 100644 --- a/solana/getClusterNodes.yaml +++ b/solana/getClusterNodes.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getClusterNodes description: Returns information about all the nodes participating in the cluster. - tags: [] + operationId: getClusterNodes parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 353c38fa..85815d52 100644 --- a/solana/getEpochInfo.yaml +++ b/solana/getEpochInfo.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getEpochInfo description: Returns information about the current epoch. - tags: [] + operationId: getEpochInfo parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 72734226..c8c3f4c4 100644 --- a/solana/getEpochSchedule.yaml +++ b/solana/getEpochSchedule.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getEpochSchedule description: Returns epoch schedule information from this cluster's genesis config. - tags: [] + operationId: getEpochSchedule parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 11f4fbcd..96127e43 100644 --- a/solana/getFeeForMessage.yaml +++ b/solana/getFeeForMessage.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getFeeForMessage description: Get the fee the network will charge for a particular message. - tags: [] + operationId: getFeeForMessage parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 c25b082a..6cc4369a 100644 --- a/solana/getFirstAvailableBlock.yaml +++ b/solana/getFirstAvailableBlock.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getFirstAvailableBlock description: Get the fee the network will charge for a particular message. - tags: [] + operationId: getFirstAvailableBlock parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 9d00c28c..9429f2b0 100644 --- a/solana/getGenesisHash.yaml +++ b/solana/getGenesisHash.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getGenesisHash description: Returns the genesis hash. - tags: [] + operationId: getGenesisHash parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 49cbc0ef..bd8165a3 100644 --- a/solana/getHealth.yaml +++ b/solana/getHealth.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getHealth description: Returns the current health of the node. - tags: [] + operationId: getHealth parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 a5353db8..86d1f034 100644 --- a/solana/getHighestSnapshotSlot.yaml +++ b/solana/getHighestSnapshotSlot.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getHighestSnapshotSlot description: Returns the highest slot information that the node has snapshots for. - tags: [] + operationId: getHighestSnapshotSlot parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 7aa18d37..798fb682 100644 --- a/solana/getIdentity.yaml +++ b/solana/getIdentity.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getIdentity description: Returns the identity pubkey for the current node. - tags: [] + operationId: getIdentity parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 3060bddb..f1a363fb 100644 --- a/solana/getInflationGovernor.yaml +++ b/solana/getInflationGovernor.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getInflationGovernor description: Returns the current inflation governor. - tags: [] + operationId: getInflationGovernor parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 497d757a..3e07f74c 100644 --- a/solana/getInflationRate.yaml +++ b/solana/getInflationRate.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getInflationRate description: Returns the specific inflation values for the current epoch. - tags: [] + operationId: getInflationRate parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 e556355b..78987d2b 100644 --- a/solana/getInflationReward.yaml +++ b/solana/getInflationReward.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 29e5f1d4..60490994 100644 --- a/solana/getLargestAccounts.yaml +++ b/solana/getLargestAccounts.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 1a368340..0a75f4e2 100644 --- a/solana/getMaxRetransmitSlot.yaml +++ b/solana/getMaxRetransmitSlot.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getMaxRetransmitSlot description: Get the max slot seen from retransmit stage. - tags: [] + operationId: getMaxRetransmitSlot parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 3b211d7f..6cad4285 100644 --- a/solana/getMaxShredInsertSlot.yaml +++ b/solana/getMaxShredInsertSlot.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getMaxShredInsertSlot description: Get the max slot seen from after shred insert.. - tags: [] + operationId: getMaxShredInsertSlot parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 a95ac23f..7e271c7c 100644 --- a/solana/getMinimumBalanceForRentExemption.yaml +++ b/solana/getMinimumBalanceForRentExemption.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getMinimumBalanceForRentExemption description: Returns minimum balance required to make account rent exempt. - tags: [] + operationId: getMinimumBalanceForRentExemption parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 55a49dc0..c8c63d3f 100644 --- a/solana/getMultipleAccounts.yaml +++ b/solana/getMultipleAccounts.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getMultipleAccounts description: Returns the account information for a list of Pubkeys. - tags: [] + operationId: getMultipleAccounts parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 da3f3a67..606cd97c 100644 --- a/solana/getProgramAccounts.yaml +++ b/solana/getProgramAccounts.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getProgramAccounts description: Returns all accounts owned by the provided program Pubkey. - tags: [] + operationId: getProgramAccounts parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 aaf403ad..73f10b4e 100644 --- a/solana/getRecentPerformanceSamples.yaml +++ b/solana/getRecentPerformanceSamples.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 42c92c2b..9c1ec6ad 100644 --- a/solana/getSignatureStatuses.yaml +++ b/solana/getSignatureStatuses.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSignatureStatuses description: Returns the statuses of a list of signatures. - tags: [] + operationId: getSignatureStatuses parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 e53eebe9..227e97c5 100644 --- a/solana/getSignaturesForAddress.yaml +++ b/solana/getSignaturesForAddress.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 4be890ed..7474d162 100644 --- a/solana/getSlot.yaml +++ b/solana/getSlot.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSlot description: Returns the slot that has reached the given or default commitment level. - tags: [] + operationId: getSlot parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 1931e1ff..823712cb 100644 --- a/solana/getSlotLeader.yaml +++ b/solana/getSlotLeader.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSlotLeader description: Returns the current slot leader. - tags: [] + operationId: getSlotLeader parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 f48fef31..43404b2b 100644 --- a/solana/getSlotLeaders.yaml +++ b/solana/getSlotLeaders.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSlotLeaders description: Returns the slot leaders for a given slot range. - tags: [] + operationId: getSlotLeaders parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 ba19a466..588ec41e 100644 --- a/solana/getSupply.yaml +++ b/solana/getSupply.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getSupply description: Returns information about the current supply. - tags: [] + operationId: getSupply parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 94ea2f79..ab7bf298 100644 --- a/solana/getTokenAccountBalance.yaml +++ b/solana/getTokenAccountBalance.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getTokenAccountBalance description: Returns the token balance of an SPL Token account.. - tags: [] + operationId: getTokenAccountBalance parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 757dbabf..eb482877 100644 --- a/solana/getTokenAccountsByOwner.yaml +++ b/solana/getTokenAccountsByOwner.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getTokenAccountsByOwner description: Returns all SPL Token accounts by token owner. - tags: [] + operationId: getTokenAccountsByOwner parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 677a72c1..f320de32 100644 --- a/solana/getTokenSupply.yaml +++ b/solana/getTokenSupply.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getTokenSupply description: Returns the total supply of an SPL Token type. - tags: [] + operationId: getTokenSupply parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 74273a28..c5f8624d 100644 --- a/solana/getTransaction.yaml +++ b/solana/getTransaction.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getTransaction description: Returns transaction details for a confirmed transaction. - tags: [] + operationId: getTransaction parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 47d2c428..6dc56d31 100644 --- a/solana/getVersion.yaml +++ b/solana/getVersion.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: getVersion description: Returns the current solana versions running on the node. - tags: [] + operationId: getVersion parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 c15fef74..0b70fd31 100644 --- a/solana/getVoteAccounts.yaml +++ b/solana/getVoteAccounts.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 151c07a1..121af008 100644 --- a/solana/isBlockhashValid.yaml +++ b/solana/isBlockhashValid.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: isBlockhashValid description: Returns whether a blockhash is still valid or not. - tags: [] + operationId: isBlockhashValid parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 b7cf0c7a..cbc72883 100644 --- a/solana/minimumLedgerSlot.yaml +++ b/solana/minimumLedgerSlot.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 cd5b60ce..376bb126 100644 --- a/solana/requestAirdrop.yaml +++ b/solana/requestAirdrop.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: requestAirdrop description: Requests an airdrop of lamports to a Pubkey - tags: [] + operationId: requestAirdrop parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -23,12 +24,6 @@ paths: application/json: schema: $ref: solana_body.yaml#/requestAirdrop - x-readme: - explorer-enabled: false - samples-languages: - - curl - - javascript - - python code-samples: - language: shell name: cURL @@ -49,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 ca8f854b..ead370e5 100644 --- a/solana/sendTransaction.yaml +++ b/solana/sendTransaction.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: sendTransaction description: Submits a signed transaction to the cluster for processing. - tags: [] + operationId: sendTransaction parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 5c3b8d45..c4716549 100644 --- a/solana/simulateTransaction.yaml +++ b/solana/simulateTransaction.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: simulateTransaction description: Simulate sending a transaction. - tags: [] + operationId: simulateTransaction parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,6 +31,5 @@ paths: application/json: schema: $ref: solana_responses.yaml#/simulateTransaction - operationId: simulateTransaction x-readme: explorer-enabled: false From 761009eee0209466ba4151e350f5bdd28b7a86f5 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 03:54:30 +0200 Subject: [PATCH 23/47] Reorder account abstraction spec fields --- ...alchemy_requestGasAndPaymasterAndData.yaml | 48 +++++++++---------- .../alchemy_requestPaymasterAndData.yaml | 48 +++++++++---------- .../eth_estimateUserOperationGas.yaml | 48 +++++++++---------- .../eth_getUserOperationByHash.yaml | 48 +++++++++---------- .../eth_getUserOperationReceipt.yaml | 48 +++++++++---------- .../eth_sendUserOperation.yaml | 48 +++++++++---------- .../eth_supportedEntryPoints.yaml | 48 +++++++++---------- .../rundler_maxPriorityFeePerGas.yaml | 4 +- 8 files changed, 156 insertions(+), 184 deletions(-) diff --git a/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml b/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml index 0bf00459..1f17ec31 100644 --- a/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml +++ b/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml @@ -21,32 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - required: true + 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: + $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 16d7b0a3..05863cc9 100644 --- a/account-abstraction/alchemy_requestPaymasterAndData.yaml +++ b/account-abstraction/alchemy_requestPaymasterAndData.yaml @@ -21,32 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - required: true + 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: + $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 b9ef1873..79f41d57 100644 --- a/account-abstraction/eth_estimateUserOperationGas.yaml +++ b/account-abstraction/eth_estimateUserOperationGas.yaml @@ -21,32 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - required: true + 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: + $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 db1a458a..4e273f58 100644 --- a/account-abstraction/eth_getUserOperationByHash.yaml +++ b/account-abstraction/eth_getUserOperationByHash.yaml @@ -21,32 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - required: true + 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: + $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 693324e6..462274a8 100644 --- a/account-abstraction/eth_getUserOperationReceipt.yaml +++ b/account-abstraction/eth_getUserOperationReceipt.yaml @@ -21,32 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - required: true + 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: + $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 dd6cb9d0..0caa1fdc 100644 --- a/account-abstraction/eth_sendUserOperation.yaml +++ b/account-abstraction/eth_sendUserOperation.yaml @@ -21,32 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - required: true + 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: + $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 ff253a33..925fd417 100644 --- a/account-abstraction/eth_supportedEntryPoints.yaml +++ b/account-abstraction/eth_supportedEntryPoints.yaml @@ -21,32 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - required: true + 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: + $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 d314aaa0..1780830f 100644 --- a/account-abstraction/rundler_maxPriorityFeePerGas.yaml +++ b/account-abstraction/rundler_maxPriorityFeePerGas.yaml @@ -22,9 +22,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -39,4 +40,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/string_result_response - operationId: rundler-maxPriorityFeePerGas From a410b15e99e53c76f5939e47b363044e879bd9f1 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:03:48 +0200 Subject: [PATCH 24/47] Refactor Arbitrum specs --- arbitrum/eth_chainId.yaml | 2 +- arbitrum/eth_createAccessList.yaml | 2 +- arbitrum/eth_feeHistory.yaml | 6 +- arbitrum/eth_getBlockByHash.yaml | 80 ++++++------ arbitrum/eth_getBlockByNumber.yaml | 74 +++++------ arbitrum/eth_getProof.yaml | 86 ++++++------ ...eth_getTransactionByBlockHashAndIndex.yaml | 48 ++++--- ...h_getTransactionByBlockNumberAndIndex.yaml | 4 +- arbitrum/eth_getTransactionByHash.yaml | 18 +-- arbitrum/eth_getTransactionReceipt.yaml | 92 +++++++------ arbitrum/eth_maxPriorityFeePerGas.yaml | 4 +- nft/nfts.yaml | 123 +++++++++--------- 12 files changed, 260 insertions(+), 279 deletions(-) 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 c256e1a8..39e225cc 100644 --- a/arbitrum/eth_createAccessList.yaml +++ b/arbitrum/eth_createAccessList.yaml @@ -15,6 +15,7 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -29,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 c2843267..736255e1 100644 --- a/arbitrum/eth_getBlockByHash.yaml +++ b/arbitrum/eth_getBlockByHash.yaml @@ -13,50 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 c063e8bf..a18668cb 100644 --- a/arbitrum/eth_getBlockByNumber.yaml +++ b/arbitrum/eth_getBlockByNumber.yaml @@ -13,47 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 5adcdc00..ac2fbc92 100644 --- a/arbitrum/eth_getProof.yaml +++ b/arbitrum/eth_getProof.yaml @@ -12,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 936cb0f7..d341f0f6 100644 --- a/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml +++ b/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml @@ -12,32 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 626ce9a5..65e004bf 100644 --- a/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -32,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 f1506ed6..d65e23a3 100644 --- a/arbitrum/eth_getTransactionByHash.yaml +++ b/arbitrum/eth_getTransactionByHash.yaml @@ -17,9 +17,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -32,6 +33,13 @@ components: [ '0x2d6da6ea7d7d7d1ca72576dc457a2b6f59fb798566fb97492b3f2835b0a59178', ] + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/eth_getTransactionByHash_arb x-readme: samples-languages: - curl @@ -57,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 de65ab94..c07b5f20 100644 --- a/arbitrum/eth_getTransactionReceipt.yaml +++ b/arbitrum/eth_getTransactionReceipt.yaml @@ -12,56 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 b0d023d5..60fa8d9a 100644 --- a/arbitrum/eth_maxPriorityFeePerGas.yaml +++ b/arbitrum/eth_maxPriorityFeePerGas.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,4 +31,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-maxpriorityfeepergas-arbitrum 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 From df01f977f749e91e889337f8d986c59a65abf60d Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:08:26 +0200 Subject: [PATCH 25/47] Refactor Astar spec --- astar/eth_maxPriorityFeePerGas.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/astar/eth_maxPriorityFeePerGas.yaml b/astar/eth_maxPriorityFeePerGas.yaml index b5e4132e..6e836a2f 100644 --- a/astar/eth_maxPriorityFeePerGas.yaml +++ b/astar/eth_maxPriorityFeePerGas.yaml @@ -7,9 +7,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -24,4 +25,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-maxPriorityFeePerGas-astar From 416bfb62cac627b97bfbcd77d6ed8638d81b9f28 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:10:21 +0200 Subject: [PATCH 26/47] Refactor Base specs --- base/eth_feeHistory.yaml | 46 ++++++++++++++---------------- base/eth_getBlockByNumber.yaml | 10 +++---- base/eth_getProof.yaml | 46 ++++++++++++++---------------- base/eth_maxPriorityFeePerGas.yaml | 4 +-- base/eth_syncing.yaml | 4 +-- 5 files changed, 51 insertions(+), 59 deletions(-) diff --git a/base/eth_feeHistory.yaml b/base/eth_feeHistory.yaml index 52b5848b..cb118077 100644 --- a/base/eth_feeHistory.yaml +++ b/base/eth_feeHistory.yaml @@ -12,31 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 12708aae..23b28f88 100644 --- a/base/eth_getProof.yaml +++ b/base/eth_getProof.yaml @@ -12,31 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 0b216b14..93b8a487 100644 --- a/base/eth_maxPriorityFeePerGas.yaml +++ b/base/eth_maxPriorityFeePerGas.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 f298c299..8774f777 100644 --- a/base/eth_syncing.yaml +++ b/base/eth_syncing.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_syncing - Base description: Returns a list of addresses owned by client. - tags: [] + operationId: eth-syncing-base parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -31,4 +32,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/eth_syncing - operationId: eth-syncing-base From 7189949db8627dd3c986d45d43727e47b0cc93db Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:18:11 +0200 Subject: [PATCH 27/47] Refactor debug specs --- debug/debug_traceBlockByHash.yaml | 18 +++++++++--------- debug/debug_traceBlockByNumber.yaml | 28 ++++++++++++++-------------- debug/debug_traceCall.yaml | 18 +++++++++--------- debug/debug_traceTransaction.yaml | 18 +++++++++--------- 4 files changed, 41 insertions(+), 41 deletions(-) diff --git a/debug/debug_traceBlockByHash.yaml b/debug/debug_traceBlockByHash.yaml index 4a70d387..4ae2d7fe 100644 --- a/debug/debug_traceBlockByHash.yaml +++ b/debug/debug_traceBlockByHash.yaml @@ -19,9 +19,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: debug_traceBlockByHash description: Replays the block that is already present in the database. - tags: [] + operationId: debug-traceblockbyhash parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -29,6 +30,13 @@ paths: 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: @@ -74,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 e25b8020..53a5256e 100644 --- a/debug/debug_traceBlockByNumber.yaml +++ b/debug/debug_traceBlockByNumber.yaml @@ -19,11 +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: - $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: @@ -69,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 540e9186..ca1f0d94 100644 --- a/debug/debug_traceCall.yaml +++ b/debug/debug_traceCall.yaml @@ -19,9 +19,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -29,6 +30,13 @@ paths: 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: @@ -78,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 ee37f965..3a6ca102 100644 --- a/debug/debug_traceTransaction.yaml +++ b/debug/debug_traceTransaction.yaml @@ -19,9 +19,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -29,6 +30,13 @@ paths: 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: @@ -75,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 From 45736ebdd3e67cfc96d552bc3bf34abba49bb327 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:35:14 +0200 Subject: [PATCH 28/47] Refactor Polygon zkEVM specs --- polygon-zkevm/eth_call.yaml | 86 ++++++------ polygon-zkevm/eth_estimateGas.yaml | 84 ++++++------ polygon-zkevm/eth_getBalance.yaml | 18 +-- polygon-zkevm/eth_getCode.yaml | 74 +++++------ polygon-zkevm/eth_getCompilers.yaml | 14 +- polygon-zkevm/eth_getStorageAt.yaml | 74 +++++------ ...h_getTransactionByBlockNumberAndIndex.yaml | 46 +++---- polygon-zkevm/eth_getTransactionReceipt.yaml | 82 ++++++------ .../eth_getUncleByBlockHashAndIndex.yaml | 64 +++++---- .../eth_getUncleByBlockNumberAndIndex.yaml | 64 +++++---- .../eth_getUncleCountByBlockHash.yaml | 70 +++++----- .../eth_getUncleCountByBlockNumber.yaml | 70 +++++----- polygon-zkevm/eth_protocolVersion.yaml | 70 +++++----- polygon-zkevm/eth_sendRawTransaction.yaml | 124 +++++++++--------- polygon-zkevm/zkevm_batchNumber.yaml | 44 +++---- .../zkevm_batchNumberByBlockNumber.yaml | 44 +++---- .../zkevm_consolidatedBlockNumber.yaml | 46 +++---- polygon-zkevm/zkevm_getBatchByNumber.yaml | 44 +++---- polygon-zkevm/zkevm_getBroadcastURI.yaml | 42 +++--- polygon-zkevm/zkevm_isBlockConsolidated.yaml | 42 +++--- polygon-zkevm/zkevm_isBlockVirtualized.yaml | 42 +++--- polygon-zkevm/zkevm_verifiedBatchNumber.yaml | 44 +++---- polygon-zkevm/zkevm_virtualBatchNumber.yaml | 44 +++---- 23 files changed, 624 insertions(+), 708 deletions(-) diff --git a/polygon-zkevm/eth_call.yaml b/polygon-zkevm/eth_call.yaml index 7ff645dd..e19e6834 100644 --- a/polygon-zkevm/eth_call.yaml +++ b/polygon-zkevm/eth_call.yaml @@ -13,53 +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: - - $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. + 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: + $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 9590209c..609e4df1 100644 --- a/polygon-zkevm/eth_estimateGas.yaml +++ b/polygon-zkevm/eth_estimateGas.yaml @@ -12,52 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 36313e12..b497a467 100644 --- a/polygon-zkevm/eth_getBalance.yaml +++ b/polygon-zkevm/eth_getBalance.yaml @@ -17,9 +17,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -27,6 +28,13 @@ components: 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 @@ -48,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 f72c33d7..1843b4fd 100644 --- a/polygon-zkevm/eth_getCode.yaml +++ b/polygon-zkevm/eth_getCode.yaml @@ -12,47 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 e6528707..f79f9d0a 100644 --- a/polygon-zkevm/eth_getCompilers.yaml +++ b/polygon-zkevm/eth_getCompilers.yaml @@ -17,9 +17,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -36,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. @@ -62,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 d0ebd7c8..cbce8b80 100644 --- a/polygon-zkevm/eth_getStorageAt.yaml +++ b/polygon-zkevm/eth_getStorageAt.yaml @@ -12,47 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 8c9d3b56..a76ec8c2 100644 --- a/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml @@ -12,31 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 679970bd..d9636dd3 100644 --- a/polygon-zkevm/eth_getTransactionReceipt.yaml +++ b/polygon-zkevm/eth_getTransactionReceipt.yaml @@ -12,51 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 77d3d18d..090d3a59 100644 --- a/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml +++ b/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml @@ -12,40 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 85acb91a..8e1ac8d3 100644 --- a/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml +++ b/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml @@ -12,40 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 140ed944..b9812dad 100644 --- a/polygon-zkevm/eth_getUncleCountByBlockHash.yaml +++ b/polygon-zkevm/eth_getUncleCountByBlockHash.yaml @@ -12,43 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 931c0b00..80ec464d 100644 --- a/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml +++ b/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml @@ -12,43 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 5f455962..1524ab83 100644 --- a/polygon-zkevm/eth_protocolVersion.yaml +++ b/polygon-zkevm/eth_protocolVersion.yaml @@ -12,43 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 3d620799..adfd9ff5 100644 --- a/polygon-zkevm/eth_sendRawTransaction.yaml +++ b/polygon-zkevm/eth_sendRawTransaction.yaml @@ -12,81 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 94fdf443..f9b4b892 100644 --- a/polygon-zkevm/zkevm_batchNumber.yaml +++ b/polygon-zkevm/zkevm_batchNumber.yaml @@ -13,30 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 792664fe..81576cc1 100644 --- a/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml +++ b/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml @@ -13,30 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 bcd0d651..5c3e419e 100644 --- a/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml +++ b/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml @@ -13,31 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Accepts no parameters. + 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: + $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 dff90c35..e641510b 100644 --- a/polygon-zkevm/zkevm_getBatchByNumber.yaml +++ b/polygon-zkevm/zkevm_getBatchByNumber.yaml @@ -13,30 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 7957ff7f..4bd329c9 100644 --- a/polygon-zkevm/zkevm_getBroadcastURI.yaml +++ b/polygon-zkevm/zkevm_getBroadcastURI.yaml @@ -13,31 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + content: + application/json: + schema: + $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 bb87d6cd..cc85991a 100644 --- a/polygon-zkevm/zkevm_isBlockConsolidated.yaml +++ b/polygon-zkevm/zkevm_isBlockConsolidated.yaml @@ -13,31 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + content: + application/json: + schema: + $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 62ec0e02..b4b245d3 100644 --- a/polygon-zkevm/zkevm_isBlockVirtualized.yaml +++ b/polygon-zkevm/zkevm_isBlockVirtualized.yaml @@ -13,31 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + content: + application/json: + schema: + $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 5e95d149..59996e17 100644 --- a/polygon-zkevm/zkevm_verifiedBatchNumber.yaml +++ b/polygon-zkevm/zkevm_verifiedBatchNumber.yaml @@ -13,30 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 924f058e..3e6daedc 100644 --- a/polygon-zkevm/zkevm_virtualBatchNumber.yaml +++ b/polygon-zkevm/zkevm_virtualBatchNumber.yaml @@ -13,30 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 From 81172cdc21a19bad469ae250bbd4b17496daa59f Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:38:18 +0200 Subject: [PATCH 29/47] Refactor Polygon PoS specs --- polygon-pos/bor_getAuthor.yaml | 4 +- polygon-pos/bor_getCurrentProposer.yaml | 4 +- polygon-pos/bor_getCurrentValidators.yaml | 4 +- polygon-pos/bor_getRootHash.yaml | 4 +- polygon-pos/bor_getSignersAtHash.yaml | 4 +- polygon-pos/eth_blockNumber.yaml | 2 +- polygon-pos/eth_feeHistory.yaml | 88 +++++++++---------- polygon-pos/eth_getRootHash.yaml | 2 +- polygon-pos/eth_getSignersAtHash.yaml | 2 +- .../eth_getTransactionReceiptsByBlock.yaml | 2 +- polygon-pos/eth_sendRawTransaction.yaml | 18 ++-- 11 files changed, 65 insertions(+), 69 deletions(-) diff --git a/polygon-pos/bor_getAuthor.yaml b/polygon-pos/bor_getAuthor.yaml index d41b544e..9a7d7936 100644 --- a/polygon-pos/bor_getAuthor.yaml +++ b/polygon-pos/bor_getAuthor.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: bor_getAuthor - Polygon PoS description: 'Returns address of Author on Polygon.' - tags: [] + operationId: bor-getauthor-polygon parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -31,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 3ea05afe..39f7ae12 100644 --- a/polygon-pos/bor_getCurrentProposer.yaml +++ b/polygon-pos/bor_getCurrentProposer.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: bor_getCurrentProposer - Polygon PoS description: "Returns current proposer's address on Polygon." - tags: [] + operationId: bor-getcurrentproposer-polygon parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 58c129b2..e8a33e1c 100644 --- a/polygon-pos/bor_getCurrentValidators.yaml +++ b/polygon-pos/bor_getCurrentValidators.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: bor_getCurrentValidators - Polygon PoS description: 'Returns current validators for Polygon.' - tags: [] + operationId: bor-getCurrentValidators-polygon parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 853de125..2a52e25b 100644 --- a/polygon-pos/bor_getRootHash.yaml +++ b/polygon-pos/bor_getRootHash.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 a6390944..095aa5b5 100644 --- a/polygon-pos/bor_getSignersAtHash.yaml +++ b/polygon-pos/bor_getSignersAtHash.yaml @@ -13,9 +13,10 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -30,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 9a8cedf8..7458be74 100644 --- a/polygon-pos/eth_feeHistory.yaml +++ b/polygon-pos/eth_feeHistory.yaml @@ -6,55 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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_getRootHash.yaml b/polygon-pos/eth_getRootHash.yaml index d83cd96c..0dde51ed 100644 --- a/polygon-pos/eth_getRootHash.yaml +++ b/polygon-pos/eth_getRootHash.yaml @@ -13,9 +13,9 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_getRootHash - Polygon PoS description: 'Returns the root hash given a block range on Polygon.' - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/polygon-pos/eth_getSignersAtHash.yaml b/polygon-pos/eth_getSignersAtHash.yaml index 1b19f271..d81fe0ec 100644 --- a/polygon-pos/eth_getSignersAtHash.yaml +++ b/polygon-pos/eth_getSignersAtHash.yaml @@ -13,9 +13,9 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_getSignersAtHash - Polygon PoS description: 'Polygon API - Returns all signs given a blockhash.' - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/polygon-pos/eth_getTransactionReceiptsByBlock.yaml b/polygon-pos/eth_getTransactionReceiptsByBlock.yaml index de78004b..ceff2a7a 100644 --- a/polygon-pos/eth_getTransactionReceiptsByBlock.yaml +++ b/polygon-pos/eth_getTransactionReceiptsByBlock.yaml @@ -13,9 +13,9 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/polygon-pos/eth_sendRawTransaction.yaml b/polygon-pos/eth_sendRawTransaction.yaml index 918a8a0e..bb6e3d1c 100644 --- a/polygon-pos/eth_sendRawTransaction.yaml +++ b/polygon-pos/eth_sendRawTransaction.yaml @@ -13,11 +13,12 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_sendRawTransaction - Polygon PoS description: | Creates a new message call transaction or a contract creation for signed transactions. </br><strong> Note: </strong> Due to network constraints, transactions on Polygon Mainnet must be submitted with a minimum gasPrice of 30 gwei. - tags: [] + operationId: eth-sendRawTransaction-polygon parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -25,6 +26,13 @@ paths: 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 @@ -61,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 From eb425ab71d16aab709e4aca7b26053da06d993ba Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:41:02 +0200 Subject: [PATCH 30/47] Refactor Optimism specs --- optimism/eth_feeHistory.yaml | 88 ++++++++++++-------------- optimism/eth_getProof.yaml | 86 ++++++++++++------------- optimism/eth_maxPriorityFeePerGas.yaml | 2 +- optimism/eth_syncing.yaml | 4 +- 4 files changed, 86 insertions(+), 94 deletions(-) diff --git a/optimism/eth_feeHistory.yaml b/optimism/eth_feeHistory.yaml index d065b8ee..635040d5 100644 --- a/optimism/eth_feeHistory.yaml +++ b/optimism/eth_feeHistory.yaml @@ -6,55 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 49fd8cf2..a0ac805e 100644 --- a/optimism/eth_getProof.yaml +++ b/optimism/eth_getProof.yaml @@ -12,54 +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: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + 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: + $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 07b8a8d4..0d11c954 100644 --- a/optimism/eth_maxPriorityFeePerGas.yaml +++ b/optimism/eth_maxPriorityFeePerGas.yaml @@ -13,9 +13,9 @@ 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/optimism/eth_syncing.yaml b/optimism/eth_syncing.yaml index ccc9ac60..6ca5ccc7 100644 --- a/optimism/eth_syncing.yaml +++ b/optimism/eth_syncing.yaml @@ -13,9 +13,10 @@ servers: paths: /{apiKey}: post: + tags: [] summary: eth_syncing - Optimism description: Returns a list of addresses owned by client. - tags: [] + operationId: eth-syncing-optimism parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -31,4 +32,3 @@ paths: application/json: schema: $ref: ../evm_responses.yaml#/eth_syncing - operationId: eth-syncing-optimism From a4aca7df85530aff4521dd91aea21587cc04b5bc Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:47:19 +0200 Subject: [PATCH 31/47] Refactor notify spec --- notify/notify.yaml | 266 ++++++++++++++++++++++----------------------- 1 file changed, 133 insertions(+), 133 deletions(-) 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: From e5cc4f1c4234526c41c078ada1826772026881f5 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 04:52:08 +0200 Subject: [PATCH 32/47] Remove tags: [] --- ...alchemy_requestGasAndPaymasterAndData.yaml | 1 - .../alchemy_requestPaymasterAndData.yaml | 1 - .../eth_estimateUserOperationGas.yaml | 1 - .../eth_getUserOperationByHash.yaml | 1 - .../eth_getUserOperationReceipt.yaml | 1 - .../eth_sendUserOperation.yaml | 1 - .../eth_supportedEntryPoints.yaml | 1 - .../rundler_maxPriorityFeePerGas.yaml | 1 - ...eth_getTransactionByBlockHashAndIndex.yaml | 1 - ...h_getTransactionByBlockNumberAndIndex.yaml | 1 - arbitrum/eth_getTransactionReceipt.yaml | 1 - arbitrum/eth_maxPriorityFeePerGas.yaml | 1 - astar/eth_maxPriorityFeePerGas.yaml | 1 - base/eth_feeHistory.yaml | 1 - base/eth_maxPriorityFeePerGas.yaml | 1 - base/eth_syncing.yaml | 1 - debug/debug_traceBlockByHash.yaml | 1 - debug/debug_traceBlockByNumber.yaml | 1 - debug/debug_traceCall.yaml | 1 - debug/debug_traceTransaction.yaml | 1 - ethereum/eth_getBlockReceipts.yaml | 1 - ethereum/eth_maxPriorityFeePerGas.yaml | 1 - optimism/eth_feeHistory.yaml | 1 - optimism/eth_maxPriorityFeePerGas.yaml | 1 - optimism/eth_syncing.yaml | 1 - polygon-pos/bor_getAuthor.yaml | 1 - polygon-pos/bor_getCurrentProposer.yaml | 1 - polygon-pos/bor_getCurrentValidators.yaml | 1 - polygon-pos/bor_getRootHash.yaml | 1 - polygon-pos/bor_getSignersAtHash.yaml | 1 - polygon-pos/eth_feeHistory.yaml | 1 - polygon-pos/eth_getRootHash.yaml | 1 - polygon-pos/eth_getSignersAtHash.yaml | 1 - .../eth_getTransactionReceiptsByBlock.yaml | 1 - polygon-pos/eth_sendRawTransaction.yaml | 1 - polygon-zkevm/eth_estimateGas.yaml | 1 - polygon-zkevm/eth_getBalance.yaml | 73 ++++++++--------- polygon-zkevm/eth_getCode.yaml | 1 - polygon-zkevm/eth_getCompilers.yaml | 79 +++++++++---------- polygon-zkevm/eth_getStorageAt.yaml | 1 - ...h_getTransactionByBlockNumberAndIndex.yaml | 1 - polygon-zkevm/eth_getTransactionReceipt.yaml | 1 - .../eth_getUncleByBlockHashAndIndex.yaml | 1 - .../eth_getUncleByBlockNumberAndIndex.yaml | 1 - .../eth_getUncleCountByBlockHash.yaml | 1 - .../eth_getUncleCountByBlockNumber.yaml | 1 - polygon-zkevm/eth_protocolVersion.yaml | 1 - polygon-zkevm/eth_sendRawTransaction.yaml | 1 - solana/getAccountInfo.yaml | 1 - solana/getBalance.yaml | 1 - solana/getBlock.yaml | 1 - solana/getBlockCommitment.yaml | 1 - solana/getBlockHeight.yaml | 1 - solana/getBlockProduction.yaml | 1 - solana/getBlockTime.yaml | 1 - solana/getBlocks.yaml | 1 - solana/getBlocksWithLimit.yaml | 1 - solana/getClusterNodes.yaml | 1 - solana/getEpochInfo.yaml | 1 - solana/getEpochSchedule.yaml | 1 - solana/getFeeForMessage.yaml | 1 - solana/getFirstAvailableBlock.yaml | 1 - solana/getGenesisHash.yaml | 1 - solana/getHealth.yaml | 1 - solana/getHighestSnapshotSlot.yaml | 1 - solana/getIdentity.yaml | 1 - solana/getInflationGovernor.yaml | 1 - solana/getInflationRate.yaml | 1 - solana/getInflationReward.yaml | 1 - solana/getLargestAccounts.yaml | 1 - solana/getMaxRetransmitSlot.yaml | 1 - solana/getMaxShredInsertSlot.yaml | 1 - solana/getMinimumBalanceForRentExemption.yaml | 1 - solana/getMultipleAccounts.yaml | 1 - solana/getProgramAccounts.yaml | 1 - solana/getRecentPerformanceSamples.yaml | 1 - solana/getSignatureStatuses.yaml | 1 - solana/getSignaturesForAddress.yaml | 1 - solana/getSlot.yaml | 1 - solana/getSlotLeader.yaml | 1 - solana/getSlotLeaders.yaml | 1 - solana/getSupply.yaml | 1 - solana/getTokenAccountBalance.yaml | 1 - solana/getTokenAccountsByOwner.yaml | 1 - solana/getTokenSupply.yaml | 1 - solana/getTransaction.yaml | 1 - solana/getVersion.yaml | 1 - solana/getVoteAccounts.yaml | 1 - solana/isBlockhashValid.yaml | 1 - solana/minimumLedgerSlot.yaml | 1 - solana/requestAirdrop.yaml | 1 - solana/sendTransaction.yaml | 1 - solana/simulateTransaction.yaml | 1 - token/alchemy_getTokenAllowance.yaml | 1 - token/alchemy_getTokenBalances.yaml | 1 - token/alchemy_getTokenMetadata.yaml | 1 - trace/trace_block.yaml | 1 - trace/trace_call.yaml | 1 - trace/trace_filter.yaml | 1 - trace/trace_get.yaml | 1 - trace/trace_rawTransaction.yaml | 1 - trace/trace_replayBlockTransactions.yaml | 1 - trace/trace_replayTransaction.yaml | 1 - trace/trace_transaction.yaml | 1 - 104 files changed, 71 insertions(+), 183 deletions(-) diff --git a/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml b/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml index 1f17ec31..dc97982e 100644 --- a/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml +++ b/account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml @@ -22,7 +22,6 @@ servers: paths: /{apiKey}: 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 diff --git a/account-abstraction/alchemy_requestPaymasterAndData.yaml b/account-abstraction/alchemy_requestPaymasterAndData.yaml index 05863cc9..93cd232d 100644 --- a/account-abstraction/alchemy_requestPaymasterAndData.yaml +++ b/account-abstraction/alchemy_requestPaymasterAndData.yaml @@ -22,7 +22,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: alchemy_requestPaymasterAndData description: Requests coverage for a `UserOperation`. Returns `paymasterAndData` if approved, errors if not. operationId: alchemy-requestPaymasterAndData diff --git a/account-abstraction/eth_estimateUserOperationGas.yaml b/account-abstraction/eth_estimateUserOperationGas.yaml index 79f41d57..73ee3b57 100644 --- a/account-abstraction/eth_estimateUserOperationGas.yaml +++ b/account-abstraction/eth_estimateUserOperationGas.yaml @@ -22,7 +22,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_estimateUserOperationGas description: Estimates the gas values for a `UserOperation`. operationId: eth-estimateUserOperationGas diff --git a/account-abstraction/eth_getUserOperationByHash.yaml b/account-abstraction/eth_getUserOperationByHash.yaml index 4e273f58..4ec8218c 100644 --- a/account-abstraction/eth_getUserOperationByHash.yaml +++ b/account-abstraction/eth_getUserOperationByHash.yaml @@ -22,7 +22,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getUserOperationByHash description: Return a `UserOperation` based on a hash (`userOpHash`). operationId: eth-getUserOperationByHash diff --git a/account-abstraction/eth_getUserOperationReceipt.yaml b/account-abstraction/eth_getUserOperationReceipt.yaml index 462274a8..c4de8fc4 100644 --- a/account-abstraction/eth_getUserOperationReceipt.yaml +++ b/account-abstraction/eth_getUserOperationReceipt.yaml @@ -22,7 +22,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getUserOperationReceipt description: Get the `UserOperationReceipt` based on the `userOpHash` value. operationId: eth-getUserOperationReceipt diff --git a/account-abstraction/eth_sendUserOperation.yaml b/account-abstraction/eth_sendUserOperation.yaml index 0caa1fdc..071e39cd 100644 --- a/account-abstraction/eth_sendUserOperation.yaml +++ b/account-abstraction/eth_sendUserOperation.yaml @@ -22,7 +22,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_sendUserOperation description: Sends a user operation to the given EVM network. operationId: eth-sendUserOperation diff --git a/account-abstraction/eth_supportedEntryPoints.yaml b/account-abstraction/eth_supportedEntryPoints.yaml index 925fd417..57280921 100644 --- a/account-abstraction/eth_supportedEntryPoints.yaml +++ b/account-abstraction/eth_supportedEntryPoints.yaml @@ -22,7 +22,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_supportedEntryPoints description: Returns an array of the `entryPoint` addresses supported by the client. operationId: eth-supportedEntryPoints diff --git a/account-abstraction/rundler_maxPriorityFeePerGas.yaml b/account-abstraction/rundler_maxPriorityFeePerGas.yaml index 1780830f..47f05fe0 100644 --- a/account-abstraction/rundler_maxPriorityFeePerGas.yaml +++ b/account-abstraction/rundler_maxPriorityFeePerGas.yaml @@ -22,7 +22,6 @@ 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.' operationId: rundler-maxPriorityFeePerGas diff --git a/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml b/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml index d341f0f6..ebc23d43 100644 --- a/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml +++ b/arbitrum/eth_getTransactionByBlockHashAndIndex.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml b/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml index 65e004bf..c03b67a2 100644 --- a/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/arbitrum/eth_getTransactionByBlockNumberAndIndex.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getTransactionByBlockNumberAndIndex - Arbitrum description: Returns information about a transaction by block number and transaction index position. operationId: eth-getTransactionByBlockNumberAndIndex-arbitrum diff --git a/arbitrum/eth_getTransactionReceipt.yaml b/arbitrum/eth_getTransactionReceipt.yaml index c07b5f20..7673ad7c 100644 --- a/arbitrum/eth_getTransactionReceipt.yaml +++ b/arbitrum/eth_getTransactionReceipt.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getTransactionReceipt - Arbitrum description: Returns the receipt of a transaction by transaction hash. operationId: eth-getTransactionReceipt-arbitrum diff --git a/arbitrum/eth_maxPriorityFeePerGas.yaml b/arbitrum/eth_maxPriorityFeePerGas.yaml index 60fa8d9a..21c58c59 100644 --- a/arbitrum/eth_maxPriorityFeePerGas.yaml +++ b/arbitrum/eth_maxPriorityFeePerGas.yaml @@ -13,7 +13,6 @@ 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." operationId: eth-maxpriorityfeepergas-arbitrum diff --git a/astar/eth_maxPriorityFeePerGas.yaml b/astar/eth_maxPriorityFeePerGas.yaml index 6e836a2f..12e0993e 100644 --- a/astar/eth_maxPriorityFeePerGas.yaml +++ b/astar/eth_maxPriorityFeePerGas.yaml @@ -7,7 +7,6 @@ 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." operationId: eth-maxPriorityFeePerGas-astar diff --git a/base/eth_feeHistory.yaml b/base/eth_feeHistory.yaml index cb118077..92c91f6e 100644 --- a/base/eth_feeHistory.yaml +++ b/base/eth_feeHistory.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_feeHistory - Base description: Returns a collection of historical gas information. operationId: eth-feeHistory-base diff --git a/base/eth_maxPriorityFeePerGas.yaml b/base/eth_maxPriorityFeePerGas.yaml index 93b8a487..c9a4ea60 100644 --- a/base/eth_maxPriorityFeePerGas.yaml +++ b/base/eth_maxPriorityFeePerGas.yaml @@ -13,7 +13,6 @@ 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." operationId: eth-maxpriorityfeepergas-base diff --git a/base/eth_syncing.yaml b/base/eth_syncing.yaml index 8774f777..ed688203 100644 --- a/base/eth_syncing.yaml +++ b/base/eth_syncing.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_syncing - Base description: Returns a list of addresses owned by client. operationId: eth-syncing-base diff --git a/debug/debug_traceBlockByHash.yaml b/debug/debug_traceBlockByHash.yaml index 4ae2d7fe..2b379c75 100644 --- a/debug/debug_traceBlockByHash.yaml +++ b/debug/debug_traceBlockByHash.yaml @@ -19,7 +19,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: debug_traceBlockByHash description: Replays the block that is already present in the database. operationId: debug-traceblockbyhash diff --git a/debug/debug_traceBlockByNumber.yaml b/debug/debug_traceBlockByNumber.yaml index 53a5256e..2f04f622 100644 --- a/debug/debug_traceBlockByNumber.yaml +++ b/debug/debug_traceBlockByNumber.yaml @@ -19,7 +19,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: debug_traceBlockByNumber description: Replays the block that is already present in the database. operationId: debug-traceblockbynumber diff --git a/debug/debug_traceCall.yaml b/debug/debug_traceCall.yaml index ca1f0d94..cfb7366f 100644 --- a/debug/debug_traceCall.yaml +++ b/debug/debug_traceCall.yaml @@ -19,7 +19,6 @@ 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. operationId: debug-tracecall diff --git a/debug/debug_traceTransaction.yaml b/debug/debug_traceTransaction.yaml index 3a6ca102..2bfdf755 100644 --- a/debug/debug_traceTransaction.yaml +++ b/debug/debug_traceTransaction.yaml @@ -19,7 +19,6 @@ 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. operationId: debug-tracetransaction diff --git a/ethereum/eth_getBlockReceipts.yaml b/ethereum/eth_getBlockReceipts.yaml index d1cf470e..012c0dea 100644 --- a/ethereum/eth_getBlockReceipts.yaml +++ b/ethereum/eth_getBlockReceipts.yaml @@ -16,7 +16,6 @@ paths: post: summary: eth_getBlockReceipts - Ethereum description: Get all transaction receipts for a given block on Ethereum. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_maxPriorityFeePerGas.yaml b/ethereum/eth_maxPriorityFeePerGas.yaml index 05eb2722..04a521d6 100644 --- a/ethereum/eth_maxPriorityFeePerGas.yaml +++ b/ethereum/eth_maxPriorityFeePerGas.yaml @@ -16,7 +16,6 @@ paths: post: summary: eth_maxPriorityFeePerGas - Ethereum 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/optimism/eth_feeHistory.yaml b/optimism/eth_feeHistory.yaml index 635040d5..048a7ae7 100644 --- a/optimism/eth_feeHistory.yaml +++ b/optimism/eth_feeHistory.yaml @@ -7,7 +7,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_feeHistory - Optimism description: Returns a collection of historical gas information. operationId: eth-feeHistory diff --git a/optimism/eth_maxPriorityFeePerGas.yaml b/optimism/eth_maxPriorityFeePerGas.yaml index 0d11c954..3033981a 100644 --- a/optimism/eth_maxPriorityFeePerGas.yaml +++ b/optimism/eth_maxPriorityFeePerGas.yaml @@ -13,7 +13,6 @@ 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." parameters: diff --git a/optimism/eth_syncing.yaml b/optimism/eth_syncing.yaml index 6ca5ccc7..3c595aeb 100644 --- a/optimism/eth_syncing.yaml +++ b/optimism/eth_syncing.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_syncing - Optimism description: Returns a list of addresses owned by client. operationId: eth-syncing-optimism diff --git a/polygon-pos/bor_getAuthor.yaml b/polygon-pos/bor_getAuthor.yaml index 9a7d7936..f0a88911 100644 --- a/polygon-pos/bor_getAuthor.yaml +++ b/polygon-pos/bor_getAuthor.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: bor_getAuthor - Polygon PoS description: 'Returns address of Author on Polygon.' operationId: bor-getauthor-polygon diff --git a/polygon-pos/bor_getCurrentProposer.yaml b/polygon-pos/bor_getCurrentProposer.yaml index 39f7ae12..03591fc6 100644 --- a/polygon-pos/bor_getCurrentProposer.yaml +++ b/polygon-pos/bor_getCurrentProposer.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: bor_getCurrentProposer - Polygon PoS description: "Returns current proposer's address on Polygon." operationId: bor-getcurrentproposer-polygon diff --git a/polygon-pos/bor_getCurrentValidators.yaml b/polygon-pos/bor_getCurrentValidators.yaml index e8a33e1c..add91130 100644 --- a/polygon-pos/bor_getCurrentValidators.yaml +++ b/polygon-pos/bor_getCurrentValidators.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: bor_getCurrentValidators - Polygon PoS description: 'Returns current validators for Polygon.' operationId: bor-getCurrentValidators-polygon diff --git a/polygon-pos/bor_getRootHash.yaml b/polygon-pos/bor_getRootHash.yaml index 2a52e25b..690fdd6e 100644 --- a/polygon-pos/bor_getRootHash.yaml +++ b/polygon-pos/bor_getRootHash.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: bor_getRootHash - Polygon PoS description: 'Polygon API - Returns the root hash given a block range.' operationId: bor-getRootHash-polygon diff --git a/polygon-pos/bor_getSignersAtHash.yaml b/polygon-pos/bor_getSignersAtHash.yaml index 095aa5b5..4dc1c393 100644 --- a/polygon-pos/bor_getSignersAtHash.yaml +++ b/polygon-pos/bor_getSignersAtHash.yaml @@ -13,7 +13,6 @@ 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.' operationId: bor-getSignersAtHash-polygon diff --git a/polygon-pos/eth_feeHistory.yaml b/polygon-pos/eth_feeHistory.yaml index 7458be74..5312f052 100644 --- a/polygon-pos/eth_feeHistory.yaml +++ b/polygon-pos/eth_feeHistory.yaml @@ -7,7 +7,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_feeHistory - Polygon PoS description: Returns a collection of historical gas information. operationId: eth-feeHistory diff --git a/polygon-pos/eth_getRootHash.yaml b/polygon-pos/eth_getRootHash.yaml index 0dde51ed..b5a743a9 100644 --- a/polygon-pos/eth_getRootHash.yaml +++ b/polygon-pos/eth_getRootHash.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getRootHash - Polygon PoS description: 'Returns the root hash given a block range on Polygon.' parameters: diff --git a/polygon-pos/eth_getSignersAtHash.yaml b/polygon-pos/eth_getSignersAtHash.yaml index d81fe0ec..2057a8ef 100644 --- a/polygon-pos/eth_getSignersAtHash.yaml +++ b/polygon-pos/eth_getSignersAtHash.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getSignersAtHash - Polygon PoS description: 'Polygon API - Returns all signs given a blockhash.' parameters: diff --git a/polygon-pos/eth_getTransactionReceiptsByBlock.yaml b/polygon-pos/eth_getTransactionReceiptsByBlock.yaml index ceff2a7a..5fcbddbf 100644 --- a/polygon-pos/eth_getTransactionReceiptsByBlock.yaml +++ b/polygon-pos/eth_getTransactionReceiptsByBlock.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getTransactionReceiptsByBlock - Polygon PoS description: 'Polygon API - Returns all transaction receipts for the given block number or hash.' parameters: diff --git a/polygon-pos/eth_sendRawTransaction.yaml b/polygon-pos/eth_sendRawTransaction.yaml index bb6e3d1c..b2068493 100644 --- a/polygon-pos/eth_sendRawTransaction.yaml +++ b/polygon-pos/eth_sendRawTransaction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_sendRawTransaction - Polygon PoS description: | Creates a new message call transaction or a contract creation for signed transactions. diff --git a/polygon-zkevm/eth_estimateGas.yaml b/polygon-zkevm/eth_estimateGas.yaml index 609e4df1..6aff1617 100644 --- a/polygon-zkevm/eth_estimateGas.yaml +++ b/polygon-zkevm/eth_estimateGas.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/polygon-zkevm/eth_getBalance.yaml b/polygon-zkevm/eth_getBalance.yaml index b497a467..cd99c244 100644 --- a/polygon-zkevm/eth_getBalance.yaml +++ b/polygon-zkevm/eth_getBalance.yaml @@ -12,47 +12,42 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - tags: [] - summary: eth_getBalance - Polygon zkEVM - description: Returns the balance of the account of a given address on Polygon zkEVM. - operationId: eth-getBalance-polygon-zkevm - parameters: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: + post: + summary: eth_getBalance - Polygon zkEVM + description: Returns the balance of the account of a given address on Polygon zkEVM. + operationId: eth-getBalance-polygon-zkevm + parameters: + - $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_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 - - 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.getBalance("0xbed9dA8f130aCC29F2580df183F3995eff78fb4D", "latest").then(console.log); + alchemy.core.getBalance("0xbed9dA8f130aCC29F2580df183F3995eff78fb4D", "latest").then(console.log); diff --git a/polygon-zkevm/eth_getCode.yaml b/polygon-zkevm/eth_getCode.yaml index 1843b4fd..a3de4361 100644 --- a/polygon-zkevm/eth_getCode.yaml +++ b/polygon-zkevm/eth_getCode.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getCode - Polygon zkEVM description: Returns code at a given address on the Polygon zkEVM network. operationId: eth-getCode-polygon-zkevm diff --git a/polygon-zkevm/eth_getCompilers.yaml b/polygon-zkevm/eth_getCompilers.yaml index f79f9d0a..bcba5ba2 100644 --- a/polygon-zkevm/eth_getCompilers.yaml +++ b/polygon-zkevm/eth_getCompilers.yaml @@ -12,54 +12,49 @@ servers: default: polygonzkevm-testnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -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. - operationId: eth-getCompilers-polygon-zkevm - parameters: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Accepts nothing. + post: + summary: eth_getCompilers - Polygon zkEVM + description: Returns a list of installed compilers (Deprecated). Response is always empty in Polygon zkEVM. + operationId: eth-getCompilers-polygon-zkevm + parameters: + - $ref: ../components/parameters.yaml#/ApiKey + requestBody: + description: Accepts nothing. + content: + application/json: + schema: + type: object + properties: + id: + $ref: ../components/schemas.yaml#/Id + jsonrpc: + $ref: ../components/schemas.yaml#/JsonRpc + method: + $ref: ../components/schemas.yaml#/Method + default: eth_getCompilers + 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 - method: - $ref: ../components/schemas.yaml#/Method - default: eth_getCompilers - 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: [] - x-readme: - samples-languages: - - curl - - javascript - - python + result: + type: array + items: + type: string + example: [] + x-readme: + samples-languages: + - curl + - javascript + - python diff --git a/polygon-zkevm/eth_getStorageAt.yaml b/polygon-zkevm/eth_getStorageAt.yaml index cbce8b80..a973d519 100644 --- a/polygon-zkevm/eth_getStorageAt.yaml +++ b/polygon-zkevm/eth_getStorageAt.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml b/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml index a76ec8c2..a8f35760 100644 --- a/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/polygon-zkevm/eth_getTransactionByBlockNumberAndIndex.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/polygon-zkevm/eth_getTransactionReceipt.yaml b/polygon-zkevm/eth_getTransactionReceipt.yaml index d9636dd3..c78af22d 100644 --- a/polygon-zkevm/eth_getTransactionReceipt.yaml +++ b/polygon-zkevm/eth_getTransactionReceipt.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: eth_getTransactionReceipt - Polygon zkEVM description: Returns the receipt of a transaction by transaction hash on Polygon zkEVM. operationId: eth-getTransactionReceipt-zkevm diff --git a/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml b/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml index 090d3a59..ca467fab 100644 --- a/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml +++ b/polygon-zkevm/eth_getUncleByBlockHashAndIndex.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml b/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml index 8e1ac8d3..7fee1448 100644 --- a/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml +++ b/polygon-zkevm/eth_getUncleByBlockNumberAndIndex.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/polygon-zkevm/eth_getUncleCountByBlockHash.yaml b/polygon-zkevm/eth_getUncleCountByBlockHash.yaml index b9812dad..2d6138b6 100644 --- a/polygon-zkevm/eth_getUncleCountByBlockHash.yaml +++ b/polygon-zkevm/eth_getUncleCountByBlockHash.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml b/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml index 80ec464d..f49f196c 100644 --- a/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml +++ b/polygon-zkevm/eth_getUncleCountByBlockNumber.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/polygon-zkevm/eth_protocolVersion.yaml b/polygon-zkevm/eth_protocolVersion.yaml index 1524ab83..8c8876e7 100644 --- a/polygon-zkevm/eth_protocolVersion.yaml +++ b/polygon-zkevm/eth_protocolVersion.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/polygon-zkevm/eth_sendRawTransaction.yaml b/polygon-zkevm/eth_sendRawTransaction.yaml index adfd9ff5..e2e27e58 100644 --- a/polygon-zkevm/eth_sendRawTransaction.yaml +++ b/polygon-zkevm/eth_sendRawTransaction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: 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 diff --git a/solana/getAccountInfo.yaml b/solana/getAccountInfo.yaml index d3220ee5..3a1193a7 100644 --- a/solana/getAccountInfo.yaml +++ b/solana/getAccountInfo.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getAccountInfo description: Returns all information associated with the account of provided Pubkey. operationId: getAccountInfo diff --git a/solana/getBalance.yaml b/solana/getBalance.yaml index f4042da9..d0de08d1 100644 --- a/solana/getBalance.yaml +++ b/solana/getBalance.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getBalance description: Returns the balance of the account of provided Pubkey. operationId: getBalance diff --git a/solana/getBlock.yaml b/solana/getBlock.yaml index 221042f7..7ecfd635 100644 --- a/solana/getBlock.yaml +++ b/solana/getBlock.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getBlock description: Returns identity and transaction information about a confirmed block in the ledger. operationId: getBlock diff --git a/solana/getBlockCommitment.yaml b/solana/getBlockCommitment.yaml index 57c145f4..d9e61815 100644 --- a/solana/getBlockCommitment.yaml +++ b/solana/getBlockCommitment.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getBlockCommitment description: Returns commitment for particular block. operationId: getBlockCommitment diff --git a/solana/getBlockHeight.yaml b/solana/getBlockHeight.yaml index 8fd0852a..598f3cf8 100644 --- a/solana/getBlockHeight.yaml +++ b/solana/getBlockHeight.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getBlockHeight description: Returns the current block height of the node. operationId: getBlockHeight diff --git a/solana/getBlockProduction.yaml b/solana/getBlockProduction.yaml index e8633992..c59d971e 100644 --- a/solana/getBlockProduction.yaml +++ b/solana/getBlockProduction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getBlockProduction description: Returns recent block production information from the current or previous epoch. operationId: getBlockProduction diff --git a/solana/getBlockTime.yaml b/solana/getBlockTime.yaml index 9c0fa381..96ca3df4 100644 --- a/solana/getBlockTime.yaml +++ b/solana/getBlockTime.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getBlockTime description: Returns the estimated production time of a block. operationId: getBlockTime diff --git a/solana/getBlocks.yaml b/solana/getBlocks.yaml index f0a22d81..75948be7 100644 --- a/solana/getBlocks.yaml +++ b/solana/getBlocks.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getBlocks description: Returns a list of confirmed blocks between two slots. operationId: getBlocks diff --git a/solana/getBlocksWithLimit.yaml b/solana/getBlocksWithLimit.yaml index 5e1970c3..b3a9033a 100644 --- a/solana/getBlocksWithLimit.yaml +++ b/solana/getBlocksWithLimit.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getBlocksWithLimit description: Returns a list of confirmed blocks starting at the given slot. operationId: getBlocksWithLimit diff --git a/solana/getClusterNodes.yaml b/solana/getClusterNodes.yaml index 8d561e38..f352b313 100644 --- a/solana/getClusterNodes.yaml +++ b/solana/getClusterNodes.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getClusterNodes description: Returns information about all the nodes participating in the cluster. operationId: getClusterNodes diff --git a/solana/getEpochInfo.yaml b/solana/getEpochInfo.yaml index 85815d52..49cc2408 100644 --- a/solana/getEpochInfo.yaml +++ b/solana/getEpochInfo.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getEpochInfo description: Returns information about the current epoch. operationId: getEpochInfo diff --git a/solana/getEpochSchedule.yaml b/solana/getEpochSchedule.yaml index c8c3f4c4..2369e23e 100644 --- a/solana/getEpochSchedule.yaml +++ b/solana/getEpochSchedule.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getEpochSchedule description: Returns epoch schedule information from this cluster's genesis config. operationId: getEpochSchedule diff --git a/solana/getFeeForMessage.yaml b/solana/getFeeForMessage.yaml index 96127e43..25153ae5 100644 --- a/solana/getFeeForMessage.yaml +++ b/solana/getFeeForMessage.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getFeeForMessage description: Get the fee the network will charge for a particular message. operationId: getFeeForMessage diff --git a/solana/getFirstAvailableBlock.yaml b/solana/getFirstAvailableBlock.yaml index 6cc4369a..b79b52b6 100644 --- a/solana/getFirstAvailableBlock.yaml +++ b/solana/getFirstAvailableBlock.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getFirstAvailableBlock description: Get the fee the network will charge for a particular message. operationId: getFirstAvailableBlock diff --git a/solana/getGenesisHash.yaml b/solana/getGenesisHash.yaml index 9429f2b0..07aa2590 100644 --- a/solana/getGenesisHash.yaml +++ b/solana/getGenesisHash.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getGenesisHash description: Returns the genesis hash. operationId: getGenesisHash diff --git a/solana/getHealth.yaml b/solana/getHealth.yaml index bd8165a3..e140a8b6 100644 --- a/solana/getHealth.yaml +++ b/solana/getHealth.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getHealth description: Returns the current health of the node. operationId: getHealth diff --git a/solana/getHighestSnapshotSlot.yaml b/solana/getHighestSnapshotSlot.yaml index 86d1f034..afcdf55a 100644 --- a/solana/getHighestSnapshotSlot.yaml +++ b/solana/getHighestSnapshotSlot.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getHighestSnapshotSlot description: Returns the highest slot information that the node has snapshots for. operationId: getHighestSnapshotSlot diff --git a/solana/getIdentity.yaml b/solana/getIdentity.yaml index 798fb682..bfb60e06 100644 --- a/solana/getIdentity.yaml +++ b/solana/getIdentity.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getIdentity description: Returns the identity pubkey for the current node. operationId: getIdentity diff --git a/solana/getInflationGovernor.yaml b/solana/getInflationGovernor.yaml index f1a363fb..2e558318 100644 --- a/solana/getInflationGovernor.yaml +++ b/solana/getInflationGovernor.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getInflationGovernor description: Returns the current inflation governor. operationId: getInflationGovernor diff --git a/solana/getInflationRate.yaml b/solana/getInflationRate.yaml index 3e07f74c..fefd4611 100644 --- a/solana/getInflationRate.yaml +++ b/solana/getInflationRate.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getInflationRate description: Returns the specific inflation values for the current epoch. operationId: getInflationRate diff --git a/solana/getInflationReward.yaml b/solana/getInflationReward.yaml index 78987d2b..7c4c85d9 100644 --- a/solana/getInflationReward.yaml +++ b/solana/getInflationReward.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getInflationReward description: Returns the inflation / staking reward for a list of addresses for an epoch. operationId: getInflationReward diff --git a/solana/getLargestAccounts.yaml b/solana/getLargestAccounts.yaml index 60490994..b0762db7 100644 --- a/solana/getLargestAccounts.yaml +++ b/solana/getLargestAccounts.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getLargestAccounts description: Returns the 20 largest accounts, by lamport balance (results may be cached up to two hours). operationId: getLargestAccounts diff --git a/solana/getMaxRetransmitSlot.yaml b/solana/getMaxRetransmitSlot.yaml index 0a75f4e2..27e7193c 100644 --- a/solana/getMaxRetransmitSlot.yaml +++ b/solana/getMaxRetransmitSlot.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getMaxRetransmitSlot description: Get the max slot seen from retransmit stage. operationId: getMaxRetransmitSlot diff --git a/solana/getMaxShredInsertSlot.yaml b/solana/getMaxShredInsertSlot.yaml index 6cad4285..bf68fda0 100644 --- a/solana/getMaxShredInsertSlot.yaml +++ b/solana/getMaxShredInsertSlot.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getMaxShredInsertSlot description: Get the max slot seen from after shred insert.. operationId: getMaxShredInsertSlot diff --git a/solana/getMinimumBalanceForRentExemption.yaml b/solana/getMinimumBalanceForRentExemption.yaml index 7e271c7c..92e07289 100644 --- a/solana/getMinimumBalanceForRentExemption.yaml +++ b/solana/getMinimumBalanceForRentExemption.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getMinimumBalanceForRentExemption description: Returns minimum balance required to make account rent exempt. operationId: getMinimumBalanceForRentExemption diff --git a/solana/getMultipleAccounts.yaml b/solana/getMultipleAccounts.yaml index c8c63d3f..bba58078 100644 --- a/solana/getMultipleAccounts.yaml +++ b/solana/getMultipleAccounts.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getMultipleAccounts description: Returns the account information for a list of Pubkeys. operationId: getMultipleAccounts diff --git a/solana/getProgramAccounts.yaml b/solana/getProgramAccounts.yaml index 606cd97c..b5db482c 100644 --- a/solana/getProgramAccounts.yaml +++ b/solana/getProgramAccounts.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getProgramAccounts description: Returns all accounts owned by the provided program Pubkey. operationId: getProgramAccounts diff --git a/solana/getRecentPerformanceSamples.yaml b/solana/getRecentPerformanceSamples.yaml index 73f10b4e..d26b3eb7 100644 --- a/solana/getRecentPerformanceSamples.yaml +++ b/solana/getRecentPerformanceSamples.yaml @@ -13,7 +13,6 @@ 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. operationId: getRecentPerformanceSamples diff --git a/solana/getSignatureStatuses.yaml b/solana/getSignatureStatuses.yaml index 9c1ec6ad..971a3d0c 100644 --- a/solana/getSignatureStatuses.yaml +++ b/solana/getSignatureStatuses.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getSignatureStatuses description: Returns the statuses of a list of signatures. operationId: getSignatureStatuses diff --git a/solana/getSignaturesForAddress.yaml b/solana/getSignaturesForAddress.yaml index 227e97c5..8128a7e2 100644 --- a/solana/getSignaturesForAddress.yaml +++ b/solana/getSignaturesForAddress.yaml @@ -13,7 +13,6 @@ 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. operationId: getSignaturesForAddress diff --git a/solana/getSlot.yaml b/solana/getSlot.yaml index 7474d162..8984b611 100644 --- a/solana/getSlot.yaml +++ b/solana/getSlot.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getSlot description: Returns the slot that has reached the given or default commitment level. operationId: getSlot diff --git a/solana/getSlotLeader.yaml b/solana/getSlotLeader.yaml index 823712cb..73839dd4 100644 --- a/solana/getSlotLeader.yaml +++ b/solana/getSlotLeader.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getSlotLeader description: Returns the current slot leader. operationId: getSlotLeader diff --git a/solana/getSlotLeaders.yaml b/solana/getSlotLeaders.yaml index 43404b2b..3ec14d1b 100644 --- a/solana/getSlotLeaders.yaml +++ b/solana/getSlotLeaders.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getSlotLeaders description: Returns the slot leaders for a given slot range. operationId: getSlotLeaders diff --git a/solana/getSupply.yaml b/solana/getSupply.yaml index 588ec41e..cee2773a 100644 --- a/solana/getSupply.yaml +++ b/solana/getSupply.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getSupply description: Returns information about the current supply. operationId: getSupply diff --git a/solana/getTokenAccountBalance.yaml b/solana/getTokenAccountBalance.yaml index ab7bf298..fc7b2e17 100644 --- a/solana/getTokenAccountBalance.yaml +++ b/solana/getTokenAccountBalance.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getTokenAccountBalance description: Returns the token balance of an SPL Token account.. operationId: getTokenAccountBalance diff --git a/solana/getTokenAccountsByOwner.yaml b/solana/getTokenAccountsByOwner.yaml index eb482877..b615de46 100644 --- a/solana/getTokenAccountsByOwner.yaml +++ b/solana/getTokenAccountsByOwner.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getTokenAccountsByOwner description: Returns all SPL Token accounts by token owner. operationId: getTokenAccountsByOwner diff --git a/solana/getTokenSupply.yaml b/solana/getTokenSupply.yaml index f320de32..447d0fff 100644 --- a/solana/getTokenSupply.yaml +++ b/solana/getTokenSupply.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getTokenSupply description: Returns the total supply of an SPL Token type. operationId: getTokenSupply diff --git a/solana/getTransaction.yaml b/solana/getTransaction.yaml index c5f8624d..9ea2db2a 100644 --- a/solana/getTransaction.yaml +++ b/solana/getTransaction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getTransaction description: Returns transaction details for a confirmed transaction. operationId: getTransaction diff --git a/solana/getVersion.yaml b/solana/getVersion.yaml index 6dc56d31..cf072036 100644 --- a/solana/getVersion.yaml +++ b/solana/getVersion.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getVersion description: Returns the current solana versions running on the node. operationId: getVersion diff --git a/solana/getVoteAccounts.yaml b/solana/getVoteAccounts.yaml index 0b70fd31..a2b9b0f9 100644 --- a/solana/getVoteAccounts.yaml +++ b/solana/getVoteAccounts.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: getVoteAccounts description: Returns the account info and associated stake for all the voting accounts in the current bank. operationId: getVoteAccounts diff --git a/solana/isBlockhashValid.yaml b/solana/isBlockhashValid.yaml index 121af008..60a4b617 100644 --- a/solana/isBlockhashValid.yaml +++ b/solana/isBlockhashValid.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: isBlockhashValid description: Returns whether a blockhash is still valid or not. operationId: isBlockhashValid diff --git a/solana/minimumLedgerSlot.yaml b/solana/minimumLedgerSlot.yaml index cbc72883..bfa57796 100644 --- a/solana/minimumLedgerSlot.yaml +++ b/solana/minimumLedgerSlot.yaml @@ -13,7 +13,6 @@ 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. operationId: minimumLedgerSlot diff --git a/solana/requestAirdrop.yaml b/solana/requestAirdrop.yaml index 376bb126..30d39d7d 100644 --- a/solana/requestAirdrop.yaml +++ b/solana/requestAirdrop.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: requestAirdrop description: Requests an airdrop of lamports to a Pubkey operationId: requestAirdrop diff --git a/solana/sendTransaction.yaml b/solana/sendTransaction.yaml index ead370e5..3b26d4ed 100644 --- a/solana/sendTransaction.yaml +++ b/solana/sendTransaction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: sendTransaction description: Submits a signed transaction to the cluster for processing. operationId: sendTransaction diff --git a/solana/simulateTransaction.yaml b/solana/simulateTransaction.yaml index c4716549..e614cb70 100644 --- a/solana/simulateTransaction.yaml +++ b/solana/simulateTransaction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: simulateTransaction description: Simulate sending a transaction. operationId: simulateTransaction diff --git a/token/alchemy_getTokenAllowance.yaml b/token/alchemy_getTokenAllowance.yaml index 09624387..f019e47d 100644 --- a/token/alchemy_getTokenAllowance.yaml +++ b/token/alchemy_getTokenAllowance.yaml @@ -19,7 +19,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: alchemy_getTokenAllowance description: 'Returns the amount which the spender is allowed to withdraw from the owner.' operationId: alchemy-getTokenAllowance diff --git a/token/alchemy_getTokenBalances.yaml b/token/alchemy_getTokenBalances.yaml index 0d0f91e3..9ee756bd 100644 --- a/token/alchemy_getTokenBalances.yaml +++ b/token/alchemy_getTokenBalances.yaml @@ -21,7 +21,6 @@ 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.' operationId: alchemy-getTokenBalances diff --git a/token/alchemy_getTokenMetadata.yaml b/token/alchemy_getTokenMetadata.yaml index 750b491d..764569bc 100644 --- a/token/alchemy_getTokenMetadata.yaml +++ b/token/alchemy_getTokenMetadata.yaml @@ -21,7 +21,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: alchemy_getTokenMetadata description: 'Returns metadata (name, symbol, decimals, logo) for a given token contract address.' operationId: alchemy-getTokenMetadata diff --git a/trace/trace_block.yaml b/trace/trace_block.yaml index 3b9f12a6..b7ec450f 100644 --- a/trace/trace_block.yaml +++ b/trace/trace_block.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: trace_block description: Returns traces created at given block. operationId: trace-block diff --git a/trace/trace_call.yaml b/trace/trace_call.yaml index 4a52f2b7..567ee3eb 100644 --- a/trace/trace_call.yaml +++ b/trace/trace_call.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: trace_call description: Executes the given call and returns a number of possible traces for it. operationId: trace-call diff --git a/trace/trace_filter.yaml b/trace/trace_filter.yaml index 448f64ae..9005d7b1 100644 --- a/trace/trace_filter.yaml +++ b/trace/trace_filter.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: trace_filter description: Returns traces matching given filter. operationId: trace-filter diff --git a/trace/trace_get.yaml b/trace/trace_get.yaml index 71cf592c..5b73f951 100644 --- a/trace/trace_get.yaml +++ b/trace/trace_get.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: trace_get description: Returns trace at given position. operationId: trace-get diff --git a/trace/trace_rawTransaction.yaml b/trace/trace_rawTransaction.yaml index 09b7deb5..19884789 100644 --- a/trace/trace_rawTransaction.yaml +++ b/trace/trace_rawTransaction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: trace_rawTransaction description: Traces a call to eth_sendRawTransaction without making the call, returning the traces. operationId: trace-rawTransaction diff --git a/trace/trace_replayBlockTransactions.yaml b/trace/trace_replayBlockTransactions.yaml index 32658891..3baef91c 100644 --- a/trace/trace_replayBlockTransactions.yaml +++ b/trace/trace_replayBlockTransactions.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: trace_replayBlockTransactions description: Replays all transactions in a block returning the requested traces for each transaction. operationId: trace-replayBlockTransactions diff --git a/trace/trace_replayTransaction.yaml b/trace/trace_replayTransaction.yaml index 590c8da3..a875a544 100644 --- a/trace/trace_replayTransaction.yaml +++ b/trace/trace_replayTransaction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: trace_replayTransaction description: Traces a call to eth_sendRawTransaction without making the call, returning the traces. operationId: trace-replayTransaction diff --git a/trace/trace_transaction.yaml b/trace/trace_transaction.yaml index bc456466..9f4ce979 100644 --- a/trace/trace_transaction.yaml +++ b/trace/trace_transaction.yaml @@ -13,7 +13,6 @@ servers: paths: /{apiKey}: post: - tags: [] summary: trace_transaction description: Returns all traces of given transaction. operationId: trace-transaction From eb827bfe2f832075e097b73717b92c357a8339b6 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:01:05 +0200 Subject: [PATCH 33/47] Remove tags: [] --- arbitrum/eth_getTransactionByHash.yaml | 1 - ethereum/eth_accounts.yaml | 1 - ethereum/eth_chainId.yaml | 1 - ethereum/eth_estimateGas.yaml | 1 - ethereum/eth_feeHistory.yaml | 1 - ethereum/eth_gasPrice.yaml | 1 - ethereum/eth_getBalance.yaml | 1 - ethereum/eth_getBlockTransactionCountByHash.yaml | 1 - ethereum/eth_getBlockTransactionCountByNumber.yaml | 1 - ethereum/eth_getCode.yaml | 1 - ethereum/eth_getFilterChanges.yaml | 1 - ethereum/eth_getFilterLogs.yaml | 1 - ethereum/eth_getStorageAt.yaml | 1 - ethereum/eth_getTransactionByBlockHashAndIndex.yaml | 1 - ethereum/eth_getTransactionByBlockNumberAndIndex.yaml | 1 - ethereum/eth_getTransactionByHash.yaml | 1 - ethereum/eth_getTransactionCount.yaml | 1 - ethereum/eth_getTransactionReceipt.yaml | 1 - ethereum/eth_getUncleByBlockHashAndIndex.yaml | 1 - ethereum/eth_getUncleByBlockNumberAndIndex.yaml | 1 - ethereum/eth_getUncleCountByBlockHash.yaml | 1 - ethereum/eth_getUncleCountByBlockNumber.yaml | 1 - ethereum/eth_newBlockFilter.yaml | 1 - ethereum/eth_newFilter.yaml | 1 - ethereum/eth_newPendingTransactionFilter.yaml | 1 - ethereum/eth_protocolVersion.yaml | 1 - ethereum/eth_sendRawTransaction.yaml | 1 - ethereum/eth_uninstallFilter.yaml | 1 - ethereum/net_listening.yaml | 1 - ethereum/net_version.yaml | 1 - ethereum/web3_clientVersion.yaml | 1 - ethereum/web3_sha3.yaml | 1 - 32 files changed, 32 deletions(-) diff --git a/arbitrum/eth_getTransactionByHash.yaml b/arbitrum/eth_getTransactionByHash.yaml index d65e23a3..a1913560 100644 --- a/arbitrum/eth_getTransactionByHash.yaml +++ b/arbitrum/eth_getTransactionByHash.yaml @@ -17,7 +17,6 @@ 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.' operationId: eth-getTransactionByHash-arbitrum diff --git a/ethereum/eth_accounts.yaml b/ethereum/eth_accounts.yaml index 13d4ff81..fb9b3c8b 100644 --- a/ethereum/eth_accounts.yaml +++ b/ethereum/eth_accounts.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_accounts - Ethereum description: Returns a list of addresses owned by client. Since Alchemy does not store keys, this will always return empty. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_chainId.yaml b/ethereum/eth_chainId.yaml index 0aafa640..f9bb2c93 100644 --- a/ethereum/eth_chainId.yaml +++ b/ethereum/eth_chainId.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_chainId - Ethereum description: 'Returns the currently configured chain ID, a value used in replay-protected transaction signing as introduced by EIP-155.' - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_estimateGas.yaml b/ethereum/eth_estimateGas.yaml index 18774558..c78e31e8 100644 --- a/ethereum/eth_estimateGas.yaml +++ b/ethereum/eth_estimateGas.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_estimateGas - Ethereum 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_feeHistory.yaml b/ethereum/eth_feeHistory.yaml index 9b6e393b..837b5daa 100644 --- a/ethereum/eth_feeHistory.yaml +++ b/ethereum/eth_feeHistory.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_feeHistory - Ethereum description: Returns a collection of historical gas information. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_gasPrice.yaml b/ethereum/eth_gasPrice.yaml index eded3bba..ecd13e83 100644 --- a/ethereum/eth_gasPrice.yaml +++ b/ethereum/eth_gasPrice.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_gasPrice - Ethereum description: Returns the current price per gas in wei. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getBalance.yaml b/ethereum/eth_getBalance.yaml index f371fc75..1ecebe22 100644 --- a/ethereum/eth_getBalance.yaml +++ b/ethereum/eth_getBalance.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getBalance - Ethereum description: Returns the balance of the account of a given address. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getBlockTransactionCountByHash.yaml b/ethereum/eth_getBlockTransactionCountByHash.yaml index 209b8070..98c2dc4d 100644 --- a/ethereum/eth_getBlockTransactionCountByHash.yaml +++ b/ethereum/eth_getBlockTransactionCountByHash.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getBlockTransactionCountByHash - Ethereum description: Returns the number of transactions in a block matching the given block hash. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getBlockTransactionCountByNumber.yaml b/ethereum/eth_getBlockTransactionCountByNumber.yaml index 5db0f727..c6d87e18 100644 --- a/ethereum/eth_getBlockTransactionCountByNumber.yaml +++ b/ethereum/eth_getBlockTransactionCountByNumber.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getBlockTransactionCountByNumber - Ethereum description: Returns the number of transactions in a block matching the given block number. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getCode.yaml b/ethereum/eth_getCode.yaml index 4e0cc92e..d06afeac 100644 --- a/ethereum/eth_getCode.yaml +++ b/ethereum/eth_getCode.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getCode - Ethereum description: Returns code at a given address. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getFilterChanges.yaml b/ethereum/eth_getFilterChanges.yaml index 64dbc4cf..b4497425 100644 --- a/ethereum/eth_getFilterChanges.yaml +++ b/ethereum/eth_getFilterChanges.yaml @@ -21,7 +21,6 @@ components: summary: eth_getFilterChanges - Ethereum operationId: eth-getfilterchanges description: 'Polling method for a filter, which returns an array of logs which occurred since last poll.' - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getFilterLogs.yaml b/ethereum/eth_getFilterLogs.yaml index 249ae8bf..ed5be131 100644 --- a/ethereum/eth_getFilterLogs.yaml +++ b/ethereum/eth_getFilterLogs.yaml @@ -21,7 +21,6 @@ components: summary: eth_getFilterLogs - Ethereum operationId: eth-getfilterlogs description: Returns an array of all logs matching filter with given id. Can compute the same results with an eth_getLogs call. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getStorageAt.yaml b/ethereum/eth_getStorageAt.yaml index fb97f7fa..4ee41f3c 100644 --- a/ethereum/eth_getStorageAt.yaml +++ b/ethereum/eth_getStorageAt.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getStorageAt - Ethereum 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getTransactionByBlockHashAndIndex.yaml b/ethereum/eth_getTransactionByBlockHashAndIndex.yaml index 84dc598b..edb9641c 100644 --- a/ethereum/eth_getTransactionByBlockHashAndIndex.yaml +++ b/ethereum/eth_getTransactionByBlockHashAndIndex.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getTransactionByBlockHashAndIndex - Ethereum description: Returns information about a transaction by block hash and transaction index position. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getTransactionByBlockNumberAndIndex.yaml b/ethereum/eth_getTransactionByBlockNumberAndIndex.yaml index ffd5997b..5c2c8853 100644 --- a/ethereum/eth_getTransactionByBlockNumberAndIndex.yaml +++ b/ethereum/eth_getTransactionByBlockNumberAndIndex.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getTransactionByBlockNumberAndIndex - Ethereum description: Returns information about a transaction by block number and transaction index position. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getTransactionByHash.yaml b/ethereum/eth_getTransactionByHash.yaml index 5f595cbc..824d093d 100644 --- a/ethereum/eth_getTransactionByHash.yaml +++ b/ethereum/eth_getTransactionByHash.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getTransactionByHash - Ethereum 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getTransactionCount.yaml b/ethereum/eth_getTransactionCount.yaml index 0702bb24..fc26d4d0 100644 --- a/ethereum/eth_getTransactionCount.yaml +++ b/ethereum/eth_getTransactionCount.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getTransactionCount - Ethereum description: Returns the number of transactions sent from an address. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getTransactionReceipt.yaml b/ethereum/eth_getTransactionReceipt.yaml index c4e3e5dd..837f4152 100644 --- a/ethereum/eth_getTransactionReceipt.yaml +++ b/ethereum/eth_getTransactionReceipt.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getTransactionReceipt - Ethereum description: Returns the receipt of a transaction by transaction hash. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getUncleByBlockHashAndIndex.yaml b/ethereum/eth_getUncleByBlockHashAndIndex.yaml index 627e27b6..2074dbc2 100644 --- a/ethereum/eth_getUncleByBlockHashAndIndex.yaml +++ b/ethereum/eth_getUncleByBlockHashAndIndex.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getUncleByBlockHashAndIndex - Ethereum description: Returns information about an uncle of a block by hash and uncle index position. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getUncleByBlockNumberAndIndex.yaml b/ethereum/eth_getUncleByBlockNumberAndIndex.yaml index d3eb213b..5efead47 100644 --- a/ethereum/eth_getUncleByBlockNumberAndIndex.yaml +++ b/ethereum/eth_getUncleByBlockNumberAndIndex.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getUncleByBlockNumberAndIndex - Ethereum description: Returns information about an uncle of a block by number and uncle index position. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getUncleCountByBlockHash.yaml b/ethereum/eth_getUncleCountByBlockHash.yaml index abff3384..85c15fe5 100644 --- a/ethereum/eth_getUncleCountByBlockHash.yaml +++ b/ethereum/eth_getUncleCountByBlockHash.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getUncleCountByBlockHash - Ethereum description: Returns the number of uncles in a block matching the given block hash. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_getUncleCountByBlockNumber.yaml b/ethereum/eth_getUncleCountByBlockNumber.yaml index 28108d6e..f416a64c 100644 --- a/ethereum/eth_getUncleCountByBlockNumber.yaml +++ b/ethereum/eth_getUncleCountByBlockNumber.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_getUncleCountByBlockNumber - Ethereum description: Returns the number of uncles in a block matching the given block number. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_newBlockFilter.yaml b/ethereum/eth_newBlockFilter.yaml index 7c2b4464..1dc72255 100644 --- a/ethereum/eth_newBlockFilter.yaml +++ b/ethereum/eth_newBlockFilter.yaml @@ -21,7 +21,6 @@ components: summary: eth_newBlockFilter - Ethereum operationId: eth-newblockfilter description: 'Creates a filter in the node, to notify when a new block arrives.' - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_newFilter.yaml b/ethereum/eth_newFilter.yaml index cf054718..62de0e76 100644 --- a/ethereum/eth_newFilter.yaml +++ b/ethereum/eth_newFilter.yaml @@ -21,7 +21,6 @@ components: summary: eth_newFilter - Ethereum operationId: eth-newfilter description: 'Creates a filter object, based on filter options, to notify when the state changes (logs).' - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_newPendingTransactionFilter.yaml b/ethereum/eth_newPendingTransactionFilter.yaml index 69077b51..d7bb3fa7 100644 --- a/ethereum/eth_newPendingTransactionFilter.yaml +++ b/ethereum/eth_newPendingTransactionFilter.yaml @@ -21,7 +21,6 @@ components: summary: eth_newPendingTransactionFilter - Ethereum operationId: eth-newpendingtransactionfilter 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_protocolVersion.yaml b/ethereum/eth_protocolVersion.yaml index d9d83710..6c2bc8d4 100644 --- a/ethereum/eth_protocolVersion.yaml +++ b/ethereum/eth_protocolVersion.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_protocolVersion - Ethereum description: Returns the current ethereum protocol version. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_sendRawTransaction.yaml b/ethereum/eth_sendRawTransaction.yaml index 6f364729..ddec3af9 100644 --- a/ethereum/eth_sendRawTransaction.yaml +++ b/ethereum/eth_sendRawTransaction.yaml @@ -20,7 +20,6 @@ components: post: summary: eth_sendRawTransaction - Ethereum description: Creates a new message call transaction or a contract creation for signed transactions. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/eth_uninstallFilter.yaml b/ethereum/eth_uninstallFilter.yaml index 328e716e..0a99c670 100644 --- a/ethereum/eth_uninstallFilter.yaml +++ b/ethereum/eth_uninstallFilter.yaml @@ -21,7 +21,6 @@ components: summary: eth_uninstallFilter - Ethereum operationId: eth-uninstallfilter 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: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/net_listening.yaml b/ethereum/net_listening.yaml index f9539a6d..4a536f5e 100644 --- a/ethereum/net_listening.yaml +++ b/ethereum/net_listening.yaml @@ -20,7 +20,6 @@ components: post: summary: net_listening - Ethereum description: Returns true if client is actively listening for network connections. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/net_version.yaml b/ethereum/net_version.yaml index 32ed4c08..1200f738 100644 --- a/ethereum/net_version.yaml +++ b/ethereum/net_version.yaml @@ -20,7 +20,6 @@ components: post: summary: net_version - Ethereum description: Returns the current network id. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/web3_clientVersion.yaml b/ethereum/web3_clientVersion.yaml index af73beb2..0205fc0d 100644 --- a/ethereum/web3_clientVersion.yaml +++ b/ethereum/web3_clientVersion.yaml @@ -20,7 +20,6 @@ components: post: summary: web3_clientVersion - Ethereum description: Returns the current client version. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/ethereum/web3_sha3.yaml b/ethereum/web3_sha3.yaml index e1261e42..0ac0511d 100644 --- a/ethereum/web3_sha3.yaml +++ b/ethereum/web3_sha3.yaml @@ -20,7 +20,6 @@ components: post: summary: web3_sha3 - Ethereum description: Returns Keccak-256 (not the standardized SHA3-256) of the given data. - tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: From 74f011c4ae73815e3a900cfb88ebab02190e4170 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:16:49 +0200 Subject: [PATCH 34/47] Refactor eth_accounts specs --- arbitrum/eth_accounts.yaml | 2 +- astar/eth_accounts.yaml | 2 +- base/eth_accounts.yaml | 2 +- components/evm.yaml | 26 ++++++++++++++++++++++++++ ethereum/eth_accounts.yaml | 20 +------------------- evm_body.yaml | 8 -------- optimism/eth_accounts.yaml | 2 +- polygon-pos/eth_accounts.yaml | 2 +- 8 files changed, 32 insertions(+), 32 deletions(-) create mode 100644 components/evm.yaml diff --git a/arbitrum/eth_accounts.yaml b/arbitrum/eth_accounts.yaml index fccf3c69..14ac07f9 100644 --- a/arbitrum/eth_accounts.yaml +++ b/arbitrum/eth_accounts.yaml @@ -13,6 +13,6 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthAccount summary: eth_accounts - Arbitrum operationId: eth-accounts-arbitrum - $ref: ../ethereum/eth_accounts.yaml#/components/pathItems/path/post diff --git a/astar/eth_accounts.yaml b/astar/eth_accounts.yaml index 867f48e9..87bd613c 100644 --- a/astar/eth_accounts.yaml +++ b/astar/eth_accounts.yaml @@ -7,6 +7,6 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthAccount summary: eth_accounts - Astar - $ref: ../ethereum/eth_accounts.yaml#/components/pathItems/path/post operationId: eth-accounts-astar diff --git a/base/eth_accounts.yaml b/base/eth_accounts.yaml index 02dd21fa..3a8170ea 100644 --- a/base/eth_accounts.yaml +++ b/base/eth_accounts.yaml @@ -14,5 +14,5 @@ paths: /{apiKey}: post: summary: eth_accounts - Base - $ref: ../ethereum/eth_accounts.yaml#/components/pathItems/path/post operationId: eth-accounts-base + $ref: ../components/evm.yaml#/EthAccount diff --git a/components/evm.yaml b/components/evm.yaml new file mode 100644 index 00000000..462388db --- /dev/null +++ b/components/evm.yaml @@ -0,0 +1,26 @@ +EthAccount: + summary: "TODO: override this" + description: Returns a list of addresses owned by client. Since Alchemy does not store keys, this will always return empty. + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: eth_accounts + responses: + '200': + description: Returns 20 Bytes - addresses owned by the client. + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response \ No newline at end of file diff --git a/ethereum/eth_accounts.yaml b/ethereum/eth_accounts.yaml index fb9b3c8b..d0513f9f 100644 --- a/ethereum/eth_accounts.yaml +++ b/ethereum/eth_accounts.yaml @@ -13,25 +13,7 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: post: + $ref: ../components/evm.yaml#/EthAccount summary: eth_accounts - Ethereum - description: Returns a list of addresses owned by client. Since Alchemy does not store keys, this will always return empty. - parameters: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - content: - application/json: - schema: - $ref: ../evm_body.yaml#/eth_accounts - responses: - '200': - description: Returns 20 Bytes - addresses owned by the client. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/string_result_response operationId: eth-accounts diff --git a/evm_body.yaml b/evm_body.yaml index c4abddbb..95605958 100644 --- a/evm_body.yaml +++ b/evm_body.yaml @@ -358,14 +358,6 @@ eth_getCode_polygon_zkevm: $ref: ./components/schemas.yaml#/Method default: eth_getCode -eth_accounts: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: eth_accounts eth_getProof: allOf: - $ref: '#/common_request_fields' diff --git a/optimism/eth_accounts.yaml b/optimism/eth_accounts.yaml index ef9ef0a4..f102ff1c 100644 --- a/optimism/eth_accounts.yaml +++ b/optimism/eth_accounts.yaml @@ -13,6 +13,6 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthAccount summary: eth_accounts - Optimism - $ref: ../ethereum/eth_accounts.yaml#/components/pathItems/path/post operationId: eth-accounts-optimism diff --git a/polygon-pos/eth_accounts.yaml b/polygon-pos/eth_accounts.yaml index 0cf1ba04..a8e82194 100644 --- a/polygon-pos/eth_accounts.yaml +++ b/polygon-pos/eth_accounts.yaml @@ -13,7 +13,7 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthAccount summary: eth_accounts - Polygon PoS description: Returns a list of addresses owned by client on Polygon. Since Alchemy does not store keys, this will always return empty. - $ref: ../ethereum/eth_accounts.yaml#/components/pathItems/path/post operationId: eth-accounts-polygon From 23a7b16f1a76a3a44318e8a67f5e6835c15897d6 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:21:18 +0200 Subject: [PATCH 35/47] Fix identation --- ethereum/eth_accounts.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ethereum/eth_accounts.yaml b/ethereum/eth_accounts.yaml index d0513f9f..dfafd156 100644 --- a/ethereum/eth_accounts.yaml +++ b/ethereum/eth_accounts.yaml @@ -13,7 +13,7 @@ servers: default: eth-mainnet paths: /{apiKey}: - post: - $ref: ../components/evm.yaml#/EthAccount - summary: eth_accounts - Ethereum - operationId: eth-accounts + post: + $ref: ../components/evm.yaml#/EthAccount + summary: eth_accounts - Ethereum + operationId: eth-accounts From fd45b4301dd01066a84275305eafde8cf8858aa0 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:21:29 +0200 Subject: [PATCH 36/47] Add placeholder for other path item schemas --- components/evm.yaml | 297 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 297 insertions(+) diff --git a/components/evm.yaml b/components/evm.yaml index 462388db..9ae6187a 100644 --- a/components/evm.yaml +++ b/components/evm.yaml @@ -20,6 +20,303 @@ EthAccount: responses: '200': description: Returns 20 Bytes - addresses owned by the client. + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthBlockNumber: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthCall: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthChainId: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthCreateAccessList: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthEstimateGas: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthFeeHistory: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthGasPrice: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthGetBalance: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthGetBlockByHash: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthGetBlockByNumber: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: ../evm_responses.yaml#/string_result_response + +EthGetBlockReceipts: + summary: "TODO: override this" + description: '' + operationId: "TODO: override this" + parameters: + - $ref: ./parameters.yaml#/ApiKey + requestBody: + content: + application/json: + schema: + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: '' + responses: + '200': + description: '' content: application/json: schema: From 297f076cad5f015dcbcb9bc0cd83c7e8e6fb56eb Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:28:31 +0200 Subject: [PATCH 37/47] Refactor eth_blockNumber --- arbitrum/eth_blockNumber.yaml | 2 +- astar/eth_blockNumber.yaml | 2 +- base/eth_blockNumber.yaml | 2 +- components/evm.yaml | 8 ++-- ethereum/eth_blockNumber.yaml | 66 +++++++++++------------------- evm_body.yaml | 8 ---- optimism/eth_blockNumber.yaml | 2 +- polygon-pos/eth_blockNumber.yaml | 2 +- polygon-zkevm/eth_blockNumber.yaml | 2 +- 9 files changed, 33 insertions(+), 61 deletions(-) diff --git a/arbitrum/eth_blockNumber.yaml b/arbitrum/eth_blockNumber.yaml index a6feebe9..ed708232 100644 --- a/arbitrum/eth_blockNumber.yaml +++ b/arbitrum/eth_blockNumber.yaml @@ -13,9 +13,9 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthBlockNumber summary: eth_blockNumber - Arbitrum operationId: eth-blocknumber-arbitrum - $ref: ../ethereum/eth_blockNumber.yaml#/components/pathItems/path/post x-readme: samples-languages: - curl diff --git a/astar/eth_blockNumber.yaml b/astar/eth_blockNumber.yaml index 03f7a472..568945fb 100644 --- a/astar/eth_blockNumber.yaml +++ b/astar/eth_blockNumber.yaml @@ -7,8 +7,8 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthBlockNumber summary: eth_blockNumber - Astar - $ref: ../ethereum/eth_blockNumber.yaml#/components/pathItems/path/post operationId: eth-blocknumber-astar x-readme: explorer-enabled: false diff --git a/base/eth_blockNumber.yaml b/base/eth_blockNumber.yaml index 71d23760..f34a496f 100644 --- a/base/eth_blockNumber.yaml +++ b/base/eth_blockNumber.yaml @@ -13,8 +13,8 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthBlockNumber summary: eth_blockNumber - Base - $ref: ../ethereum/eth_blockNumber.yaml#/components/pathItems/path/post operationId: eth-blocknumber-base x-readme: samples-languages: diff --git a/components/evm.yaml b/components/evm.yaml index 9ae6187a..5b014257 100644 --- a/components/evm.yaml +++ b/components/evm.yaml @@ -27,7 +27,7 @@ EthAccount: EthBlockNumber: summary: "TODO: override this" - description: '' + description: Returns the number of the most recent block. operationId: "TODO: override this" parameters: - $ref: ./parameters.yaml#/ApiKey @@ -43,14 +43,14 @@ EthBlockNumber: $ref: ./schemas.yaml#/JsonRpc method: $ref: ./schemas.yaml#/Method - default: '' + default: eth_blockNumber responses: '200': - description: '' + description: Returns integer of the current block number the client is on. content: application/json: schema: - $ref: ../evm_responses.yaml#/string_result_response + $ref: ../evm_responses.yaml#/eth_blockNumber EthCall: summary: "TODO: override this" diff --git a/ethereum/eth_blockNumber.yaml b/ethereum/eth_blockNumber.yaml index f28fcc19..dee11ef7 100644 --- a/ethereum/eth_blockNumber.yaml +++ b/ethereum/eth_blockNumber.yaml @@ -14,48 +14,28 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - summary: eth_blockNumber - Ethereum - operationId: eth-blocknumber - description: Returns the number of the most recent block. - parameters: - - $ref: ../components/parameters.yaml#/ApiKey - requestBody: - description: Accepts nothing. - content: - application/json: - schema: - $ref: ../evm_body.yaml#/eth_blockNumber - 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"; + post: + summary: eth_blockNumber - Ethereum + operationId: eth-blocknumber + 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); + // 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); - // Get the latest block number - alchemy.core.getBlockNumber().then(console.log); - responses: - '200': - description: Returns integer of the current block number the client is on. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_blockNumber + // Get the latest block number + alchemy.core.getBlockNumber().then(console.log); diff --git a/evm_body.yaml b/evm_body.yaml index 95605958..4f8cbe08 100644 --- a/evm_body.yaml +++ b/evm_body.yaml @@ -1,12 +1,4 @@ # ========= EVM Methods ============== -eth_blockNumber: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: eth_blockNumber eth_getBlockByHash: allOf: - $ref: '#/common_request_fields' diff --git a/optimism/eth_blockNumber.yaml b/optimism/eth_blockNumber.yaml index 89b8eb0d..19ba557f 100644 --- a/optimism/eth_blockNumber.yaml +++ b/optimism/eth_blockNumber.yaml @@ -13,8 +13,8 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthBlockNumber summary: eth_blockNumber - Optimism - $ref: ../ethereum/eth_blockNumber.yaml#/components/pathItems/path/post operationId: eth-blocknumber-optimism x-readme: explorer-enabled: false diff --git a/polygon-pos/eth_blockNumber.yaml b/polygon-pos/eth_blockNumber.yaml index 25b752c3..41b21096 100644 --- a/polygon-pos/eth_blockNumber.yaml +++ b/polygon-pos/eth_blockNumber.yaml @@ -13,10 +13,10 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthBlockNumber 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: - curl diff --git a/polygon-zkevm/eth_blockNumber.yaml b/polygon-zkevm/eth_blockNumber.yaml index cc20532f..9b0e9016 100644 --- a/polygon-zkevm/eth_blockNumber.yaml +++ b/polygon-zkevm/eth_blockNumber.yaml @@ -13,9 +13,9 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthBlockNumber summary: eth_blockNumber - Polygon zkEVM operationId: eth-blocknumber-polygon-zkevm - $ref: ../ethereum/eth_blockNumber.yaml#/components/pathItems/path/post x-readme: samples-languages: - curl From e5bd70483a604f632a3210c90e8789251196d17e Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:44:34 +0200 Subject: [PATCH 38/47] Add ref --- ethereum/eth_blockNumber.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/ethereum/eth_blockNumber.yaml b/ethereum/eth_blockNumber.yaml index dee11ef7..77d205fa 100644 --- a/ethereum/eth_blockNumber.yaml +++ b/ethereum/eth_blockNumber.yaml @@ -15,6 +15,7 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthBlockNumber summary: eth_blockNumber - Ethereum operationId: eth-blocknumber x-readme: From 03f740edab0704db476c957cc9a26d503844040e Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:44:46 +0200 Subject: [PATCH 39/47] Start refactoring eth_call --- components/evm.yaml | 17 ++++++- components/schemas.yaml | 10 ++-- ethereum/eth_call.yaml | 100 +++++++++++++++++++--------------------- evm_body.yaml | 73 +++-------------------------- evm_responses.yaml | 6 +-- 5 files changed, 77 insertions(+), 129 deletions(-) diff --git a/components/evm.yaml b/components/evm.yaml index 5b014257..c25f0af9 100644 --- a/components/evm.yaml +++ b/components/evm.yaml @@ -54,11 +54,12 @@ EthBlockNumber: EthCall: summary: "TODO: override this" - description: '' + description: Executes a new message call immediately without creating a transaction on the block chain operationId: "TODO: override this" parameters: - $ref: ./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: application/json: schema: @@ -70,7 +71,19 @@ EthCall: $ref: ./schemas.yaml#/JsonRpc method: $ref: ./schemas.yaml#/Method - default: '' + default: 'eth_call' + params: + type: array + minItems: 1 + maxItems: 1 + items: + oneOf: + - allOf: + - $ref: ./schemas.yaml#/TxObject + # title: Transaction Object + - $ref: '../evm_body.yaml#/gas_550' + - $ref: '#/BlockNumberOrTagOrHash' + title: Block number or block tag or block hash responses: '200': description: '' diff --git a/components/schemas.yaml b/components/schemas.yaml index e57b9b60..5337375b 100644 --- a/components/schemas.yaml +++ b/components/schemas.yaml @@ -13,11 +13,11 @@ Address: FromAddress: $ref: '#/Address' # TODO: would hex make more sense than 20 bytes here? - description: 'address the transaction is sent from' + description: '20 Bytes - The address the transaction is sent from.' ToAddress: $ref: '#/Address' - description: 'address the transaction is directed to' + description: '20 Bytes - The address the transaction is directed to' # USDC contract default: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' @@ -28,9 +28,8 @@ Value: Data: $ref: '#/Hex' - description: '' - # transfer 1 USDC to address - default: '0xa9059cbb000000000000000000000000fc43f5f9dd45258b3aff31bdbe6561d97e8b71de00000000000000000000000000000000000000000000000000000000000f4240' + description: Hash of the method signature and encoded parameters + default: '0x' GasLimit: $ref: '#/Hex' @@ -50,6 +49,7 @@ MaxFeePerGas: TxObject: type: object + description: The transaction call object properties: from: $ref: '#/FromAddress' diff --git a/ethereum/eth_call.yaml b/ethereum/eth_call.yaml index cc9eb373..aa21751b 100644 --- a/ethereum/eth_call.yaml +++ b/ethereum/eth_call.yaml @@ -14,59 +14,53 @@ servers: default: eth-mainnet paths: /{apiKey}: - $ref: '#/components/pathItems/path' -components: - pathItems: - path: - post: - operationId: eth-call - summary: eth_call - Ethereum - description: Executes a new message call immediately without creating a transaction on the block chain. - parameters: - - $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. + post: + $ref: ../components/evm.yaml#/EthCall + operationId: eth-call + summary: eth_call - Ethereum + requestBody: + description: Accepts the transaction call object, state overrides and the block number / block hash / block tag to execute the call on. + content: + application/json: + schema: + $ref: ../evm_body.yaml#/eth_call_550_gas + 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); + + // Make a sample eth_call + alchemy.core + .call({ + to: "0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41", + gas: "0x76c0", + gasPrice: "0x9184e72a000", + data: "0x3b3b57debf074faa138b72c65adbdcfb329847e4f2c04bde7f7dd7fcad5a52d2f395a558", + }) + .then(console.log); + - language: python + code: "from web3 import Web3, HTTPProvider\r\n\r\n#Replace with your Alchemy API key:\r\napiKey = \"demo\"\r\n\r\n# Initialize a Web3.py instance\r\nweb3 = Web3(Web3.HTTPProvider('https://eth-mainnet.g.alchemy.com/v2 /'+apiKey))\r\n\r\n# Query the blockchain (replace example parameters)\r\ndata = web3.eth.call({\r\n\t\t'value': 0, \r\n\t\t'gas': 21736, \r\n\t\t'maxFeePerGas': 2000000000, \r\n\t\t'maxPriorityFeePerGas': 1000000000, \r\n\t\t'to': '0xc305c90',\r\n\t\t'data': '0x477a5c98'\r\n\t\t}) \r\n\r\n# Print the output to console\r\nprint(data)" + name: web3.py + responses: + '200': + description: The result of the call. content: application/json: schema: - $ref: ../evm_body.yaml#/eth_call_550_gas - 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); - - // Make a sample eth_call - alchemy.core - .call({ - to: "0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41", - gas: "0x76c0", - gasPrice: "0x9184e72a000", - data: "0x3b3b57debf074faa138b72c65adbdcfb329847e4f2c04bde7f7dd7fcad5a52d2f395a558", - }) - .then(console.log); - - language: python - code: "from web3 import Web3, HTTPProvider\r\n\r\n#Replace with your Alchemy API key:\r\napiKey = \"demo\"\r\n\r\n# Initialize a Web3.py instance\r\nweb3 = Web3(Web3.HTTPProvider('https://eth-mainnet.g.alchemy.com/v2 /'+apiKey))\r\n\r\n# Query the blockchain (replace example parameters)\r\ndata = web3.eth.call({\r\n\t\t'value': 0, \r\n\t\t'gas': 21736, \r\n\t\t'maxFeePerGas': 2000000000, \r\n\t\t'maxPriorityFeePerGas': 1000000000, \r\n\t\t'to': '0xc305c90',\r\n\t\t'data': '0x477a5c98'\r\n\t\t}) \r\n\r\n# Print the output to console\r\nprint(data)" - name: web3.py - responses: - '200': - description: The result of the call. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_call + $ref: ../evm_responses.yaml#/eth_call diff --git a/evm_body.yaml b/evm_body.yaml index 4f8cbe08..c59b5482 100644 --- a/evm_body.yaml +++ b/evm_body.yaml @@ -418,7 +418,7 @@ eth_estimateGas_550: items: oneOf: - allOf: - - $ref: '#/transaction_object' + - $ref: './components/schemas.yaml#/TxObject' - $ref: '#/gas_550' - $ref: '#/blockNumber_or_blocktag_param_eth' @@ -437,7 +437,7 @@ eth_estimateGas_polygon_zkEVM: items: oneOf: - allOf: - - $ref: '#/transaction_object' + - $ref: './components/schemas.yaml#/TxObject' - $ref: '#/gas_550' - $ref: '#/blockNumber_or_blocktag_param_polygon_zkevm' @@ -777,7 +777,7 @@ trace_call: 3. `string` - Block Identifier: Block hash, block number (in hex), or block tag (select in 3rd box) items: anyOf: - - $ref: '#/transaction_object' + - $ref: './components/schemas.yaml#/TxObject' title: Transaction Object description: transaction object. - $ref: '#/trace_type_array' @@ -1081,7 +1081,7 @@ eth_createAccessList: maxItems: 2 items: anyOf: - - $ref: '#/transaction_object' + - $ref: './components/schemas.yaml#/TxObject' title: Transaction object - $ref: '#/blockNumber_or_blocktag_param_l2' title: Block number or block tag @@ -1196,7 +1196,7 @@ debug_traceCall: 3. `tracer` - Object: Currently supports `callTracer` and `prestateTracer` (see above for definitions). items: anyOf: - - $ref: '#/transaction_object' + - $ref: './components/schemas.yaml#/TxObject' title: Transaction object - type: string title: Block identifier @@ -1347,27 +1347,6 @@ topics: '0x00000000000000000000000054a2d42a40f51259dedd1978f6c118a0f0eff078', ] -eth_call_550_gas: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: eth_call - params: - type: array - minItems: 1 - maxItems: 1 - items: - oneOf: - - allOf: - - $ref: '#/transaction_object' - title: Transaction Object - - $ref: '#/gas_550' - - $ref: '#/BlockNumberOrTagOrHash' - title: Block number or block tag or block hash - eth_call_polygon_zkevm: allOf: - $ref: '#/common_request_fields' @@ -1383,55 +1362,17 @@ eth_call_polygon_zkevm: items: oneOf: - allOf: - - $ref: '#/transaction_object' + - $ref: './components/schemas.yaml#/TxObject' title: Transaction Object - $ref: '#/gas_550' - $ref: '#/BlockNumberOrTagOrHash_polygon_zkevm' title: Block number or block tag or block hash -transaction_object: - type: object - description: The transaction call object - properties: - from: - type: string - description: 20 Bytes - The address the transaction is sent from. - pattern: '^0[xX][0-9a-fA-F]+$' - to: - type: string - description: 20 Bytes - The address the transaction is directed to - default: '0xd46e8dd67c5d32be8058bb8eb970870f07244567' - pattern: '^0[xX][0-9a-fA-F]+$' - gas: - type: string - description: Integer of the gas provided for the transaction execution. - pattern: '^0[xX][0-9a-fA-F]+$' - default: '0x00' - gasPrice: - type: string - description: | - Integer of the gasPrice used for each paid gas. - <br/><strong>NOTE:</strong> most of our users <b>(95%+)</b> never set the gasPrice on eth_call. - pattern: '^0[xX][0-9a-fA-F]+$' - default: '0x09184e72a000' - value: - type: string - description: Integer of the value sent with this transaction - pattern: '^0[xX][0-9a-fA-F]+$' - default: '0x00' - data: - type: string - description: Hash of the method signature and encoded parameters - pattern: '^0[xX][0-9a-fA-F]+$' - default: '0x' - required: - - to gas_550: type: object properties: gas: - type: string - pattern: '^0[xX][0-9a-fA-F]+$' + $ref: './components/schemas.yaml#/Hex' default: '0x1C9C380' description: | Integer of the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions. diff --git a/evm_responses.yaml b/evm_responses.yaml index 95157b34..35631e30 100644 --- a/evm_responses.yaml +++ b/evm_responses.yaml @@ -271,7 +271,7 @@ eth_getTransactionByHash: properties: result: description: 'A transaction object, or null when no transaction was found' - $ref: '#/transaction_object' + $ref: './components/schemas.yaml#/TxObject' example: $ref: ./evm_examples.yaml#/eth_getTransactionByHash @@ -282,7 +282,7 @@ eth_getTransactionByHash_arb: properties: result: description: 'A transaction object, or null when no transaction was found' - $ref: '#/transaction_object_arb' + $ref: './components/schemas.yaml#/TxObject_arb' example: $ref: ./evm_examples.yaml#/eth_getTransactionByHash_arb @@ -735,7 +735,7 @@ eth_subscribe: result: description: An object whose contents vary depending on the type of subscription. oneOf: - - $ref: '#/transaction_object' + - $ref: './components/schemas.yaml#/TxObject' - type: string - $ref: '#/block_object' - $ref: '#/log_object' From 014ffc0a7c939d4cc91b94a505dfc11c969e7043 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:47:44 +0200 Subject: [PATCH 40/47] Refactor BlockNumber out of evm_body.yaml --- components/schemas.yaml | 6 ++++++ components/starknet/schemas.yaml | 8 ++++---- evm_body.yaml | 12 +++--------- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/components/schemas.yaml b/components/schemas.yaml index 5337375b..2c7319cc 100644 --- a/components/schemas.yaml +++ b/components/schemas.yaml @@ -72,6 +72,12 @@ TxObject: required: - to +BlockNumber: + title: Block number + type: string + description: The hex value of a **block number**. + default: '0x61A80' + Id: type: integer default: 1 diff --git a/components/starknet/schemas.yaml b/components/starknet/schemas.yaml index 462c5bfc..4dae038c 100644 --- a/components/starknet/schemas.yaml +++ b/components/starknet/schemas.yaml @@ -39,7 +39,7 @@ EmittedEvent: $ref: '#/BlockHash' block_number: title: The number of the block in which the event was emitted - $ref: '#/BlockNumber' + $ref: './components/schemas.yaml#/BlockNumber' transaction_hash: title: The transaction that emitted the event $ref: '#/TxnHash' @@ -113,7 +113,7 @@ BlockId: - type: object properties: block_number: - $ref: '#/BlockNumber' + $ref: './components/schemas.yaml#/BlockNumber' required: - block_number - $ref: '#/BlockTag' @@ -326,7 +326,7 @@ BlockHeader: $ref: '#/BlockHash' block_number: description: The block number (its height) - $ref: '#/BlockNumber' + $ref: './components/schemas.yaml#/BlockNumber' new_root: description: The new global state root $ref: '#/Felt' @@ -744,7 +744,7 @@ CommonReceiptProperties: block_hash: $ref: '#/BlockHash' block_number: - $ref: '#/BlockNumber' + $ref: './components/schemas.yaml#/BlockNumber' messages_sent: type: array items: diff --git a/evm_body.yaml b/evm_body.yaml index c59b5482..a0303d4d 100644 --- a/evm_body.yaml +++ b/evm_body.yaml @@ -550,7 +550,7 @@ eth_getUncleCountByBlockNumber: minItems: 1 maxItems: 1 items: - -$ref: '#/BlockNumber' + -$ref: './components/schemas.yaml#/BlockNumber' eth_getFilterChanges: allOf: - $ref: '#/common_request_fields' @@ -1607,7 +1607,7 @@ BlockNumberOrTagOrHash: title: Block number or tag, or block hash oneOf: - title: Block Number - $ref: '#/BlockNumber' + $ref: './components/schemas.yaml#/BlockNumber' - title: Block Tag $ref: '#/BlockTag' - title: Block Hash @@ -1617,7 +1617,7 @@ BlockNumberOrTagOrHash_polygon_zkevm: title: Block number or tag, or block hash oneOf: - title: Block Number - $ref: '#/BlockNumber' + $ref: './components/schemas.yaml#/BlockNumber' - title: Block Tag $ref: '#/BlockTag_polygon_zkevm' - title: Block Hash @@ -1656,12 +1656,6 @@ BlockTag_polygon_zkevm: - earliest default: latest -BlockNumber: - title: Block number - type: string - description: The hex value of a **block number**. - default: '0x61A80' - BlockHashEIP1898: title: Block hash type: object From 94233eb5085c4b6308d6f135cfabbcafdb33cf8a Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 05:50:58 +0200 Subject: [PATCH 41/47] Refactor eth_call --- arbitrum/eth_call.yaml | 2 +- astar/eth_call.yaml | 2 +- base/eth_call.yaml | 2 +- components/evm.yaml | 4 ++-- ethereum/eth_call.yaml | 13 ------------- optimism/eth_call.yaml | 2 +- polygon-pos/eth_call.yaml | 4 ++-- 7 files changed, 8 insertions(+), 21 deletions(-) diff --git a/arbitrum/eth_call.yaml b/arbitrum/eth_call.yaml index cc264a54..853caa52 100644 --- a/arbitrum/eth_call.yaml +++ b/arbitrum/eth_call.yaml @@ -7,8 +7,8 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthCall summary: eth_call - Arbitrum - $ref: ../ethereum/eth_call.yaml#/components/pathItems/path/post operationId: eth-call-arbitrum x-readme: explorer-enabled: false diff --git a/astar/eth_call.yaml b/astar/eth_call.yaml index 058f5a8b..1c77e2cc 100644 --- a/astar/eth_call.yaml +++ b/astar/eth_call.yaml @@ -7,8 +7,8 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthCall summary: eth_call - Astar - $ref: ../ethereum/eth_call.yaml#/components/pathItems/path/post operationId: eth-call-astar x-readme: explorer-enabled: false diff --git a/base/eth_call.yaml b/base/eth_call.yaml index 87f6fc6b..485aa955 100644 --- a/base/eth_call.yaml +++ b/base/eth_call.yaml @@ -13,8 +13,8 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthCall summary: eth_call - Base - $ref: ../ethereum/eth_call.yaml#/components/pathItems/path/post operationId: eth-call-base x-readme: explorer-enabled: false diff --git a/components/evm.yaml b/components/evm.yaml index c25f0af9..57759346 100644 --- a/components/evm.yaml +++ b/components/evm.yaml @@ -86,11 +86,11 @@ EthCall: title: Block number or block tag or block hash responses: '200': - description: '' + description: The result of the call. content: application/json: schema: - $ref: ../evm_responses.yaml#/string_result_response + $ref: ../evm_responses.yaml#/eth_call EthChainId: summary: "TODO: override this" diff --git a/ethereum/eth_call.yaml b/ethereum/eth_call.yaml index aa21751b..f909992e 100644 --- a/ethereum/eth_call.yaml +++ b/ethereum/eth_call.yaml @@ -18,12 +18,6 @@ paths: $ref: ../components/evm.yaml#/EthCall operationId: eth-call summary: eth_call - Ethereum - requestBody: - description: Accepts the transaction call object, state overrides and the block number / block hash / block tag to execute the call on. - content: - application/json: - schema: - $ref: ../evm_body.yaml#/eth_call_550_gas x-readme: explorer-enabled: false samples-languages: @@ -57,10 +51,3 @@ paths: - language: python code: "from web3 import Web3, HTTPProvider\r\n\r\n#Replace with your Alchemy API key:\r\napiKey = \"demo\"\r\n\r\n# Initialize a Web3.py instance\r\nweb3 = Web3(Web3.HTTPProvider('https://eth-mainnet.g.alchemy.com/v2 /'+apiKey))\r\n\r\n# Query the blockchain (replace example parameters)\r\ndata = web3.eth.call({\r\n\t\t'value': 0, \r\n\t\t'gas': 21736, \r\n\t\t'maxFeePerGas': 2000000000, \r\n\t\t'maxPriorityFeePerGas': 1000000000, \r\n\t\t'to': '0xc305c90',\r\n\t\t'data': '0x477a5c98'\r\n\t\t}) \r\n\r\n# Print the output to console\r\nprint(data)" name: web3.py - responses: - '200': - description: The result of the call. - content: - application/json: - schema: - $ref: ../evm_responses.yaml#/eth_call diff --git a/optimism/eth_call.yaml b/optimism/eth_call.yaml index 28e7fcb0..525f9910 100644 --- a/optimism/eth_call.yaml +++ b/optimism/eth_call.yaml @@ -13,8 +13,8 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthCall summary: eth_call - Optimism - $ref: ../ethereum/eth_call.yaml#/components/pathItems/path/post operationId: eth-call-optimism x-readme: explorer-enabled: false diff --git a/polygon-pos/eth_call.yaml b/polygon-pos/eth_call.yaml index a50857c8..37415c4d 100644 --- a/polygon-pos/eth_call.yaml +++ b/polygon-pos/eth_call.yaml @@ -13,10 +13,10 @@ servers: paths: /{apiKey}: post: + $ref: ../components/evm.yaml#/EthCall summary: eth_call - Polygon PoS - operationId: eth-call-polygon description: Executes a new message call immediately without creating a transaction on the block chain on Polygon. - $ref: ../ethereum/eth_call.yaml#/components/pathItems/path/post + operationId: eth-call-polygon x-readme: explorer-enabled: false samples-languages: From 5dff3abff8fa6147e721a8588a6eb8b32307547d Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 06:01:53 +0200 Subject: [PATCH 42/47] Move zkEVM request bodies out of evm_body.yaml --- components/evm.yaml | 2 +- ethereum/eth_call.yaml | 2 +- evm_body.yaml | 127 +----------------- polygon-zkevm/zkevm_batchNumber.yaml | 10 +- .../zkevm_batchNumberByBlockNumber.yaml | 20 ++- .../zkevm_consolidatedBlockNumber.yaml | 10 +- polygon-zkevm/zkevm_getBatchByNumber.yaml | 23 +++- polygon-zkevm/zkevm_getBroadcastURI.yaml | 10 +- polygon-zkevm/zkevm_isBlockConsolidated.yaml | 20 ++- polygon-zkevm/zkevm_isBlockVirtualized.yaml | 20 ++- polygon-zkevm/zkevm_verifiedBatchNumber.yaml | 10 +- polygon-zkevm/zkevm_virtualBatchNumber.yaml | 10 +- 12 files changed, 127 insertions(+), 137 deletions(-) diff --git a/components/evm.yaml b/components/evm.yaml index 57759346..bdeedd7d 100644 --- a/components/evm.yaml +++ b/components/evm.yaml @@ -71,7 +71,7 @@ EthCall: $ref: ./schemas.yaml#/JsonRpc method: $ref: ./schemas.yaml#/Method - default: 'eth_call' + default: eth_call params: type: array minItems: 1 diff --git a/ethereum/eth_call.yaml b/ethereum/eth_call.yaml index f909992e..2dcbbb87 100644 --- a/ethereum/eth_call.yaml +++ b/ethereum/eth_call.yaml @@ -16,8 +16,8 @@ paths: /{apiKey}: post: $ref: ../components/evm.yaml#/EthCall - operationId: eth-call summary: eth_call - Ethereum + operationId: eth-call x-readme: explorer-enabled: false samples-languages: diff --git a/evm_body.yaml b/evm_body.yaml index a0303d4d..56bfd86c 100644 --- a/evm_body.yaml +++ b/evm_body.yaml @@ -1752,6 +1752,7 @@ blockNumber_or_blockHash_param_eth: items: type: string default: 'latest' + blockNumber_or_blockHash_param_l2: type: object properties: @@ -1806,132 +1807,6 @@ blockNumber_uncleIndex_param_l2: type: string default: ['latest', '0x0'] -# ======= zkEVM Methods ======= - -zkevm_consolidatedBlockNumber: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_consolidatedBlockNumber - -zkevm_isBlockVirtualized: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_isBlockVirtualized - params: - type: array - description: | - 1. String - The block number (in hex) - minItems: 1 - maxItems: 1 - items: - type: string - pattern: '^0x[0-9a-fA-F]+$' - default: ['0x0'] - -zkevm_isBlockConsolidated: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_isBlockConsolidated - params: - type: array - description: | - 1. String - The block number (in hex) - minItems: 1 - maxItems: 1 - items: - type: string - pattern: '^0x[0-9a-fA-F]+$' - default: ['0x0'] - -zkevm_batchNumberByBlockNumber: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_batchNumberByBlockNumber - params: - type: array - description: | - 1. String - The block number (in hex) - minItems: 1 - maxItems: 1 - items: - type: string - pattern: '^0x[0-9a-fA-F]+$' - default: ['0x0'] - -zkevm_batchNumber: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_batchNumber - -zkevm_virtualBatchNumber: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_virtualBatchNumber - -zkevm_verifiedBatchNumber: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_verifiedBatchNumber - -zkevm_getBatchByNumber: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_getBatchByNumber - params: - type: array - description: | - 1. String - The batch number (in hex) or batch tag - - The optional batch height descriptions are: - * `latest` - The most recent batch in the canonical chain observed by the client, this batch may be re-orged out of the canonical chain even under healthy/normal conditions. - * `earliest` - The lowest numbered batch the client has available. Intuitively, you can think of this as the first batch created. - minItems: 1 - maxItems: 1 - items: - type: string - default: ['0x0'] - -zkevm_getBroadcastURI: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: zkevm_getBroadcastURI - # ===================== Account Abstraction Methods ===================== eth_sendUserOperation: diff --git a/polygon-zkevm/zkevm_batchNumber.yaml b/polygon-zkevm/zkevm_batchNumber.yaml index f9b4b892..a2a0a561 100644 --- a/polygon-zkevm/zkevm_batchNumber.yaml +++ b/polygon-zkevm/zkevm_batchNumber.yaml @@ -30,7 +30,15 @@ paths: content: application/json: schema: - $ref: '../evm_responses.yaml#/zkevm_batchNumber' + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_batchNumber x-readme: samples-languages: - curl diff --git a/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml b/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml index 81576cc1..86f93549 100644 --- a/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml +++ b/polygon-zkevm/zkevm_batchNumberByBlockNumber.yaml @@ -23,7 +23,25 @@ paths: content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_batchNumberByBlockNumber' + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_batchNumberByBlockNumber + params: + type: array + description: | + 1. String - The block number (in hex) + minItems: 1 + maxItems: 1 + items: + type: string + pattern: '^0x[0-9a-fA-F]+$' + default: ['0x0'] responses: '200': description: Returns the batch number of the batch connected to the block. diff --git a/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml b/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml index 5c3e419e..bf3c1e8d 100644 --- a/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml +++ b/polygon-zkevm/zkevm_consolidatedBlockNumber.yaml @@ -24,7 +24,15 @@ paths: content: application/json: schema: - $ref: ../evm_body.yaml#/zkevm_consolidatedBlockNumber + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_consolidatedBlockNumber responses: '200': description: The latest block number that is connected to the latest batch verified. diff --git a/polygon-zkevm/zkevm_getBatchByNumber.yaml b/polygon-zkevm/zkevm_getBatchByNumber.yaml index e641510b..5e66375a 100644 --- a/polygon-zkevm/zkevm_getBatchByNumber.yaml +++ b/polygon-zkevm/zkevm_getBatchByNumber.yaml @@ -23,7 +23,28 @@ paths: content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_getBatchByNumber' + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_getBatchByNumber + params: + type: array + description: | + 1. String - The batch number (in hex) or batch tag + + The optional batch height descriptions are: + * `latest` - The most recent batch in the canonical chain observed by the client, this batch may be re-orged out of the canonical chain even under healthy/normal conditions. + * `earliest` - The lowest numbered batch the client has available. Intuitively, you can think of this as the first batch created. + minItems: 1 + maxItems: 1 + items: + type: string + default: ['0x0'] responses: '200': description: Returns information about the batch identified by the provided batch number or tag. diff --git a/polygon-zkevm/zkevm_getBroadcastURI.yaml b/polygon-zkevm/zkevm_getBroadcastURI.yaml index 4bd329c9..47e2042a 100644 --- a/polygon-zkevm/zkevm_getBroadcastURI.yaml +++ b/polygon-zkevm/zkevm_getBroadcastURI.yaml @@ -24,7 +24,15 @@ paths: content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_getBroadcastURI' + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_getBroadcastURI responses: '200': description: Returns the configured Broadcast URL of the Trusted Sequencer. diff --git a/polygon-zkevm/zkevm_isBlockConsolidated.yaml b/polygon-zkevm/zkevm_isBlockConsolidated.yaml index cc85991a..65332d21 100644 --- a/polygon-zkevm/zkevm_isBlockConsolidated.yaml +++ b/polygon-zkevm/zkevm_isBlockConsolidated.yaml @@ -24,7 +24,25 @@ paths: content: application/json: schema: - $ref: ../evm_body.yaml#/zkevm_isBlockConsolidated + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_isBlockConsolidated + params: + type: array + description: | + 1. String - The block number (in hex) + minItems: 1 + maxItems: 1 + items: + type: string + pattern: '^0x[0-9a-fA-F]+$' + default: ['0x0'] responses: '200': description: Returns true if the provided block number is already connected to a batch that was already verified, otherwise false. diff --git a/polygon-zkevm/zkevm_isBlockVirtualized.yaml b/polygon-zkevm/zkevm_isBlockVirtualized.yaml index b4b245d3..d8c05e6c 100644 --- a/polygon-zkevm/zkevm_isBlockVirtualized.yaml +++ b/polygon-zkevm/zkevm_isBlockVirtualized.yaml @@ -24,7 +24,25 @@ paths: content: application/json: schema: - $ref: ../evm_body.yaml#/zkevm_isBlockVirtualized + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_isBlockVirtualized + params: + type: array + description: | + 1. String - The block number (in hex) + minItems: 1 + maxItems: 1 + items: + type: string + pattern: '^0x[0-9a-fA-F]+$' + default: ['0x0'] responses: '200': description: Returns true if the provided block number is already connected to a batch that was already virtualized, otherwise false. diff --git a/polygon-zkevm/zkevm_verifiedBatchNumber.yaml b/polygon-zkevm/zkevm_verifiedBatchNumber.yaml index 59996e17..6424b274 100644 --- a/polygon-zkevm/zkevm_verifiedBatchNumber.yaml +++ b/polygon-zkevm/zkevm_verifiedBatchNumber.yaml @@ -23,7 +23,15 @@ paths: content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_verifiedBatchNumber' + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_verifiedBatchNumber responses: '200': description: Returns the latest verified batch number. diff --git a/polygon-zkevm/zkevm_virtualBatchNumber.yaml b/polygon-zkevm/zkevm_virtualBatchNumber.yaml index 3e6daedc..742a13dd 100644 --- a/polygon-zkevm/zkevm_virtualBatchNumber.yaml +++ b/polygon-zkevm/zkevm_virtualBatchNumber.yaml @@ -23,7 +23,15 @@ paths: content: application/json: schema: - $ref: '../evm_body.yaml#/zkevm_virtualBatchNumber' + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: zkevm_virtualBatchNumber responses: '200': description: Returns the latest virtual batch number. From 47761647234f5cfeb95022cd77d6236cae87dd54 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 06:13:47 +0200 Subject: [PATCH 43/47] Move debug specs out of evm_body.yaml --- debug/components.yaml | 12 +++ debug/debug_traceBlockByHash.yaml | 30 +++++- debug/debug_traceBlockByNumber.yaml | 28 +++++- debug/debug_traceCall.yaml | 42 ++++++++- debug/debug_traceTransaction.yaml | 34 ++++++- evm_body.yaml | 138 ---------------------------- 6 files changed, 142 insertions(+), 142 deletions(-) create mode 100644 debug/components.yaml diff --git a/debug/components.yaml b/debug/components.yaml new file mode 100644 index 00000000..15ef8f2f --- /dev/null +++ b/debug/components.yaml @@ -0,0 +1,12 @@ +Tracer: + type: string + default: callTracer + enum: + - callTracer + - prestateTracer + +TracerConfig: + type: object + properties: + onlyTopCall: + type: boolean \ No newline at end of file diff --git a/debug/debug_traceBlockByHash.yaml b/debug/debug_traceBlockByHash.yaml index 2b379c75..bf00d4eb 100644 --- a/debug/debug_traceBlockByHash.yaml +++ b/debug/debug_traceBlockByHash.yaml @@ -28,7 +28,35 @@ paths: content: application/json: schema: - $ref: ../evm_body.yaml#/debug_traceBlockByHash + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: debug_traceBlockByHash + params: + type: array + description: | + 1. `string` - Block hash for the block to be traced + 2. `tracer` Object - Currently supports `callTracer` and `prestateTracer` (see above for definitions). + minItems: 1 + maxItems: 1 + items: + anyOf: + - type: string + title: Block hash + description: block hash + default: '0x7bd8357213af34d3fe7f725d9b21187a5a58127e39aac5776fd0594e3391ea6e' + - type: object + title: Tracer + properties: + tracer: + $ref: './components.yaml#/Tracer' + tracerConfig: + $ref: './components.yaml#/TracerConfig' responses: '200': description: 'Returns - array of block traces' diff --git a/debug/debug_traceBlockByNumber.yaml b/debug/debug_traceBlockByNumber.yaml index 2f04f622..15798299 100644 --- a/debug/debug_traceBlockByNumber.yaml +++ b/debug/debug_traceBlockByNumber.yaml @@ -28,7 +28,33 @@ paths: content: application/json: schema: - $ref: ../evm_body.yaml#/debug_traceBlockByNumber + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: debug_traceBlockByNumber + params: + type: array + description: | + 1. String - Block number (in hex) or block tag + 2. `tracer` Object - Currently supports `callTracer` and `prestateTracer` (see above for definitions). + minItems: 1 + maxItems: 1 + items: + anyOf: + - $ref: '#/blockNumber_or_blocktag_param_eth' + title: Block Number or Block Tag + - type: object + title: tracer + properties: + tracer: + $ref: './components.yaml#/Tracer' + tracerConfig: + $ref: './components.yaml#/TracerConfig' responses: '200': description: 'Returns - array of block traces' diff --git a/debug/debug_traceCall.yaml b/debug/debug_traceCall.yaml index cfb7366f..6a80a2cb 100644 --- a/debug/debug_traceCall.yaml +++ b/debug/debug_traceCall.yaml @@ -28,7 +28,47 @@ paths: content: application/json: schema: - $ref: ../evm_body.yaml#/debug_traceCall + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: debug_traceCall + params: + type: array + minItems: 1 + maxItems: 1 + description: | + 1. `object` - Transaction Object + 2. `string` - Block Identifier: Block hash, block number (in hex), or block tag + 3. `tracer` - Object: Currently supports `callTracer` and `prestateTracer` (see above for definitions). + items: + anyOf: + - $ref: '../components/schemas.yaml#/TxObject' + title: Transaction object + - type: string + title: Block identifier + description: | + String - One of the following options: + 1. **block hash** + 2. **block number** (in hex) + 3. **block tag** (one of the following): + * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet. + * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions. + * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. + * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. + * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created. + default: finalized + - type: object + title: Tracer + properties: + tracer: + $ref: './components.yaml#/Tracer' + tracerConfig: + $ref: './components.yaml#/TracerConfig' responses: '200': description: 'Returns - Array of block traces' diff --git a/debug/debug_traceTransaction.yaml b/debug/debug_traceTransaction.yaml index 2bfdf755..94c72644 100644 --- a/debug/debug_traceTransaction.yaml +++ b/debug/debug_traceTransaction.yaml @@ -28,7 +28,39 @@ paths: content: application/json: schema: - $ref: ../evm_body.yaml#/debug_traceTransaction + type: object + properties: + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: debug_traceTransaction + params: + type: array + minItems: 1 + maxItems: 1 + description: | + 1. String - Transaction hash + 2. Object - options for call, can be any of the following options: + - `tracer`: Object - Currently supports `callTracer` and `prestateTracer` (see above for definitions). + - `timeout`: String - A duration string of decimal numbers that overrides the default timeout of 5 seconds for JavaScript-based tracing calls. Max timeout is "10s". Valid time units are "ns", "us", "ms", "s" each with optional fraction, such as "300ms" or "2s45ms". + items: + anyOf: + - $ref: '#/transactionHash_param' + - type: object + description: options for call + title: Options + properties: + tracer: + $ref: './components.yaml#/Tracer' + tracerConfig: + $ref: './components.yaml#/TracerConfig' + timeout: + type: string + description: A duration string of decimal numbers that overrides the default timeout of 5 seconds for JavaScript-based tracing calls. Max timeout is "10s". Valid time units are "ns", "us", "ms", "s" each with optional fraction, such as "300ms" or "2s45ms". + default: 5s responses: '200': description: 'Returns - transaction trace' diff --git a/evm_body.yaml b/evm_body.yaml index 56bfd86c..9ea5ff26 100644 --- a/evm_body.yaml +++ b/evm_body.yaml @@ -1165,146 +1165,8 @@ alchemy_getAssetTransfers: type: string description: 'String - UUID for pagination. If more results are available, a uuid pageKey will be returned in the response. Pass that uuid into pageKey to fetch the next 1000 or maxCount.' -# ============= Debug API Methods =============== -tracer: - type: string - default: callTracer - enum: - - callTracer - - prestateTracer -tracerConfig: - type: object - properties: - onlyTopCall: - type: boolean -debug_traceCall: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: debug_traceCall - params: - type: array - minItems: 1 - maxItems: 1 - description: | - 1. `object` - Transaction Object - 2. `string` - Block Identifier: Block hash, block number (in hex), or block tag - 3. `tracer` - Object: Currently supports `callTracer` and `prestateTracer` (see above for definitions). - items: - anyOf: - - $ref: './components/schemas.yaml#/TxObject' - title: Transaction object - - type: string - title: Block identifier - description: | - String - One of the following options: - 1. **block hash** - 2. **block number** (in hex) - 3. **block tag** (one of the following): - * `pending` - A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Intuitively, you can think of these as blocks that have not been mined yet. - * `latest` - The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions. - * `safe` - The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is “unlikely” to be re-orged. - * `finalized` - The most recent crypto-economically secure block, that has been accepted by >2/3 of validators. Cannot be re-orged outside of manual intervention driven by community coordination. Intuitively, this block is very unlikely to be re-orged. - * `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created. - default: finalized - - type: object - title: Tracer - properties: - tracer: - $ref: '#/tracer' - tracerConfig: - $ref: '#/tracerConfig' -debug_traceBlockByHash: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: debug_traceBlockByHash - params: - type: array - description: | - 1. `string` - Block hash for the block to be traced - 2. `tracer` Object - Currently supports `callTracer` and `prestateTracer` (see above for definitions). - minItems: 1 - maxItems: 1 - items: - anyOf: - - type: string - title: Block hash - description: block hash - default: '0x7bd8357213af34d3fe7f725d9b21187a5a58127e39aac5776fd0594e3391ea6e' - - type: object - title: Tracer - properties: - tracer: - $ref: '#/tracer' - tracerConfig: - $ref: '#/tracerConfig' -debug_traceBlockByNumber: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: debug_traceBlockByNumber - params: - type: array - description: | - 1. String - Block number (in hex) or block tag - 2. `tracer` Object - Currently supports `callTracer` and `prestateTracer` (see above for definitions). - minItems: 1 - maxItems: 1 - items: - anyOf: - - $ref: '#/blockNumber_or_blocktag_param_eth' - title: Block Number or Block Tag - - type: object - title: tracer - properties: - tracer: - $ref: '#/tracer' - tracerConfig: - $ref: '#/tracerConfig' -debug_traceTransaction: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: debug_traceTransaction - params: - type: array - minItems: 1 - maxItems: 1 - description: | - 1. String - Transaction hash - 2. Object - options for call, can be any of the following options: - - `tracer`: Object - Currently supports `callTracer` and `prestateTracer` (see above for definitions). - - `timeout`: String - A duration string of decimal numbers that overrides the default timeout of 5 seconds for JavaScript-based tracing calls. Max timeout is "10s". Valid time units are "ns", "us", "ms", "s" each with optional fraction, such as "300ms" or "2s45ms". - items: - anyOf: - - $ref: '#/transactionHash_param' - - type: object - description: options for call - title: Options - properties: - tracer: - $ref: '#/tracer' - tracerConfig: - $ref: '#/tracerConfig' - timeout: - type: string - description: A duration string of decimal numbers that overrides the default timeout of 5 seconds for JavaScript-based tracing calls. Max timeout is "10s". Valid time units are "ns", "us", "ms", "s" each with optional fraction, such as "300ms" or "2s45ms". - default: 5s # ============ EVM Models ============== common_request_fields: From d9822f1ba9852372a4f41cc4ec2ac5180599a64d Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 06:17:40 +0200 Subject: [PATCH 44/47] Refactor alchemy_getAssetTransfers --- evm_body.yaml | 80 ------------------------ transfers/alchemy_getAssetTransfers.yaml | 73 ++++++++++++++++++++- 2 files changed, 72 insertions(+), 81 deletions(-) diff --git a/evm_body.yaml b/evm_body.yaml index 9ea5ff26..41a902f2 100644 --- a/evm_body.yaml +++ b/evm_body.yaml @@ -1087,86 +1087,6 @@ eth_createAccessList: title: Block number or block tag default: pending -# ============= Transfers API Methods =============== -alchemy_getAssetTransfers: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: alchemy_getAssetTransfers - params: - type: array - minItems: 1 - maxItems: 1 - items: - type: object - required: - - category - properties: - fromBlock: - type: string - description: 'String - Inclusive from block (hex string, int, `latest`, or `indexed`). Defaults to `0x0`' - default: '0x0' - toBlock: - type: string - description: 'String - Inclusive to block (hex string, int, `latest`, or `indexed`). Defaults to `latest`. Read more about block tags <span class="custom-style"><a href="https://docs.alchemy.com/reference/transfers-api-quickstart#what-are-the-different-types-of-block-tags" target="_blank">here</a></span>' - default: latest - fromAddress: - type: string - description: String - From address (hex string). Default wildcard - any address - pattern: '^0[xX][0-9a-fA-F]+$' - toAddress: - type: string - description: String - To address (hex string). Default wildcard - any address - pattern: '^0[xX][0-9a-fA-F]+$' - default: '0x5c43B1eD97e52d009611D89b74fA829FE4ac56b1' - contractAddresses: - type: array - description: 'String - List of contract addresses (hex strings) to filter for - only applies to "erc20", "erc721", "erc1155" transfers. Default wildcard - any address' - items: - type: string - pattern: '^0[xX][0-9a-fA-F]+$' - category: - type: array - description: | - 'Array of categories, can be any of the following: "external", "internal", "erc20", "erc721", "erc1155", or "specialnft". See the table above for supported categories on each network.' - items: - type: string - enum: - - external - - internal - - erc20 - - erc721 - - erc1155 - - specialnft - default: ['external'] - order: - type: string - description: | - String - Whether to return results in ascending (`asc`) or descending (`desc`) order. Ascending order is from oldest to newest transactions, descending order is from newest to oldest. Defaults to `asc`. - enum: - - asc - - desc - withMetadata: - type: boolean - description: Boolean - Whether or not to include additional metadata about each transfer event. Defaults to `false`. - default: false - excludeZeroValue: - type: boolean - description: Boolean - A boolean to exclude transfers with zero value - zero value is not the same as null value. Defaults to `true`. - default: true - maxCount: - type: string - description: Max hex string number of results to return per call. Defaults to `0x3e8` (1000). - default: '0x3e8' - pageKey: - type: string - description: 'String - UUID for pagination. If more results are available, a uuid pageKey will be returned in the response. Pass that uuid into pageKey to fetch the next 1000 or maxCount.' - - - # ============ EVM Models ============== common_request_fields: diff --git a/transfers/alchemy_getAssetTransfers.yaml b/transfers/alchemy_getAssetTransfers.yaml index 129b87a1..8a3dcf72 100644 --- a/transfers/alchemy_getAssetTransfers.yaml +++ b/transfers/alchemy_getAssetTransfers.yaml @@ -29,7 +29,78 @@ paths: 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 + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: alchemy_getAssetTransfers + params: + type: array + minItems: 1 + maxItems: 1 + items: + type: object + required: + - category + properties: + fromBlock: + type: string + description: 'String - Inclusive from block (hex string, int, `latest`, or `indexed`). Defaults to `0x0`' + default: '0x0' + toBlock: + type: string + description: 'String - Inclusive to block (hex string, int, `latest`, or `indexed`). Defaults to `latest`. Read more about block tags <span class="custom-style"><a href="https://docs.alchemy.com/reference/transfers-api-quickstart#what-are-the-different-types-of-block-tags" target="_blank">here</a></span>' + default: latest + fromAddress: + type: '../components/schemas.yaml#/Address' + description: String - From address (hex string). Default wildcard - any address + toAddress: + type: '../components/schemas.yaml#/Address' + description: String - To address (hex string). Default wildcard - any address + default: '0x5c43B1eD97e52d009611D89b74fA829FE4ac56b1' + contractAddresses: + type: array + description: 'String - List of contract addresses (hex strings) to filter for - only applies to "erc20", "erc721", "erc1155" transfers. Default wildcard - any address' + items: + type: '../components/schemas.yaml#/Address' + category: + type: array + description: | + 'Array of categories, can be any of the following: "external", "internal", "erc20", "erc721", "erc1155", or "specialnft". See the table above for supported categories on each network.' + items: + type: string + enum: + - external + - internal + - erc20 + - erc721 + - erc1155 + - specialnft + default: ['external'] + order: + type: string + description: | + String - Whether to return results in ascending (`asc`) or descending (`desc`) order. Ascending order is from oldest to newest transactions, descending order is from newest to oldest. Defaults to `asc`. + enum: + - asc + - desc + withMetadata: + type: boolean + description: Boolean - Whether or not to include additional metadata about each transfer event. Defaults to `false`. + default: false + excludeZeroValue: + type: boolean + description: Boolean - A boolean to exclude transfers with zero value - zero value is not the same as null value. Defaults to `true`. + default: true + maxCount: + type: string + description: Max hex string number of results to return per call. Defaults to `0x3e8` (1000). + default: '0x3e8' + pageKey: + type: string + description: 'String - UUID for pagination. If more results are available, a uuid pageKey will be returned in the response. Pass that uuid into pageKey to fetch the next 1000 or maxCount.' responses: '200': description: '' From 106c5521ef81701fa09efb86d03fd6727d370eb5 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Thu, 19 Oct 2023 06:25:27 +0200 Subject: [PATCH 45/47] Refactor simple request bodies --- ethereum/eth_chainId.yaml | 8 ++- ethereum/eth_gasPrice.yaml | 8 ++- ethereum/eth_maxPriorityFeePerGas.yaml | 8 ++- ethereum/eth_newBlockFilter.yaml | 8 ++- ethereum/eth_protocolVersion.yaml | 8 ++- ethereum/net_listening.yaml | 8 ++- ethereum/net_version.yaml | 8 ++- ethereum/web3_clientVersion.yaml | 8 ++- ethereum/web3_sha3.yaml | 1 + evm_body.yaml | 68 ++------------------------ 10 files changed, 61 insertions(+), 72 deletions(-) diff --git a/ethereum/eth_chainId.yaml b/ethereum/eth_chainId.yaml index f9bb2c93..1d0ab445 100644 --- a/ethereum/eth_chainId.yaml +++ b/ethereum/eth_chainId.yaml @@ -26,7 +26,13 @@ components: content: application/json: schema: - $ref: ../evm_body.yaml#/eth_chainId + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: eth_chainId responses: '200': description: Returns integer of the current chain ID. diff --git a/ethereum/eth_gasPrice.yaml b/ethereum/eth_gasPrice.yaml index ecd13e83..96cda517 100644 --- a/ethereum/eth_gasPrice.yaml +++ b/ethereum/eth_gasPrice.yaml @@ -26,7 +26,13 @@ components: content: application/json: schema: - $ref: ../evm_body.yaml#/eth_gasPrice + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: eth_gasPrice x-readme: explorer-enabled: false samples-languages: diff --git a/ethereum/eth_maxPriorityFeePerGas.yaml b/ethereum/eth_maxPriorityFeePerGas.yaml index 04a521d6..e8d65304 100644 --- a/ethereum/eth_maxPriorityFeePerGas.yaml +++ b/ethereum/eth_maxPriorityFeePerGas.yaml @@ -22,7 +22,13 @@ paths: content: application/json: schema: - $ref: ../evm_body.yaml#/eth_maxPriorityFeePerGas + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: eth_maxPriorityFeePerGas responses: '200': description: Returns the estimated priority fee per gas. diff --git a/ethereum/eth_newBlockFilter.yaml b/ethereum/eth_newBlockFilter.yaml index 1dc72255..1ad26b9c 100644 --- a/ethereum/eth_newBlockFilter.yaml +++ b/ethereum/eth_newBlockFilter.yaml @@ -28,7 +28,13 @@ components: content: application/json: schema: - $ref: ../evm_body.yaml#/eth_newBlockFilter + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: eth_newBlockFilter responses: '200': description: Returns a filter id. diff --git a/ethereum/eth_protocolVersion.yaml b/ethereum/eth_protocolVersion.yaml index 6c2bc8d4..6a2a084b 100644 --- a/ethereum/eth_protocolVersion.yaml +++ b/ethereum/eth_protocolVersion.yaml @@ -26,7 +26,13 @@ components: content: application/json: schema: - $ref: ../evm_body.yaml#/eth_protocolVersion + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: eth_protocolVersion responses: '200': description: Returns the current ethereum protocol version. diff --git a/ethereum/net_listening.yaml b/ethereum/net_listening.yaml index 4a536f5e..60f75fb5 100644 --- a/ethereum/net_listening.yaml +++ b/ethereum/net_listening.yaml @@ -26,7 +26,13 @@ components: content: application/json: schema: - $ref: ../evm_body.yaml#/net_listening + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: net_listening responses: '200': description: 'Returns true when listening, otherwise false.' diff --git a/ethereum/net_version.yaml b/ethereum/net_version.yaml index 1200f738..ba6220af 100644 --- a/ethereum/net_version.yaml +++ b/ethereum/net_version.yaml @@ -26,7 +26,13 @@ components: content: application/json: schema: - $ref: ../evm_body.yaml#/net_version + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: net_version responses: '200': description: Returns the current network id. diff --git a/ethereum/web3_clientVersion.yaml b/ethereum/web3_clientVersion.yaml index 0205fc0d..c9c42840 100644 --- a/ethereum/web3_clientVersion.yaml +++ b/ethereum/web3_clientVersion.yaml @@ -26,7 +26,13 @@ components: content: application/json: schema: - $ref: ../evm_body.yaml#/web3_clientVersion + id: + $ref: ./schemas.yaml#/Id + jsonrpc: + $ref: ./schemas.yaml#/JsonRpc + method: + $ref: ./schemas.yaml#/Method + default: web3_clientVersion responses: '200': description: Returns the current client version. diff --git a/ethereum/web3_sha3.yaml b/ethereum/web3_sha3.yaml index 0ac0511d..e1261e42 100644 --- a/ethereum/web3_sha3.yaml +++ b/ethereum/web3_sha3.yaml @@ -20,6 +20,7 @@ components: post: summary: web3_sha3 - Ethereum description: Returns Keccak-256 (not the standardized SHA3-256) of the given data. + tags: [] parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: diff --git a/evm_body.yaml b/evm_body.yaml index 41a902f2..6489d939 100644 --- a/evm_body.yaml +++ b/evm_body.yaml @@ -387,22 +387,6 @@ eth_getProof: - $ref: '#/BlockNumberOrTagOrHash' title: Block Number or Block Hash or Block Tag -eth_protocolVersion: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: eth_protocolVersion -eth_gasPrice: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: eth_gasPrice eth_estimateGas_550: allOf: - $ref: '#/common_request_fields' @@ -473,38 +457,7 @@ eth_feeHistory: title: reward percentiles description: (optional) A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order, weighted by gas used. default: [25, 75] -eth_maxPriorityFeePerGas: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: eth_maxPriorityFeePerGas -eth_chainId: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: eth_chainId -net_version: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: net_version -net_listening: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: net_listening + eth_getUncleByBlockHashAndIndex: allOf: - $ref: '#/common_request_fields' @@ -569,14 +522,7 @@ eth_getFilterLogs: method: $ref: ./components/schemas.yaml#/Method default: eth_getFilterLogs -eth_newBlockFilter: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: eth_newBlockFilter + eth_newFilter: allOf: - $ref: '#/common_request_fields' @@ -591,6 +537,7 @@ eth_newFilter: maxItems: 1 items: $ref: '#/filter_options' + eth_newPendingTransactionFilter: allOf: - $ref: '#/common_request_fields' @@ -608,14 +555,7 @@ eth_uninstallFilter: method: $ref: ./components/schemas.yaml#/Method default: eth_uninstallFilter -web3_clientVersion: - allOf: - - $ref: '#/common_request_fields' - - type: object - properties: - method: - $ref: ./components/schemas.yaml#/Method - default: web3_clientVersion + web3_sha3: allOf: - $ref: '#/common_request_fields' From f509c46fbab7fe449ef1234cd460ae894dabf910 Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Fri, 20 Oct 2023 14:53:04 +0200 Subject: [PATCH 46/47] Move sample-languages --- ethereum/eth_blockNumber.yaml | 9 +++++---- ethereum/eth_call.yaml | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/ethereum/eth_blockNumber.yaml b/ethereum/eth_blockNumber.yaml index 77d205fa..f99a6116 100644 --- a/ethereum/eth_blockNumber.yaml +++ b/ethereum/eth_blockNumber.yaml @@ -12,6 +12,11 @@ servers: - eth-sepolia - eth-goerli default: eth-mainnet +x-readme: + samples-languages: + - curl + - javascript + - python paths: /{apiKey}: post: @@ -19,10 +24,6 @@ paths: summary: eth_blockNumber - Ethereum operationId: eth-blocknumber x-readme: - samples-languages: - - curl - - javascript - - python code-samples: - language: javascript name: Alchemy SDK diff --git a/ethereum/eth_call.yaml b/ethereum/eth_call.yaml index 2dcbbb87..a812b64b 100644 --- a/ethereum/eth_call.yaml +++ b/ethereum/eth_call.yaml @@ -12,6 +12,11 @@ servers: - eth-sepolia - eth-goerli default: eth-mainnet +x-readme: + samples-languages: + - curl + - javascript + - python paths: /{apiKey}: post: @@ -20,10 +25,6 @@ paths: operationId: eth-call x-readme: explorer-enabled: false - samples-languages: - - curl - - javascript - - python code-samples: - language: javascript name: Alchemy SDK From 5f8a76336996cafa627691ddc65616eac0eff02d Mon Sep 17 00:00:00 2001 From: Bastien <bastienm95@gmail.com> Date: Fri, 20 Oct 2023 14:53:11 +0200 Subject: [PATCH 47/47] Move operationId --- ethereum/eth_chainId.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ethereum/eth_chainId.yaml b/ethereum/eth_chainId.yaml index 1d0ab445..0034c240 100644 --- a/ethereum/eth_chainId.yaml +++ b/ethereum/eth_chainId.yaml @@ -20,6 +20,7 @@ components: post: summary: eth_chainId - Ethereum description: 'Returns the currently configured chain ID, a value used in replay-protected transaction signing as introduced by EIP-155.' + operationId: eth-chainId parameters: - $ref: ../components/parameters.yaml#/ApiKey requestBody: @@ -40,4 +41,3 @@ components: application/json: schema: $ref: ../evm_responses.yaml#/string_result_response - operationId: eth-chainId