@avalabs/glacier-sdk 2.8.0-alpha.120 → 2.8.0-alpha.122

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/dist/index.d.ts +547 -589
  2. package/dist/index.js +137 -145
  3. package/esm/generated/models/ChainInfo.d.ts +1 -4
  4. package/esm/generated/models/CompletedValidatorDetails.d.ts +15 -0
  5. package/esm/generated/models/CreateEvmTransactionExportRequest.d.ts +8 -0
  6. package/esm/generated/models/CreatePrimaryNetworkTransactionExportRequest.d.ts +8 -0
  7. package/esm/generated/models/Erc1155TokenBalance.d.ts +1 -2
  8. package/esm/generated/models/Erc20Token.d.ts +1 -3
  9. package/esm/generated/models/Erc20TokenBalance.d.ts +2 -5
  10. package/esm/generated/models/GetChainResponse.d.ts +1 -4
  11. package/esm/generated/models/GetNetworkDetailsResponse.d.ts +2 -2
  12. package/esm/generated/models/GetTransactionResponse.d.ts +1 -7
  13. package/esm/generated/models/HistoricalReward.d.ts +24 -0
  14. package/esm/generated/models/ListCollectibleBalancesResponse.d.ts +1 -2
  15. package/esm/generated/models/ListHistoricalRewardsResponse.d.ts +11 -0
  16. package/esm/generated/models/{ListListingsResponse.d.ts → ListPendingRewardsResponse.d.ts} +4 -4
  17. package/esm/generated/models/ListValidatorDetailsResponse.d.ts +11 -0
  18. package/esm/generated/models/Method.d.ts +1 -7
  19. package/esm/generated/models/NativeTokenBalance.d.ts +2 -5
  20. package/esm/generated/models/NetworkToken.d.ts +1 -3
  21. package/esm/generated/models/NetworkTokenDetails.d.ts +1 -3
  22. package/esm/generated/models/PChainBalance.d.ts +13 -0
  23. package/esm/generated/models/PChainSharedAsset.d.ts +8 -0
  24. package/esm/generated/models/PendingReward.d.ts +22 -0
  25. package/esm/generated/models/PrimaryNetworkChainInfo.d.ts +2 -5
  26. package/esm/generated/models/PrimaryNetworkOptions.d.ts +1 -0
  27. package/esm/generated/models/PrimaryNetworkTxType.d.ts +19 -0
  28. package/esm/generated/models/PrimaryNetworkTxType.js +20 -0
  29. package/esm/generated/models/Rewards.d.ts +6 -0
  30. package/esm/generated/models/RichAddress.d.ts +1 -3
  31. package/esm/generated/models/StakingDistribution.d.ts +1 -1
  32. package/esm/generated/models/TransactionDetails.d.ts +1 -7
  33. package/esm/generated/models/TransactionExportMetadata.d.ts +1 -4
  34. package/esm/generated/models/ValidationStatusType.d.ts +5 -0
  35. package/esm/generated/models/ValidationStatusType.js +6 -0
  36. package/esm/generated/models/XChainBalances.d.ts +2 -2
  37. package/esm/generated/services/EvmService.d.ts +105 -259
  38. package/esm/generated/services/EvmService.js +1 -92
  39. package/esm/generated/services/HealthCheckService.d.ts +1 -1
  40. package/esm/generated/services/OperationsService.d.ts +5 -1
  41. package/esm/generated/services/PrimaryNetworkService.d.ts +222 -62
  42. package/esm/generated/services/PrimaryNetworkService.js +111 -3
  43. package/esm/index.d.ts +10 -18
  44. package/esm/index.js +2 -7
  45. package/package.json +2 -2
  46. package/esm/generated/models/Address.d.ts +0 -8
  47. package/esm/generated/models/CancelListingEventResponse.d.ts +0 -5
  48. package/esm/generated/models/CloseAuctionEventResponse.d.ts +0 -6
  49. package/esm/generated/models/ListingCurrencyType.d.ts +0 -6
  50. package/esm/generated/models/ListingCurrencyType.js +0 -7
  51. package/esm/generated/models/ListingEventType.d.ts +0 -8
  52. package/esm/generated/models/ListingEventType.js +0 -9
  53. package/esm/generated/models/ListingResponse.d.ts +0 -19
  54. package/esm/generated/models/ListingType.d.ts +0 -6
  55. package/esm/generated/models/ListingType.js +0 -7
  56. package/esm/generated/models/ListingsSortByOption.d.ts +0 -5
  57. package/esm/generated/models/ListingsSortByOption.js +0 -6
  58. package/esm/generated/models/NftFilterOptionsProperty.d.ts +0 -10
  59. package/esm/generated/models/NftSearchBody.d.ts +0 -10
  60. package/esm/generated/models/NftSearchResultTypeOption.d.ts +0 -6
  61. package/esm/generated/models/NftSearchResultTypeOption.js +0 -7
  62. package/esm/generated/models/OpenListingEventResponse.d.ts +0 -17
  63. package/esm/generated/models/PaginationParams.d.ts +0 -13
  64. package/esm/generated/models/PrimaryNetwork.d.ts +0 -6
  65. package/esm/generated/models/PrimaryNetwork.js +0 -7
  66. package/esm/generated/models/PrimaryNetworkChainName.d.ts +0 -7
  67. package/esm/generated/models/PrimaryNetworkChainName.js +0 -8
  68. package/esm/generated/models/PurchaseListingEventResponse.d.ts +0 -17
  69. package/esm/generated/models/TokenWithPrice.d.ts +0 -28
