Skip to content

Commit b297310

Browse files
committed
add and modify eth_getBlockReceipts for EVM networks
1 parent 8fe9411 commit b297310

8 files changed

+284
-11
lines changed

.github/workflows/sync-apis.yaml

+31-6
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ jobs:
282282
run: rdme openapi eth_sendPrivateTransaction.yaml --key=$README_API_KEY --id=62d6beb6c58877026441688c
283283

284284

285-
# Update Ethereum APIs
285+
# Update Ethereum APIs
286286
- name: Update Ethereum API - eth_createAccessList
287287
env:
288288
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -524,7 +524,7 @@ jobs:
524524
run: rdme openapi eth_getTransactionByBlockNumberAndIndex.yaml --key=$README_API_KEY --id=62d85761c50d8b00730dc6ce
525525

526526

527-
# Update Polygon PoS APIs
527+
# Update Polygon PoS APIs
528528
- name: Update Polygon PoS API - eth_createAccessList
529529
env:
530530
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -789,6 +789,11 @@ jobs:
789789
working-directory: ./polygon-pos
790790
run: rdme openapi eth_estimateGas.yaml --key=$README_API_KEY --id=62d829e641abed0013809424
791791

792+
- name: Update Polygon PoS API - eth_getBlockReceipts
793+
env:
794+
README_API_KEY: ${{ secrets.README_API_KEY }}
795+
working-directory: ./polygon-pos
796+
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478bb129ff720025c9a648
792797

793798
# Update Arbitrum APIs
794799
- name: Update Arbitrum API - eth_accounts
@@ -1019,8 +1024,13 @@ jobs:
10191024
working-directory: ./arbitrum
10201025
run: rdme openapi eth_getUncleByBlockHashAndIndex.yaml --key=$README_API_KEY --id=6549ec1d353781003ef523e7
10211026

1027+
- name: Update Arbitrum API - eth_getBlockReceipts
1028+
env:
1029+
README_API_KEY: ${{ secrets.README_API_KEY }}
1030+
working-directory: ./arbitrum
1031+
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478bf4f226da0052ab0376
10221032

1023-
# Update Optimism APIs
1033+
# Update Optimism APIs
10241034
- name: Update Optimism API - eth_accounts
10251035
env:
10261036
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1243,8 +1253,13 @@ jobs:
12431253
working-directory: ./optimism
12441254
run: rdme openapi eth_call.yaml --key=$README_API_KEY --id=62d953c76ccd56004569e216
12451255

1256+
- name: Update Optimism API - eth_getBlockReceipts
1257+
env:
1258+
README_API_KEY: ${{ secrets.README_API_KEY }}
1259+
working-directory: ./optimism
1260+
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478d4cf5fb9e006b384bdc
12461261

1247-
# Update Base APIs
1262+
# Update Base APIs
12481263
- name: Update Base API - eth_accounts
12491264
env:
12501265
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1473,6 +1488,11 @@ jobs:
14731488
working-directory: ./base
14741489
run: rdme openapi web3_sha3.yaml --key=$README_API_KEY --id=64db9bf4b9b936004d709d89
14751490

1491+
- name: Update Base API - eth_getBlockReceipts
1492+
env:
1493+
README_API_KEY: ${{ secrets.README_API_KEY }}
1494+
working-directory: ./base
1495+
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478d8a5ae4f200302a5134
14761496

14771497
# Update Polygon zkEVM APIs
14781498
- name: Update Polygon zkEVM API - eth_blockNumber
@@ -1927,8 +1947,13 @@ jobs:
19271947
working-directory: ./astar
19281948
run: rdme openapi eth_uninstallFilter.yaml --key=$README_API_KEY --id=643eca95b0ef80002e25fc91
19291949

1950+
- name: Update Astar API - eth_getBlockReceipts
1951+
env:
1952+
README_API_KEY: ${{ secrets.README_API_KEY }}
1953+
working-directory: ./astar
1954+
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478dbfb3284d001bbc2275
19301955

1931-
# Update Solana APIs
1956+
# Update Solana APIs
19321957
- name: Update Solana API - simulateTransaction
19331958
env:
19341959
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2211,7 +2236,7 @@ jobs:
22112236
working-directory: ./solana
22122237
run: rdme openapi getRecentPrioritizationFees.yaml --key=$README_API_KEY --id=6626a026ea0e350010d6a42e
22132238

