Skip to content

Commit 20e9993

Browse files
moldy530moldy530
authored
docs: update the wallet_ methods to match expecations in parser script (#482)
1 parent be86262 commit 20e9993

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 rdme@8.6.4
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=67f42a071b2ed2000fe43664
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=67f42a73b8d375005371bee4
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=67f42a871b2ed2000fe43c36
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=67f42ab1538a23001074ae82
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=67f42a9efe1c72002a20e949
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 }}
@@ -574,8 +600,7 @@ jobs:
574600
working-directory: ./ethereum
575601
run: rdme openapi eth_getTransactionByBlockNumberAndIndex.yaml --key=$README_API_KEY --id=62d85761c50d8b00730dc6ce
576602

577-
578-
# Update Polygon PoS APIs
603+
# Update Polygon PoS APIs
579604
- name: Update Polygon PoS API - eth_createAccessList
580605
env:
581606
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -852,7 +877,7 @@ jobs:
852877
working-directory: ./polygon-pos
853878
run: rdme openapi eth_maxPriorityFeePerGas.yaml --key=$README_API_KEY --id=66450f53f4b6e9002412113d
854879

855-
# Update Arbitrum APIs
880+
# Update Arbitrum APIs
856881
- name: Update Arbitrum API - eth_accounts
857882
env:
858883
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1087,7 +1112,7 @@ jobs:
10871112
working-directory: ./arbitrum
10881113
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478bf4f226da0052ab0376
10891114

1090-
# Update Optimism APIs
1115+
# Update Optimism APIs
10911116
- name: Update Optimism API - eth_accounts
10921117
env:
10931118
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1315,8 +1340,8 @@ jobs:
13151340
README_API_KEY: ${{ secrets.README_API_KEY }}
13161341
working-directory: ./optimism
13171342
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478d4cf5fb9e006b384bdc
1318-
1319-
# Update Base APIs
1343+
1344+
# Update Base APIs
13201345
- name: Update Base API - eth_accounts
13211346
env:
13221347
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1551,7 +1576,7 @@ jobs:
15511576
working-directory: ./base
15521577
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478d8a5ae4f200302a5134
15531578

1554-
# Update Polygon zkEVM APIs
1579+
# Update Polygon zkEVM APIs
15551580
- name: Update Polygon zkEVM API - eth_blockNumber
15561581
env:
15571582
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1803,7 +1828,7 @@ jobs:
18031828
README_API_KEY: ${{ secrets.README_API_KEY }}
18041829
working-directory: ./polygon-zkevm
18051830
run: rdme openapi eth_protocolVersion.yaml --key=$README_API_KEY --id=6421e143fe648e088d9b4f23
1806-
1831+
18071832
- name: Update Polygon zkEVM API - zkevm_estimateFee
18081833
env:
18091834
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -1816,8 +1841,7 @@ jobs:
18161841
working-directory: ./polygon-zkevm
18171842
run: rdme openapi zkevm_estimateGasPrice.yaml --key=$README_API_KEY --id=661e8a3744fc0500449f8f59
18181843

1819-
1820-
# Update Astar APIs
1844+
# Update Astar APIs
18211845
- name: Update Astar API - eth_accounts
18221846
env:
18231847
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2010,7 +2034,7 @@ jobs:
20102034
working-directory: ./astar
20112035
run: rdme openapi eth_getBlockReceipts.yaml --key=$README_API_KEY --id=66478dbfb3284d001bbc2275
20122036

2013-
# Update Solana APIs
2037+
# Update Solana APIs
20142038
- name: Update Solana API - simulateTransaction
20152039
env:
20162040
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2286,14 +2310,14 @@ jobs:
22862310
README_API_KEY: ${{ secrets.README_API_KEY }}
22872311
working-directory: ./solana
22882312
run: rdme openapi getRecentBlockhash.yaml --key=$README_API_KEY --id=65b40be89801a0001c5f3b19
2289-
2313+
22902314
- name: Update Solana API - getRecentPrioritizationFees
22912315
env:
22922316
README_API_KEY: ${{ secrets.README_API_KEY }}
22932317
working-directory: ./solana
22942318
run: rdme openapi getRecentPrioritizationFees.yaml --key=$README_API_KEY --id=6626a026ea0e350010d6a42e
22952319

2296-
# Update Starknet APIs
2320+
# Update Starknet APIs
22972321
- name: Update Starknet API - starknet_addDeclareTransaction
22982322
env:
22992323
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2444,7 +2468,7 @@ jobs:
24442468
working-directory: ./starknet
24452469
run: rdme openapi starknet_getClass.yaml --key=$README_API_KEY --id=6440711368d835000b7711a0
24462470

2447-
# Update zkSync APIs
2471+
# Update zkSync APIs
24482472
- name: Update zkSync API - eth_accounts
24492473
env:
24502474
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2462,7 +2486,7 @@ jobs:
24622486
README_API_KEY: ${{ secrets.README_API_KEY }}
24632487
working-directory: ./zkSync
24642488
run: rdme openapi eth_call.yaml --key=$README_API_KEY --id=65e8aabb65335a0053fefb98
2465-
2489+
24662490
- name: Update zkSync API - eth_chainId
24672491
env:
24682492
README_API_KEY: ${{ secrets.README_API_KEY }}
@@ -2522,7 +2546,7 @@ jobs:
25222546
README_API_KEY: ${{ secrets.README_API_KEY }}
25232547
working-directory: ./zkSync
25242548
run: rdme openapi eth_getBlockTransactionCountByHash.yaml --key=$README_API_KEY --id=65ecc438e846970073400ae9
2525-
2549+
25262550
- name: Update zkSync API - eth_getBlockTransactionCountByNumber
25272551
env:
25282552
README_API_KEY: ${{ secrets.README_API_KEY }}

0 commit comments

Comments
 (0)