Skip to content

Commit 173d8cd

Browse files
AlvaroLukenAlvaroLuken
committed
Merge branch 'al/add-eth-simulatev1-endpoint' of github.com:AlvaroLuken/docs-openapi-specs into al/add-eth-simulatev1-endpoint
2 parents 6495529 + 7f3744e commit 173d8cd

9 files changed

+253
-121
lines changed

‎.github/workflows/sync-apis.yaml

+124-100
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Workflow to upload APIs to docs staging environment
1+
# Workflow to upload APIs to docs staging environment
22

3-
name: Sync OpenAPI definition to ReadMe staging
3+
name: Sync OpenAPI definition to ReadMe staging
44

55
# Controls when the workflow will run
66
on:
77
# Triggers the workflow on push or pull request events but only for the "main" branch
88
push:
99
branches:
1010
- main
11-
11+
1212
# Allows you to run this workflow manually from the Actions tab
1313
workflow_dispatch:
1414

@@ -27,67 +27,66 @@ jobs:
2727
- name: Setup Node.js
2828
uses: actions/setup-node@v3
2929
with:
30-
node-version: '16'
30+
node-version: '16'
3131

3232
# Install rdme globally
3333
- name: Install rdme
3434
run: npm install -g [email protected]
3535

36-
# NOTE(@peter): Turned off as we want to manually have a grouped Data field. This shouldn't be a problem
37-
# once we switch to Fern-based docs.
38-
#
39-
# Update NFT API
40-
# - name: Update NFT API
41-
# env:
42-
# README_API_KEY: ${{ secrets.README_API_KEY }}
43-
# working-directory: ./nft
44-
# run: rdme openapi nfts.yaml --key=$README_API_KEY --id=62bb5f1af2192000e16f5c93
45-
#
46-
# Update Notify API
47-
# - name: Update Notify API
48-
# env:
49-
# README_API_KEY: ${{ secrets.README_API_KEY }}
50-
# working-directory: ./notify
51-
# run: rdme openapi notify.yaml --key=$README_API_KEY --id=62d74663f3ed8d0071190eb2
52-
#
53-
# Update Transfers API
54-
# - name: Update Transfers API
55-
# env:
56-
# README_API_KEY: ${{ secrets.README_API_KEY }}
57-
# working-directory: ./transfers
58-
# run: rdme openapi alchemy_getAssetTransfers.yaml --key=$README_API_KEY --id=67ca34df40250800249a1615
59-
#
60-
# Update Prices API
61-
# - name: Update Prices API
62-
# env:
63-
# README_API_KEY: ${{ secrets.README_API_KEY }}
64-
# working-directory: ./prices
65-
# run: rdme openapi prices.yaml --key=$README_API_KEY --id=6722b04865e1af005abf91bc
66-
#
67-
# Update Transaction Receipts API
68-
# - name: Update Transaction Receipts API - alchemy_getTransactionReceipts
69-
# env:
70-
# README_API_KEY: ${{ secrets.README_API_KEY }}
71-
# working-directory: ./transaction-receipts
72-
# run: rdme openapi alchemy_getTransactionReceipts.yaml --key=$README_API_KEY --id=62d76a925edcd00083b41115
73-
#
74-
# NOTE(@peter): This is deprecated for now - this was hard moved into data/v1.
75-
# Update Blocks API
76-
# - name: Update Blocks API
77-
# env:
78-
# README_API_KEY: ${{ secrets.README_API_KEY }}
79-
# working-directory: ./blocks
80-
# run: rdme openapi blocks.yaml --key=$README_API_KEY --id=67ca622e17a5e80058eba91e
81-
82-
# Update Gas Manager Admin API
36+
# NOTE(@peter): Turned off as we want to manually have a grouped Data field. This shouldn't be a problem
37+
# once we switch to Fern-based docs.
38+
#
39+
# Update NFT API
40+
# - name: Update NFT API
41+
# env:
42+
# README_API_KEY: ${{ secrets.README_API_KEY }}
43+
# working-directory: ./nft
44+
# run: rdme openapi nfts.yaml --key=$README_API_KEY --id=62bb5f1af2192000e16f5c93
45+
#
46+
# Update Notify API
47+
# - name: Update Notify API
48+
# env:
49+
# README_API_KEY: ${{ secrets.README_API_KEY }}
50+
# working-directory: ./notify
51+
# run: rdme openapi notify.yaml --key=$README_API_KEY --id=62d74663f3ed8d0071190eb2
52+
#
53+
# Update Transfers API
54+
# - name: Update Transfers API
55+
# env:
56+
# README_API_KEY: ${{ secrets.README_API_KEY }}
57+
# working-directory: ./transfers
58+
# run: rdme openapi alchemy_getAssetTransfers.yaml --key=$README_API_KEY --id=67ca34df40250800249a1615
59+
#
60+
# Update Prices API
61+
# - name: Update Prices API
62+
# env:
63+
# README_API_KEY: ${{ secrets.README_API_KEY }}
64+
# working-directory: ./prices
65+
# run: rdme openapi prices.yaml --key=$README_API_KEY --id=6722b04865e1af005abf91bc
66+
#
67+
# Update Transaction Receipts API
68+
# - name: Update Transaction Receipts API - alchemy_getTransactionReceipts
69+
# env:
70+
# README_API_KEY: ${{ secrets.README_API_KEY }}
71+
# working-directory: ./transaction-receipts
72+
# run: rdme openapi alchemy_getTransactionReceipts.yaml --key=$README_API_KEY --id=62d76a925edcd00083b41115
73+
#
74+
# NOTE(@peter): This is deprecated for now - this was hard moved into data/v1.
75+
# Update Blocks API
76+
# - name: Update Blocks API
77+
# env:
78+
# README_API_KEY: ${{ secrets.README_API_KEY }}
79+
# working-directory: ./blocks
80+
# run: rdme openapi blocks.yaml --key=$README_API_KEY --id=67ca622e17a5e80058eba91e
81+
82+
# Update Gas Manager Admin API
8383
- name: Update Gas Manager Admin API
8484
env:
8585
README_API_KEY: ${{ secrets.README_API_KEY }}
8686
working-directory: ./account-abstraction
8787
run: rdme openapi gas_manager_admin.yaml --key=$README_API_KEY --id=648a94b656f41511b55a453b
8888