2214-
# Update Starknet APIs
2239+
# Update Starknet APIs
22152240
- name: Update Starknet API - starknet_addDeclareTransaction
22162241
env:
22172242
README_API_KEY: ${{ secrets.README_API_KEY }}

arbitrum/eth_getBlockReceipts.yaml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
openapi: 3.1.0
2+
info:
3+
title: eth_getBlockReceipts - Arbitrum
4+
version: '1.0'
5+
servers:
6+
- url: 'https://{network}.g.alchemy.com/v2/'
7+
variables:
8+
network:
9+
enum:
10+
- arb-mainnet
11+
- arb-sepolia
12+
default: arb-mainnet
13+
x-sandbox:
14+
category:
15+
type:
16+
$ref: '../components/sandbox.yaml#/Category'
17+
value: core
18+
paths:
19+
/{apiKey}:
20+
post:
21+
summary: eth_getBlockReceipts - Arbitrum
22+
description: Get all transaction receipts for a given block on Arbitrum.
23+
tags: []
24+
parameters:
25+
- name: apiKey
26+
in: path
27+
schema:
28+
type: string
29+
default: docs-demo
30+
description: |
31+
<style>
32+
.custom-style {
33+
color: #048FF4;
34+
}
35+
</style>
36+
For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span>
37+
required: true
38+
requestBody:
39+
content:
40+
application/json:
41+
schema:
42+
$ref: ../evm_body.yaml#/eth_getBlockReceipts
43+
responses:
44+
'200':
45+
description: ''
46+
content:
47+
application/json:
48+
schema:
49+
$ref: ../evm_responses.yaml#/eth_getBlockReceipts
50+
operationId: eth-getBlockReceipts-arbitrum

astar/eth_getBlockReceipts.yaml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
openapi: 3.1.0
2+
info:
3+
title: eth_getBlockReceipts - Astar
4+
version: '1.0'
5+
servers:
6+
- url: 'https://astar-mainnet.g.alchemy.com/v2'
7+
x-sandbox:
8+
category:
9+
type:
10+
$ref: '../components/sandbox.yaml#/Category'
11+
value: core
12+
paths:
13+
/{apiKey}:
14+
post:
15+
summary: eth_getBlockReceipts - Astar
16+
description: Get all transaction receipts for a given block on Astar.
17+
tags: []
18+
parameters:
19+
- name: apiKey
20+
in: path
21+
schema:
22+
type: string
23+
default: docs-demo
24+
description: |
25+
<style>
26+
.custom-style {
27+
color: #048FF4;
28+
}
29+
</style>
30+
For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span>
31+
required: true
32+
requestBody:
33+
content:
34+
application/json:
35+
schema:
36+
$ref: ../evm_body.yaml#/eth_getBlockReceipts
37+
responses:
38+
'200':
39+
description: ''
40+
content:
41+
application/json:
42+
schema:
43+
$ref: ../evm_responses.yaml#/eth_getBlockReceipts
44+
operationId: eth-getBlockReceipts-astar

base/eth_getBlockReceipts.yaml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
openapi: 3.1.0
2+
info:
3+
title: eth_getBlockReceipts - Base
4+
version: '1.0'
5+
servers:
6+
- url: https://{network}.g.alchemy.com/v2
7+
variables:
8+
network:
9+
enum:
10+
- base-mainnet
11+
- base-sepolia
12+
default: base-mainnet
13+
x-sandbox:
14+
category:
15+
type:
16+
$ref: '../components/sandbox.yaml#/Category'
17+
value: core
18+
paths:
19+
/{apiKey}:
20+
post:
21+
summary: eth_getBlockReceipts - Base
22+
description: Get all transaction receipts for a given block on Base.
23+
tags: []
24+
parameters:
25+
- name: apiKey
26+
in: path
27+
schema:
28+
type: string
29+
default: docs-demo
30+
description: |
31+
<style>
32+
.custom-style {
33+
color: #048FF4;
34+
}
35+
</style>
36+
For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span>
37+
required: true
38+
requestBody:
39+
content:
40+
application/json:
41+
schema:
42+
$ref: ../evm_body.yaml#/eth_getBlockReceipts
43+
responses:
44+
'200':
45+
description: ''
46+
content:
47+
application/json:
48+
schema:
49+
$ref: ../evm_responses.yaml#/eth_getBlockReceipts
50+
operationId: eth-getBlockReceipts-base

evm_body.yaml

