Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor evm_body, evm_responses and evm_examples #262

Open
wants to merge 47 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
98fa0e5
Add custom styling
bmoyroud Oct 19, 2023
55dd694
Use ApiKey for account abstraction specs
bmoyroud Oct 19, 2023
fbe7c09
Use ApiKey for Arbitrum specs
bmoyroud Oct 19, 2023
05f1b8b
Use ApiKey for Astar spec
bmoyroud Oct 19, 2023
23475b6
Use ApiKey for Base specs
bmoyroud Oct 19, 2023
c443516
Use ApiKey for debug specs
bmoyroud Oct 19, 2023
2234013
Use ApiKey for Ethereum specs
bmoyroud Oct 19, 2023
71ee021
Use ApiKey for Optimism specs
bmoyroud Oct 19, 2023
c5fb765
Use ApiKey for Polygon PoS specs
bmoyroud Oct 19, 2023
cbdee96
Use ApiKey for Polygon zkEVM specs
bmoyroud Oct 19, 2023
1fd837f
Use ApiKey for Solana specs
bmoyroud Oct 19, 2023
b6a4af8
Use ApiKey for Starknet specs
bmoyroud Oct 19, 2023
1af5073
Use ApiKey for Token API specs
bmoyroud Oct 19, 2023
91391c0
Use ApiKey for trace specs
bmoyroud Oct 19, 2023
9138edc
Use ApiKey for transaction receipts specs
bmoyroud Oct 19, 2023
452c5c1
Use ApiKey for Transfers API spec
bmoyroud Oct 19, 2023
4cd0435
Reorder Starknet specs
bmoyroud Oct 19, 2023
8021507
Reorder trace specs
bmoyroud Oct 19, 2023
f06fd94
Reorder Token API specs
bmoyroud Oct 19, 2023
7ad1e23
Reorder tx receipt spec
bmoyroud Oct 19, 2023
155f789
Reorder Transfers API spec
bmoyroud Oct 19, 2023
6329ce8
Reorder Solana spec fields
bmoyroud Oct 19, 2023
761009e
Reorder account abstraction spec fields
bmoyroud Oct 19, 2023
a410b15
Refactor Arbitrum specs
bmoyroud Oct 19, 2023
df01f97
Refactor Astar spec
bmoyroud Oct 19, 2023
416bfb6
Refactor Base specs
bmoyroud Oct 19, 2023
7189949
Refactor debug specs
bmoyroud Oct 19, 2023
45736eb
Refactor Polygon zkEVM specs
bmoyroud Oct 19, 2023
81172cd
Refactor Polygon PoS specs
bmoyroud Oct 19, 2023
eb425ab
Refactor Optimism specs
bmoyroud Oct 19, 2023
a4aca7d
Refactor notify spec
bmoyroud Oct 19, 2023
e5cc4f1
Remove tags: []
bmoyroud Oct 19, 2023
eb827bf
Remove tags: []
bmoyroud Oct 19, 2023
74f011c
Refactor eth_accounts specs
bmoyroud Oct 19, 2023
23a7b16
Fix identation
bmoyroud Oct 19, 2023
fd45b43
Add placeholder for other path item schemas
bmoyroud Oct 19, 2023
297f076
Refactor eth_blockNumber
bmoyroud Oct 19, 2023
e5bd704
Add ref
bmoyroud Oct 19, 2023
03f740e
Start refactoring eth_call
bmoyroud Oct 19, 2023
014ffc0
Refactor BlockNumber out of evm_body.yaml
bmoyroud Oct 19, 2023
94233eb
Refactor eth_call
bmoyroud Oct 19, 2023
5dff3ab
Move zkEVM request bodies out of evm_body.yaml
bmoyroud Oct 19, 2023
4776164
Move debug specs out of evm_body.yaml
bmoyroud Oct 19, 2023
d9822f1
Refactor alchemy_getAssetTransfers
bmoyroud Oct 19, 2023
106c552
Refactor simple request bodies
bmoyroud Oct 19, 2023
f509c46
Move sample-languages
bmoyroud Oct 20, 2023
5f8a763
Move operationId
bmoyroud Oct 20, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 20 additions & 37 deletions account-abstraction/alchemy_requestGasAndPaymasterAndData.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,27 @@ servers:
default: eth-mainnet
paths:
/{apiKey}:
$ref: '#/components/pathItems/path'
components:
pathItems:
path:
post:
summary: alchemy_requestGasAndPaymasterAndData
description: Requests gas and coverage for a `UserOperation`. Returns `paymasterAndData` and gas parameters if approved, errors if not. Optionally accepts fee parameter overrides to be used in the `UserOperation`.
tags: []
parameters:
- name: apiKey
in: path
post:
summary: alchemy_requestGasAndPaymasterAndData
description: Requests gas and coverage for a `UserOperation`. Returns `paymasterAndData` and gas parameters if approved, errors if not. Optionally accepts fee parameter overrides to be used in the `UserOperation`.
operationId: alchemy-requestGasAndPaymasterAndData
parameters:
- $ref: ../components/parameters.yaml#/ApiKey
requestBody:
required: true
content:
application/json:
schema:
type: string
default: docs-demo
description: |
<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
requestBody:
required: true
$ref: ../evm_body.yaml#/alchemy_requestGasAndPaymasterAndData
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_body.yaml#/alchemy_requestGasAndPaymasterAndData
x-readme:
samples-languages:
- curl
- javascript
- python
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_responses.yaml#/alchemy_requestGasAndPaymasterAndData
operationId: alchemy-requestGasAndPaymasterAndData
$ref: ../evm_responses.yaml#/alchemy_requestGasAndPaymasterAndData
x-readme:
samples-languages:
- curl
- javascript
- python
57 changes: 20 additions & 37 deletions account-abstraction/alchemy_requestPaymasterAndData.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,27 @@ servers:
default: eth-mainnet
paths:
/{apiKey}:
$ref: '#/components/pathItems/path'
components:
pathItems:
path:
post:
summary: alchemy_requestPaymasterAndData
description: Requests coverage for a `UserOperation`. Returns `paymasterAndData` if approved, errors if not.
tags: []
parameters:
- name: apiKey
in: path
post:
summary: alchemy_requestPaymasterAndData
description: Requests coverage for a `UserOperation`. Returns `paymasterAndData` if approved, errors if not.
operationId: alchemy-requestPaymasterAndData
parameters:
- $ref: ../components/parameters.yaml#/ApiKey
requestBody:
required: true
content:
application/json:
schema:
type: string
default: docs-demo
description: |
<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
requestBody:
required: true
$ref: ../evm_body.yaml#/alchemy_requestPaymasterAndData
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_body.yaml#/alchemy_requestPaymasterAndData
x-readme:
samples-languages:
- curl
- javascript
- python
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_responses.yaml#/alchemy_requestPaymasterAndData
operationId: alchemy-requestPaymasterAndData
$ref: ../evm_responses.yaml#/alchemy_requestPaymasterAndData
x-readme:
samples-languages:
- curl
- javascript
- python
57 changes: 20 additions & 37 deletions account-abstraction/eth_estimateUserOperationGas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,27 @@ servers:
default: eth-mainnet
paths:
/{apiKey}:
$ref: '#/components/pathItems/path'
components:
pathItems:
path:
post:
summary: eth_estimateUserOperationGas
description: Estimates the gas values for a `UserOperation`.
tags: []
parameters:
- name: apiKey
in: path
post:
summary: eth_estimateUserOperationGas
description: Estimates the gas values for a `UserOperation`.
operationId: eth-estimateUserOperationGas
parameters:
- $ref: ../components/parameters.yaml#/ApiKey
requestBody:
required: true
content:
application/json:
schema:
type: string
default: docs-demo
description: |
<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
requestBody:
required: true
$ref: ../evm_body.yaml#/eth_estimateUserOperationGas
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_body.yaml#/eth_estimateUserOperationGas
x-readme:
samples-languages:
- curl
- javascript
- python
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_responses.yaml#/eth_estimateUserOperationGas
operationId: eth-estimateUserOperationGas
$ref: ../evm_responses.yaml#/eth_estimateUserOperationGas
x-readme:
samples-languages:
- curl
- javascript
- python
57 changes: 20 additions & 37 deletions account-abstraction/eth_getUserOperationByHash.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,27 @@ servers:
default: eth-mainnet
paths:
/{apiKey}:
$ref: '#/components/pathItems/path'
components:
pathItems:
path:
post:
summary: eth_getUserOperationByHash
description: Return a `UserOperation` based on a hash (`userOpHash`).
tags: []
parameters:
- name: apiKey
in: path
post:
summary: eth_getUserOperationByHash
description: Return a `UserOperation` based on a hash (`userOpHash`).
operationId: eth-getUserOperationByHash
parameters:
- $ref: ../components/parameters.yaml#/ApiKey
requestBody:
required: true
content:
application/json:
schema:
type: string
default: docs-demo
description: |
<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
requestBody:
required: true
$ref: ../evm_body.yaml#/eth_getUserOperationByHash
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_body.yaml#/eth_getUserOperationByHash
x-readme:
samples-languages:
- curl
- javascript
- python
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_responses.yaml#/eth_getUserOperationByHash
operationId: eth-getUserOperationByHash
$ref: ../evm_responses.yaml#/eth_getUserOperationByHash
x-readme:
samples-languages:
- curl
- javascript
- python
57 changes: 20 additions & 37 deletions account-abstraction/eth_getUserOperationReceipt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,27 @@ servers:
default: eth-mainnet
paths:
/{apiKey}:
$ref: '#/components/pathItems/path'
components:
pathItems:
path:
post:
summary: eth_getUserOperationReceipt
description: Get the `UserOperationReceipt` based on the `userOpHash` value.
tags: []
parameters:
- name: apiKey
in: path
post:
summary: eth_getUserOperationReceipt
description: Get the `UserOperationReceipt` based on the `userOpHash` value.
operationId: eth-getUserOperationReceipt
parameters:
- $ref: ../components/parameters.yaml#/ApiKey
requestBody:
required: true
content:
application/json:
schema:
type: string
default: docs-demo
description: |
<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
requestBody:
required: true
$ref: ../evm_body.yaml#/eth_getUserOperationReceipt
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_body.yaml#/eth_getUserOperationReceipt
x-readme:
samples-languages:
- curl
- javascript
- python
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_responses.yaml#/eth_getUserOperationReceipt
operationId: eth-getUserOperationReceipt
$ref: ../evm_responses.yaml#/eth_getUserOperationReceipt
x-readme:
samples-languages:
- curl
- javascript
- python
57 changes: 20 additions & 37 deletions account-abstraction/eth_sendUserOperation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,27 @@ servers:
default: eth-mainnet
paths:
/{apiKey}:
$ref: '#/components/pathItems/path'
components:
pathItems:
path:
post:
summary: eth_sendUserOperation
description: Sends a user operation to the given EVM network.
tags: []
parameters:
- name: apiKey
in: path
post:
summary: eth_sendUserOperation
description: Sends a user operation to the given EVM network.
operationId: eth-sendUserOperation
parameters:
- $ref: ../components/parameters.yaml#/ApiKey
requestBody:
required: true
content:
application/json:
schema:
type: string
default: docs-demo
description: |
<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
requestBody:
required: true
$ref: ../evm_body.yaml#/eth_sendUserOperation
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_body.yaml#/eth_sendUserOperation
x-readme:
samples-languages:
- curl
- javascript
- python
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: ../evm_responses.yaml#/eth_sendUserOperation
operationId: eth-sendUserOperation
$ref: ../evm_responses.yaml#/eth_sendUserOperation
x-readme:
samples-languages:
- curl
- javascript
- python
Loading