@covalenthq/client-sdk 1.0.1 → 2.0.0

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 (147) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +223 -282
  3. package/package.json +25 -12
  4. package/dist/cjs/index.d.ts +0 -20
  5. package/dist/cjs/index.js +0 -8190
  6. package/dist/cjs/index.js.map +0 -1
  7. package/dist/cjs/services/BalanceService.d.ts +0 -638
  8. package/dist/cjs/services/BaseService.d.ts +0 -571
  9. package/dist/cjs/services/CovalentClient.d.ts +0 -57
  10. package/dist/cjs/services/NftService.d.ts +0 -686
  11. package/dist/cjs/services/PricingService.d.ts +0 -103
  12. package/dist/cjs/services/SecurityService.d.ts +0 -162
  13. package/dist/cjs/services/TransactionService.d.ts +0 -711
  14. package/dist/cjs/services/XykService.d.ts +0 -1018
  15. package/dist/cjs/util/ApiHelpers.d.ts +0 -6
  16. package/dist/cjs/util/ApiKeyValidator.d.ts +0 -8
  17. package/dist/cjs/util/CalculatePrettyBalance.d.ts +0 -1
  18. package/dist/cjs/util/Chains.d.ts +0 -223
  19. package/dist/cjs/util/backoff.d.ts +0 -12
  20. package/dist/cjs/util/prettifyCurrency.d.ts +0 -2
  21. package/dist/cjs/util/types/BalanceServiceTypes.d.ts +0 -378
  22. package/dist/cjs/util/types/BaseServiceTypes.d.ts +0 -276
  23. package/dist/cjs/util/types/GenericTypes.d.ts +0 -116
  24. package/dist/cjs/util/types/NftServiceTypes.d.ts +0 -303
  25. package/dist/cjs/util/types/PricingServiceTypes.d.ts +0 -33
  26. package/dist/cjs/util/types/SecurityServiceTypes.d.ts +0 -121
  27. package/dist/cjs/util/types/TransactionServiceTypes.d.ts +0 -388
  28. package/dist/cjs/util/types/XykServiceTypes.d.ts +0 -687
  29. package/dist/es/index.d.ts +0 -20
  30. package/dist/es/index.js +0 -8176
  31. package/dist/es/index.js.map +0 -1
  32. package/dist/es/services/BalanceService.d.ts +0 -638
  33. package/dist/es/services/BaseService.d.ts +0 -571
  34. package/dist/es/services/CovalentClient.d.ts +0 -57
  35. package/dist/es/services/NftService.d.ts +0 -686
  36. package/dist/es/services/PricingService.d.ts +0 -103
  37. package/dist/es/services/SecurityService.d.ts +0 -162
  38. package/dist/es/services/TransactionService.d.ts +0 -711
  39. package/dist/es/services/XykService.d.ts +0 -1018
  40. package/dist/es/util/ApiHelpers.d.ts +0 -6
  41. package/dist/es/util/ApiKeyValidator.d.ts +0 -8
  42. package/dist/es/util/CalculatePrettyBalance.d.ts +0 -1
  43. package/dist/es/util/Chains.d.ts +0 -223
  44. package/dist/es/util/backoff.d.ts +0 -12
  45. package/dist/es/util/prettifyCurrency.d.ts +0 -2
  46. package/dist/es/util/types/BalanceServiceTypes.d.ts +0 -378
  47. package/dist/es/util/types/BaseServiceTypes.d.ts +0 -276
  48. package/dist/es/util/types/GenericTypes.d.ts +0 -116
  49. package/dist/es/util/types/NftServiceTypes.d.ts +0 -303
  50. package/dist/es/util/types/PricingServiceTypes.d.ts +0 -33
  51. package/dist/es/util/types/SecurityServiceTypes.d.ts +0 -121
  52. package/dist/es/util/types/TransactionServiceTypes.d.ts +0 -388
  53. package/dist/es/util/types/XykServiceTypes.d.ts +0 -687
  54. package/dist/esm/index.d.ts +0 -20
  55. package/dist/esm/index.js +0 -8176
  56. package/dist/esm/index.js.map +0 -1
  57. package/dist/esm/services/BalanceService.d.ts +0 -638
  58. package/dist/esm/services/BaseService.d.ts +0 -571
  59. package/dist/esm/services/CovalentClient.d.ts +0 -57
  60. package/dist/esm/services/NftService.d.ts +0 -686
  61. package/dist/esm/services/PricingService.d.ts +0 -103
  62. package/dist/esm/services/SecurityService.d.ts +0 -162
  63. package/dist/esm/services/TransactionService.d.ts +0 -711
  64. package/dist/esm/services/XykService.d.ts +0 -1018
  65. package/dist/esm/util/ApiHelpers.d.ts +0 -6
  66. package/dist/esm/util/ApiKeyValidator.d.ts +0 -8
  67. package/dist/esm/util/CalculatePrettyBalance.d.ts +0 -1
  68. package/dist/esm/util/Chains.d.ts +0 -223
  69. package/dist/esm/util/backoff.d.ts +0 -12
  70. package/dist/esm/util/prettifyCurrency.d.ts +0 -2
  71. package/dist/esm/util/types/BalanceServiceTypes.d.ts +0 -378
  72. package/dist/esm/util/types/BaseServiceTypes.d.ts +0 -276
  73. package/dist/esm/util/types/GenericTypes.d.ts +0 -116
  74. package/dist/esm/util/types/NftServiceTypes.d.ts +0 -303
  75. package/dist/esm/util/types/PricingServiceTypes.d.ts +0 -33
  76. package/dist/esm/util/types/SecurityServiceTypes.d.ts +0 -121
  77. package/dist/esm/util/types/TransactionServiceTypes.d.ts +0 -388
  78. package/dist/esm/util/types/XykServiceTypes.d.ts +0 -687
  79. package/dist/index.d.ts +0 -20
  80. package/dist/index.js +0 -21
  81. package/dist/index.js.map +0 -1
  82. package/dist/services/BalanceService.d.ts +0 -638
  83. package/dist/services/BalanceService.js +0 -959
  84. package/dist/services/BalanceService.js.map +0 -1
  85. package/dist/services/BaseService.d.ts +0 -571
  86. package/dist/services/BaseService.js +0 -1202
  87. package/dist/services/BaseService.js.map +0 -1
  88. package/dist/services/CovalentClient.d.ts +0 -57
  89. package/dist/services/CovalentClient.js +0 -49
  90. package/dist/services/CovalentClient.js.map +0 -1
  91. package/dist/services/NftService.d.ts +0 -686
  92. package/dist/services/NftService.js +0 -1490
  93. package/dist/services/NftService.js.map +0 -1
  94. package/dist/services/PricingService.d.ts +0 -103
  95. package/dist/services/PricingService.js +0 -155
  96. package/dist/services/PricingService.js.map +0 -1
  97. package/dist/services/SecurityService.d.ts +0 -162
  98. package/dist/services/SecurityService.js +0 -249
  99. package/dist/services/SecurityService.js.map +0 -1
  100. package/dist/services/TransactionService.d.ts +0 -711
  101. package/dist/services/TransactionService.js +0 -1687
  102. package/dist/services/TransactionService.js.map +0 -1
  103. package/dist/services/XykService.d.ts +0 -1018
  104. package/dist/services/XykService.js +0 -1827
  105. package/dist/services/XykService.js.map +0 -1
  106. package/dist/util/ApiHelpers.d.ts +0 -6
  107. package/dist/util/ApiHelpers.js +0 -87
  108. package/dist/util/ApiHelpers.js.map +0 -1
  109. package/dist/util/ApiKeyValidator.d.ts +0 -8
  110. package/dist/util/ApiKeyValidator.js +0 -13
  111. package/dist/util/ApiKeyValidator.js.map +0 -1
  112. package/dist/util/CalculatePrettyBalance.d.ts +0 -1
  113. package/dist/util/CalculatePrettyBalance.js +0 -32
  114. package/dist/util/CalculatePrettyBalance.js.map +0 -1
  115. package/dist/util/Chains.d.ts +0 -223
  116. package/dist/util/Chains.js +0 -225
  117. package/dist/util/Chains.js.map +0 -1
  118. package/dist/util/backoff.d.ts +0 -12
  119. package/dist/util/backoff.js +0 -47
  120. package/dist/util/backoff.js.map +0 -1
  121. package/dist/util/prettifyCurrency.d.ts +0 -2
  122. package/dist/util/prettifyCurrency.js +0 -69
  123. package/dist/util/prettifyCurrency.js.map +0 -1
  124. package/dist/util/types/BalanceServiceTypes.d.ts +0 -378
  125. package/dist/util/types/BalanceServiceTypes.js +0 -2
  126. package/dist/util/types/BalanceServiceTypes.js.map +0 -1
  127. package/dist/util/types/BaseServiceTypes.d.ts +0 -276
  128. package/dist/util/types/BaseServiceTypes.js +0 -2
  129. package/dist/util/types/BaseServiceTypes.js.map +0 -1
  130. package/dist/util/types/GenericTypes.d.ts +0 -116
  131. package/dist/util/types/GenericTypes.js +0 -2
  132. package/dist/util/types/GenericTypes.js.map +0 -1
  133. package/dist/util/types/NftServiceTypes.d.ts +0 -303
  134. package/dist/util/types/NftServiceTypes.js +0 -2
  135. package/dist/util/types/NftServiceTypes.js.map +0 -1
  136. package/dist/util/types/PricingServiceTypes.d.ts +0 -33
  137. package/dist/util/types/PricingServiceTypes.js +0 -2
  138. package/dist/util/types/PricingServiceTypes.js.map +0 -1
  139. package/dist/util/types/SecurityServiceTypes.d.ts +0 -121
  140. package/dist/util/types/SecurityServiceTypes.js +0 -2
  141. package/dist/util/types/SecurityServiceTypes.js.map +0 -1
  142. package/dist/util/types/TransactionServiceTypes.d.ts +0 -388
  143. package/dist/util/types/TransactionServiceTypes.js +0 -2
  144. package/dist/util/types/TransactionServiceTypes.js.map +0 -1
  145. package/dist/util/types/XykServiceTypes.d.ts +0 -687
  146. package/dist/util/types/XykServiceTypes.js +0 -2
  147. package/dist/util/types/XykServiceTypes.js.map +0 -1