89-
90-
# Update AA APIs
89+
# Update AA APIs
9190
- name: Update AA API - alchemy_requestGasAndPaymasterAndData
9291
env:
9392
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -160,14 +159,44 @@ jobs:
160159
working-directory: ./account-abstraction
161160
run: rdme openapi alchemy_requestFeePayer.yaml --key=$README_API_KEY --id=67dc9614acaaf200248f71ea
162161

163-
# Update Embedded Accounts API
162+
# Update Embedded Accounts API
164163
- name: Update Embedded Accounts API - accounts
165164
env:
166165
README_API_KEY: ${{ secrets.README_API_KEY }}
167166
working-directory: ./accounts
168-
run: rdme openapi accounts.yaml --key=$README_API_KEY --id=65e02c093719c50070e3b97a
167+
run: rdme openapi accounts.yaml --key=$README_API_KEY --id=65e02c093719c50070e3b97a
168+
169+
- name: Update Embedded Accounts API - wallet_createAccount
170+
env:
171+
README_API_KEY: ${{ secrets.README_API_KEY }}
172+
working-directory: ./accounts
173+
run: rdme openapi wallet_createAccount.yaml --key=$README_API_KEY --id=67f434bd4a56c70043d51750
174+
175+
- name: Update Embedded Accounts API - wallet_listAccounts
176+
env:
177+
README_API_KEY: ${{ secrets.README_API_KEY }}
178+
working-directory: ./accounts
179+
run: rdme openapi wallet_listAccounts.yaml --key=$README_API_KEY --id=67f434d69d19f30070176aba
180+
181+
- name: Update Embedded Accounts API - wallet_prepareCalls
182+
env:
183+
README_API_KEY: ${{ secrets.README_API_KEY }}
184+
working-directory: ./accounts
185+
run: rdme openapi wallet_prepareCalls.yaml --key=$README_API_KEY --id=67f434ebb15dc5001e63e055
169186

170-
# Update Debug APIs
187+
- name: Update Embedded Accounts API - wallet_sendPreparedCalls
188+
env:
189+
README_API_KEY: ${{ secrets.README_API_KEY }}
190+
working-directory: ./accounts
191+
run: rdme openapi wallet_sendPreparedCalls.yaml --key=$README_API_KEY --id=67f434ff538a23001074cc8d
192+
193+
- name: Update Embedded Accounts API - wallet_requestAccount
194+
env:
195+
README_API_KEY: ${{ secrets.README_API_KEY }}
196+
working-directory: ./accounts
197+
run: rdme openapi wallet_requestAccount.yaml --key=$README_API_KEY --id=67f435141927c200189a230a
198+
199+
# Update Debug APIs
171200
- name: Update Debug API - debug_traceBlockByHash
172201
env:
173202
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -210,30 +239,29 @@ jobs:
210239
working-directory: ./debug
211240
run: rdme openapi debug_getRawReceipts.yaml --key=$README_API_KEY --id=6727c488a71b2c0071a805d5
212241