+8-4
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,11 @@ eth_getBlockReceipts:
247247
$ref: ./components/schemas.yaml#/Method
248248
default: eth_getBlockReceipts
249249
params:
250-
$ref: '#/blockNumber_or_blockHash_param_eth'
250+
type: array
251+
minItems: 1
252+
maxItems: 1
253+
items:
254+
$ref: '#/blockNumber_or_blockHash_param_eth'
251255

252256
eth_sendRawTransaction:
253257
allOf:
@@ -2059,14 +2063,14 @@ blockNumber_or_blockHash_param_eth:
20592063
3. **block tag** (one of the following):
20602064
* `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.
20612065
* `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.
2062-
* `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.
2063-
* `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.
2066+
* `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 (not applicable for zkSync, Astar, Polygon PoS & Polygon zkEVM).
2067+
* `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 (not applicable for Astar, Polygon PoS & Polygon zkEVM).
20642068
* `earliest` - The lowest numbered block the client has available. Intuitively, you can think of this as the first block created.
20652069
minItems: 1
20662070
maxItems: 1
20672071
items:
20682072
type: string
2069-
default: 'latest'
2073+
default: 'finalized'
20702074
blockNumber_or_blockHash_param_l2:
20712075
type: object
20722076
title: Block Number or Hash

optimism/eth_getBlockReceipts.yaml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
openapi: 3.1.0
2+
info:
3+
title: eth_getBlockReceipts - Optimism
4+
version: '1.0'
5+
servers:
6+
- url: 'https://{network}.g.alchemy.com/v2/'
7+
variables:
8+
network:
9+
enum:
10+
- opt-mainnet
11+
- opt-sepolia
12+
default: opt-mainnet
13+
x-sandbox:
14+
category:
15+
type:
16+
$ref: '../components/sandbox.yaml#/Category'
17+
value: core
18+
paths:
19+
/{apiKey}:
20+
post:
21+
summary: eth_getBlockReceipts - Optimism
22+
description: Get all transaction receipts for a given block on Optimism.
23+
tags: []
24+
parameters:
25+
- name: apiKey
26+
in: path
27+
schema:
28+
type: string
29+
default: docs-demo
30+
description: |
31+
<style>
32+
.custom-style {
33+
color: #048FF4;
34+
}
35+
</style>
36+
For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span>
37+
required: true
38+
requestBody:
39+
content:
40+
application/json:
41+
schema:
42+
$ref: ../evm_body.yaml#/eth_getBlockReceipts
43+
responses:
44+
'200':
45+
description: ''
46+
content:
47+
application/json:
48+
schema:
49+
$ref: ../evm_responses.yaml#/eth_getBlockReceipts
50+
operationId: eth-getBlockReceipts-optimism

polygon-pos/eth_getBlockReceipts.yaml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
openapi: 3.1.0
2+
info:
3+
title: eth_getBlockReceipts - Polygon PoS
4+
version: '1.0'
5+
servers:
6+
- url: 'https://{network}.g.alchemy.com/v2/'
7+
variables:
8+
network:
9+
enum:
10+
- polygon-mainnet
11+
- polygon-amoy
12+
default: polygon-mainnet
13+
x-sandbox:
14+
category:
15+
type:
16+
$ref: '../components/sandbox.yaml#/Category'
17+
value: core
18+
paths:
19+
/{apiKey}:
20+
post:
21+
summary: eth_getBlockReceipts - Polygon PoS
22+
description: Get all transaction receipts for a given block on Polygon.
23+
tags: []
24+
parameters:
25+
- name: apiKey
26+
in: path
27+
schema:
28+
type: string
29+
default: docs-demo
30+
description: |
31+
<style>
32+
.custom-style {
33+
color: #048FF4;
34+
}
35+
</style>
36+
For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span>
37+
required: true
38+
requestBody:
39+
content:
40+
application/json:
41+
schema:
42+
$ref: ../evm_body.yaml#/eth_getBlockReceipts
43+
responses:
44+
'200':
45+
description: ''
46+
content:
47+
application/json:
48+
schema:
49+
$ref: ../evm_responses.yaml#/eth_getBlockReceipts
50+
operationId: eth-getBlockReceipts-polygon-pos

zkSync/eth_getBlockReceipts.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ paths:
1919
/{apiKey}:
2020
post:
2121
summary: eth_getBlockReceipts - zkSync
22-
description: Get all transaction receipts for a given block on Ethereum.
22+
description: Get all transaction receipts for a given block on zkSync.
2323
tags: []
2424
parameters:
2525
- name: apiKey

0 commit comments

Comments
 (0)