@@ -1,686 +0,0 @@
1
- import { Chain, Quote, Response, ChainID, Source } from "./CovalentClient";
2
- import { Chains } from "../util/Chains";
3
- declare class ChainCollectionResponse {
4
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
5
- updated_at: Date;
6
- /** * The requested chain ID eg: `1`. */
7
- chain_id: number;
8
- /** * The requested chain name eg: `eth-mainnet`. */
9
- chain_name: string;
10
- /** * List of response items. */
11
- items: ChainCollectionItem[];
12
- /** * Pagination metadata. */
13
- pagination: Pagination;
14
- constructor(data: ChainCollectionResponse);
15
- }
16
- declare class ChainCollectionItem {
17
- /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
18
- contract_address: string;
19
- /** * The string returned by the `name()` method. */
20
- contract_name: string;
21
- /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
22
- is_spam: boolean;
23
- token_total_supply: number;
24
- cached_metadata_count: number;
25
- cached_asset_count: number;
26
- last_scraped_at: Date;
27
- constructor(data: ChainCollectionItem);
28
- }
29
- declare class Pagination {
30
- /** * True is there is another page. */
31
- has_more: boolean;
32
- /** * The requested page number. */
33
- page_number: number;
34
- /** * The requested number of items on the current page. */
35
- page_size: number;
36
- /** * The total number of items across all pages for this request. */
37
- total_count: number;
38
- constructor(data: Pagination);
39
- }
40
- declare class NftAddressBalanceNftResponse {
41
- /** * The requested address. */
42
- address: string;
43
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
44
- updated_at: Date;
45
- /** * List of response items. */
46
- items: NftTokenContractBalanceItem[];
47
- constructor(data: NftAddressBalanceNftResponse);
48
- }
49
- declare class NftTokenContractBalanceItem {
50
- /** * The string returned by the `name()` method. */
51
- contract_name: string;
52
- /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
53
- contract_ticker_symbol: string;
54
- /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
55
- contract_address: string;
56
- /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
57
- supports_erc: string[];
58
- /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
59
- is_spam: boolean;
60
- last_transfered_at: Date;
61
- /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
62
- balance: bigint | null;
63
- balance_24h: string;
64
- type: string;
65
- /** * The current floor price converted to fiat in `quote-currency`. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on. */
66
- floor_price_quote: number;
67
- /** * A prettier version of the floor price quote for rendering purposes. */
68
- pretty_floor_price_quote: string;
69
- /** * The current floor price in native currency. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on. */
70
- floor_price_native_quote: number;
71
- nft_data: NftData[];
72
- constructor(data: NftTokenContractBalanceItem);
73
- }
74
- declare class NftData {
75
- /** * The token's id. */
76
- token_id: bigint | null;
77
- token_url: string;
78
- /** * The original minter. */
79
- original_owner: string;
80
- /** * The current holder of this NFT. */
81
- current_owner: string;
82
- external_data: NftExternalData;
83
- /** * If `true`, the asset data is available from the Covalent CDN. */
84
- asset_cached: boolean;
85
- /** * If `true`, the image data is available from the Covalent CDN. */
86
- image_cached: boolean;
87
- constructor(data: NftData);
88
- }
89
- declare class NftExternalData {
90
- name: string;
91
- description: string;
92
- asset_url: string;
93
- asset_file_extension: string;
94
- asset_mime_type: string;
95
- asset_size_bytes: string;
96
- image: string;
97
- image_256: string;
98
- image_512: string;
99
- image_1024: string;
100
- animation_url: string;
101
- external_url: string;
102
- attributes: NftCollectionAttribute[];
103
- constructor(data: NftExternalData);
104
- }
105
- declare class NftCollectionAttribute {
106
- trait_type: string;
107
- value: string;
108
- constructor(data: NftCollectionAttribute);
109
- }
110
- declare class NftMetadataResponse {
111
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
112
- updated_at: Date;
113
- /** * List of response items. */
114
- items: NftTokenContract[];
115
- /** * Pagination metadata. */
116
- pagination: Pagination;
117
- constructor(data: NftMetadataResponse);
118
- }
119
- declare class NftTokenContract {
120
- /** * The string returned by the `name()` method. */
121
- contract_name: string;
122
- /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
123
- contract_ticker_symbol: string;
124
- /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
125
- contract_address: string;
126
- /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
127
- is_spam: boolean;
128
- type: string;
129
- nft_data: NftData;
130
- constructor(data: NftTokenContract);
131
- }
132
- declare class NftTransactionsResponse {
133
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
134
- updated_at: Date;
135
- /** * The requested chain ID eg: `1`. */
136
- chain_id: number;
137
- /** * The requested chain name eg: `eth-mainnet`. */
138
- chain_name: string;
139
- /** * List of response items. */
140
- items: NftTransaction[];
141
- constructor(data: NftTransactionsResponse);
142
- }
143
- declare class NftTransaction {
144
- /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
145
- contract_decimals: number;
146
- /** * The string returned by the `name()` method. */
147
- contract_name: string;
148
- /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
149
- contract_ticker_symbol: string;
150
- /** * The contract logo URL. */
151
- logo_url: string;
152
- /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
153
- contract_address: string;
154
- /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
155
- supports_erc: string[];
156
- nft_transactions: NftTransactionItem[];
157
- /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
158
- is_spam: boolean;
159
- constructor(data: NftTransaction);
160
- }
161
- declare class NftTransactionItem {
162
- /** * The block signed timestamp in UTC. */
163
- block_signed_at: Date;
164
- /** * The height of the block. */
165
- block_height: number;
166
- /** * The requested transaction hash. */
167
- tx_hash: string;
168
- /** * The offset is the position of the tx in the block. */
169
- tx_offset: number;
170
- /** * Whether or not transaction is successful. */
171
- successful: boolean;
172
- /** * The sender's wallet address. */
173
- from_address: string;
174
- /** * The label of `from` address. */
175
- from_address_label: string;
176
- /** * The receiver's wallet address. */
177
- to_address: string;
178
- /** * The label of `to` address. */
179
- to_address_label: string;
180
- /** * The value attached to this tx. */
181
- value: bigint | null;
182
- /** * The value attached in `quote-currency` to this tx. */
183
- value_quote: number;
184
- /** * A prettier version of the quote for rendering purposes. */
185
- pretty_value_quote: string;
186
- gas_offered: number;
187
- /** * The gas spent for this tx. */
188
- gas_spent: number;
189
- /** * The gas price at the time of this tx. */
190
- gas_price: number;
191
- /** * The total transaction fees (gas_price * gas_spent) paid for this tx, denoted in wei. */
192
- fees_paid: bigint | null;
193
- /** * The gas spent in `quote-currency` denomination. */
194
- gas_quote: number;
195
- /** * A prettier version of the quote for rendering purposes. */
196
- pretty_gas_quote: string;
197
- gas_quote_rate: number;
198
- /** * The log events. */
199
- log_events: LogEvent[];
200
- constructor(data: NftTransactionItem);
201
- }
202
- declare class LogEvent {
203
- /** * The block signed timestamp in UTC. */
204
- block_signed_at: Date;
205
- /** * The height of the block. */
206
- block_height: number;
207
- /** * The offset is the position of the tx in the block. */
208
- tx_offset: number;
209
- /** * The offset is the position of the log entry within an event log. */
210
- log_offset: number;
211
- /** * The requested transaction hash. */
212
- tx_hash: string;
213
- /** * The log topics in raw data. */
214
- raw_log_topics: string[];
215
- /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
216
- sender_contract_decimals: number;
217
- /** * The name of the sender. */
218
- sender_name: string;
219
- sender_contract_ticker_symbol: string;
220
- /** * The address of the sender. */
221
- sender_address: string;
222
- /** * The label of the sender address. */
223
- sender_address_label: string;
224
- /** * The contract logo URL. */
225
- sender_logo_url: string;
226
- /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
227
- supports_erc: string[];
228
- /** * The address of the deployed UniswapV2 like factory contract for this DEX. */
229
- sender_factory_address: string;
230
- /** * The log events in raw. */
231
- raw_log_data: string;
232
- /** * The decoded item. */
233
- decoded: DecodedItem;
234
- constructor(data: LogEvent);
235
- }
236
- declare class DecodedItem {
237
- name: string;
238
- signature: string;
239
- params: Param[];
240
- constructor(data: DecodedItem);
241
- }
242
- declare class Param {
243
- name: string;
244
- type: string;
245
- indexed: boolean;
246
- decoded: boolean;
247
- value: string;
248
- constructor(data: Param);
249
- }
250
- declare class NftCollectionTraitsResponse {
251
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
252
- updated_at: Date;
253
- /** * List of response items. */
254
- items: NftTrait[];
255
- constructor(data: NftCollectionTraitsResponse);
256
- }
257
- declare class NftTrait {
258
- name: string;
259
- constructor(data: NftTrait);
260
- }
261
- declare class NftCollectionAttributesForTraitResponse {
262
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
263
- updated_at: Date;
264
- /** * List of response items. */
265
- items: NftSummaryAttribute[];
266
- constructor(data: NftCollectionAttributesForTraitResponse);
267
- }
268
- declare class NftSummaryAttribute {
269
- trait_type: string;
270
- values: NftAttribute[];
271
- unique_values: number;
272
- constructor(data: NftSummaryAttribute);
273
- }
274
- declare class NftAttribute {
275
- value: string;
276
- count: number;
277
- constructor(data: NftAttribute);
278
- }
279
- declare class NftCollectionTraitSummaryResponse {
280
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
281
- updated_at: Date;
282
- /** * List of response items. */
283
- items: NftTraitSummary[];
284
- constructor(data: NftCollectionTraitSummaryResponse);
285
- }
286
- declare class NftTraitSummary {
287
- /** * Trait name */
288
- name: string;
289
- /** * Type of the value of the trait. */
290
- value_type: string;
291
- /** * Populated for `numeric` traits. */
292
- value_numeric: NftTraitNumeric;
293
- /** * Populated for `string` traits. */
294
- value_string: NftTraitString;
295
- attributes: NftSummaryAttribute[];
296
- constructor(data: NftTraitSummary);
297
- }
298
- declare class NftTraitNumeric {
299
- min: number;
300
- max: number;
301
- constructor(data: NftTraitNumeric);
302
- }
303
- declare class NftTraitString {
304
- /** * String value */
305
- value: string;
306
- /** * Number of distinct tokens that have this trait value. */
307
- token_count: number;
308
- /** * Percentage of tokens in the collection that have this trait. */
309
- trait_percentage: number;
310
- constructor(data: NftTraitString);
311
- }
312
- declare class NftOwnershipForCollectionResponse {
313
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
314
- updated_at: Date;
315
- /** * The requested address. */
316
- address: string;
317
- /** * The requested collection. */
318
- collection: string;
319
- /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
320
- is_spam: boolean;
321
- /** * List of response items. */
322
- items: NftOwnershipForCollectionItem[];
323
- constructor(data: NftOwnershipForCollectionResponse);
324
- }
325
- declare class NftOwnershipForCollectionItem {
326
- /** * The string returned by the `name()` method. */
327
- contract_name: string;
328
- /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
329
- contract_ticker_symbol: string;
330
- /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
331
- contract_address: string;
332
- /** * The token's id. */
333
- token_id: bigint | null;
334
- /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
335
- supports_erc: string[];
336
- last_transfered_at: Date;
337
- /** * Nft balance. */
338
- balance: bigint | null;
339
- balance_24h: string;
340
- type: string;
341
- nft_data: NftData;
342
- constructor(data: NftOwnershipForCollectionItem);
343
- }
344
- declare class NftMarketSaleCountResponse {
345
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
346
- updated_at: Date;
347
- /** * The requested address. */
348
- address: string;
349
- /** * The requested quote currency eg: `USD`. */
350
- quote_currency: string;
351
- /** * The requested chain name eg: `eth-mainnet`. */
352
- chain_name: string;
353
- /** * The requested chain ID eg: `1`. */
354
- chain_id: number;
355
- /** * List of response items. */
356
- items: MarketSaleCountItem[];
357
- constructor(data: NftMarketSaleCountResponse);
358
- }
359
- declare class MarketSaleCountItem {
360
- /** * The timestamp of the date of sale. */
361
- date: Date;
362
- /** * The total amount of sales for the current day. */
363
- sale_count: number;
364
- constructor(data: MarketSaleCountItem);
365
- }
366
- declare class NftMarketVolumeResponse {
367
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
368
- updated_at: Date;
369
- /** * The requested address. */
370
- address: string;
371
- /** * The requested quote currency eg: `USD`. */
372
- quote_currency: string;
373
- /** * The requested chain name eg: `eth-mainnet`. */
374
- chain_name: string;
375
- /** * The requested chain ID eg: `1`. */
376
- chain_id: number;
377
- /** * List of response items. */
378
- items: MarketVolumeItem[];
379
- constructor(data: NftMarketVolumeResponse);
380
- }
381
- declare class MarketVolumeItem {
382
- /** * The timestamp of the date of sale. */
383
- date: Date;
384
- /** * The ticker symbol for the native currency. */
385
- native_ticker_symbol: string;
386
- /** * The contract name of the native currency. */
387
- native_name: string;
388
- /** * The current volume converted to fiat in `quote-currency`. */
389
- volume_quote: number;
390
- /** * The current volume in native currency. */
391
- volume_native_quote: number;
392
- /** * A prettier version of the volume quote for rendering purposes. */
393
- pretty_volume_quote: string;
394
- constructor(data: MarketVolumeItem);
395
- }
396
- declare class NftMarketFloorPriceResponse {
397
- /** * The timestamp when the response was generated. Useful to show data staleness to users. */
398
- updated_at: Date;
399
- /** * The requested address. */
400
- address: string;
401
- /** * The requested quote currency eg: `USD`. */
402
- quote_currency: string;
403
- /** * The requested chain name eg: `eth-mainnet`. */
404
- chain_name: string;
405
- /** * The requested chain ID eg: `1`. */
406
- chain_id: number;
407
- /** * List of response items. */
408
- items: MarketFloorPriceItem[];
409
- constructor(data: NftMarketFloorPriceResponse);
410
- }
411
- declare class MarketFloorPriceItem {
412
- /** * The timestamp of the date of sale. */
413
- date: Date;
414
- /** * The ticker symbol for the native currency. */
415
- native_ticker_symbol: string;
416
- /** * The contract name of the native currency. */
417
- native_name: string;
418
- /** * The current floor price in native currency. */
419
- floor_price_native_quote: number;
420
- /** * The current floor price converted to fiat in `quote-currency`. */
421
- floor_price_quote: number;
422
- /** * A prettier version of the floor price quote for rendering purposes. */
423
- pretty_floor_price_quote: string;
424
- constructor(data: MarketFloorPriceItem);
425
- }
426
- export interface GetChainCollectionsQueryParamOpts {
427
- /** * Number of items per page. Omitting this parameter defaults to 100. */
428
- pageSize?: number;
429
- /** * 0-indexed page number to begin pagination. */
430
- pageNumber?: number;
431
- /** * If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`. */
432
- noSpam?: boolean;
433
- }
434
- export interface GetNftsForAddressQueryParamOpts {
435
- /** * If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`. */
436
- noSpam?: boolean;
437
- /** * If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs. */
438
- noNftAssetMetadata?: boolean;
439
- /** * By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side. */
440
- withUncached?: boolean;
441
- }
442
- export interface GetTokenIdsForContractWithMetadataQueryParamOpts {
443
- /** * Omit metadata. */
444
- noMetadata?: boolean;
445
- /** * Number of items per page. Omitting this parameter defaults to 100. */
446
- pageSize?: number;
447
- /** * 0-indexed page number to begin pagination. */
448
- pageNumber?: number;
449
- /** * Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding. */
450
- traitsFilter?: string;
451
- /** * Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. If used with "traits-filter", only NFTs matching both filters will be returned. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding. */
452
- valuesFilter?: string;
453
- /** * By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side. */
454
- withUncached?: boolean;
455
- }
456
- export interface GetNftMetadataForGivenTokenIdForContractQueryParamOpts {
457
- /** * Omit metadata. */
458
- noMetadata?: boolean;
459
- /** * By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side. */
460
- withUncached?: boolean;
461
- }
462
- export interface GetNftTransactionsForContractTokenIdQueryParamOpts {
463
- /** * If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`. */
464
- noSpam?: boolean;
465
- }
466
- export interface CheckOwnershipInNftQueryParamOpts {
467
- /** * Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Must be used with "values-filter", is case-sensitive, and requires proper URL encoding. */
468
- traitsFilter?: string;
469
- /** * Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. Must be used with "traits-filter", is case-sensitive, and requires proper URL encoding. */
470
- valuesFilter?: string;
471
- }
472
- export interface GetNftMarketSaleCountQueryParamOpts {
473
- /** * The number of days to return data for. Request up 365 days. Defaults to 30 days. */
474
- days?: number;
475
- /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
476
- quoteCurrency?: Quote;
477
- }
478
- export interface GetNftMarketVolumeQueryParamOpts {
479
- /** * The number of days to return data for. Request up 365 days. Defaults to 30 days. */
480
- days?: number;
481
- /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
482
- quoteCurrency?: Quote;
483
- }
484
- export interface GetNftMarketFloorPriceQueryParamOpts {
485
- /** * The number of days to return data for. Request up 365 days. Defaults to 30 days. */
486
- days?: number;
487
- /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
488
- quoteCurrency?: Quote;
489
- }
490
- /**
491
- * NFT APIs
492
- *
493
- */
494
- export declare class NftService {
495
- private apiKey;
496
- private debug;
497
- private threadCount;
498
- private is_key_valid;
499
- private enableRetry;
500
- private source;
501
- private LIMIT;
502
- constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry: boolean, source: Source);
503
- /**
504
- *
505
- * Commonly used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files.
506
- *
507
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
508
- * @param {GetChainCollectionsQueryParamOpts} queryParamOpts
509
- * - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
510
- * - `pageNumber`: 0-indexed page number to begin pagination.
511
- * - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
512
- *
513
- */
514
- getChainCollections(chainName: Chain | Chains | ChainID, queryParamOpts?: GetChainCollectionsQueryParamOpts): AsyncIterable<ChainCollectionItem>;
515
- /**
516
- *
517
- * Commonly used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files.
518
- *
519
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
520
- * @param {GetChainCollectionsQueryParamOpts} queryParamOpts
521
- * - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
522
- * - `pageNumber`: 0-indexed page number to begin pagination.
523
- * - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
524
- *
525
- */
526
- getChainCollectionsByPage(chainName: Chain | Chains | ChainID, queryParamOpts?: GetChainCollectionsQueryParamOpts): Promise<Response<ChainCollectionResponse>>;
527
- /**
528
- *
529
- * Commonly used to render the NFTs (including ERC721 and ERC1155) held by an address.
530
- *
531
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
532
- * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
533
- * @param {GetNftsForAddressQueryParamOpts} queryParamOpts
534
- * - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
535
- * - `noNftAssetMetadata`: If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs.
536
- * - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
537
- *
538
- */
539
- getNftsForAddress(chainName: Chain | Chains | ChainID, walletAddress: string, queryParamOpts?: GetNftsForAddressQueryParamOpts): Promise<Response<NftAddressBalanceNftResponse>>;
540
- /**
541
- *
542
- * Commonly used to get NFT token IDs with metadata from a collection. Useful for building NFT card displays.
543
- *
544
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
545
- * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
546
- * @param {GetTokenIdsForContractWithMetadataQueryParamOpts} queryParamOpts
547
- * - `noMetadata`: Omit metadata.
548
- * - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
549
- * - `pageNumber`: 0-indexed page number to begin pagination.
550
- * - `traitsFilter`: Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding.
551
- * - `valuesFilter`: Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. If used with "traits-filter", only NFTs matching both filters will be returned. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding.
552
- * - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
553
- *
554
- */
555
- getTokenIdsForContractWithMetadata(chainName: Chain | Chains | ChainID, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): AsyncIterable<NftTokenContract>;
556
- /**
557
- *
558
- * Commonly used to get NFT token IDs with metadata from a collection. Useful for building NFT card displays.
559
- *
560
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
561
- * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
562
- * @param {GetTokenIdsForContractWithMetadataQueryParamOpts} queryParamOpts
563
- * - `noMetadata`: Omit metadata.
564
- * - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
565
- * - `pageNumber`: 0-indexed page number to begin pagination.
566
- * - `traitsFilter`: Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding.
567
- * - `valuesFilter`: Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. If used with "traits-filter", only NFTs matching both filters will be returned. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding.
568
- * - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
569
- *
570
- */
571
- getTokenIdsForContractWithMetadataByPage(chainName: Chain | Chains | ChainID, contractAddress: string, queryParamOpts?: GetTokenIdsForContractWithMetadataQueryParamOpts): Promise<Response<NftMetadataResponse>>;
572
- /**
573
- *
574
- * Commonly used to get a single NFT metadata by token ID from a collection. Useful for building NFT card displays.
575
- *
576
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
577
- * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
578
- * @param {string} tokenId - The requested token ID.
579
- * @param {GetNftMetadataForGivenTokenIdForContractQueryParamOpts} queryParamOpts
580
- * - `noMetadata`: Omit metadata.
581
- * - `withUncached`: By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side.
582
- *
583
- */
584
- getNftMetadataForGivenTokenIdForContract(chainName: Chain | Chains | ChainID, contractAddress: string, tokenId: string, queryParamOpts?: GetNftMetadataForGivenTokenIdForContractQueryParamOpts): Promise<Response<NftMetadataResponse>>;
585
- /**
586
- *
587
- * Commonly used to get all transactions of an NFT token. Useful for building a transaction history table or price chart.
588
- *
589
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
590
- * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
591
- * @param {string} tokenId - The requested token ID.
592
- * @param {GetNftTransactionsForContractTokenIdQueryParamOpts} queryParamOpts
593
- * - `noSpam`: If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`.
594
- *
595
- */
596
- getNftTransactionsForContractTokenId(chainName: Chain | Chains | ChainID, contractAddress: string, tokenId: string, queryParamOpts?: GetNftTransactionsForContractTokenIdQueryParamOpts): Promise<Response<NftTransactionsResponse>>;
597
- /**
598
- *
599
- * Commonly used to fetch and render the traits of a collection as seen in rarity calculators.
600
- *
601
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
602
- * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
603
- *
604
- */
605
- getTraitsForCollection(chainName: Chain | Chains | ChainID, collectionContract: string): Promise<Response<NftCollectionTraitsResponse>>;
606
- /**
607
- *
608
- * Commonly used to get the count of unique values for traits within an NFT collection.
609
- *
610
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
611
- * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
612
- * @param {string} trait - The requested trait.
613
- *
614
- */
615
- getAttributesForTraitInCollection(chainName: Chain | Chains | ChainID, collectionContract: string, trait: string): Promise<Response<NftCollectionAttributesForTraitResponse>>;
616
- /**
617
- *
618
- * Commonly used to calculate rarity scores for a collection based on its traits.
619
- *
620
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
621
- * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
622
- *
623
- */
624
- getCollectionTraitsSummary(chainName: Chain | Chains | ChainID, collectionContract: string): Promise<Response<NftCollectionTraitSummaryResponse>>;
625
- /**
626
- *
627
- * Commonly used to verify ownership of NFTs (including ERC-721 and ERC-1155) within a collection.
628
- *
629
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
630
- * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
631
- * @param {string} collectionContract - The requested collection address.
632
- * @param {CheckOwnershipInNftQueryParamOpts} queryParamOpts
633
- * - `traitsFilter`: Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Must be used with "values-filter", is case-sensitive, and requires proper URL encoding.
634
- * - `valuesFilter`: Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. Must be used with "traits-filter", is case-sensitive, and requires proper URL encoding.
635
- *
636
- */
637
- checkOwnershipInNft(chainName: Chain | Chains | ChainID, walletAddress: string, collectionContract: string, queryParamOpts?: CheckOwnershipInNftQueryParamOpts): Promise<Response<NftOwnershipForCollectionResponse>>;
638
- /**
639
- *
640
- * Commonly used to verify ownership of a specific token (ERC-721 or ERC-1155) within a collection.
641
- *
642
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
643
- * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
644
- * @param {string} collectionContract - The requested collection address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
645
- * @param {string} tokenId - The requested token ID.
646
- *
647
- */
648
- checkOwnershipInNftForSpecificTokenId(chainName: Chain | Chains | ChainID, walletAddress: string, collectionContract: string, tokenId: string): Promise<Response<NftOwnershipForCollectionResponse>>;
649
- /**
650
- *
651
- * Commonly used to build a time-series chart of the sales count of an NFT collection.
652
- *
653
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
654
- * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
655
- * @param {GetNftMarketSaleCountQueryParamOpts} queryParamOpts
656
- * - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
657
- * - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
658
- *
659
- */
660
- getNftMarketSaleCount(chainName: Chain | Chains | ChainID, contractAddress: string, queryParamOpts?: GetNftMarketSaleCountQueryParamOpts): Promise<Response<NftMarketSaleCountResponse>>;
661
- /**
662
- *
663
- * Commonly used to build a time-series chart of the transaction volume of an NFT collection.
664
- *
665
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
666
- * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
667
- * @param {GetNftMarketVolumeQueryParamOpts} queryParamOpts
668
- * - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
669
- * - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
670
- *
671
- */
672
- getNftMarketVolume(chainName: Chain | Chains | ChainID, contractAddress: string, queryParamOpts?: GetNftMarketVolumeQueryParamOpts): Promise<Response<NftMarketVolumeResponse>>;
673
- /**
674
- *
675
- * Commonly used to render a price floor chart for an NFT collection.
676
- *
677
- * @param {string} chainName - The chain name eg: `eth-mainnet`.
678
- * @param {string} contractAddress - The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
679
- * @param {GetNftMarketFloorPriceQueryParamOpts} queryParamOpts
680
- * - `days`: The number of days to return data for. Request up 365 days. Defaults to 30 days.
681
- * - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
682
- *
683
- */
684
- getNftMarketFloorPrice(chainName: Chain | Chains | ChainID, contractAddress: string, queryParamOpts?: GetNftMarketFloorPriceQueryParamOpts): Promise<Response<NftMarketFloorPriceResponse>>;
685
- }
686
- export {};