213-
# NOTE(@peter): Turned off as we want to manually have a grouped Data field. This shouldn't be a problem
214-
# once we switch to Fern-based docs.
215-
#
216-
# Update Token APIs
217-
# - name: Update Token API - alchemy_getTokenAllowance
218-
# env:
219-
# README_API_KEY: ${{ secrets.README_API_KEY }}
220-
# working-directory: ./token
221-
# run: rdme openapi alchemy_getTokenAllowance.yaml --key=$README_API_KEY --id=62d557bb6c138d007e01972e
222-
223-
# - name: Update Token API - alchemy_getTokenBalances
224-
# env:
225-
# README_API_KEY: ${{ secrets.README_API_KEY }}
226-
# working-directory: ./token
227-
# run: rdme openapi alchemy_getTokenBalances.yaml --key=$README_API_KEY --id=62d551cf2cef3a00205a5924
228-
229-
# - name: Update Token API - alchemy_getTokenMetadata
230-
# env:
231-
# README_API_KEY: ${{ secrets.README_API_KEY }}
232-
# working-directory: ./token
233-
# run: rdme openapi alchemy_getTokenMetadata.yaml --key=$README_API_KEY --id=62d5581637732c00307aec6e
234-
235-
236-
# Update Trace APIs
242+
# NOTE(@peter): Turned off as we want to manually have a grouped Data field. This shouldn't be a problem
243+
# once we switch to Fern-based docs.
244+
#
245+
# Update Token APIs
246+
# - name: Update Token API - alchemy_getTokenAllowance
247+
# env:
248+
# README_API_KEY: ${{ secrets.README_API_KEY }}
249+
# working-directory: ./token
250+
# run: rdme openapi alchemy_getTokenAllowance.yaml --key=$README_API_KEY --id=62d557bb6c138d007e01972e
251+
252+
# - name: Update Token API - alchemy_getTokenBalances
253+
# env:
254+
# README_API_KEY: ${{ secrets.README_API_KEY }}
255+
# working-directory: ./token
256+
# run: rdme openapi alchemy_getTokenBalances.yaml --key=$README_API_KEY --id=62d551cf2cef3a00205a5924
257+
258+
# - name: Update Token API - alchemy_getTokenMetadata
259+
# env:
260+
# README_API_KEY: ${{ secrets.README_API_KEY }}
261+
# working-directory: ./token
262+
# run: rdme openapi alchemy_getTokenMetadata.yaml --key=$README_API_KEY --id=62d5581637732c00307aec6e
263+
264+
# Update Trace APIs
237265
- name: Update Trace API - trace_block
238266
env:
239267
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -282,8 +310,7 @@ jobs:
282310
working-directory: ./trace
283311
run: rdme openapi trace_transaction.yaml --key=$README_API_KEY --id=62e0cdd38dfdce003924d062
284312

285-
286-
# Update Transact APIs
313+
# Update Transact APIs
287314
- name: Update Transact API - alchemy_getGasOptimizedTransactionStatus
288315
env:
289316
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -332,8 +359,7 @@ jobs:
332359
working-directory: ./transact
333360
run: rdme openapi eth_sendPrivateTransaction.yaml --key=$README_API_KEY --id=62d6beb6c58877026441688c
334361

335-
336-
# Update Ethereum APIs
362+
# Update Ethereum APIs
337363
- name: Update Ethereum API - eth_createAccessList
338364
env:
339365
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -580,8 +606,7 @@ jobs:
580606
working-directory: ./ethereum
581607
run: rdme openapi eth_simulateV1.yaml --key=$README_API_KEY --id=67f44614304e6c004147ece2
582608

583-
584-
# Update Polygon PoS APIs
609+
# Update Polygon PoS APIs
585610
- name: Update Polygon PoS API - eth_createAccessList
586611
env:
587612
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -858,7 +883,7 @@ jobs:
858883
working-directory: ./polygon-pos
859884
run: rdme openapi eth_maxPriorityFeePerGas.yaml --key=$README_API_KEY --id=66450f53f4b6e9002412113d
860885