@@ -15,18 +15,13 @@ import { ListErc20TransactionsResponse } from '../models/ListErc20TransactionsRe
15
15
  import { ListErc721BalancesResponse } from '../models/ListErc721BalancesResponse.js';
16
16
  import { ListErc721TransactionsResponse } from '../models/ListErc721TransactionsResponse.js';
17
17
  import { ListEvmBlocksResponse } from '../models/ListEvmBlocksResponse.js';
18
- import { ListingEventType } from '../models/ListingEventType.js';
19
- import { ListingsSortByOption } from '../models/ListingsSortByOption.js';
20
18
  import { ListInternalTransactionsResponse } from '../models/ListInternalTransactionsResponse.js';
21
- import { ListListingsResponse } from '../models/ListListingsResponse.js';
22
19
  import { ListNativeTransactionsResponse } from '../models/ListNativeTransactionsResponse.js';
23
20
  import { ListNftCollectionWithMetricsResponse } from '../models/ListNftCollectionWithMetricsResponse.js';
24
21
  import { ListTransactionDetailsResponse } from '../models/ListTransactionDetailsResponse.js';
25
22
  import { ListTransfersResponse } from '../models/ListTransfersResponse.js';
26
23
  import { NetworkType } from '../models/NetworkType.js';
27
- import { NftCollection } from '../models/NftCollection.js';
28
24
  import { NftCollectionWithMetrics } from '../models/NftCollectionWithMetrics.js';
29
- import { NftSearchBody } from '../models/NftSearchBody.js';
30
25
  import { SortOrder } from '../models/SortOrder.js';
31
26
  import { TransactionStatus } from '../models/TransactionStatus.js';
32
27
  import { TrendingTimeframe } from '../models/TrendingTimeframe.js';