861-
# Update Arbitrum APIs
886+
# Update Arbitrum APIs
862887
- name: Update Arbitrum API - eth_accounts
863888
env:
864889
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1093,7 +1118,7 @@ jobs:
10931118
working-directory: ./arbitrum
10941119
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478bf4f226da0052ab0376
10951120

1096-
# Update Optimism APIs
1121+
# Update Optimism APIs
10971122
- name: Update Optimism API - eth_accounts
10981123
env:
10991124
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1321,8 +1346,8 @@ jobs:
13211346
README_API_KEY: ${{ secrets.README_API_KEY }}
13221347
working-directory: ./optimism
13231348
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478d4cf5fb9e006b384bdc
1324-
1325-
# Update Base APIs
1349+
1350+
# Update Base APIs
13261351
- name: Update Base API - eth_accounts
13271352
env:
13281353
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1557,7 +1582,7 @@ jobs:
15571582
working-directory: ./base
15581583
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478d8a5ae4f200302a5134
15591584

1560-
# Update Polygon zkEVM APIs
1585+
# Update Polygon zkEVM APIs
15611586
- name: Update Polygon zkEVM API - eth_blockNumber
15621587
env:
15631588
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1809,7 +1834,7 @@ jobs:
18091834
README_API_KEY: ${{ secrets.README_API_KEY }}
18101835
working-directory: ./polygon-zkevm
18111836
run: rdme openapi eth_protocolVersion.yaml --key=$README_API_KEY --id=6421e143fe648e088d9b4f23
1812-
1837+
18131838
- name: Update Polygon zkEVM API - zkevm_estimateFee
18141839
env:
18151840
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1822,8 +1847,7 @@ jobs:
18221847
working-directory: ./polygon-zkevm
18231848
run: rdme openapi zkevm_estimateGasPrice.yaml --key=$README_API_KEY --id=661e8a3744fc0500449f8f59
18241849

1825-
1826-
# Update Astar APIs
1850+
# Update Astar APIs
18271851
- name: Update Astar API - eth_accounts
18281852
env:
18291853
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2016,7 +2040,7 @@ jobs:
20162040
working-directory: ./astar
20172041
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478dbfb3284d001bbc2275
20182042

2019-
# Update Solana APIs
2043+
# Update Solana APIs
20202044
- name: Update Solana API - simulateTransaction
20212045
env:
20222046
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2292,14 +2316,14 @@ jobs:
22922316
README_API_KEY: ${{ secrets.README_API_KEY }}
22932317
working-directory: ./solana
22942318
run: rdme openapi getRecentBlockhash.yaml --key=$README_API_KEY --id=65b40be89801a0001c5f3b19
2295-
2319+
22962320
- name: Update Solana API - getRecentPrioritizationFees
22972321
env:
22982322
README_API_KEY: ${{ secrets.README_API_KEY }}
22992323
working-directory: ./solana
23002324
run: rdme openapi getRecentPrioritizationFees.yaml --key=$README_API_KEY --id=6626a026ea0e350010d6a42e
23012325

2302-
# Update Starknet APIs
2326+
# Update Starknet APIs
23032327
- name: Update Starknet API - starknet_addDeclareTransaction
23042328
env:
23052329
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2450,7 +2474,7 @@ jobs:
24502474
working-directory: ./starknet
24512475
run: rdme openapi starknet_getClass.yaml --key=$README_API_KEY --id=6440711368d835000b7711a0
24522476

2453-
# Update zkSync APIs
2477+
# Update zkSync APIs
24542478
- name: Update zkSync API - eth_accounts
24552479
env:
24562480
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2468,7 +2492,7 @@ jobs:
24682492
README_API_KEY: ${{ secrets.README_API_KEY }}
24692493
working-directory: ./zkSync
24702494
run: rdme openapi eth_call.yaml --key=$README_API_KEY --id=65e8aabb65335a0053fefb98
2471-
2495+
24722496
- name: Update zkSync API - eth_chainId
24732497
env:
24742498
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2528,7 +2552,7 @@ jobs:
25282552
README_API_KEY: ${{ secrets.README_API_KEY }}
25292553
working-directory: ./zkSync
25302554
run: rdme openapi eth_getBlockTransactionCountByHash.yaml --key=$README_API_KEY --id=65ecc438e846970073400ae9
2531-
2555+
25322556
- name: Update zkSync API - eth_getBlockTransactionCountByNumber
25332557
env:
25342558
README_API_KEY: ${{ secrets.README_API_KEY }}

0 commit comments

Comments
 (0)