@@ -37,14 +32,16 @@ declare class EvmService {
37
32
  readonly httpRequest: BaseHttpRequest;
38
33
  constructor(httpRequest: BaseHttpRequest);
39
34
  /**
40
- * Get native token balance of a wallet address for a given chain.
35
+ * Get native token balance
36
+ * Gets native token balance of a wallet address.
37
+ *
38
+ * Balance at a given block can be retrieved with the `blockNumber` parameter.
41
39
  * @returns GetNativeBalanceResponse
42
40
  * @throws ApiError
43
41
  */
44
42
  getNativeBalance({ chainId, address, blockNumber, currency, }: {
45
43
  /**
46
- * A supported evm chain id. Use the `/chains` endpoint to get
47
- * a list of supported chain ids.
44
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
48
45
  */
49
46
  chainId: string;
50
47
  /**
@@ -61,14 +58,18 @@ declare class EvmService {
61
58
  currency?: CurrencyCode;
62
59
  }): CancelablePromise<GetNativeBalanceResponse>;
63
60
  /**
64
- * List ERC-20 token balances of a wallet address for a given chain.
61
+ * List ERC-20 balances
62
+ * Lists ERC-20 token balances of a wallet address.
63
+ *
64
+ * Balance at a given block can be retrieved with the `blockNumber` parameter.
65
+ *
66
+ * Balance for specific contracts can be retrieved with the `contractAddresses` parameter.
65
67
  * @returns ListErc20BalancesResponse
66
68
  * @throws ApiError
67
69
  */
68
70
  listErc20Balances({ chainId, address, blockNumber, pageSize, pageToken, contractAddresses, currency, }: {
69
71
  /**
70
- * A supported evm chain id. Use the `/chains` endpoint to get
71
- * a list of supported chain ids.
72
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
72
73
  */
73
74
  chainId: string;
74
75
  /**
@@ -80,8 +81,7 @@ declare class EvmService {
80
81
  */
81
82
  blockNumber?: string;
82
83
  /**
83
- * The maximum number of items to return. The minimum page size
84
- * is 1. The maximum pageSize is 100.
84
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
85
85
  */
86
86
  pageSize?: number;
87
87
  /**
@@ -98,14 +98,16 @@ declare class EvmService {
98
98
  currency?: CurrencyCode;
99
99
  }): CancelablePromise<ListErc20BalancesResponse>;
100
100
  /**
101
- * List ERC-721 token balances of a wallet address for a given chain.
101
+ * List ERC-721 balances
102
+ * Lists ERC-721 token balances of a wallet address.
103
+ *
104
+ * Balance for a specific contract can be retrieved with the `contractAddress` parameter.
102
105
  * @returns ListErc721BalancesResponse
103
106
  * @throws ApiError
104
107
  */
105
108
  listErc721Balances({ chainId, address, pageSize, pageToken, contractAddress, }: {
106
109
  /**
107
- * A supported evm chain id. Use the `/chains` endpoint to get
108
- * a list of supported chain ids.
110
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
109
111
  */
110
112
  chainId: string;
111
113
  /**
@@ -113,8 +115,7 @@ declare class EvmService {
113
115
  */
114
116
  address: string;
115
117
  /**
116
- * The maximum number of items to return. The minimum page size
117
- * is 1. The maximum pageSize is 100.
118
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
118
119
  */
119
120
  pageSize?: number;
120
121
  /**
@@ -127,14 +128,18 @@ declare class EvmService {
127
128
  contractAddress?: string;
128
129
  }): CancelablePromise<ListErc721BalancesResponse>;
129
130
  /**
130
- * List ERC-1155 token balances of a wallet address for a given chain.
131
+ * List ERC-1155 balances
132
+ * Lists ERC-1155 token balances of a wallet address.
133
+ *
134
+ * Balance at a given block can be retrieved with the `blockNumber` parameter.
135
+ *
136
+ * Balance for a specific contract can be retrieved with the `contractAddress` parameter.
131
137
  * @returns ListErc1155BalancesResponse
132
138
  * @throws ApiError
133
139
  */
134
140
  listErc1155Balances({ chainId, address, blockNumber, pageSize, pageToken, contractAddress, }: {
135
141
  /**
136
- * A supported evm chain id. Use the `/chains` endpoint to get
137
- * a list of supported chain ids.
142
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
138
143
  */
139
144
  chainId: string;
140
145
  /**
@@ -146,8 +151,7 @@ declare class EvmService {
146
151
  */
147
152
  blockNumber?: string;
148
153
  /**
149
- * The maximum number of items to return. The minimum page size
150
- * is 1. The maximum pageSize is 100.
154
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
151
155
  */
152
156
  pageSize?: number;
153
157
  /**
@@ -160,15 +164,16 @@ declare class EvmService {
160
164
  contractAddress?: string;
161
165
  }): CancelablePromise<ListErc1155BalancesResponse>;
162
166
  /**
163
- * List ERC-721 and ERC-1155 token balances of a wallet address
164
- * for a given chain.
167
+ * List collectible (ERC-721/ERC-1155) balances
168
+ * Lists ERC-721 and ERC-1155 token balances of a wallet address.
169
+ *
170
+ * Balance for a specific contract can be retrieved with the `contractAddress` parameter.
165
171
  * @returns ListCollectibleBalancesResponse
166
172
  * @throws ApiError
167
173
  */
168
174
  listCollectibleBalances({ chainId, address, pageSize, pageToken, contractAddress, }: {
169
175
  /**
170
- * A supported evm chain id. Use the `/chains` endpoint to get
171
- * a list of supported chain ids.
176
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
172
177
  */
173
178
  chainId: string;
174
179
  /**
@@ -176,8 +181,7 @@ declare class EvmService {
176
181
  */
177
182
  address: string;
178
183
  /**
179
- * The maximum number of items to return. The minimum page size
180
- * is 1. The maximum pageSize is 100.
184
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
181
185
  */
182
186
  pageSize?: number;
183
187
  /**
@@ -190,19 +194,18 @@ declare class EvmService {
190
194
  contractAddress?: string;
191
195
  }): CancelablePromise<ListCollectibleBalancesResponse>;
192
196
  /**
193
- * Returns the latest blocks indexed for the chain.
197
+ * List latest blocks
198
+ * Lists the latest indexed blocks on the EVM-compatible chain sorted in descending order by block timestamp.
194
199
  * @returns ListEvmBlocksResponse
195
200
  * @throws ApiError
196
201
  */
197
202
  getLatestBlocks({ chainId, pageSize, pageToken, }: {
198
203
  /**
199
- * A supported evm chain id. Use the `/chains` endpoint to get
200
- * a list of supported chain ids.
204
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
201
205
  */
202
206
  chainId: string;
203
207
  /**
204
- * The maximum number of items to return. The minimum page size
205
- * is 1. The maximum pageSize is 100.
208
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
206
209
  */
207
210
  pageSize?: number;
208
211
  /**
@@ -211,14 +214,14 @@ declare class EvmService {
211
214
  pageToken?: string;
212
215
  }): CancelablePromise<ListEvmBlocksResponse>;
213
216
  /**
214
- * Returns the details of an individual block for the chain.
217
+ * Get block
218
+ * Gets the details of an individual block on the EVM-compatible chain.
215
219
  * @returns GetEvmBlockResponse
216
220
  * @throws ApiError
217
221
  */
218
222
  getBlock({ chainId, blockId, }: {
219
223
  /**
220
- * A supported evm chain id. Use the `/chains` endpoint to get
221
- * a list of supported chain ids.
224
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
222
225
  */
223
226
  chainId: string;
224
227
  /**
@@ -227,14 +230,14 @@ declare class EvmService {
227
230
  blockId: string;
228
231
  }): CancelablePromise<GetEvmBlockResponse>;
229
232
  /**
230
- * If the address is a smart contract, returns the transaction at which it was deployed.
233
+ * Get deployment transaction
234
+ * If the address is a smart contract, returns the transaction in which it was deployed.
231
235
  * @returns GetTransactionResponse
232
236
  * @throws ApiError
233
237
  */
234
238
  getDeploymentTransaction({ chainId, address, currency, }: {
235
239
  /**
236
- * A supported evm chain id. Use the `/chains` endpoint to get
237
- * a list of supported chain ids.
240
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
238
241
  */
239
242
  chainId: string;
240
243
  /**
@@ -247,7 +250,8 @@ declare class EvmService {
247
250
  currency?: CurrencyCode;
248
251
  }): CancelablePromise<GetTransactionResponse>;
249
252
  /**
250
- * Gets the list of chains supported by the api.
253
+ * List chains
254
+ * Lists the supported EVM-compatible chains. Filterable by network.
251
255
  * @returns ListChainsResponse
252
256
  * @throws ApiError
253
257
  */
@@ -258,28 +262,26 @@ declare class EvmService {
258
262
  network?: NetworkType;
259
263
  }): CancelablePromise<ListChainsResponse>;
260
264
  /**
261
- * Gets chain information by chain id.
265
+ * Get chain information
266
+ * Gets chain information for the EVM-compatible chain if supported by the api.
262
267
  * @returns GetChainResponse
263
268
  * @throws ApiError
264
269
  */
265
270
  getChainInfo({ chainId, }: {
266
271
  /**
267
- * A supported evm chain id. Use the `/chains` endpoint to get
268
- * a list of supported chain ids.
272
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
269
273
  */
270
274
  chainId: string;
271
275
  }): CancelablePromise<GetChainResponse>;
272
276
  /**
273
- * Triggers reindexing for a single nft contract and token id pair.
274
- * Triggers reindexing of token metadata for nft contracts.
275
- * Will throw 400 if Nft has been indexed within the last hour.
277
+ * Reindex NFT metadata
278
+ * Triggers reindexing of token metadata for NFT contracts. Will return 400 if the NFT has been indexed within the last hour.
276
279
  * @returns any
277
280
  * @throws ApiError
278
281
  */
279
282
  reindexNft({ chainId, address, tokenId, }: {
280
283
  /**
281
- * A supported evm chain id. Use the `/chains` endpoint to get
282
- * a list of supported chain ids.
284
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
283
285
  */
284
286
  chainId: string;
285
287
  /**
@@ -292,14 +294,14 @@ declare class EvmService {
292
294
  tokenId: string;
293
295
  }): CancelablePromise<any>;
294
296
  /**
295
- * Get collection data for provided a ChainID and address.
297
+ * Get collection details
298
+ * Get collection details for a specific contract.
296
299
  * @returns NftCollectionWithMetrics
297
300
  * @throws ApiError
298
301
  */
299
302
  getCollection({ chainId, address, timeframe, }: {
300
303
  /**
301
- * A supported evm chain id. Use the `/chains` endpoint to get
302
- * a list of supported chain ids.
304
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
303
305
  */
304
306
  chainId: string;
305
307
  /**
@@ -312,135 +314,18 @@ declare class EvmService {
312
314
  timeframe?: TrendingTimeframe;
313
315
  }): CancelablePromise<NftCollectionWithMetrics>;
314
316
  /**
315
- * List open listings for a NFT token.
316
- * @returns ListListingsResponse
317
- * @throws ApiError
318
- */
319
- listListingsByCollectionTokenId({ chainId, address, tokenId, pageSize, pageToken, sortBy, sortOrder, currency, includeHistory, }: {
320
- /**
321
- * A supported evm chain id. Use the `/chains` endpoint to get
322
- * a list of supported chain ids.
323
- */
324
- chainId: string;
325
- /**
326
- * Contract address on the relevant chain.
327
- */
328
- address: string;
329
- /**
330
- * TokenId on the contract
331
- */
332
- tokenId: string;
333
- /**
334
- * The maximum number of items to return. The minimum page size
335
- * is 1. The maximum pageSize is 100.
336
- */
337
- pageSize?: number;
338
- /**
339
- * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
340
- */
341
- pageToken?: string;
342
- /**
343
- * Which property to sort by, in conjunction with sortOrder.
344
- */
345
- sortBy?: ListingsSortByOption;
346
- /**
347
- * The order by which to sort results. Use "asc" for ascending
348
- * order, "desc" for descending order. Sorted by timestamp or the `sortBy`
349
- * query parameter, if provided.
350
- */
351
- sortOrder?: SortOrder;
352
- /**
353
- * The currency that return values should use. Defaults to USD.
354
- */
355
- currency?: CurrencyCode;
356
- /**
357
- * Determines whether to return full transaction history for listings.
358
- */
359
- includeHistory?: boolean;
360
- }): CancelablePromise<ListListingsResponse>;
361
- /**
362
- * List open listings for a NFT collection.
363
- * @returns ListListingsResponse
364
- * @throws ApiError
365
- */
366
- listListingsByCollection({ chainId, address, pageSize, pageToken, sortBy, sortOrder, currency, includeHistory, }: {
367
- /**
368
- * A supported evm chain id. Use the `/chains` endpoint to get
369
- * a list of supported chain ids.
370
- */
371
- chainId: string;
372
- /**
373
- * Contract address on the relevant chain.
374
- */
375
- address: string;
376
- /**
377
- * The maximum number of items to return. The minimum page size
378
- * is 1. The maximum pageSize is 100.
379
- */
380
- pageSize?: number;
381
- /**
382
- * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
383
- */
384
- pageToken?: string;
385
- /**
386
- * Which property to sort by, in conjunction with sortOrder.
387
- */
388
- sortBy?: ListingsSortByOption;
389
- /**
390
- * The order by which to sort results. Use "asc" for ascending
391
- * order, "desc" for descending order. Sorted by timestamp or the `sortBy`
392
- * query parameter, if provided.
393
- */
394
- sortOrder?: SortOrder;
395
- /**
396
- * The currency that return values should use. Defaults to USD.
397
- */
398
- currency?: CurrencyCode;
399
- /**
400
- * Determines whether to return full transaction history for listings.
401
- */
402
- includeHistory?: boolean;
403
- }): CancelablePromise<ListListingsResponse>;
404
- /**
405
- * List recent listings on the chain.
406
- * @returns ListListingsResponse
407
- * @throws ApiError
408
- */
409
- listRecentListings({ chainId, pageSize, pageToken, eventType, currency, }: {
410
- /**
411
- * A supported evm chain id. Use the `/chains` endpoint to get
412
- * a list of supported chain ids.
413
- */
414
- chainId: string;
415
- /**
416
- * The maximum number of items to return. The minimum page size
417
- * is 1. The maximum pageSize is 100.
418
- */
419
- pageSize?: number;
420
- /**
421
- * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
422
- */
423
- pageToken?: string;
424
- eventType?: ListingEventType;
425
- /**
426
- * The currency that return values should use. Defaults to USD.
427
- */
428
- currency?: CurrencyCode;
429
- }): CancelablePromise<ListListingsResponse>;
430
- /**
431
- * List details and metrics for collections.
317
+ * List collections
318
+ * Lists details and metrics for collections.
432
319
  * @returns ListNftCollectionWithMetricsResponse
433
320
  * @throws ApiError
434
321
  */
435
322
  listCollections({ chainId, pageSize, pageToken, timeframe, sortBy, sortOrder, }: {
436
323
  /**
437
- * A supported evm chain id. Use the `/chains` endpoint to get
438
- * a list of supported chain ids.
324
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
439
325
  */
440
326
  chainId: string;
441
327
  /**
442
- * The maximum number of items to return. The minimum page size
443
- * is 1. The maximum pageSize is 100.
328
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
444
329
  */
445
330
  pageSize?: number;
446
331
  /**
@@ -456,36 +341,19 @@ declare class EvmService {
456
341
  */
457
342
  sortBy?: CollectionSortByOption;
458
343
  /**
459
- * The order by which to sort results. Use "asc" for ascending
460
- * order, "desc" for descending order. Sorted by timestamp or the `sortBy`
461
- * query parameter, if provided.
344
+ * The order by which to sort results. Use "asc" for ascending order, "desc" for descending order. Sorted by timestamp or the `sortBy` query parameter, if provided.
462
345
  */
463
346
  sortOrder?: SortOrder;
464
347
  }): CancelablePromise<ListNftCollectionWithMetricsResponse>;
465
348
  /**
466
- * Search for token by name and contract name.
467
- * @returns any
468
- * @throws ApiError
469
- */
470
- search({ chainId, requestBody, }: {
471
- /**
472
- * A supported evm chain id. Use the `/chains` endpoint to get
473
- * a list of supported chain ids.
474
- */
475
- chainId: string;
476
- requestBody: NftSearchBody;
477
- }): CancelablePromise<{
478
- results?: Array<NftCollection>;
479
- }>;
480
- /**
481
- * Get metadata for a specific token by providing the contract address and token id.
349
+ * Get token details
350
+ * Get token details for a specific token of a contract.
482
351
  * @returns any
483
352
  * @throws ApiError
484
353
  */
485
- getTokenMetadata({ chainId, address, tokenId, }: {
354
+ getTokenDetails({ chainId, address, tokenId, }: {
486
355
  /**
487
- * A supported evm chain id. Use the `/chains` endpoint to get
488
- * a list of supported chain ids.
356
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
489
357
  */
490
358
  chainId: string;
491
359
  /**
@@ -498,15 +366,14 @@ declare class EvmService {
498
366
  tokenId: string;
499
367
  }): CancelablePromise<(Erc721Token | Erc1155Token)>;
500
368
  /**
501
- * Gets a list of erc transfers for an ERC-20, ERC-721,
502
- * or ERC-1155 contract address.
369
+ * List ERC transfers
370
+ * Lists ERC transfers for an ERC-20, ERC-721, or ERC-1155 contract address.
503
371
  * @returns ListTransfersResponse
504
372
  * @throws ApiError
505
373
  */
506
374
  listTransfers({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
507
375
  /**
508
- * A supported evm chain id. Use the `/chains` endpoint to get
509
- * a list of supported chain ids.
376
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
510
377
  */
511
378
  chainId: string;
512
379
  /**
@@ -516,8 +383,7 @@ declare class EvmService {
516
383
  startBlock?: number;
517
384
  endBlock?: number;
518
385
  /**
519
- * The maximum number of items to return. The minimum page size
520
- * is 1. The maximum pageSize is 100.
386
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
521
387
  */
522
388
  pageSize?: number;
523
389
  /**
@@ -526,24 +392,16 @@ declare class EvmService {
526
392
  pageToken?: string;
527
393
  }): CancelablePromise<ListTransfersResponse>;
528
394
  /**
529
- * Gets a list of transactions for an address and chain.
530
- * Returns a list of transactions where the given wallet
531
- * address had an on-chain interaction for a given chain. The ERC-20
532
- * transfers, ERC-721 transfers, ERC-1155, and internal transactions
533
- * returned are only those where the input address had an interaction.
534
- * Specifically, those list only inlcude entries where the input address
535
- * was the sender (`from` field) or the receiver (`to` field) for the
536
- * sub-transaction. Therefore the transactions returned from this list may
537
- * not be complete representations of the on-chain data. For a complete
538
- * view of a transaction use the `/chains/:chainId/transactions/:txHash`
539
- * endpoint.
395
+ * List transactions
396
+ * Returns a list of transactions where the given wallet address had an on-chain interaction for the given chain. The ERC-20 transfers, ERC-721 transfers, ERC-1155, and internal transactions returned are only those where the input address had an interaction. Specifically, those lists only inlcude entries where the input address was the sender (`from` field) or the receiver (`to` field) for the sub-transaction. Therefore the transactions returned from this list may not be complete representations of the on-chain data. For a complete view of a transaction use the `/chains/:chainId/transactions/:txHash` endpoint.
397
+ *
398
+ * Filterable by block ranges.
540
399
  * @returns ListTransactionDetailsResponse
541
400
  * @throws ApiError
542
401
  */
543
402
  listTransactions({ chainId, address, pageSize, pageToken, startBlock, endBlock, sortOrder, }: {
544
403
  /**
545
- * A supported evm chain id. Use the `/chains` endpoint to get
546
- * a list of supported chain ids.
404
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
547
405
  */
548
406
  chainId: string;
549
407
  /**
@@ -551,8 +409,7 @@ declare class EvmService {
551
409
  */
552
410
  address: string;
553
411
  /**
554
- * The maximum number of items to return. The minimum page size
555
- * is 1. The maximum pageSize is 100.
412
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
556
413
  */
557
414
  pageSize?: number;
558
415
  /**
@@ -562,21 +419,19 @@ declare class EvmService {
562
419
  startBlock?: number;
563
420
  endBlock?: number;
564
421
  /**
565
- * The order by which to sort results. Use "asc" for ascending
566
- * order, "desc" for descending order. Sorted by timestamp or the `sortBy`
567
- * query parameter, if provided.
422
+ * The order by which to sort results. Use "asc" for ascending order, "desc" for descending order. Sorted by timestamp or the `sortBy` query parameter, if provided.
568
423
  */
569
424
  sortOrder?: SortOrder;
570
425
  }): CancelablePromise<ListTransactionDetailsResponse>;
571
426
  /**
572
- * Gets a list of native transactions for an address and chain.
427
+ * List native transactions
428
+ * Lists native transactions for an address. Filterable by block range.
573
429
  * @returns ListNativeTransactionsResponse
574
430
  * @throws ApiError
575
431
  */
576
432
  listNativeTransactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
577
433
  /**
578
- * A supported evm chain id. Use the `/chains` endpoint to get
579
- * a list of supported chain ids.
434
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
580
435
  */
581
436
  chainId: string;
582
437
  /**
@@ -586,8 +441,7 @@ declare class EvmService {
586
441
  startBlock?: number;
587
442
  endBlock?: number;
588
443
  /**
589
- * The maximum number of items to return. The minimum page size
590
- * is 1. The maximum pageSize is 100.
444
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
591
445
  */
592
446
  pageSize?: number;
593
447
  /**
@@ -596,14 +450,14 @@ declare class EvmService {
596
450
  pageToken?: string;
597
451
  }): CancelablePromise<ListNativeTransactionsResponse>;
598
452
  /**
599
- * Lists ERC-20 transfers for an address.
453
+ * List ERC-20 transfers
454
+ * Lists ERC-20 transfers for an address. Filterable by block range.
600
455
  * @returns ListErc20TransactionsResponse
601
456
  * @throws ApiError
602
457
  */
603
458
  listErc20Transactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
604
459
  /**
605
- * A supported evm chain id. Use the `/chains` endpoint to get
606
- * a list of supported chain ids.
460
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
607
461
  */
608
462
  chainId: string;
609
463
  /**
@@ -613,8 +467,7 @@ declare class EvmService {
613
467
  startBlock?: number;
614
468
  endBlock?: number;
615
469
  /**
616
- * The maximum number of items to return. The minimum page size
617
- * is 1. The maximum pageSize is 100.
470
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
618
471
  */
619
472
  pageSize?: number;
620
473
  /**
@@ -623,14 +476,14 @@ declare class EvmService {
623
476
  pageToken?: string;
624
477
  }): CancelablePromise<ListErc20TransactionsResponse>;
625
478
  /**
626
- * Lists ERC-721 transfers for an address.
479
+ * List ERC-721 transfers
480
+ * Lists ERC-721 transfers for an address. Filterable by block range.
627
481
  * @returns ListErc721TransactionsResponse
628
482
  * @throws ApiError
629
483
  */
630
484
  listErc721Transactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
631
485
  /**
632
- * A supported evm chain id. Use the `/chains` endpoint to get
633
- * a list of supported chain ids.
486
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
634
487
  */
635
488
  chainId: string;
636
489
  /**
@@ -640,8 +493,7 @@ declare class EvmService {
640
493
  startBlock?: number;
641
494
  endBlock?: number;
642
495
  /**
643
- * The maximum number of items to return. The minimum page size
644
- * is 1. The maximum pageSize is 100.
496
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
645
497
  */
646
498
  pageSize?: number;
647
499
  /**
@@ -650,14 +502,14 @@ declare class EvmService {
650
502
  pageToken?: string;
651
503
  }): CancelablePromise<ListErc721TransactionsResponse>;
652
504
  /**
653
- * Lists of ERC-1155 transfers for an address.
505
+ * List ERC-1155 transfers
506
+ * Lists ERC-1155 transfers for an address. Filterable by block range.
654
507
  * @returns ListErc1155TransactionsResponse
655
508
  * @throws ApiError
656
509
  */
657
510
  listErc1155Transactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
658
511
  /**
659
- * A supported evm chain id. Use the `/chains` endpoint to get
660
- * a list of supported chain ids.
512
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
661
513
  */
662
514
  chainId: string;
663
515
  /**
@@ -667,8 +519,7 @@ declare class EvmService {
667
519
  startBlock?: number;
668
520
  endBlock?: number;
669
521
  /**
670
- * The maximum number of items to return. The minimum page size
671
- * is 1. The maximum pageSize is 100.
522
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
672
523
  */
673
524
  pageSize?: number;
674
525
  /**
@@ -677,19 +528,16 @@ declare class EvmService {
677
528
  pageToken?: string;
678
529
  }): CancelablePromise<ListErc1155TransactionsResponse>;
679
530
  /**
680
- * Lists internal transactions for an address.
681
- * Returns a list of internal transactions for an address and
682
- * chain. Note that the internal transactions list only contains CALL or
683
- * CALLCODE transactions with a non-zero value and CREATE/CREATE2
684
- * transactions. To get a complete list of internal transactions use the
685
- * `debug_` prefixed RPC methods on an archive node.
531
+ * List internal transactions
532
+ * Returns a list of internal transactions for an address and chain. Filterable by block range.
533
+ *
534
+ * Note that the internal transactions list only contains `CALL` or `CALLCODE` transactions with a non-zero value and `CREATE`/`CREATE2` transactions. To get a complete list of internal transactions use the `debug_` prefixed RPC methods on an archive node.
686
535
  * @returns ListInternalTransactionsResponse
687
536
  * @throws ApiError
688
537
  */
689
538
  listInternalTransactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
690
539
  /**
691
- * A supported evm chain id. Use the `/chains` endpoint to get
692
- * a list of supported chain ids.
540
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
693
541
  */
694
542
  chainId: string;
695
543
  /**
@@ -699,8 +547,7 @@ declare class EvmService {
699
547
  startBlock?: number;
700
548
  endBlock?: number;
701
549
  /**
702
- * The maximum number of items to return. The minimum page size
703
- * is 1. The maximum pageSize is 100.
550
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
704
551
  */
705
552
  pageSize?: number;
706
553
  /**
@@ -709,14 +556,14 @@ declare class EvmService {
709
556
  pageToken?: string;
710
557
  }): CancelablePromise<ListInternalTransactionsResponse>;
711
558
  /**
559
+ * Get transaction
712
560
  * Gets the details of a single transaction.
713
561
  * @returns GetTransactionResponse
714
562
  * @throws ApiError
715
563
  */
716
564
  getTransaction({ chainId, txHash, }: {
717
565
  /**
718
- * A supported evm chain id. Use the `/chains` endpoint to get
719
- * a list of supported chain ids.
566
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
720
567
  */
721
568
  chainId: string;
722
569
  /**
@@ -725,14 +572,14 @@ declare class EvmService {
725
572
  txHash: string;
726
573
  }): CancelablePromise<GetTransactionResponse>;
727
574
  /**
728
- * Gets the transactions that occured in a given block.
575
+ * List transactions for a block
576
+ * Lists the transactions that occured in a given block.
729
577
  * @returns ListNativeTransactionsResponse
730
578
  * @throws ApiError
731
579
  */
732
580
  getTransactionsForBlock({ chainId, blockId, }: {
733
581
  /**
734
- * A supported evm chain id. Use the `/chains` endpoint to get
735
- * a list of supported chain ids.
582
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
736
583
  */
737
584
  chainId: string;
738
585
  /**
@@ -741,19 +588,18 @@ declare class EvmService {
741
588
  blockId: string;
742
589
  }): CancelablePromise<ListNativeTransactionsResponse>;
743
590
  /**
744
- * Gets the latest transactions; can be filtered by status.
591
+ * List latest transactions
592
+ * Lists the latest transactions. Filterable by status.
745
593
  * @returns ListNativeTransactionsResponse
746
594
  * @throws ApiError
747
595
  */
748
596
  listLatestTransactions({ chainId, pageSize, pageToken, status, }: {
749
597
  /**
750
- * A supported evm chain id. Use the `/chains` endpoint to get
751
- * a list of supported chain ids.
598
+ * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
752
599
  */
753
600
  chainId: string;
754
601
  /**
755
- * The maximum number of items to return. The minimum page size
756
- * is 1. The maximum pageSize is 100.
602
+ * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
757
603
  */
758
604
  pageSize?: number;
759
605
  /**