diff --git a/docs-md/classes/Alchemy.md b/docs-md/classes/Alchemy.md index e5fcedca..45d8ba3c 100644 --- a/docs-md/classes/Alchemy.md +++ b/docs-md/classes/Alchemy.md @@ -38,7 +38,7 @@ different network or API key, create a new instance of [Alchemy](Alchemy.md). #### Defined in -[src/api/alchemy.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy.ts#L63) +[src/api/alchemy.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy.ts#L63) ## Properties @@ -51,7 +51,7 @@ and allows access to the underlying providers. #### Defined in -[src/api/alchemy.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy.ts#L42) +[src/api/alchemy.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy.ts#L42) ___ @@ -64,7 +64,7 @@ Enhanced APIs. #### Defined in -[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy.ts#L24) +[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy.ts#L24) ___ @@ -77,7 +77,7 @@ transactions. #### Defined in -[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy.ts#L54) +[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy.ts#L54) ___ @@ -89,7 +89,7 @@ The `nft` namespace contains methods for Alchemy's NFT API. #### Defined in -[src/api/alchemy.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy.ts#L27) +[src/api/alchemy.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy.ts#L27) ___ @@ -102,7 +102,7 @@ as part of the Notify API. #### Defined in -[src/api/alchemy.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy.ts#L48) +[src/api/alchemy.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy.ts#L48) ___ @@ -115,7 +115,7 @@ checking on the state of submitted transasctions. #### Defined in -[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy.ts#L36) +[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy.ts#L36) ___ @@ -127,4 +127,4 @@ The `ws` namespace contains methods for using WebSockets and creating subscripti #### Defined in -[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy.ts#L30) +[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy.ts#L30) diff --git a/docs-md/classes/AlchemyConfig.md b/docs-md/classes/AlchemyConfig.md index fa62c0e2..39c76e4f 100644 --- a/docs-md/classes/AlchemyConfig.md +++ b/docs-md/classes/AlchemyConfig.md @@ -40,7 +40,7 @@ exposes the underlying providers for more advanced use cases. #### Defined in -[src/api/alchemy-config.ts:64](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L64) +[src/api/alchemy-config.ts:64](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L64) ## Properties @@ -52,7 +52,7 @@ The Alchemy API key. #### Defined in -[src/api/alchemy-config.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L23) +[src/api/alchemy-config.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L23) ___ @@ -64,7 +64,7 @@ The optional Alchemy auth token to use when sending requests with the Notify API #### Defined in -[src/api/alchemy-config.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L41) +[src/api/alchemy-config.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L41) ___ @@ -76,7 +76,7 @@ Setting to enable automatic batching on json-rpc requests. Defaults to false. #### Defined in -[src/api/alchemy-config.ts:32](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L32) +[src/api/alchemy-config.ts:32](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L32) ___ @@ -88,7 +88,7 @@ The maximum number of retries to perform. #### Defined in -[src/api/alchemy-config.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L29) +[src/api/alchemy-config.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L29) ___ @@ -100,7 +100,7 @@ The Network that this SDK is associated with. #### Defined in -[src/api/alchemy-config.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L26) +[src/api/alchemy-config.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L26) ___ @@ -112,7 +112,7 @@ The optional Request timeout provided in `ms` for NFT and NOTIFY API. Defaults t #### Defined in -[src/api/alchemy-config.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L46) +[src/api/alchemy-config.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L46) ___ @@ -125,7 +125,7 @@ and apiKey. #### Defined in -[src/api/alchemy-config.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L38) +[src/api/alchemy-config.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L38) ## Methods @@ -149,7 +149,7 @@ other less-common methods. #### Defined in -[src/api/alchemy-config.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L107) +[src/api/alchemy-config.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L107) ___ @@ -174,4 +174,4 @@ other less-common methods. #### Defined in -[src/api/alchemy-config.ts:129](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-config.ts#L129) +[src/api/alchemy-config.ts:129](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-config.ts#L129) diff --git a/docs-md/classes/AlchemyProvider.md b/docs-md/classes/AlchemyProvider.md index 454f2fdf..8b2aa79a 100644 --- a/docs-md/classes/AlchemyProvider.md +++ b/docs-md/classes/AlchemyProvider.md @@ -402,7 +402,7 @@ ___ #### Defined in -[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-provider.ts#L41) +[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-provider.ts#L41) ___ @@ -412,7 +412,7 @@ ___ #### Defined in -[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-provider.ts#L43) +[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-provider.ts#L43) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-provider.ts#L42) +[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-provider.ts#L42) ## Accessors @@ -936,7 +936,7 @@ JsonRpcProvider.\_startPending #### Defined in -[src/api/alchemy-provider.ts:211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-provider.ts#L211) +[src/api/alchemy-provider.ts:211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-provider.ts#L211) ___ @@ -1136,7 +1136,7 @@ JsonRpcProvider.detectNetwork #### Defined in -[src/api/alchemy-provider.ts:199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-provider.ts#L199) +[src/api/alchemy-provider.ts:199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-provider.ts#L199) ___ @@ -1615,7 +1615,7 @@ CommunityResourcable.isCommunityResource #### Defined in -[src/api/alchemy-provider.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-provider.ts#L221) +[src/api/alchemy-provider.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-provider.ts#L221) ___ @@ -1728,7 +1728,7 @@ not defined in ethers. #### Defined in -[src/api/alchemy-provider.ts:332](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-provider.ts#L332) +[src/api/alchemy-provider.ts:332](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-provider.ts#L332) ___ @@ -1998,7 +1998,7 @@ JsonRpcProvider.send #### Defined in -[src/api/alchemy-provider.ts:235](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-provider.ts#L235) +[src/api/alchemy-provider.ts:235](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-provider.ts#L235) ___ diff --git a/docs-md/classes/AlchemyWebSocketProvider.md b/docs-md/classes/AlchemyWebSocketProvider.md index 9323e70b..71a42c69 100644 --- a/docs-md/classes/AlchemyWebSocketProvider.md +++ b/docs-md/classes/AlchemyWebSocketProvider.md @@ -202,7 +202,7 @@ WebSocketProvider.\_events #### Defined in -[src/api/alchemy-websocket-provider.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L81) +[src/api/alchemy-websocket-provider.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L81) ___ @@ -504,7 +504,7 @@ ___ #### Defined in -[src/api/alchemy-websocket-provider.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L82) +[src/api/alchemy-websocket-provider.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L82) ___ @@ -941,7 +941,7 @@ order to parse the Alchemy subscription event. #### Defined in -[src/api/alchemy-websocket-provider.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L947) +[src/api/alchemy-websocket-provider.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L947) ___ @@ -970,7 +970,7 @@ order to parse the Alchemy subscription event. #### Defined in -[src/api/alchemy-websocket-provider.ts:970](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L970) +[src/api/alchemy-websocket-provider.ts:970](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L970) ___ @@ -1000,7 +1000,7 @@ order to parse the Alchemy subscription event. #### Defined in -[src/api/alchemy-websocket-provider.ts:871](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L871) +[src/api/alchemy-websocket-provider.ts:871](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L871) ___ @@ -1047,7 +1047,7 @@ order to parse the Alchemy subscription event. #### Defined in -[src/api/alchemy-websocket-provider.ts:911](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L911) +[src/api/alchemy-websocket-provider.ts:911](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L911) ___ @@ -1262,7 +1262,7 @@ WebSocketProvider.destroy #### Defined in -[src/api/alchemy-websocket-provider.ts:407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L407) +[src/api/alchemy-websocket-provider.ts:407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L407) ___ @@ -1307,7 +1307,7 @@ ___ #### Defined in -[src/api/alchemy-websocket-provider.ts:703](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L703) +[src/api/alchemy-websocket-provider.ts:703](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L703) ___ @@ -1761,7 +1761,7 @@ CommunityResourcable.isCommunityResource #### Defined in -[src/api/alchemy-websocket-provider.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L419) +[src/api/alchemy-websocket-provider.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L419) ___ @@ -1808,7 +1808,7 @@ WebSocketProvider.listenerCount #### Defined in -[src/api/alchemy-websocket-provider.ts:223](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L223) +[src/api/alchemy-websocket-provider.ts:223](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L223) ___ @@ -1837,7 +1837,7 @@ WebSocketProvider.listeners #### Defined in -[src/api/alchemy-websocket-provider.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L239) +[src/api/alchemy-websocket-provider.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L239) ___ @@ -1891,7 +1891,7 @@ WebSocketProvider.off #### Defined in -[src/api/alchemy-websocket-provider.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L191) +[src/api/alchemy-websocket-provider.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L191) ___ @@ -1920,7 +1920,7 @@ WebSocketProvider.on #### Defined in -[src/api/alchemy-websocket-provider.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L163) +[src/api/alchemy-websocket-provider.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L163) ___ @@ -1951,7 +1951,7 @@ WebSocketProvider.once #### Defined in -[src/api/alchemy-websocket-provider.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L178) +[src/api/alchemy-websocket-provider.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L178) ___ @@ -2048,7 +2048,7 @@ WebSocketProvider.removeAllListeners #### Defined in -[src/api/alchemy-websocket-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-websocket-provider.ts#L207) +[src/api/alchemy-websocket-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-websocket-provider.ts#L207) ___ diff --git a/docs-md/classes/CoreNamespace.md b/docs-md/classes/CoreNamespace.md index 9ae56642..e9063415 100644 --- a/docs-md/classes/CoreNamespace.md +++ b/docs-md/classes/CoreNamespace.md @@ -68,7 +68,7 @@ calling getters on Contracts. #### Defined in -[src/api/core-namespace.ts:242](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L242) +[src/api/core-namespace.ts:242](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L242) ___ @@ -97,7 +97,7 @@ This is an alias for [TransactNamespace.estimateGas](TransactNamespace.md#estima #### Defined in -[src/api/core-namespace.ts:263](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L263) +[src/api/core-namespace.ts:263](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L263) ___ @@ -127,7 +127,7 @@ with this information cached. #### Defined in -[src/api/core-namespace.ts:384](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L384) +[src/api/core-namespace.ts:384](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L384) ___ @@ -155,7 +155,7 @@ response object. #### Defined in -[src/api/core-namespace.ts:611](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L611) +[src/api/core-namespace.ts:611](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L611) ▸ **getAssetTransfers**(`params`): `Promise`<[`AssetTransfersResponse`](../interfaces/AssetTransfersResponse.md)\> @@ -175,7 +175,7 @@ https://docs.alchemy.com/alchemy/enhanced-apis/transfers-api#alchemy_getassettra #### Defined in -[src/api/core-namespace.ts:623](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L623) +[src/api/core-namespace.ts:623](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L623) ___ @@ -198,7 +198,7 @@ Returns the balance of a given address as of the provided block. #### Defined in -[src/api/core-namespace.ts:69](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L69) +[src/api/core-namespace.ts:69](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L69) ___ @@ -223,7 +223,7 @@ hashes. To get the full transaction details on the block, use #### Defined in -[src/api/core-namespace.ts:151](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L151) +[src/api/core-namespace.ts:151](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L151) ___ @@ -239,7 +239,7 @@ Returns the block number of the most recently mined block. #### Defined in -[src/api/core-namespace.ts:188](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L188) +[src/api/core-namespace.ts:188](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L188) ___ @@ -263,7 +263,7 @@ hash. Transactions on the block are represented as an array of #### Defined in -[src/api/core-namespace.ts:166](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L166) +[src/api/core-namespace.ts:166](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L166) ___ @@ -287,7 +287,7 @@ no contract deployed, the result is `0x`. #### Defined in -[src/api/core-namespace.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L98) +[src/api/core-namespace.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L98) ___ @@ -309,7 +309,7 @@ gasPrice should be used. #### Defined in -[src/api/core-namespace.ts:214](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L214) +[src/api/core-namespace.ts:214](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L214) ___ @@ -325,7 +325,7 @@ Returns the best guess of the current gas price to use in a transaction. #### Defined in -[src/api/core-namespace.ts:198](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L198) +[src/api/core-namespace.ts:198](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L198) ___ @@ -347,7 +347,7 @@ Returns an array of logs that match the provided filter. #### Defined in -[src/api/core-namespace.ts:354](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L354) +[src/api/core-namespace.ts:354](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L354) ___ @@ -363,7 +363,7 @@ Returns the {@link EthersNetworkAlias} Alchemy is connected to. #### Defined in -[src/api/core-namespace.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L178) +[src/api/core-namespace.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L178) ___ @@ -388,7 +388,7 @@ provided block in `Bytes32` format. #### Defined in -[src/api/core-namespace.ts:116](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L116) +[src/api/core-namespace.ts:116](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L116) ___ @@ -410,7 +410,7 @@ Returns the ERC-20 token balances for a specific owner address. #### Defined in -[src/api/core-namespace.ts:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L425) +[src/api/core-namespace.ts:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L425) ▸ **getTokenBalances**(`addressOrName`, `contractAddresses?`): `Promise`<[`TokenBalancesResponse`](../interfaces/TokenBalancesResponse.md)\> @@ -429,7 +429,7 @@ Returns the token balances for a specific owner address given a list of contract #### Defined in -[src/api/core-namespace.ts:437](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L437) +[src/api/core-namespace.ts:437](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L437) ▸ **getTokenBalances**(`addressOrName`, `options`): `Promise`<[`TokenBalancesResponseErc20`](../interfaces/TokenBalancesResponseErc20.md)\> @@ -450,7 +450,7 @@ This overload covers the erc-20 token type which includes a page key in the resp #### Defined in -[src/api/core-namespace.ts:451](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L451) +[src/api/core-namespace.ts:451](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L451) ▸ **getTokenBalances**(`addressOrName`, `options`): `Promise`<[`TokenBalancesResponse`](../interfaces/TokenBalancesResponse.md)\> @@ -473,7 +473,7 @@ the response. #### Defined in -[src/api/core-namespace.ts:467](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L467) +[src/api/core-namespace.ts:467](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L467) ___ @@ -495,7 +495,7 @@ Returns metadata for a given token contract address. #### Defined in -[src/api/core-namespace.ts:590](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L590) +[src/api/core-namespace.ts:590](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L590) ___ @@ -519,7 +519,7 @@ of each token and the relevant metadata. #### Defined in -[src/api/core-namespace.ts:525](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L525) +[src/api/core-namespace.ts:525](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L525) ___ @@ -548,7 +548,7 @@ NOTE: This is an alias for [TransactNamespace.getTransaction](TransactNamespace. #### Defined in -[src/api/core-namespace.ts:283](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L283) +[src/api/core-namespace.ts:283](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L283) ___ @@ -573,7 +573,7 @@ transaction from the address sent to the network. #### Defined in -[src/api/core-namespace.ts:134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L134) +[src/api/core-namespace.ts:134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L134) ___ @@ -599,7 +599,7 @@ waitForTransaction method below. #### Defined in -[src/api/core-namespace.ts:300](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L300) +[src/api/core-namespace.ts:300](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L300) ___ @@ -621,7 +621,7 @@ Gets all transaction receipts for a given block by number or block hash. #### Defined in -[src/api/core-namespace.ts:638](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L638) +[src/api/core-namespace.ts:638](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L638) ___ @@ -643,7 +643,7 @@ Checks if the provided address is a smart contract. #### Defined in -[src/api/core-namespace.ts:83](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L83) +[src/api/core-namespace.ts:83](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L83) ___ @@ -667,7 +667,7 @@ An ENS name requires additional configuration to setup a reverse record, so not #### Defined in -[src/api/core-namespace.ts:662](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L662) +[src/api/core-namespace.ts:662](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L662) ___ @@ -687,7 +687,7 @@ up and running smoothly. #### Defined in -[src/api/core-namespace.ts:228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L228) +[src/api/core-namespace.ts:228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L228) ___ @@ -710,7 +710,7 @@ if the ENS name does not have an underlying address. #### Defined in -[src/api/core-namespace.ts:650](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L650) +[src/api/core-namespace.ts:650](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L650) ___ @@ -733,7 +733,7 @@ Allows sending a raw message to the Alchemy backend. #### Defined in -[src/api/core-namespace.ts:367](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L367) +[src/api/core-namespace.ts:367](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L367) ___ @@ -759,7 +759,7 @@ NOTE: This is an alias for [TransactNamespace.getTransaction](TransactNamespace. #### Defined in -[src/api/core-namespace.ts:317](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L317) +[src/api/core-namespace.ts:317](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L317) ___ @@ -790,4 +790,4 @@ NOTE: This is an alias for [TransactNamespace.getTransaction](TransactNamespace. #### Defined in -[src/api/core-namespace.ts:339](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/core-namespace.ts#L339) +[src/api/core-namespace.ts:339](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/core-namespace.ts#L339) diff --git a/docs-md/classes/DebugNamespace.md b/docs-md/classes/DebugNamespace.md index 0ed1590e..a3b70404 100644 --- a/docs-md/classes/DebugNamespace.md +++ b/docs-md/classes/DebugNamespace.md @@ -41,7 +41,7 @@ Replays a block that has already been mined. #### Defined in -[src/api/debug-namespace.ts:120](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/debug-namespace.ts#L120) +[src/api/debug-namespace.ts:120](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/debug-namespace.ts#L120) ▸ **traceBlock**(`blockIdentifier`, `tracer`): `Promise`<[`DebugPrestateTrace`](../modules.md#debugprestatetrace)\> @@ -60,7 +60,7 @@ Replays a block that has already been mined. #### Defined in -[src/api/debug-namespace.ts:131](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/debug-namespace.ts#L131) +[src/api/debug-namespace.ts:131](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/debug-namespace.ts#L131) ___ @@ -85,7 +85,7 @@ final state of the parent block as the base. #### Defined in -[src/api/debug-namespace.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/debug-namespace.ts#L36) +[src/api/debug-namespace.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/debug-namespace.ts#L36) ▸ **traceCall**(`transaction`, `blockIdentifier`, `tracer`): `Promise`<[`DebugPrestateTrace`](../modules.md#debugprestatetrace)\> @@ -106,7 +106,7 @@ final state of the parent block as the base. #### Defined in -[src/api/debug-namespace.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/debug-namespace.ts#L51) +[src/api/debug-namespace.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/debug-namespace.ts#L51) ___ @@ -133,7 +133,7 @@ that corresponds to the given hash. #### Defined in -[src/api/debug-namespace.ts:79](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/debug-namespace.ts#L79) +[src/api/debug-namespace.ts:79](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/debug-namespace.ts#L79) ▸ **traceTransaction**(`transactionHash`, `tracer`, `timeout?`): `Promise`<[`DebugPrestateTrace`](../modules.md#debugprestatetrace)\> @@ -156,4 +156,4 @@ that corresponds to the given hash. #### Defined in -[src/api/debug-namespace.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/debug-namespace.ts#L98) +[src/api/debug-namespace.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/debug-namespace.ts#L98) diff --git a/docs-md/classes/NftNamespace.md b/docs-md/classes/NftNamespace.md index 5193612e..b58fc298 100644 --- a/docs-md/classes/NftNamespace.md +++ b/docs-md/classes/NftNamespace.md @@ -61,7 +61,7 @@ Get the rarity of each attribute of an NFT. #### Defined in -[src/api/nft-namespace.ts:534](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L534) +[src/api/nft-namespace.ts:534](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L534) ___ @@ -85,7 +85,7 @@ Get the NFT collection metadata associated with the provided parameters. #### Defined in -[src/api/nft-namespace.ts:168](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L168) +[src/api/nft-namespace.ts:168](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L168) ___ @@ -107,7 +107,7 @@ Get the NFT contract metadata associated with the provided parameters. #### Defined in -[src/api/nft-namespace.ts:147](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L147) +[src/api/nft-namespace.ts:147](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L147) ___ @@ -129,7 +129,7 @@ Get the NFT contract metadata for multiple NFT contracts in a single request. #### Defined in -[src/api/nft-namespace.ts:156](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L156) +[src/api/nft-namespace.ts:156](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L156) ___ @@ -152,7 +152,7 @@ Gets all NFT contracts held by the specified owner address. #### Defined in -[src/api/nft-namespace.ts:378](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L378) +[src/api/nft-namespace.ts:378](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L378) ___ @@ -176,7 +176,7 @@ Returns the floor prices of a NFT contract by marketplace. #### Defined in -[src/api/nft-namespace.ts:508](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L508) +[src/api/nft-namespace.ts:508](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L508) ___ @@ -199,7 +199,7 @@ Get all the NFTs minted by a specified owner address. #### Defined in -[src/api/nft-namespace.ts:422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L422) +[src/api/nft-namespace.ts:422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L422) ___ @@ -223,7 +223,7 @@ Get the NFT metadata associated with the provided parameters. #### Defined in -[src/api/nft-namespace.ts:101](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L101) +[src/api/nft-namespace.ts:101](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L101) ___ @@ -246,7 +246,7 @@ Gets the NFT metadata for multiple NFT tokens. #### Defined in -[src/api/nft-namespace.ts:134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L134) +[src/api/nft-namespace.ts:134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L134) ___ @@ -270,7 +270,7 @@ Returns NFT sales that have happened through on-chain marketplaces. #### Defined in -[src/api/nft-namespace.ts:518](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L518) +[src/api/nft-namespace.ts:518](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L518) ▸ **getNftSales**(`options?`): `Promise`<[`GetNftSalesResponse`](../interfaces/GetNftSalesResponse.md)\> @@ -286,7 +286,7 @@ Returns NFT sales that have happened through on-chain marketplaces. #### Defined in -[src/api/nft-namespace.ts:519](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L519) +[src/api/nft-namespace.ts:519](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L519) ___ @@ -314,7 +314,7 @@ their associated metadata, use [GetBaseNftsForContractOptions](../interfaces/Get #### Defined in -[src/api/nft-namespace.ts:253](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L253) +[src/api/nft-namespace.ts:253](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L253) ▸ **getNftsForContract**(`contractAddress`, `options?`): `Promise`<[`NftContractBaseNftsResponse`](../interfaces/NftContractBaseNftsResponse.md)\> @@ -338,7 +338,7 @@ all NFTs with their associated metadata, use [GetNftsForContractOptions](../inte #### Defined in -[src/api/nft-namespace.ts:267](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L267) +[src/api/nft-namespace.ts:267](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L267) ___ @@ -367,7 +367,7 @@ associated metadata, use [GetBaseNftsForContractOptions](../interfaces/GetBaseNf #### Defined in -[src/api/nft-namespace.ts:289](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L289) +[src/api/nft-namespace.ts:289](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L289) ▸ **getNftsForContractIterator**(`contractAddress`, `options?`): `AsyncIterable`<[`BaseNft`](../interfaces/BaseNft.md)\> @@ -393,7 +393,7 @@ NFTs with their associated metadata, use [GetNftsForContractOptions](../interfac #### Defined in -[src/api/nft-namespace.ts:305](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L305) +[src/api/nft-namespace.ts:305](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L305) ___ @@ -419,7 +419,7 @@ all NFTs with their associated metadata, use [GetNftsForOwnerOptions](../interfa #### Defined in -[src/api/nft-namespace.ts:217](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L217) +[src/api/nft-namespace.ts:217](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L217) ▸ **getNftsForOwner**(`owner`, `options?`): `Promise`<[`OwnedNftsResponse`](../interfaces/OwnedNftsResponse.md)\> @@ -441,7 +441,7 @@ their associated metadata, use [GetBaseNftsForOwnerOptions](../interfaces/GetBas #### Defined in -[src/api/nft-namespace.ts:231](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L231) +[src/api/nft-namespace.ts:231](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L231) ___ @@ -467,7 +467,7 @@ keys until all NFTs have been fetched. #### Defined in -[src/api/nft-namespace.ts:182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L182) +[src/api/nft-namespace.ts:182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L182) ▸ **getNftsForOwnerIterator**(`owner`, `options?`): `AsyncIterable`<[`OwnedBaseNft`](../interfaces/OwnedBaseNft.md)\> @@ -489,7 +489,7 @@ pages through all page keys until all NFTs have been fetched. #### Defined in -[src/api/nft-namespace.ts:196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L196) +[src/api/nft-namespace.ts:196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L196) ___ @@ -512,7 +512,7 @@ Gets all the owners for a given NFT contract along with the token balance. #### Defined in -[src/api/nft-namespace.ts:323](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L323) +[src/api/nft-namespace.ts:323](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L323) ▸ **getOwnersForContract**(`contractAddress`, `options?`): `Promise`<[`GetOwnersForContractResponse`](../interfaces/GetOwnersForContractResponse.md)\> @@ -535,7 +535,7 @@ which has the `withTokenBalances` field set to `true`. #### Defined in -[src/api/nft-namespace.ts:339](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L339) +[src/api/nft-namespace.ts:339](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L339) ___ @@ -561,7 +561,7 @@ Gets all the owners for a given NFT contract address and token ID. #### Defined in -[src/api/nft-namespace.ts:362](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L362) +[src/api/nft-namespace.ts:362](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L362) ___ @@ -579,7 +579,7 @@ https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-clas #### Defined in -[src/api/nft-namespace.ts:472](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L472) +[src/api/nft-namespace.ts:472](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L472) ___ @@ -605,7 +605,7 @@ block range, use [GetTransfersForContractOptions](../interfaces/GetTransfersForC #### Defined in -[src/api/nft-namespace.ts:409](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L409) +[src/api/nft-namespace.ts:409](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L409) ___ @@ -629,7 +629,7 @@ Gets all NFT transfers for a given owner's address. #### Defined in -[src/api/nft-namespace.ts:392](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L392) +[src/api/nft-namespace.ts:392](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L392) ___ @@ -654,7 +654,7 @@ sent by a different address. #### Defined in -[src/api/nft-namespace.ts:495](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L495) +[src/api/nft-namespace.ts:495](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L495) ___ @@ -678,7 +678,7 @@ https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-clas #### Defined in -[src/api/nft-namespace.ts:463](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L463) +[src/api/nft-namespace.ts:463](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L463) ___ @@ -707,7 +707,7 @@ process. To refresh the metadata for a specific token, use the #### Defined in -[src/api/nft-namespace.ts:596](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L596) +[src/api/nft-namespace.ts:596](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L596) ___ @@ -739,7 +739,7 @@ To trigger a refresh for all NFTs in a contract, use [refreshContract](NftNamesp #### Defined in -[src/api/nft-namespace.ts:578](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L578) +[src/api/nft-namespace.ts:578](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L578) ___ @@ -763,7 +763,7 @@ https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-clas #### Defined in -[src/api/nft-namespace.ts:483](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L483) +[src/api/nft-namespace.ts:483](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L483) ___ @@ -785,7 +785,7 @@ Search for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts #### Defined in -[src/api/nft-namespace.ts:546](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L546) +[src/api/nft-namespace.ts:546](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L546) ___ @@ -807,7 +807,7 @@ Get a summary of attribute prevalence for an NFT collection. #### Defined in -[src/api/nft-namespace.ts:557](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L557) +[src/api/nft-namespace.ts:557](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L557) ___ @@ -831,7 +831,7 @@ NFT. Returns a boolean indicating whether the owner address owns the provided NF #### Defined in -[src/api/nft-namespace.ts:436](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L436) +[src/api/nft-namespace.ts:436](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L436) ▸ **verifyNftOwnership**(`owner`, `contractAddresses`): `Promise`<{ `[contractAddress: string]`: `boolean`; }\> @@ -851,4 +851,4 @@ contract address to a boolean indicating whether the owner address owns the NFT. #### Defined in -[src/api/nft-namespace.ts:445](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/nft-namespace.ts#L445) +[src/api/nft-namespace.ts:445](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/nft-namespace.ts#L445) diff --git a/docs-md/classes/NotifyNamespace.md b/docs-md/classes/NotifyNamespace.md index a9c0f91b..6ca38f8a 100644 --- a/docs-md/classes/NotifyNamespace.md +++ b/docs-md/classes/NotifyNamespace.md @@ -56,7 +56,7 @@ Note that the webhook will be created in the app network of the provided app id. #### Defined in -[src/api/notify-namespace.ts:360](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L360) +[src/api/notify-namespace.ts:360](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L360) ▸ **createWebhook**(`url`, `type`, `params`): `Promise`<[`DroppedTransactionWebhook`](../interfaces/DroppedTransactionWebhook.md)\> @@ -79,7 +79,7 @@ Note that the webhook will be created in the app network of the provided app id. #### Defined in -[src/api/notify-namespace.ts:377](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L377) +[src/api/notify-namespace.ts:377](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L377) ▸ **createWebhook**(`url`, `type`, `params`): `Promise`<[`NftActivityWebhook`](../interfaces/NftActivityWebhook.md)\> @@ -99,7 +99,7 @@ Create a new [NftActivityWebhook](../interfaces/NftActivityWebhook.md) to track #### Defined in -[src/api/notify-namespace.ts:391](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L391) +[src/api/notify-namespace.ts:391](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L391) ▸ **createWebhook**(`url`, `type`, `params`): `Promise`<[`NftMetadataUpdateWebhook`](../interfaces/NftMetadataUpdateWebhook.md)\> @@ -117,7 +117,7 @@ Create a new [NftActivityWebhook](../interfaces/NftActivityWebhook.md) to track #### Defined in -[src/api/notify-namespace.ts:397](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L397) +[src/api/notify-namespace.ts:397](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L397) ▸ **createWebhook**(`url`, `type`, `params`): `Promise`<[`CustomGraphqlWebhook`](../interfaces/CustomGraphqlWebhook.md)\> @@ -137,7 +137,7 @@ Create a new [CustomGraphqlWebhook](../interfaces/CustomGraphqlWebhook.md) to tr #### Defined in -[src/api/notify-namespace.ts:411](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L411) +[src/api/notify-namespace.ts:411](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L411) ▸ **createWebhook**(`url`, `type`, `params`): `Promise`<[`AddressActivityWebhook`](../interfaces/AddressActivityWebhook.md)\> @@ -157,7 +157,7 @@ Create a new [AddressActivityWebhook](../interfaces/AddressActivityWebhook.md) t #### Defined in -[src/api/notify-namespace.ts:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L425) +[src/api/notify-namespace.ts:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L425) ___ @@ -179,7 +179,7 @@ Delete the provided webhook. #### Defined in -[src/api/notify-namespace.ts:545](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L545) +[src/api/notify-namespace.ts:545](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L545) ▸ **deleteWebhook**(`webhookId`): `Promise`<`void`\> @@ -197,7 +197,7 @@ Delete the provided webhook. #### Defined in -[src/api/notify-namespace.ts:552](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L552) +[src/api/notify-namespace.ts:552](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L552) ___ @@ -220,7 +220,7 @@ Get all addresses tracked for the provided [AddressActivityWebhook](../interface #### Defined in -[src/api/notify-namespace.ts:91](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L91) +[src/api/notify-namespace.ts:91](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L91) ▸ **getAddresses**(`webhookId`, `options?`): `Promise`<[`AddressActivityResponse`](../interfaces/AddressActivityResponse.md)\> @@ -239,7 +239,7 @@ Get all addresses tracked for the provided [AddressActivityWebhook](../interface #### Defined in -[src/api/notify-namespace.ts:104](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L104) +[src/api/notify-namespace.ts:104](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L104) ___ @@ -260,7 +260,7 @@ This method returns a response object containing all the webhooks #### Defined in -[src/api/notify-namespace.ts:72](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L72) +[src/api/notify-namespace.ts:72](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L72) ___ @@ -282,7 +282,7 @@ Get the graphql query used for the provided [CustomGraphqlWebhook](../interfaces #### Defined in -[src/api/notify-namespace.ts:132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L132) +[src/api/notify-namespace.ts:132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L132) ▸ **getGraphqlQuery**(`webhookId`): `Promise`<[`CustomGraphqlWebhookConfig`](../interfaces/CustomGraphqlWebhookConfig.md)\> @@ -300,7 +300,7 @@ Get the graphql query used for the provided [CustomGraphqlWebhook](../interfaces #### Defined in -[src/api/notify-namespace.ts:143](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L143) +[src/api/notify-namespace.ts:143](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L143) ___ @@ -323,7 +323,7 @@ Get all NFTs tracked for the provided [NftActivityWebhook](../interfaces/NftActi #### Defined in -[src/api/notify-namespace.ts:167](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L167) +[src/api/notify-namespace.ts:167](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L167) ▸ **getNftFilters**(`webhookId`, `options?`): `Promise`<[`NftFiltersResponse`](../interfaces/NftFiltersResponse.md)\> @@ -342,7 +342,7 @@ Get all NFT filters tracked for the provided [NftActivityWebhook](../interfaces/ #### Defined in -[src/api/notify-namespace.ts:180](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L180) +[src/api/notify-namespace.ts:180](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L180) ___ @@ -371,7 +371,7 @@ ___ #### Defined in -[src/api/notify-namespace.ts:584](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L584) +[src/api/notify-namespace.ts:584](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L584) ___ @@ -394,7 +394,7 @@ Update a [NftActivityWebhook](../interfaces/NftActivityWebhook.md)'s active stat #### Defined in -[src/api/notify-namespace.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L209) +[src/api/notify-namespace.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L209) ▸ **updateWebhook**(`nftWebhookId`, `update`): `Promise`<`void`\> @@ -413,7 +413,7 @@ Update a [NftActivityWebhook](../interfaces/NftActivityWebhook.md)'s active stat #### Defined in -[src/api/notify-namespace.ts:220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L220) +[src/api/notify-namespace.ts:220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L220) ▸ **updateWebhook**(`nftMetadataWebhookId`, `update`): `Promise`<`void`\> @@ -432,7 +432,7 @@ Update a [NftMetadataUpdateWebhook](../interfaces/NftMetadataUpdateWebhook.md)'s #### Defined in -[src/api/notify-namespace.ts:228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L228) +[src/api/notify-namespace.ts:228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L228) ▸ **updateWebhook**(`customGraphqlWebhookId`, `update`): `Promise`<`void`\> @@ -452,7 +452,7 @@ The graphql query associated with the webhook is immutable. #### Defined in -[src/api/notify-namespace.ts:240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L240) +[src/api/notify-namespace.ts:240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L240) ▸ **updateWebhook**(`addressWebhook`, `update`): `Promise`<`void`\> @@ -471,7 +471,7 @@ Update a [AddressActivityWebhook](../interfaces/AddressActivityWebhook.md)'s act #### Defined in -[src/api/notify-namespace.ts:251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L251) +[src/api/notify-namespace.ts:251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L251) ▸ **updateWebhook**(`addressWebhookId`, `update`): `Promise`<`void`\> @@ -490,7 +490,7 @@ Update a [AddressActivityWebhook](../interfaces/AddressActivityWebhook.md)'s act #### Defined in -[src/api/notify-namespace.ts:262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L262) +[src/api/notify-namespace.ts:262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L262) ___ @@ -504,4 +504,4 @@ ___ #### Defined in -[src/api/notify-namespace.ts:575](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/notify-namespace.ts#L575) +[src/api/notify-namespace.ts:575](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/notify-namespace.ts#L575) diff --git a/docs-md/classes/TransactNamespace.md b/docs-md/classes/TransactNamespace.md index 5532ba1b..02b206ad 100644 --- a/docs-md/classes/TransactNamespace.md +++ b/docs-md/classes/TransactNamespace.md @@ -52,7 +52,7 @@ Returns a boolean indicating whether the cancellation was successful. #### Defined in -[src/api/transact-namespace.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L86) +[src/api/transact-namespace.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L86) ___ @@ -81,7 +81,7 @@ This is an alias for [CoreNamespace.estimateGas](CoreNamespace.md#estimategas). #### Defined in -[src/api/transact-namespace.ts:258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L258) +[src/api/transact-namespace.ts:258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L258) ___ @@ -101,7 +101,7 @@ transaction request. #### Defined in -[src/api/transact-namespace.ts:274](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L274) +[src/api/transact-namespace.ts:274](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L274) ___ @@ -130,7 +130,7 @@ NOTE: This is an alias for [CoreNamespace.getTransaction](CoreNamespace.md#gettr #### Defined in -[src/api/transact-namespace.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L221) +[src/api/transact-namespace.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L221) ___ @@ -157,7 +157,7 @@ Returns the transaction hash of the submitted transaction. #### Defined in -[src/api/transact-namespace.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L54) +[src/api/transact-namespace.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L54) ___ @@ -183,7 +183,7 @@ NOTE: This is an alias for [CoreNamespace.sendTransaction](CoreNamespace.md#send #### Defined in -[src/api/transact-namespace.ts:238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L238) +[src/api/transact-namespace.ts:238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L238) ___ @@ -210,7 +210,7 @@ blockchain. #### Defined in -[src/api/transact-namespace.ts:137](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L137) +[src/api/transact-namespace.ts:137](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L137) ___ @@ -236,7 +236,7 @@ Returns a list of asset changes for each transaction during simulation. #### Defined in -[src/api/transact-namespace.ts:109](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L109) +[src/api/transact-namespace.ts:109](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L109) ___ @@ -262,7 +262,7 @@ Note that this method does not run the transaction on the blockchain. #### Defined in -[src/api/transact-namespace.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L191) +[src/api/transact-namespace.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L191) ___ @@ -288,7 +288,7 @@ Note that this method does not run any transactions on the blockchain. #### Defined in -[src/api/transact-namespace.ts:164](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L164) +[src/api/transact-namespace.ts:164](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L164) ___ @@ -319,4 +319,4 @@ NOTE: This is an alias for [CoreNamespace.waitForTransaction](CoreNamespace.md#w #### Defined in -[src/api/transact-namespace.ts:299](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/transact-namespace.ts#L299) +[src/api/transact-namespace.ts:299](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/transact-namespace.ts#L299) diff --git a/docs-md/classes/Wallet.md b/docs-md/classes/Wallet.md index 60d2b5a7..086a6c29 100644 --- a/docs-md/classes/Wallet.md +++ b/docs-md/classes/Wallet.md @@ -91,7 +91,7 @@ EthersWallet.constructor #### Defined in -[src/api/alchemy-wallet.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L39) +[src/api/alchemy-wallet.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L39) ## Properties @@ -173,7 +173,7 @@ ___ #### Defined in -[src/api/alchemy-wallet.ts:31](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L31) +[src/api/alchemy-wallet.ts:31](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L31) ___ @@ -321,7 +321,7 @@ EthersWallet.call #### Defined in -[src/api/alchemy-wallet.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L102) +[src/api/alchemy-wallet.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L102) ___ @@ -424,7 +424,7 @@ EthersWallet.estimateGas #### Defined in -[src/api/alchemy-wallet.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L90) +[src/api/alchemy-wallet.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L90) ___ @@ -470,7 +470,7 @@ EthersWallet.getBalance #### Defined in -[src/api/alchemy-wallet.ts:66](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L66) +[src/api/alchemy-wallet.ts:66](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L66) ___ @@ -492,7 +492,7 @@ EthersWallet.getChainId #### Defined in -[src/api/alchemy-wallet.ts:142](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L142) +[src/api/alchemy-wallet.ts:142](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L142) ___ @@ -520,7 +520,7 @@ EthersWallet.getFeeData #### Defined in -[src/api/alchemy-wallet.ts:166](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L166) +[src/api/alchemy-wallet.ts:166](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L166) ___ @@ -542,7 +542,7 @@ EthersWallet.getGasPrice #### Defined in -[src/api/alchemy-wallet.ts:151](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L151) +[src/api/alchemy-wallet.ts:151](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L151) ___ @@ -571,7 +571,7 @@ EthersWallet.getTransactionCount #### Defined in -[src/api/alchemy-wallet.ts:77](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L77) +[src/api/alchemy-wallet.ts:77](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L77) ___ @@ -585,7 +585,7 @@ ___ #### Defined in -[src/api/alchemy-wallet.ts:182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L182) +[src/api/alchemy-wallet.ts:182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L182) ___ @@ -615,7 +615,7 @@ EthersWallet.populateTransaction #### Defined in -[src/api/alchemy-wallet.ts:117](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L117) +[src/api/alchemy-wallet.ts:117](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L117) ___ @@ -645,7 +645,7 @@ EthersWallet.resolveName #### Defined in -[src/api/alchemy-wallet.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L178) +[src/api/alchemy-wallet.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L178) ___ @@ -673,7 +673,7 @@ EthersWallet.sendTransaction #### Defined in -[src/api/alchemy-wallet.ts:131](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/alchemy-wallet.ts#L131) +[src/api/alchemy-wallet.ts:131](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/alchemy-wallet.ts#L131) ___ diff --git a/docs-md/classes/WebSocketNamespace.md b/docs-md/classes/WebSocketNamespace.md index 50ee2159..f20ee145 100644 --- a/docs-md/classes/WebSocketNamespace.md +++ b/docs-md/classes/WebSocketNamespace.md @@ -43,7 +43,7 @@ no event is provided, the total number of listeners for all events is returned. #### Defined in -[src/api/websocket-namespace.ts:104](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/websocket-namespace.ts#L104) +[src/api/websocket-namespace.ts:104](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/websocket-namespace.ts#L104) ___ @@ -66,7 +66,7 @@ no event is provided, all listeners will be included. #### Defined in -[src/api/websocket-namespace.ts:118](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/websocket-namespace.ts#L118) +[src/api/websocket-namespace.ts:118](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/websocket-namespace.ts#L118) ___ @@ -90,7 +90,7 @@ listener is provided, all listeners for the event will be removed. #### Defined in -[src/api/websocket-namespace.ts:70](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/websocket-namespace.ts#L70) +[src/api/websocket-namespace.ts:70](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/websocket-namespace.ts#L70) ___ @@ -115,7 +115,7 @@ how to use them. #### Defined in -[src/api/websocket-namespace.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/websocket-namespace.ts#L35) +[src/api/websocket-namespace.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/websocket-namespace.ts#L35) ___ @@ -140,7 +140,7 @@ events. See [AlchemyEventType](../modules.md#alchemyeventtype) for how to use th #### Defined in -[src/api/websocket-namespace.ts:53](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/websocket-namespace.ts#L53) +[src/api/websocket-namespace.ts:53](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/websocket-namespace.ts#L53) ___ @@ -163,4 +163,4 @@ is provided, all events and their listeners are removed. #### Defined in -[src/api/websocket-namespace.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/websocket-namespace.ts#L86) +[src/api/websocket-namespace.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/websocket-namespace.ts#L86) diff --git a/docs-md/enums/AlchemySubscription.md b/docs-md/enums/AlchemySubscription.md index d105928f..030bb124 100644 --- a/docs-md/enums/AlchemySubscription.md +++ b/docs-md/enums/AlchemySubscription.md @@ -22,7 +22,7 @@ the Websocket Namespace. #### Defined in -[src/types/types.ts:609](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L609) +[src/types/types.ts:609](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L609) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[src/types/types.ts:608](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L608) +[src/types/types.ts:608](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L608) diff --git a/docs-md/enums/AssetTransfersCategory.md b/docs-md/enums/AssetTransfersCategory.md index dbbc636f..dafc3779 100644 --- a/docs-md/enums/AssetTransfersCategory.md +++ b/docs-md/enums/AssetTransfersCategory.md @@ -26,7 +26,7 @@ ERC1155 transfers. #### Defined in -[src/types/types.ts:375](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L375) +[src/types/types.ts:375](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L375) ___ @@ -38,7 +38,7 @@ ERC20 transfers. #### Defined in -[src/types/types.ts:369](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L369) +[src/types/types.ts:369](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L369) ___ @@ -50,7 +50,7 @@ ERC721 transfers. #### Defined in -[src/types/types.ts:372](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L372) +[src/types/types.ts:372](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L372) ___ @@ -64,7 +64,7 @@ accessed by users. #### Defined in -[src/types/types.ts:359](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L359) +[src/types/types.ts:359](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L359) ___ @@ -78,7 +78,7 @@ another smart contract or sending #### Defined in -[src/types/types.ts:366](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L366) +[src/types/types.ts:366](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L366) ___ @@ -90,4 +90,4 @@ Special contracts that don't follow ERC 721/1155, (ex: CryptoKitties). #### Defined in -[src/types/types.ts:378](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L378) +[src/types/types.ts:378](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L378) diff --git a/docs-md/enums/CommitmentLevel.md b/docs-md/enums/CommitmentLevel.md index fb3c549e..bf9c7cfa 100644 --- a/docs-md/enums/CommitmentLevel.md +++ b/docs-md/enums/CommitmentLevel.md @@ -25,7 +25,7 @@ The lowest numbered block available that is usually the first block created. #### Defined in -[src/types/types.ts:1354](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1354) +[src/types/types.ts:1354](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1354) ___ @@ -39,7 +39,7 @@ This block is very unlikely to be re-orged. This is only available on #### Defined in -[src/types/types.ts:1350](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1350) +[src/types/types.ts:1350](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1350) ___ @@ -52,7 +52,7 @@ this block may be re-orged out of the canonical chain. #### Defined in -[src/types/types.ts:1338](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1338) +[src/types/types.ts:1338](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1338) ___ @@ -66,7 +66,7 @@ is a proxy for blocks that have not been mined yet. #### Defined in -[src/types/types.ts:1333](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1333) +[src/types/types.ts:1333](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1333) ___ @@ -80,4 +80,4 @@ only available on [Network.ETH_GOERLI](Network.md#eth_goerli) and [Network.ETH_S #### Defined in -[src/types/types.ts:1344](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1344) +[src/types/types.ts:1344](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1344) diff --git a/docs-md/enums/DebugCallType.md b/docs-md/enums/DebugCallType.md index fcbefbe4..fb37df85 100644 --- a/docs-md/enums/DebugCallType.md +++ b/docs-md/enums/DebugCallType.md @@ -21,7 +21,7 @@ The type of call in a debug call trace. #### Defined in -[src/types/types.ts:908](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L908) +[src/types/types.ts:908](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L908) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[src/types/types.ts:907](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L907) +[src/types/types.ts:907](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L907) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/types/types.ts:910](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L910) +[src/types/types.ts:910](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L910) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[src/types/types.ts:909](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L909) +[src/types/types.ts:909](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L909) diff --git a/docs-md/enums/DebugTracerType.md b/docs-md/enums/DebugTracerType.md index 0ff21e0f..64655370 100644 --- a/docs-md/enums/DebugTracerType.md +++ b/docs-md/enums/DebugTracerType.md @@ -20,7 +20,7 @@ The type of tracer to use when running debug methods in the #### Defined in -[src/types/types.ts:1368](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1368) +[src/types/types.ts:1368](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1368) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/types.ts:1369](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1369) +[src/types/types.ts:1369](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1369) diff --git a/docs-md/enums/DecodingAuthority.md b/docs-md/enums/DecodingAuthority.md index 6b8300b2..edbe01b4 100644 --- a/docs-md/enums/DecodingAuthority.md +++ b/docs-md/enums/DecodingAuthority.md @@ -19,4 +19,4 @@ Authority used to decode calls and logs when using the #### Defined in -[src/types/types.ts:871](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L871) +[src/types/types.ts:871](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L871) diff --git a/docs-md/enums/GetTransfersForOwnerTransferType.md b/docs-md/enums/GetTransfersForOwnerTransferType.md index 6af826ca..53c33b50 100644 --- a/docs-md/enums/GetTransfersForOwnerTransferType.md +++ b/docs-md/enums/GetTransfersForOwnerTransferType.md @@ -20,7 +20,7 @@ NFTs that were minted by the owner. #### Defined in -[src/types/types.ts:486](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L486) +[src/types/types.ts:486](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L486) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/types.ts:485](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L485) +[src/types/types.ts:485](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L485) diff --git a/docs-md/enums/Network.md b/docs-md/enums/Network.md index f168f581..8ccc73b2 100644 --- a/docs-md/enums/Network.md +++ b/docs-md/enums/Network.md @@ -38,7 +38,7 @@ available on which networks #### Defined in -[src/types/types.ts:89](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L89) +[src/types/types.ts:89](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L89) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[src/types/types.ts:88](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L88) +[src/types/types.ts:88](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L88) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[src/types/types.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L90) +[src/types/types.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L90) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[src/types/types.ts:94](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L94) +[src/types/types.ts:94](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L94) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[src/types/types.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L98) +[src/types/types.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L98) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[src/types/types.ts:97](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L97) +[src/types/types.ts:97](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L97) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[src/types/types.ts:99](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L99) +[src/types/types.ts:99](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L99) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[src/types/types.ts:83](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L83) +[src/types/types.ts:83](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L83) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[src/types/types.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L82) +[src/types/types.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L82) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[src/types/types.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L84) +[src/types/types.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L84) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[src/types/types.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L93) +[src/types/types.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L93) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[src/types/types.ts:91](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L91) +[src/types/types.ts:91](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L91) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[src/types/types.ts:92](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L92) +[src/types/types.ts:92](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L92) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[src/types/types.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L86) +[src/types/types.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L86) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[src/types/types.ts:85](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L85) +[src/types/types.ts:85](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L85) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[src/types/types.ts:87](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L87) +[src/types/types.ts:87](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L87) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[src/types/types.ts:95](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L95) +[src/types/types.ts:95](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L95) ___ @@ -208,4 +208,4 @@ ___ #### Defined in -[src/types/types.ts:96](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L96) +[src/types/types.ts:96](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L96) diff --git a/docs-md/enums/NftCollectionMarketplace.md b/docs-md/enums/NftCollectionMarketplace.md index 5c01be59..11dba23b 100644 --- a/docs-md/enums/NftCollectionMarketplace.md +++ b/docs-md/enums/NftCollectionMarketplace.md @@ -19,4 +19,4 @@ Enum representing the supported NFT marketplaces on a #### Defined in -[src/types/nft-types.ts:1226](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1226) +[src/types/nft-types.ts:1226](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1226) diff --git a/docs-md/enums/NftFilters.md b/docs-md/enums/NftFilters.md index 83e66fef..f465eea3 100644 --- a/docs-md/enums/NftFilters.md +++ b/docs-md/enums/NftFilters.md @@ -24,7 +24,7 @@ NFTs that have been airdropped to a user. #### Defined in -[src/types/nft-types.ts:210](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L210) +[src/types/nft-types.ts:210](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L210) ___ @@ -36,4 +36,4 @@ NFTs that have been classified as spam. #### Defined in -[src/types/nft-types.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L207) +[src/types/nft-types.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L207) diff --git a/docs-md/enums/NftOrdering.md b/docs-md/enums/NftOrdering.md index 2f564842..6eb32c03 100644 --- a/docs-md/enums/NftOrdering.md +++ b/docs-md/enums/NftOrdering.md @@ -21,4 +21,4 @@ Enum of ordering that can be applied to a [getNftsForOwner](../classes/NftNamesp #### Defined in -[src/types/nft-types.ts:220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L220) +[src/types/nft-types.ts:220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L220) diff --git a/docs-md/enums/NftRefreshState.md b/docs-md/enums/NftRefreshState.md index 44b209cd..0905d08c 100644 --- a/docs-md/enums/NftRefreshState.md +++ b/docs-md/enums/NftRefreshState.md @@ -25,7 +25,7 @@ The contract has already been queued for refresh. #### Defined in -[src/types/nft-types.ts:898](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L898) +[src/types/nft-types.ts:898](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L898) ___ @@ -37,7 +37,7 @@ The provided contract is not an NFT or does not contain metadata. #### Defined in -[src/types/nft-types.ts:895](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L895) +[src/types/nft-types.ts:895](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L895) ___ @@ -49,7 +49,7 @@ The contract refresh is complete. #### Defined in -[src/types/nft-types.ts:904](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L904) +[src/types/nft-types.ts:904](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L904) ___ @@ -61,7 +61,7 @@ The contract is currently being refreshed. #### Defined in -[src/types/nft-types.ts:901](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L901) +[src/types/nft-types.ts:901](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L901) ___ @@ -73,7 +73,7 @@ The contract refresh has been queued and await execution. #### Defined in -[src/types/nft-types.ts:907](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L907) +[src/types/nft-types.ts:907](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L907) ___ @@ -85,4 +85,4 @@ The contract was unable to be queued due to an internal error. #### Defined in -[src/types/nft-types.ts:910](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L910) +[src/types/nft-types.ts:910](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L910) diff --git a/docs-md/enums/NftSaleMarketplace.md b/docs-md/enums/NftSaleMarketplace.md index 827b6aeb..dc3f35fc 100644 --- a/docs-md/enums/NftSaleMarketplace.md +++ b/docs-md/enums/NftSaleMarketplace.md @@ -25,7 +25,7 @@ Enum representing the supported NFT marketplaces by the #### Defined in -[src/types/nft-types.ts:814](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L814) +[src/types/nft-types.ts:814](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L814) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[src/types/nft-types.ts:813](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L813) +[src/types/nft-types.ts:813](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L813) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[src/types/nft-types.ts:810](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L810) +[src/types/nft-types.ts:810](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L810) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[src/types/nft-types.ts:809](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L809) +[src/types/nft-types.ts:809](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L809) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[src/types/nft-types.ts:815](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L815) +[src/types/nft-types.ts:815](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L815) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[src/types/nft-types.ts:812](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L812) +[src/types/nft-types.ts:812](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L812) ___ @@ -85,4 +85,4 @@ ___ #### Defined in -[src/types/nft-types.ts:811](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L811) +[src/types/nft-types.ts:811](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L811) diff --git a/docs-md/enums/NftSaleTakerType.md b/docs-md/enums/NftSaleTakerType.md index 282a26b5..c3a84d90 100644 --- a/docs-md/enums/NftSaleTakerType.md +++ b/docs-md/enums/NftSaleTakerType.md @@ -20,7 +20,7 @@ method. #### Defined in -[src/types/nft-types.ts:839](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L839) +[src/types/nft-types.ts:839](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L839) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/nft-types.ts:840](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L840) +[src/types/nft-types.ts:840](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L840) diff --git a/docs-md/enums/NftSpamClassification.md b/docs-md/enums/NftSpamClassification.md index 2feb33e6..ba79bdfe 100644 --- a/docs-md/enums/NftSpamClassification.md +++ b/docs-md/enums/NftSpamClassification.md @@ -29,7 +29,7 @@ Potential reasons why an NFT contract was classified as spam. #### Defined in -[src/types/nft-types.ts:68](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L68) +[src/types/nft-types.ts:68](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L68) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[src/types/nft-types.ts:66](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L66) +[src/types/nft-types.ts:66](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L66) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[src/types/nft-types.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L67) +[src/types/nft-types.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L67) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[src/types/nft-types.ts:76](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L76) +[src/types/nft-types.ts:76](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L76) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[src/types/nft-types.ts:72](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L72) +[src/types/nft-types.ts:72](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L72) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[src/types/nft-types.ts:73](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L73) +[src/types/nft-types.ts:73](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L73) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -[src/types/nft-types.ts:74](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L74) +[src/types/nft-types.ts:74](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L74) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -[src/types/nft-types.ts:71](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L71) +[src/types/nft-types.ts:71](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L71) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[src/types/nft-types.ts:69](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L69) +[src/types/nft-types.ts:69](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L69) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[src/types/nft-types.ts:75](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L75) +[src/types/nft-types.ts:75](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L75) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -[src/types/nft-types.ts:70](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L70) +[src/types/nft-types.ts:70](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L70) ___ @@ -139,4 +139,4 @@ ___ #### Defined in -[src/types/nft-types.ts:77](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L77) +[src/types/nft-types.ts:77](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L77) diff --git a/docs-md/enums/NftTokenType.md b/docs-md/enums/NftTokenType.md index 915bd940..d332252a 100644 --- a/docs-md/enums/NftTokenType.md +++ b/docs-md/enums/NftTokenType.md @@ -22,7 +22,7 @@ An enum for specifying the token type on NFTs. #### Defined in -[src/types/nft-types.ts:13](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L13) +[src/types/nft-types.ts:13](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L13) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[src/types/nft-types.ts:12](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L12) +[src/types/nft-types.ts:12](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L12) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/types/nft-types.ts:15](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L15) +[src/types/nft-types.ts:15](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L15) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/types/nft-types.ts:14](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L14) +[src/types/nft-types.ts:14](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L14) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[src/types/nft-types.ts:16](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L16) +[src/types/nft-types.ts:16](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L16) diff --git a/docs-md/enums/OpenSeaSafelistRequestStatus.md b/docs-md/enums/OpenSeaSafelistRequestStatus.md index 65259737..6e22ab08 100644 --- a/docs-md/enums/OpenSeaSafelistRequestStatus.md +++ b/docs-md/enums/OpenSeaSafelistRequestStatus.md @@ -23,7 +23,7 @@ Collections that are approved on open sea and can be found in search results. #### Defined in -[src/types/types.ts:581](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L581) +[src/types/types.ts:581](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L581) ___ @@ -35,7 +35,7 @@ Brand new collections. #### Defined in -[src/types/types.ts:585](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L585) +[src/types/types.ts:585](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L585) ___ @@ -47,7 +47,7 @@ Collections that requested safelisting on OpenSea. #### Defined in -[src/types/types.ts:583](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L583) +[src/types/types.ts:583](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L583) ___ @@ -59,4 +59,4 @@ Verified collection. #### Defined in -[src/types/types.ts:579](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L579) +[src/types/types.ts:579](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L579) diff --git a/docs-md/enums/SimulateAssetType.md b/docs-md/enums/SimulateAssetType.md index 66e50de8..8255d4e5 100644 --- a/docs-md/enums/SimulateAssetType.md +++ b/docs-md/enums/SimulateAssetType.md @@ -26,7 +26,7 @@ ERC1155 approval or transfers. #### Defined in -[src/types/types.ts:751](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L751) +[src/types/types.ts:751](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L751) ___ @@ -38,7 +38,7 @@ ERC20 approval or transfers. #### Defined in -[src/types/types.ts:747](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L747) +[src/types/types.ts:747](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L747) ___ @@ -50,7 +50,7 @@ ERC721 approval or transfers. #### Defined in -[src/types/types.ts:749](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L749) +[src/types/types.ts:749](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L749) ___ @@ -63,7 +63,7 @@ run on (ex: ETH for Ethereum, MATIC for Polygon, ETH for Arbitrum). #### Defined in -[src/types/types.ts:745](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L745) +[src/types/types.ts:745](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L745) ___ @@ -76,4 +76,4 @@ CryptoKitties and CryptoPunks. #### Defined in -[src/types/types.ts:756](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L756) +[src/types/types.ts:756](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L756) diff --git a/docs-md/enums/SimulateChangeType.md b/docs-md/enums/SimulateChangeType.md index 83e9e3cb..f459c03d 100644 --- a/docs-md/enums/SimulateChangeType.md +++ b/docs-md/enums/SimulateChangeType.md @@ -26,7 +26,7 @@ APPROVE with zero amount → approval being cleared #### Defined in -[src/types/types.ts:771](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L771) +[src/types/types.ts:771](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L771) ___ @@ -38,4 +38,4 @@ Represents a transaction that transferred tokens from one address to another. #### Defined in -[src/types/types.ts:776](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L776) +[src/types/types.ts:776](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L776) diff --git a/docs-md/enums/SortingOrder.md b/docs-md/enums/SortingOrder.md index e5ebfc0a..eb8cf852 100644 --- a/docs-md/enums/SortingOrder.md +++ b/docs-md/enums/SortingOrder.md @@ -19,7 +19,7 @@ Enum for representing the supported sorting orders of the API. #### Defined in -[src/types/types.ts:518](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L518) +[src/types/types.ts:518](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L518) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[src/types/types.ts:519](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L519) +[src/types/types.ts:519](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L519) diff --git a/docs-md/enums/TokenBalanceType.md b/docs-md/enums/TokenBalanceType.md index e177d440..58c04645 100644 --- a/docs-md/enums/TokenBalanceType.md +++ b/docs-md/enums/TokenBalanceType.md @@ -22,7 +22,7 @@ available on Mainnet in Ethereum, Polygon, and Arbitrum. #### Defined in -[src/types/types.ts:108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L108) +[src/types/types.ts:108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L108) ___ @@ -36,4 +36,4 @@ all tokens that the address has ever received. #### Defined in -[src/types/types.ts:115](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L115) +[src/types/types.ts:115](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L115) diff --git a/docs-md/enums/WebhookType.md b/docs-md/enums/WebhookType.md index 50b6fc37..68a56764 100644 --- a/docs-md/enums/WebhookType.md +++ b/docs-md/enums/WebhookType.md @@ -23,7 +23,7 @@ The type of [Webhook](../interfaces/Webhook.md). #### Defined in -[src/types/types.ts:1050](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1050) +[src/types/types.ts:1050](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1050) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[src/types/types.ts:1049](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1049) +[src/types/types.ts:1049](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1049) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[src/types/types.ts:1053](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1053) +[src/types/types.ts:1053](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1053) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[src/types/types.ts:1048](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1048) +[src/types/types.ts:1048](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1048) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[src/types/types.ts:1051](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1051) +[src/types/types.ts:1051](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1051) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[src/types/types.ts:1052](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1052) +[src/types/types.ts:1052](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1052) diff --git a/docs-md/enums/WebhookVersion.md b/docs-md/enums/WebhookVersion.md index 7901dadf..3a1ffc99 100644 --- a/docs-md/enums/WebhookVersion.md +++ b/docs-md/enums/WebhookVersion.md @@ -19,7 +19,7 @@ The version of the webhook. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:1042](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1042) +[src/types/types.ts:1042](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1042) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[src/types/types.ts:1043](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1043) +[src/types/types.ts:1043](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1043) diff --git a/docs-md/interfaces/AcquiredAt.md b/docs-md/interfaces/AcquiredAt.md index 6b001e54..82321c66 100644 --- a/docs-md/interfaces/AcquiredAt.md +++ b/docs-md/interfaces/AcquiredAt.md @@ -21,7 +21,7 @@ Block number of the block at which an NFT was last acquired. #### Defined in -[src/types/nft-types.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L86) +[src/types/nft-types.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L86) ___ @@ -33,4 +33,4 @@ Timestamp of the block at which an NFT was last acquired. #### Defined in -[src/types/nft-types.ts:83](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L83) +[src/types/nft-types.ts:83](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L83) diff --git a/docs-md/interfaces/AddressActivityResponse.md b/docs-md/interfaces/AddressActivityResponse.md index 630b20f9..9b123486 100644 --- a/docs-md/interfaces/AddressActivityResponse.md +++ b/docs-md/interfaces/AddressActivityResponse.md @@ -22,7 +22,7 @@ The addresses for the webhook. #### Defined in -[src/types/types.ts:1131](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1131) +[src/types/types.ts:1131](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1131) ___ @@ -34,7 +34,7 @@ Optional page key used to fetch the remaining addresses. #### Defined in -[src/types/types.ts:1135](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1135) +[src/types/types.ts:1135](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1135) ___ @@ -46,4 +46,4 @@ The total number of addresses. #### Defined in -[src/types/types.ts:1133](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1133) +[src/types/types.ts:1133](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1133) diff --git a/docs-md/interfaces/AddressActivityWebhook.md b/docs-md/interfaces/AddressActivityWebhook.md index 4a7ee4ee..86fda2aa 100644 --- a/docs-md/interfaces/AddressActivityWebhook.md +++ b/docs-md/interfaces/AddressActivityWebhook.md @@ -41,7 +41,7 @@ The app id of the app used for the webhook. This field is only present on #### Defined in -[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1037) +[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1037) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1018) +[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1018) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1026) +[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1026) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1020) +[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1020) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1030) +[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1030) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1028) +[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1028) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:1080](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1080) +[src/types/types.ts:1080](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1080) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1024) +[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1024) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1032) +[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1032) diff --git a/docs-md/interfaces/AddressWebhookParams.md b/docs-md/interfaces/AddressWebhookParams.md index e8f0aa36..dc8549e9 100644 --- a/docs-md/interfaces/AddressWebhookParams.md +++ b/docs-md/interfaces/AddressWebhookParams.md @@ -22,7 +22,7 @@ Array of addresses the webhook should activity for. #### Defined in -[src/types/types.ts:1194](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1194) +[src/types/types.ts:1194](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1194) ___ @@ -35,4 +35,4 @@ created on network of the app provided in the api key config. #### Defined in -[src/types/types.ts:1199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1199) +[src/types/types.ts:1199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1199) diff --git a/docs-md/interfaces/AlchemyMinedTransactionsEventFilter.md b/docs-md/interfaces/AlchemyMinedTransactionsEventFilter.md index 98bc03e2..ed646b09 100644 --- a/docs-md/interfaces/AlchemyMinedTransactionsEventFilter.md +++ b/docs-md/interfaces/AlchemyMinedTransactionsEventFilter.md @@ -33,7 +33,7 @@ Limit 100 address filters. Requires a non-empty array. #### Defined in -[src/types/types.ts:681](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L681) +[src/types/types.ts:681](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L681) ___ @@ -47,7 +47,7 @@ the entire transaction response is included). #### Defined in -[src/types/types.ts:694](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L694) +[src/types/types.ts:694](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L694) ___ @@ -60,7 +60,7 @@ Defaults to false. #### Defined in -[src/types/types.ts:687](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L687) +[src/types/types.ts:687](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L687) ___ @@ -70,4 +70,4 @@ ___ #### Defined in -[src/types/types.ts:675](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L675) +[src/types/types.ts:675](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L675) diff --git a/docs-md/interfaces/AlchemyPendingTransactionsEventFilter.md b/docs-md/interfaces/AlchemyPendingTransactionsEventFilter.md index a4b790f6..fca1ddee 100644 --- a/docs-md/interfaces/AlchemyPendingTransactionsEventFilter.md +++ b/docs-md/interfaces/AlchemyPendingTransactionsEventFilter.md @@ -37,7 +37,7 @@ present, then this filter will return transactions sent from the #### Defined in -[src/types/types.ts:637](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L637) +[src/types/types.ts:637](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L637) ___ @@ -54,7 +54,7 @@ response as subscribing to `newPendingTransactions`. #### Defined in -[src/types/types.ts:657](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L657) +[src/types/types.ts:657](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L657) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[src/types/types.ts:627](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L627) +[src/types/types.ts:627](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L627) ___ @@ -81,4 +81,4 @@ present, then this filter will return transactions sent from the #### Defined in -[src/types/types.ts:647](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L647) +[src/types/types.ts:647](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L647) diff --git a/docs-md/interfaces/AlchemySettings.md b/docs-md/interfaces/AlchemySettings.md index fb2b3722..f4093623 100644 --- a/docs-md/interfaces/AlchemySettings.md +++ b/docs-md/interfaces/AlchemySettings.md @@ -28,7 +28,7 @@ Defaults to: "demo" (a rate-limited public API key) #### Defined in -[src/types/types.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L30) +[src/types/types.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L30) ___ @@ -41,7 +41,7 @@ in the Alchemy Dashboard on the Notify tab. #### Defined in -[src/types/types.ts:56](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L56) +[src/types/types.ts:56](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L56) ___ @@ -56,7 +56,7 @@ This implementation is based on the `JsonRpcBatchProvider` in ethers. #### Defined in -[src/types/types.ts:70](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L70) +[src/types/types.ts:70](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L70) ___ @@ -68,7 +68,7 @@ The maximum number of retries to attempt if a request fails. Defaults to 5. #### Defined in -[src/types/types.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L41) +[src/types/types.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L41) ___ @@ -83,7 +83,7 @@ Defaults to: Network.ETH_MAINNET #### Defined in -[src/types/types.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L38) +[src/types/types.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L38) ___ @@ -96,7 +96,7 @@ Default to 0 (No timeout). #### Defined in -[src/types/types.ts:62](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L62) +[src/types/types.ts:62](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L62) ___ @@ -112,4 +112,4 @@ that not all methods will work with custom URLs. #### Defined in -[src/types/types.ts:50](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L50) +[src/types/types.ts:50](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L50) diff --git a/docs-md/interfaces/AssetTransfersMetadata.md b/docs-md/interfaces/AssetTransfersMetadata.md index 7bf8b95e..27c363ed 100644 --- a/docs-md/interfaces/AssetTransfersMetadata.md +++ b/docs-md/interfaces/AssetTransfersMetadata.md @@ -21,4 +21,4 @@ Timestamp of the block from which the transaction event originated. #### Defined in -[src/types/types.ts:477](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L477) +[src/types/types.ts:477](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L477) diff --git a/docs-md/interfaces/AssetTransfersParams.md b/docs-md/interfaces/AssetTransfersParams.md index 09a66293..37ea83ac 100644 --- a/docs-md/interfaces/AssetTransfersParams.md +++ b/docs-md/interfaces/AssetTransfersParams.md @@ -36,7 +36,7 @@ REQUIRED field. An array of categories to get transfers for. #### Defined in -[src/types/types.ts:319](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L319) +[src/types/types.ts:319](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L319) ___ @@ -49,7 +49,7 @@ List of contract addresses to filter for - only applies to "erc20", #### Defined in -[src/types/types.ts:310](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L310) +[src/types/types.ts:310](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L310) ___ @@ -62,7 +62,7 @@ different than null value. Defaults to `true` if omitted. #### Defined in -[src/types/types.ts:316](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L316) +[src/types/types.ts:316](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L316) ___ @@ -75,7 +75,7 @@ for all addresses if omitted. #### Defined in -[src/types/types.ts:298](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L298) +[src/types/types.ts:298](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L298) ___ @@ -88,7 +88,7 @@ defaults to `0x0` if omitted. #### Defined in -[src/types/types.ts:280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L280) +[src/types/types.ts:280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L280) ___ @@ -100,7 +100,7 @@ The maximum number of results to return per page. Defaults to 1000 if omitted. #### Defined in -[src/types/types.ts:322](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L322) +[src/types/types.ts:322](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L322) ___ @@ -113,7 +113,7 @@ Defaults to ascending if omitted. #### Defined in -[src/types/types.ts:292](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L292) +[src/types/types.ts:292](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L292) ___ @@ -126,7 +126,7 @@ Optional page key from an existing [OwnedBaseNftsResponse](OwnedBaseNftsResponse #### Defined in -[src/types/types.ts:328](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L328) +[src/types/types.ts:328](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L328) ___ @@ -139,7 +139,7 @@ for all address if omitted. #### Defined in -[src/types/types.ts:304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L304) +[src/types/types.ts:304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L304) ___ @@ -152,7 +152,7 @@ defaults to the latest block if omitted. #### Defined in -[src/types/types.ts:286](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L286) +[src/types/types.ts:286](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L286) ___ @@ -165,4 +165,4 @@ to `false` if omitted. #### Defined in -[src/types/types.ts:334](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L334) +[src/types/types.ts:334](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L334) diff --git a/docs-md/interfaces/AssetTransfersResponse.md b/docs-md/interfaces/AssetTransfersResponse.md index 6c86bb44..45c32cc7 100644 --- a/docs-md/interfaces/AssetTransfersResponse.md +++ b/docs-md/interfaces/AssetTransfersResponse.md @@ -21,7 +21,7 @@ Page key for the next page of results, if one exists. #### Defined in -[src/types/types.ts:389](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L389) +[src/types/types.ts:389](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L389) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[src/types/types.ts:387](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L387) +[src/types/types.ts:387](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L387) diff --git a/docs-md/interfaces/AssetTransfersResult.md b/docs-md/interfaces/AssetTransfersResult.md index ac4a2484..1013b90b 100644 --- a/docs-md/interfaces/AssetTransfersResult.md +++ b/docs-md/interfaces/AssetTransfersResult.md @@ -38,7 +38,7 @@ information was not available. #### Defined in -[src/types/types.ts:449](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L449) +[src/types/types.ts:449](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L449) ___ @@ -50,7 +50,7 @@ The block number where the transfer occurred. #### Defined in -[src/types/types.ts:416](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L416) +[src/types/types.ts:416](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L416) ___ @@ -62,7 +62,7 @@ The category of the transfer. #### Defined in -[src/types/types.ts:413](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L413) +[src/types/types.ts:413](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L413) ___ @@ -75,7 +75,7 @@ token. `null` if not an ERC1155 transfer. #### Defined in -[src/types/types.ts:440](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L440) +[src/types/types.ts:440](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L440) ___ @@ -88,7 +88,7 @@ ERC721 transfer. #### Defined in -[src/types/types.ts:434](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L434) +[src/types/types.ts:434](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L434) ___ @@ -100,7 +100,7 @@ The from address of the transfer. #### Defined in -[src/types/types.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L419) +[src/types/types.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L419) ___ @@ -112,7 +112,7 @@ The transaction hash of the transfer transaction. #### Defined in -[src/types/types.ts:452](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L452) +[src/types/types.ts:452](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L452) ___ @@ -124,7 +124,7 @@ Information about the raw contract of the asset transferred. #### Defined in -[src/types/types.ts:455](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L455) +[src/types/types.ts:455](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L455) ___ @@ -136,7 +136,7 @@ The to address of the transfer. #### Defined in -[src/types/types.ts:422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L422) +[src/types/types.ts:422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L422) ___ @@ -148,7 +148,7 @@ The token id of the token transferred. #### Defined in -[src/types/types.ts:443](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L443) +[src/types/types.ts:443](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L443) ___ @@ -160,7 +160,7 @@ The unique ID of the transfer. #### Defined in -[src/types/types.ts:410](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L410) +[src/types/types.ts:410](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L410) ___ @@ -173,4 +173,4 @@ decimal). `null` if ERC721 transfer or contract decimal not available. #### Defined in -[src/types/types.ts:428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L428) +[src/types/types.ts:428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L428) diff --git a/docs-md/interfaces/AssetTransfersWithMetadataParams.md b/docs-md/interfaces/AssetTransfersWithMetadataParams.md index 57c401a4..c872116f 100644 --- a/docs-md/interfaces/AssetTransfersWithMetadataParams.md +++ b/docs-md/interfaces/AssetTransfersWithMetadataParams.md @@ -41,7 +41,7 @@ REQUIRED field. An array of categories to get transfers for. #### Defined in -[src/types/types.ts:319](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L319) +[src/types/types.ts:319](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L319) ___ @@ -58,7 +58,7 @@ List of contract addresses to filter for - only applies to "erc20", #### Defined in -[src/types/types.ts:310](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L310) +[src/types/types.ts:310](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L310) ___ @@ -75,7 +75,7 @@ different than null value. Defaults to `true` if omitted. #### Defined in -[src/types/types.ts:316](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L316) +[src/types/types.ts:316](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L316) ___ @@ -92,7 +92,7 @@ for all addresses if omitted. #### Defined in -[src/types/types.ts:298](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L298) +[src/types/types.ts:298](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L298) ___ @@ -109,7 +109,7 @@ defaults to `0x0` if omitted. #### Defined in -[src/types/types.ts:280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L280) +[src/types/types.ts:280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L280) ___ @@ -125,7 +125,7 @@ The maximum number of results to return per page. Defaults to 1000 if omitted. #### Defined in -[src/types/types.ts:322](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L322) +[src/types/types.ts:322](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L322) ___ @@ -142,7 +142,7 @@ Defaults to ascending if omitted. #### Defined in -[src/types/types.ts:292](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L292) +[src/types/types.ts:292](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L292) ___ @@ -159,7 +159,7 @@ Optional page key from an existing [OwnedBaseNftsResponse](OwnedBaseNftsResponse #### Defined in -[src/types/types.ts:328](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L328) +[src/types/types.ts:328](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L328) ___ @@ -176,7 +176,7 @@ for all address if omitted. #### Defined in -[src/types/types.ts:304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L304) +[src/types/types.ts:304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L304) ___ @@ -193,7 +193,7 @@ defaults to the latest block if omitted. #### Defined in -[src/types/types.ts:286](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L286) +[src/types/types.ts:286](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L286) ___ @@ -210,4 +210,4 @@ to `false` if omitted. #### Defined in -[src/types/types.ts:344](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L344) +[src/types/types.ts:344](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L344) diff --git a/docs-md/interfaces/AssetTransfersWithMetadataResponse.md b/docs-md/interfaces/AssetTransfersWithMetadataResponse.md index 2005a63c..6b474e87 100644 --- a/docs-md/interfaces/AssetTransfersWithMetadataResponse.md +++ b/docs-md/interfaces/AssetTransfersWithMetadataResponse.md @@ -20,7 +20,7 @@ the [AssetTransfersWithMetadataParams](AssetTransfersWithMetadataParams.md) are #### Defined in -[src/types/types.ts:400](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L400) +[src/types/types.ts:400](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L400) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/types.ts:399](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L399) +[src/types/types.ts:399](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L399) diff --git a/docs-md/interfaces/AssetTransfersWithMetadataResult.md b/docs-md/interfaces/AssetTransfersWithMetadataResult.md index 82162321..f02a60c6 100644 --- a/docs-md/interfaces/AssetTransfersWithMetadataResult.md +++ b/docs-md/interfaces/AssetTransfersWithMetadataResult.md @@ -44,7 +44,7 @@ information was not available. #### Defined in -[src/types/types.ts:449](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L449) +[src/types/types.ts:449](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L449) ___ @@ -60,7 +60,7 @@ The block number where the transfer occurred. #### Defined in -[src/types/types.ts:416](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L416) +[src/types/types.ts:416](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L416) ___ @@ -76,7 +76,7 @@ The category of the transfer. #### Defined in -[src/types/types.ts:413](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L413) +[src/types/types.ts:413](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L413) ___ @@ -93,7 +93,7 @@ token. `null` if not an ERC1155 transfer. #### Defined in -[src/types/types.ts:440](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L440) +[src/types/types.ts:440](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L440) ___ @@ -110,7 +110,7 @@ ERC721 transfer. #### Defined in -[src/types/types.ts:434](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L434) +[src/types/types.ts:434](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L434) ___ @@ -126,7 +126,7 @@ The from address of the transfer. #### Defined in -[src/types/types.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L419) +[src/types/types.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L419) ___ @@ -142,7 +142,7 @@ The transaction hash of the transfer transaction. #### Defined in -[src/types/types.ts:452](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L452) +[src/types/types.ts:452](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L452) ___ @@ -154,7 +154,7 @@ Additional metadata about the transfer event. #### Defined in -[src/types/types.ts:466](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L466) +[src/types/types.ts:466](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L466) ___ @@ -170,7 +170,7 @@ Information about the raw contract of the asset transferred. #### Defined in -[src/types/types.ts:455](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L455) +[src/types/types.ts:455](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L455) ___ @@ -186,7 +186,7 @@ The to address of the transfer. #### Defined in -[src/types/types.ts:422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L422) +[src/types/types.ts:422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L422) ___ @@ -202,7 +202,7 @@ The token id of the token transferred. #### Defined in -[src/types/types.ts:443](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L443) +[src/types/types.ts:443](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L443) ___ @@ -218,7 +218,7 @@ The unique ID of the transfer. #### Defined in -[src/types/types.ts:410](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L410) +[src/types/types.ts:410](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L410) ___ @@ -235,4 +235,4 @@ decimal). `null` if ERC721 transfer or contract decimal not available. #### Defined in -[src/types/types.ts:428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L428) +[src/types/types.ts:428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L428) diff --git a/docs-md/interfaces/BaseNft.md b/docs-md/interfaces/BaseNft.md index 899fb27a..b3949bcb 100644 --- a/docs-md/interfaces/BaseNft.md +++ b/docs-md/interfaces/BaseNft.md @@ -31,7 +31,7 @@ The contract address of the NFT. #### Defined in -[src/types/nft-types.ts:1240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1240) +[src/types/nft-types.ts:1240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1240) ___ @@ -43,4 +43,4 @@ The NFT token ID as an integer string. #### Defined in -[src/types/nft-types.ts:1242](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1242) +[src/types/nft-types.ts:1242](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1242) diff --git a/docs-md/interfaces/BaseNftCollection.md b/docs-md/interfaces/BaseNftCollection.md index cacfb072..cbbf642e 100644 --- a/docs-md/interfaces/BaseNftCollection.md +++ b/docs-md/interfaces/BaseNftCollection.md @@ -23,7 +23,7 @@ The banner image URL for the collection. #### Defined in -[src/types/nft-types.ts:1296](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1296) +[src/types/nft-types.ts:1296](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1296) ___ @@ -35,7 +35,7 @@ The external URL for the collection. #### Defined in -[src/types/nft-types.ts:1294](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1294) +[src/types/nft-types.ts:1294](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1294) ___ @@ -47,7 +47,7 @@ The name of the collection. #### Defined in -[src/types/nft-types.ts:1290](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1290) +[src/types/nft-types.ts:1290](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1290) ___ @@ -59,4 +59,4 @@ The OpenSea human-readable slug of the collection. #### Defined in -[src/types/nft-types.ts:1292](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1292) +[src/types/nft-types.ts:1292](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1292) diff --git a/docs-md/interfaces/ComputeRarityResponse.md b/docs-md/interfaces/ComputeRarityResponse.md index 327953df..c40eaaab 100644 --- a/docs-md/interfaces/ComputeRarityResponse.md +++ b/docs-md/interfaces/ComputeRarityResponse.md @@ -18,4 +18,4 @@ Response object for the [NftNamespace.computeRarity](../classes/NftNamespace.md# #### Defined in -[src/types/nft-types.ts:851](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L851) +[src/types/nft-types.ts:851](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L851) diff --git a/docs-md/interfaces/CustomGraphqlWebhook.md b/docs-md/interfaces/CustomGraphqlWebhook.md index 2bc789cc..cb477e4a 100644 --- a/docs-md/interfaces/CustomGraphqlWebhook.md +++ b/docs-md/interfaces/CustomGraphqlWebhook.md @@ -42,7 +42,7 @@ The app id of the app used for the webhook. This field is only present on #### Defined in -[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1037) +[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1037) ___ @@ -58,7 +58,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1018) +[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1018) ___ @@ -74,7 +74,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1026) +[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1026) ___ @@ -90,7 +90,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1020) +[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1020) ___ @@ -106,7 +106,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1030) +[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1030) ___ @@ -122,7 +122,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1028) +[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1028) ___ @@ -138,7 +138,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:1108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1108) +[src/types/types.ts:1108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1108) ___ @@ -154,7 +154,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1024) +[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1024) ___ @@ -170,4 +170,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1032) +[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1032) diff --git a/docs-md/interfaces/CustomGraphqlWebhookConfig.md b/docs-md/interfaces/CustomGraphqlWebhookConfig.md index 20657edd..67ba477a 100644 --- a/docs-md/interfaces/CustomGraphqlWebhookConfig.md +++ b/docs-md/interfaces/CustomGraphqlWebhookConfig.md @@ -20,4 +20,4 @@ The graphql query for the webhook. #### Defined in -[src/types/types.ts:1141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1141) +[src/types/types.ts:1141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1141) diff --git a/docs-md/interfaces/CustomGraphqlWebhookParams.md b/docs-md/interfaces/CustomGraphqlWebhookParams.md index d83dd78f..7f7dd5e9 100644 --- a/docs-md/interfaces/CustomGraphqlWebhookParams.md +++ b/docs-md/interfaces/CustomGraphqlWebhookParams.md @@ -22,7 +22,7 @@ GraphQL query #### Defined in -[src/types/types.ts:1180](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1180) +[src/types/types.ts:1180](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1180) ___ @@ -35,4 +35,4 @@ created on network of the app provided in the api key config. #### Defined in -[src/types/types.ts:1185](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1185) +[src/types/types.ts:1185](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1185) diff --git a/docs-md/interfaces/DebugCallTrace.md b/docs-md/interfaces/DebugCallTrace.md index 75e21976..d3f4a6f4 100644 --- a/docs-md/interfaces/DebugCallTrace.md +++ b/docs-md/interfaces/DebugCallTrace.md @@ -30,7 +30,7 @@ Array of sub-calls executed as part of the original call. #### Defined in -[src/types/types.ts:1440](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1440) +[src/types/types.ts:1440](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1440) ___ @@ -42,7 +42,7 @@ Optional error field. #### Defined in -[src/types/types.ts:1436](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1436) +[src/types/types.ts:1436](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1436) ___ @@ -54,7 +54,7 @@ From address of the transaction. #### Defined in -[src/types/types.ts:1422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1422) +[src/types/types.ts:1422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1422) ___ @@ -66,7 +66,7 @@ Gas provided for call as a hex string. #### Defined in -[src/types/types.ts:1428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1428) +[src/types/types.ts:1428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1428) ___ @@ -78,7 +78,7 @@ Gas used during the call as a hex string. #### Defined in -[src/types/types.ts:1430](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1430) +[src/types/types.ts:1430](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1430) ___ @@ -90,7 +90,7 @@ Call data. #### Defined in -[src/types/types.ts:1432](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1432) +[src/types/types.ts:1432](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1432) ___ @@ -102,7 +102,7 @@ Return data. #### Defined in -[src/types/types.ts:1434](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1434) +[src/types/types.ts:1434](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1434) ___ @@ -114,7 +114,7 @@ Solidity revert reason, if the call reverted. #### Defined in -[src/types/types.ts:1438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1438) +[src/types/types.ts:1438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1438) ___ @@ -126,7 +126,7 @@ To address of the transaction. #### Defined in -[src/types/types.ts:1424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1424) +[src/types/types.ts:1424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1424) ___ @@ -138,7 +138,7 @@ The type of call: `CALL` or `CREATE` for the top-level call. #### Defined in -[src/types/types.ts:1420](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1420) +[src/types/types.ts:1420](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1420) ___ @@ -150,4 +150,4 @@ Amount of value transfer as a hex string. #### Defined in -[src/types/types.ts:1426](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1426) +[src/types/types.ts:1426](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1426) diff --git a/docs-md/interfaces/DebugCallTracer.md b/docs-md/interfaces/DebugCallTracer.md index c525a115..9d0c50b5 100644 --- a/docs-md/interfaces/DebugCallTracer.md +++ b/docs-md/interfaces/DebugCallTracer.md @@ -32,7 +32,7 @@ Defaults to `false`. #### Defined in -[src/types/types.ts:1392](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1392) +[src/types/types.ts:1392](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1392) ___ @@ -44,4 +44,4 @@ Specified type is `CALL_TRACER`. #### Defined in -[src/types/types.ts:1387](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1387) +[src/types/types.ts:1387](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1387) diff --git a/docs-md/interfaces/DebugPrestate.md b/docs-md/interfaces/DebugPrestate.md index a1b99d5e..53bfb653 100644 --- a/docs-md/interfaces/DebugPrestate.md +++ b/docs-md/interfaces/DebugPrestate.md @@ -23,7 +23,7 @@ Balance of the account in wei as a hex string. #### Defined in -[src/types/types.ts:1483](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1483) +[src/types/types.ts:1483](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1483) ___ @@ -35,7 +35,7 @@ Hex-encoded bytecode. #### Defined in -[src/types/types.ts:1487](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1487) +[src/types/types.ts:1487](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1487) ___ @@ -47,7 +47,7 @@ Nonce #### Defined in -[src/types/types.ts:1485](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1485) +[src/types/types.ts:1485](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1485) ___ @@ -59,4 +59,4 @@ Storage slots of the contract. #### Defined in -[src/types/types.ts:1489](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1489) +[src/types/types.ts:1489](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1489) diff --git a/docs-md/interfaces/DebugPrestateTracer.md b/docs-md/interfaces/DebugPrestateTracer.md index 16ca34e4..c41e9411 100644 --- a/docs-md/interfaces/DebugPrestateTracer.md +++ b/docs-md/interfaces/DebugPrestateTracer.md @@ -29,7 +29,7 @@ Defaults to `false`. #### Defined in -[src/types/types.ts:1412](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1412) +[src/types/types.ts:1412](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1412) ___ @@ -41,4 +41,4 @@ Specified type is `PRESTATE_TRACER`. #### Defined in -[src/types/types.ts:1407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1407) +[src/types/types.ts:1407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1407) diff --git a/docs-md/interfaces/DebugTransaction.md b/docs-md/interfaces/DebugTransaction.md index 48e61d28..8fd695de 100644 --- a/docs-md/interfaces/DebugTransaction.md +++ b/docs-md/interfaces/DebugTransaction.md @@ -25,7 +25,7 @@ The data associated with the transaction. #### Defined in -[src/types/types.ts:1320](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1320) +[src/types/types.ts:1320](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1320) ___ @@ -37,7 +37,7 @@ The address the transaction is sent from. #### Defined in -[src/types/types.ts:1312](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1312) +[src/types/types.ts:1312](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1312) ___ @@ -49,7 +49,7 @@ The gas provided for the transaction execution, as a hex string. #### Defined in -[src/types/types.ts:1314](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1314) +[src/types/types.ts:1314](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1314) ___ @@ -61,7 +61,7 @@ The gas price to use as a hex string. #### Defined in -[src/types/types.ts:1316](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1316) +[src/types/types.ts:1316](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1316) ___ @@ -73,7 +73,7 @@ The address the transaction is directed to. #### Defined in -[src/types/types.ts:1310](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1310) +[src/types/types.ts:1310](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1310) ___ @@ -85,4 +85,4 @@ The value associated with the transaction as a hex string. #### Defined in -[src/types/types.ts:1318](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1318) +[src/types/types.ts:1318](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1318) diff --git a/docs-md/interfaces/DecodedCallParam.md b/docs-md/interfaces/DecodedCallParam.md index 36702455..fcd80665 100644 --- a/docs-md/interfaces/DecodedCallParam.md +++ b/docs-md/interfaces/DecodedCallParam.md @@ -28,7 +28,7 @@ The name of the parameter. #### Defined in -[src/types/types.ts:879](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L879) +[src/types/types.ts:879](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L879) ___ @@ -40,7 +40,7 @@ The type of the parameter. #### Defined in -[src/types/types.ts:881](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L881) +[src/types/types.ts:881](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L881) ___ @@ -52,4 +52,4 @@ Value of the parameter. #### Defined in -[src/types/types.ts:877](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L877) +[src/types/types.ts:877](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L877) diff --git a/docs-md/interfaces/DecodedDebugCallTrace.md b/docs-md/interfaces/DecodedDebugCallTrace.md index a841cfdb..9c10ca56 100644 --- a/docs-md/interfaces/DecodedDebugCallTrace.md +++ b/docs-md/interfaces/DecodedDebugCallTrace.md @@ -24,7 +24,7 @@ The source used to provide the decoded call trace. #### Defined in -[src/types/types.ts:902](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L902) +[src/types/types.ts:902](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L902) ___ @@ -36,7 +36,7 @@ Method inputs. #### Defined in -[src/types/types.ts:898](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L898) +[src/types/types.ts:898](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L898) ___ @@ -48,7 +48,7 @@ The smart contract method called. #### Defined in -[src/types/types.ts:896](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L896) +[src/types/types.ts:896](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L896) ___ @@ -60,4 +60,4 @@ Method outputs. #### Defined in -[src/types/types.ts:900](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L900) +[src/types/types.ts:900](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L900) diff --git a/docs-md/interfaces/DecodedLog.md b/docs-md/interfaces/DecodedLog.md index 3c58060c..aa6d535c 100644 --- a/docs-md/interfaces/DecodedLog.md +++ b/docs-md/interfaces/DecodedLog.md @@ -23,7 +23,7 @@ The source used to provide the decoded log. #### Defined in -[src/types/types.ts:935](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L935) +[src/types/types.ts:935](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L935) ___ @@ -35,7 +35,7 @@ The decoded name of the log event. #### Defined in -[src/types/types.ts:931](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L931) +[src/types/types.ts:931](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L931) ___ @@ -47,4 +47,4 @@ The decoded inputs to the log. #### Defined in -[src/types/types.ts:933](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L933) +[src/types/types.ts:933](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L933) diff --git a/docs-md/interfaces/DecodedLogInput.md b/docs-md/interfaces/DecodedLogInput.md index a2362b94..8a20ae0d 100644 --- a/docs-md/interfaces/DecodedLogInput.md +++ b/docs-md/interfaces/DecodedLogInput.md @@ -29,7 +29,7 @@ Whether the log is marked as indexed in the smart contract. #### Defined in -[src/types/types.ts:887](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L887) +[src/types/types.ts:887](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L887) ___ @@ -45,7 +45,7 @@ The name of the parameter. #### Defined in -[src/types/types.ts:879](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L879) +[src/types/types.ts:879](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L879) ___ @@ -61,7 +61,7 @@ The type of the parameter. #### Defined in -[src/types/types.ts:881](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L881) +[src/types/types.ts:881](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L881) ___ @@ -77,4 +77,4 @@ Value of the parameter. #### Defined in -[src/types/types.ts:877](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L877) +[src/types/types.ts:877](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L877) diff --git a/docs-md/interfaces/DeployResult.md b/docs-md/interfaces/DeployResult.md index 9ca50e91..b6789049 100644 --- a/docs-md/interfaces/DeployResult.md +++ b/docs-md/interfaces/DeployResult.md @@ -21,7 +21,7 @@ The block number the contract was deployed in. #### Defined in -[src/types/types.ts:598](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L598) +[src/types/types.ts:598](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L598) ___ @@ -33,4 +33,4 @@ The address of the contract deployer, if it is available. #### Defined in -[src/types/types.ts:595](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L595) +[src/types/types.ts:595](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L595) diff --git a/docs-md/interfaces/DisplayNftForContract.md b/docs-md/interfaces/DisplayNftForContract.md index aedf4a3c..2ca857f4 100644 --- a/docs-md/interfaces/DisplayNftForContract.md +++ b/docs-md/interfaces/DisplayNftForContract.md @@ -21,7 +21,7 @@ The name of the NFT, if available. #### Defined in -[src/types/nft-types.ts:576](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L576) +[src/types/nft-types.ts:576](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L576) ___ @@ -33,4 +33,4 @@ A token id of an NFT owned by the owner on the contract. #### Defined in -[src/types/nft-types.ts:574](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L574) +[src/types/nft-types.ts:574](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L574) diff --git a/docs-md/interfaces/DroppedTransactionWebhook.md b/docs-md/interfaces/DroppedTransactionWebhook.md index f37e9f35..92929a68 100644 --- a/docs-md/interfaces/DroppedTransactionWebhook.md +++ b/docs-md/interfaces/DroppedTransactionWebhook.md @@ -41,7 +41,7 @@ The app id of the app used for the webhook. This field is only present on #### Defined in -[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1037) +[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1037) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1018) +[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1018) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1026) +[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1026) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1020) +[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1020) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1030) +[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1030) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1028) +[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1028) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:1071](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1071) +[src/types/types.ts:1071](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1071) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1024) +[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1024) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1032) +[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1032) diff --git a/docs-md/interfaces/ERC1155Metadata.md b/docs-md/interfaces/ERC1155Metadata.md index 7179e9f8..43b3c70b 100644 --- a/docs-md/interfaces/ERC1155Metadata.md +++ b/docs-md/interfaces/ERC1155Metadata.md @@ -20,7 +20,7 @@ transferred is an ERC1155. #### Defined in -[src/types/nft-types.ts:920](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L920) +[src/types/nft-types.ts:920](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L920) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/nft-types.ts:921](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L921) +[src/types/nft-types.ts:921](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L921) diff --git a/docs-md/interfaces/EventFilter.md b/docs-md/interfaces/EventFilter.md index 63cc5b2e..509ad181 100644 --- a/docs-md/interfaces/EventFilter.md +++ b/docs-md/interfaces/EventFilter.md @@ -29,7 +29,7 @@ The address to filter by. If omitted, filters for all addresses. #### Defined in -[src/types/types.ts:1468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1468) +[src/types/types.ts:1468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1468) ___ @@ -41,4 +41,4 @@ The topics to filter by, or null to match any topics. #### Defined in -[src/types/types.ts:1470](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1470) +[src/types/types.ts:1470](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1470) diff --git a/docs-md/interfaces/Filter.md b/docs-md/interfaces/Filter.md index 429eb920..7690b5d0 100644 --- a/docs-md/interfaces/Filter.md +++ b/docs-md/interfaces/Filter.md @@ -34,7 +34,7 @@ The address to filter by. If omitted, filters for all addresses. #### Defined in -[src/types/types.ts:1468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1468) +[src/types/types.ts:1468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1468) ___ @@ -46,7 +46,7 @@ The starting block (inclusive) to search for logs matching the filter. #### Defined in -[src/types/types.ts:1458](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1458) +[src/types/types.ts:1458](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1458) ___ @@ -58,7 +58,7 @@ The end block (inclusive) to search for logs matching the filter. #### Defined in -[src/types/types.ts:1460](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1460) +[src/types/types.ts:1460](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1460) ___ @@ -74,4 +74,4 @@ The topics to filter by, or null to match any topics. #### Defined in -[src/types/types.ts:1470](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1470) +[src/types/types.ts:1470](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1470) diff --git a/docs-md/interfaces/FilterByBlockHash.md b/docs-md/interfaces/FilterByBlockHash.md index 04deacdb..f83759f0 100644 --- a/docs-md/interfaces/FilterByBlockHash.md +++ b/docs-md/interfaces/FilterByBlockHash.md @@ -33,7 +33,7 @@ The address to filter by. If omitted, filters for all addresses. #### Defined in -[src/types/types.ts:1468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1468) +[src/types/types.ts:1468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1468) ___ @@ -45,7 +45,7 @@ The specific block hash to search for logs matching the filter. #### Defined in -[src/types/types.ts:1449](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1449) +[src/types/types.ts:1449](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1449) ___ @@ -61,4 +61,4 @@ The topics to filter by, or null to match any topics. #### Defined in -[src/types/types.ts:1470](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1470) +[src/types/types.ts:1470](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1470) diff --git a/docs-md/interfaces/FloorPriceError.md b/docs-md/interfaces/FloorPriceError.md index 28e250d2..4a5b1abf 100644 --- a/docs-md/interfaces/FloorPriceError.md +++ b/docs-md/interfaces/FloorPriceError.md @@ -21,4 +21,4 @@ Error fetching floor prices from the given marketplace #### Defined in -[src/types/nft-types.ts:473](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L473) +[src/types/nft-types.ts:473](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L473) diff --git a/docs-md/interfaces/FloorPriceMarketplace.md b/docs-md/interfaces/FloorPriceMarketplace.md index 3690cbe3..741f1feb 100644 --- a/docs-md/interfaces/FloorPriceMarketplace.md +++ b/docs-md/interfaces/FloorPriceMarketplace.md @@ -24,7 +24,7 @@ The link to the collection on the given marketplace #### Defined in -[src/types/nft-types.ts:460](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L460) +[src/types/nft-types.ts:460](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L460) ___ @@ -36,7 +36,7 @@ The floor price of the collection on the given marketplace #### Defined in -[src/types/nft-types.ts:456](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L456) +[src/types/nft-types.ts:456](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L456) ___ @@ -48,7 +48,7 @@ The currency in which the floor price is denominated #### Defined in -[src/types/nft-types.ts:458](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L458) +[src/types/nft-types.ts:458](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L458) ___ @@ -60,4 +60,4 @@ UTC timestamp of when the floor price was retrieved from the marketplace #### Defined in -[src/types/nft-types.ts:462](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L462) +[src/types/nft-types.ts:462](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L462) diff --git a/docs-md/interfaces/GetAddressesOptions.md b/docs-md/interfaces/GetAddressesOptions.md index d71b4ace..f41e93ea 100644 --- a/docs-md/interfaces/GetAddressesOptions.md +++ b/docs-md/interfaces/GetAddressesOptions.md @@ -21,7 +21,7 @@ Number of addresses to fetch. #### Defined in -[src/types/types.ts:1122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1122) +[src/types/types.ts:1122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1122) ___ @@ -33,4 +33,4 @@ Page #### Defined in -[src/types/types.ts:1125](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1125) +[src/types/types.ts:1125](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1125) diff --git a/docs-md/interfaces/GetAllWebhooksResponse.md b/docs-md/interfaces/GetAllWebhooksResponse.md index b67c8000..b2c1543c 100644 --- a/docs-md/interfaces/GetAllWebhooksResponse.md +++ b/docs-md/interfaces/GetAllWebhooksResponse.md @@ -21,7 +21,7 @@ The total number of webhooks. #### Defined in -[src/types/types.ts:1116](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1116) +[src/types/types.ts:1116](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1116) ___ @@ -33,4 +33,4 @@ All webhooks attached to the provided auth token. #### Defined in -[src/types/types.ts:1114](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1114) +[src/types/types.ts:1114](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1114) diff --git a/docs-md/interfaces/GetBaseNftsForContractOptions.md b/docs-md/interfaces/GetBaseNftsForContractOptions.md index f995d5b5..a39976de 100644 --- a/docs-md/interfaces/GetBaseNftsForContractOptions.md +++ b/docs-md/interfaces/GetBaseNftsForContractOptions.md @@ -27,7 +27,7 @@ Optional boolean flag to omit NFT metadata. Defaults to `false`. #### Defined in -[src/types/nft-types.ts:998](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L998) +[src/types/nft-types.ts:998](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L998) ___ @@ -40,7 +40,7 @@ Optional page key from an existing [NftContractBaseNftsResponse](NftContractBase #### Defined in -[src/types/nft-types.ts:995](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L995) +[src/types/nft-types.ts:995](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L995) ___ @@ -53,7 +53,7 @@ Maximum page size is 100. #### Defined in -[src/types/nft-types.ts:1004](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1004) +[src/types/nft-types.ts:1004](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1004) ___ @@ -68,4 +68,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/nft-types.ts:1012](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1012) +[src/types/nft-types.ts:1012](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1012) diff --git a/docs-md/interfaces/GetBaseNftsForOwnerOptions.md b/docs-md/interfaces/GetBaseNftsForOwnerOptions.md index 497ed410..461d0b96 100644 --- a/docs-md/interfaces/GetBaseNftsForOwnerOptions.md +++ b/docs-md/interfaces/GetBaseNftsForOwnerOptions.md @@ -31,7 +31,7 @@ Optional list of contract addresses to filter the results by. Limit is 20. #### Defined in -[src/types/nft-types.ts:161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L161) +[src/types/nft-types.ts:161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L161) ___ @@ -44,7 +44,7 @@ of these filters are excluded from the response. #### Defined in -[src/types/nft-types.ts:167](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L167) +[src/types/nft-types.ts:167](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L167) ___ @@ -57,7 +57,7 @@ of these filters are included in the response. #### Defined in -[src/types/nft-types.ts:173](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L173) +[src/types/nft-types.ts:173](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L173) ___ @@ -69,7 +69,7 @@ Optional boolean flag to include NFT metadata. Defaults to `false`. #### Defined in -[src/types/nft-types.ts:182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L182) +[src/types/nft-types.ts:182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L182) ___ @@ -82,7 +82,7 @@ contract address and token ID in lexicographic order. #### Defined in -[src/types/nft-types.ts:196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L196) +[src/types/nft-types.ts:196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L196) ___ @@ -95,7 +95,7 @@ Optional page key from an existing [OwnedBaseNftsResponse](OwnedBaseNftsResponse #### Defined in -[src/types/nft-types.ts:158](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L158) +[src/types/nft-types.ts:158](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L158) ___ @@ -108,7 +108,7 @@ Maximum page size is 100. #### Defined in -[src/types/nft-types.ts:179](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L179) +[src/types/nft-types.ts:179](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L179) ___ @@ -123,4 +123,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/nft-types.ts:190](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L190) +[src/types/nft-types.ts:190](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L190) diff --git a/docs-md/interfaces/GetContractMetadataBatchResponse.md b/docs-md/interfaces/GetContractMetadataBatchResponse.md index 0a565eab..6ce09319 100644 --- a/docs-md/interfaces/GetContractMetadataBatchResponse.md +++ b/docs-md/interfaces/GetContractMetadataBatchResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/nft-types.ts:357](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L357) +[src/types/nft-types.ts:357](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L357) diff --git a/docs-md/interfaces/GetContractsForOwnerOptions.md b/docs-md/interfaces/GetContractsForOwnerOptions.md index eff87281..03cf77ab 100644 --- a/docs-md/interfaces/GetContractsForOwnerOptions.md +++ b/docs-md/interfaces/GetContractsForOwnerOptions.md @@ -26,7 +26,7 @@ conjunction with [includeFilters](GetContractsForOwnerOptions.md#includefilters) #### Defined in -[src/types/nft-types.ts:517](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L517) +[src/types/nft-types.ts:517](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L517) ___ @@ -40,7 +40,7 @@ conjunction with [excludeFilters](GetContractsForOwnerOptions.md#excludefilters) #### Defined in -[src/types/nft-types.ts:510](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L510) +[src/types/nft-types.ts:510](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L510) ___ @@ -53,7 +53,7 @@ contract address and token ID in lexicographic order. #### Defined in -[src/types/nft-types.ts:523](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L523) +[src/types/nft-types.ts:523](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L523) ___ @@ -65,7 +65,7 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/nft-types.ts:497](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L497) +[src/types/nft-types.ts:497](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L497) ___ @@ -78,4 +78,4 @@ is 100. Defaults to 100. #### Defined in -[src/types/nft-types.ts:503](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L503) +[src/types/nft-types.ts:503](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L503) diff --git a/docs-md/interfaces/GetContractsForOwnerResponse.md b/docs-md/interfaces/GetContractsForOwnerResponse.md index c54f4904..0bfffb3f 100644 --- a/docs-md/interfaces/GetContractsForOwnerResponse.md +++ b/docs-md/interfaces/GetContractsForOwnerResponse.md @@ -22,7 +22,7 @@ The list of contracts, that match the query, held by the given address. #### Defined in -[src/types/nft-types.ts:533](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L533) +[src/types/nft-types.ts:533](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L533) ___ @@ -34,7 +34,7 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/nft-types.ts:536](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L536) +[src/types/nft-types.ts:536](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L536) ___ @@ -46,4 +46,4 @@ Total number of NFT contracts held by the given address. #### Defined in -[src/types/nft-types.ts:539](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L539) +[src/types/nft-types.ts:539](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L539) diff --git a/docs-md/interfaces/GetFloorPriceResponse.md b/docs-md/interfaces/GetFloorPriceResponse.md index 159eccfa..f32069e7 100644 --- a/docs-md/interfaces/GetFloorPriceResponse.md +++ b/docs-md/interfaces/GetFloorPriceResponse.md @@ -19,7 +19,7 @@ The response object for the [getFloorPrice](../classes/NftNamespace.md#getfloorp #### Defined in -[src/types/nft-types.ts:487](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L487) +[src/types/nft-types.ts:487](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L487) ___ @@ -32,4 +32,4 @@ marketplaces supported: OpenSea, LooksRare #### Defined in -[src/types/nft-types.ts:486](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L486) +[src/types/nft-types.ts:486](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L486) diff --git a/docs-md/interfaces/GetMintedNftsOptions.md b/docs-md/interfaces/GetMintedNftsOptions.md index d7b324fd..3495ea07 100644 --- a/docs-md/interfaces/GetMintedNftsOptions.md +++ b/docs-md/interfaces/GetMintedNftsOptions.md @@ -23,7 +23,7 @@ all contract addresses. #### Defined in -[src/types/nft-types.ts:637](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L637) +[src/types/nft-types.ts:637](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L637) ___ @@ -36,7 +36,7 @@ pagination. #### Defined in -[src/types/nft-types.ts:649](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L649) +[src/types/nft-types.ts:649](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L649) ___ @@ -49,4 +49,4 @@ NFTs. #### Defined in -[src/types/nft-types.ts:643](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L643) +[src/types/nft-types.ts:643](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L643) diff --git a/docs-md/interfaces/GetNftMetadataBatchResponse.md b/docs-md/interfaces/GetNftMetadataBatchResponse.md index f4283752..371f2ec0 100644 --- a/docs-md/interfaces/GetNftMetadataBatchResponse.md +++ b/docs-md/interfaces/GetNftMetadataBatchResponse.md @@ -18,4 +18,4 @@ An array of NFT metadata objects. #### Defined in -[src/types/nft-types.ts:353](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L353) +[src/types/nft-types.ts:353](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L353) diff --git a/docs-md/interfaces/GetNftMetadataOptions.md b/docs-md/interfaces/GetNftMetadataOptions.md index e5bcfe40..9bcf42ae 100644 --- a/docs-md/interfaces/GetNftMetadataOptions.md +++ b/docs-md/interfaces/GetNftMetadataOptions.md @@ -23,7 +23,7 @@ the response. Defaults to false for faster response times. #### Defined in -[src/types/nft-types.ts:413](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L413) +[src/types/nft-types.ts:413](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L413) ___ @@ -35,7 +35,7 @@ Optional field to specify the type of token to speed up the query. #### Defined in -[src/types/nft-types.ts:400](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L400) +[src/types/nft-types.ts:400](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L400) ___ @@ -50,4 +50,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/nft-types.ts:407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L407) +[src/types/nft-types.ts:407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L407) diff --git a/docs-md/interfaces/GetNftSalesOptions.md b/docs-md/interfaces/GetNftSalesOptions.md index aeb5f95e..0cab4e57 100644 --- a/docs-md/interfaces/GetNftSalesOptions.md +++ b/docs-md/interfaces/GetNftSalesOptions.md @@ -36,7 +36,7 @@ The address of the NFT buyer to filter sales by. #### Defined in -[src/types/nft-types.ts:673](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L673) +[src/types/nft-types.ts:673](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L673) ___ @@ -48,7 +48,7 @@ The block number to start fetching NFT sales data from. #### Defined in -[src/types/nft-types.ts:661](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L661) +[src/types/nft-types.ts:661](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L661) ___ @@ -60,7 +60,7 @@ The maximum number of NFT sales to return. #### Defined in -[src/types/nft-types.ts:685](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L685) +[src/types/nft-types.ts:685](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L685) ___ @@ -72,7 +72,7 @@ The NFT marketplace to filter sales by. #### Defined in -[src/types/nft-types.ts:670](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L670) +[src/types/nft-types.ts:670](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L670) ___ @@ -84,7 +84,7 @@ Whether to return the results in ascending or descending order by block number. #### Defined in -[src/types/nft-types.ts:667](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L667) +[src/types/nft-types.ts:667](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L667) ___ @@ -96,7 +96,7 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/nft-types.ts:688](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L688) +[src/types/nft-types.ts:688](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L688) ___ @@ -108,7 +108,7 @@ The address of the NFT seller to filter sales by. #### Defined in -[src/types/nft-types.ts:676](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L676) +[src/types/nft-types.ts:676](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L676) ___ @@ -121,7 +121,7 @@ Defaults to returning both buyer and seller taker trades. #### Defined in -[src/types/nft-types.ts:682](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L682) +[src/types/nft-types.ts:682](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L682) ___ @@ -133,4 +133,4 @@ The block number limit to fetch NFT sales data from. #### Defined in -[src/types/nft-types.ts:664](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L664) +[src/types/nft-types.ts:664](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L664) diff --git a/docs-md/interfaces/GetNftSalesOptionsByContractAddress.md b/docs-md/interfaces/GetNftSalesOptionsByContractAddress.md index 7afceb80..cb95cb17 100644 --- a/docs-md/interfaces/GetNftSalesOptionsByContractAddress.md +++ b/docs-md/interfaces/GetNftSalesOptionsByContractAddress.md @@ -43,7 +43,7 @@ The address of the NFT buyer to filter sales by. #### Defined in -[src/types/nft-types.ts:673](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L673) +[src/types/nft-types.ts:673](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L673) ___ @@ -55,7 +55,7 @@ The contract address of a NFT collection to filter sales by. #### Defined in -[src/types/nft-types.ts:702](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L702) +[src/types/nft-types.ts:702](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L702) ___ @@ -71,7 +71,7 @@ The block number to start fetching NFT sales data from. #### Defined in -[src/types/nft-types.ts:661](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L661) +[src/types/nft-types.ts:661](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L661) ___ @@ -87,7 +87,7 @@ The maximum number of NFT sales to return. #### Defined in -[src/types/nft-types.ts:685](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L685) +[src/types/nft-types.ts:685](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L685) ___ @@ -103,7 +103,7 @@ The NFT marketplace to filter sales by. #### Defined in -[src/types/nft-types.ts:670](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L670) +[src/types/nft-types.ts:670](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L670) ___ @@ -119,7 +119,7 @@ Whether to return the results in ascending or descending order by block number. #### Defined in -[src/types/nft-types.ts:667](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L667) +[src/types/nft-types.ts:667](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L667) ___ @@ -135,7 +135,7 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/nft-types.ts:688](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L688) +[src/types/nft-types.ts:688](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L688) ___ @@ -151,7 +151,7 @@ The address of the NFT seller to filter sales by. #### Defined in -[src/types/nft-types.ts:676](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L676) +[src/types/nft-types.ts:676](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L676) ___ @@ -168,7 +168,7 @@ Defaults to returning both buyer and seller taker trades. #### Defined in -[src/types/nft-types.ts:682](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L682) +[src/types/nft-types.ts:682](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L682) ___ @@ -184,7 +184,7 @@ The block number limit to fetch NFT sales data from. #### Defined in -[src/types/nft-types.ts:664](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L664) +[src/types/nft-types.ts:664](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L664) ___ @@ -196,4 +196,4 @@ The token ID of an NFT within the specified contractAddress to filter sales by. #### Defined in -[src/types/nft-types.ts:705](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L705) +[src/types/nft-types.ts:705](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L705) diff --git a/docs-md/interfaces/GetNftSalesResponse.md b/docs-md/interfaces/GetNftSalesResponse.md index 0ad60643..70b885c1 100644 --- a/docs-md/interfaces/GetNftSalesResponse.md +++ b/docs-md/interfaces/GetNftSalesResponse.md @@ -22,7 +22,7 @@ List of NFT sales that match the query #### Defined in -[src/types/nft-types.ts:715](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L715) +[src/types/nft-types.ts:715](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L715) ___ @@ -34,7 +34,7 @@ The page key to use to fetch the next page if more results are available. #### Defined in -[src/types/nft-types.ts:723](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L723) +[src/types/nft-types.ts:723](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L723) ___ @@ -46,4 +46,4 @@ Block Information of the block as of which the corresponding data is valid. #### Defined in -[src/types/nft-types.ts:719](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L719) +[src/types/nft-types.ts:719](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L719) diff --git a/docs-md/interfaces/GetNftsForContractOptions.md b/docs-md/interfaces/GetNftsForContractOptions.md index 86b5b9fd..2f46baad 100644 --- a/docs-md/interfaces/GetNftsForContractOptions.md +++ b/docs-md/interfaces/GetNftsForContractOptions.md @@ -27,7 +27,7 @@ Optional boolean flag to omit NFT metadata. Defaults to `false`. #### Defined in -[src/types/nft-types.ts:964](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L964) +[src/types/nft-types.ts:964](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L964) ___ @@ -40,7 +40,7 @@ Optional page key from an existing [NftContractBaseNftsResponse](NftContractBase #### Defined in -[src/types/nft-types.ts:961](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L961) +[src/types/nft-types.ts:961](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L961) ___ @@ -53,7 +53,7 @@ Maximum page size is 100. #### Defined in -[src/types/nft-types.ts:970](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L970) +[src/types/nft-types.ts:970](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L970) ___ @@ -68,4 +68,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/nft-types.ts:978](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L978) +[src/types/nft-types.ts:978](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L978) diff --git a/docs-md/interfaces/GetNftsForOwnerOptions.md b/docs-md/interfaces/GetNftsForOwnerOptions.md index 87f9ddab..a497fcc7 100644 --- a/docs-md/interfaces/GetNftsForOwnerOptions.md +++ b/docs-md/interfaces/GetNftsForOwnerOptions.md @@ -31,7 +31,7 @@ Optional list of contract addresses to filter the results by. Limit is 20. #### Defined in -[src/types/nft-types.ts:106](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L106) +[src/types/nft-types.ts:106](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L106) ___ @@ -44,7 +44,7 @@ of these filters are excluded from the response. #### Defined in -[src/types/nft-types.ts:112](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L112) +[src/types/nft-types.ts:112](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L112) ___ @@ -57,7 +57,7 @@ of these filters are included in the response. #### Defined in -[src/types/nft-types.ts:118](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L118) +[src/types/nft-types.ts:118](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L118) ___ @@ -69,7 +69,7 @@ Optional boolean flag to omit NFT metadata. Defaults to `false`. #### Defined in -[src/types/nft-types.ts:127](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L127) +[src/types/nft-types.ts:127](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L127) ___ @@ -82,7 +82,7 @@ contract address and token ID in lexicographic order. #### Defined in -[src/types/nft-types.ts:141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L141) +[src/types/nft-types.ts:141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L141) ___ @@ -95,7 +95,7 @@ Optional page key from an existing [OwnedBaseNftsResponse](OwnedBaseNftsResponse #### Defined in -[src/types/nft-types.ts:103](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L103) +[src/types/nft-types.ts:103](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L103) ___ @@ -108,7 +108,7 @@ Maximum page size is 100. #### Defined in -[src/types/nft-types.ts:124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L124) +[src/types/nft-types.ts:124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L124) ___ @@ -123,4 +123,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/nft-types.ts:135](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L135) +[src/types/nft-types.ts:135](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L135) diff --git a/docs-md/interfaces/GetOwnersForContractOptions.md b/docs-md/interfaces/GetOwnersForContractOptions.md index 5744c9aa..fd4ca345 100644 --- a/docs-md/interfaces/GetOwnersForContractOptions.md +++ b/docs-md/interfaces/GetOwnersForContractOptions.md @@ -26,7 +26,7 @@ The block number in hex or decimal to fetch owners for. #### Defined in -[src/types/nft-types.ts:1031](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1031) +[src/types/nft-types.ts:1031](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1031) ___ @@ -39,7 +39,7 @@ when `withTokenBalances` is not set to `true`. #### Defined in -[src/types/nft-types.ts:1040](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1040) +[src/types/nft-types.ts:1040](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1040) ___ @@ -51,7 +51,7 @@ Optional page key to paginate the next page for large requests. #### Defined in -[src/types/nft-types.ts:1034](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1034) +[src/types/nft-types.ts:1034](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1034) ___ @@ -64,4 +64,4 @@ to false when omitted. #### Defined in -[src/types/nft-types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1028) +[src/types/nft-types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1028) diff --git a/docs-md/interfaces/GetOwnersForContractResponse.md b/docs-md/interfaces/GetOwnersForContractResponse.md index cb7bcd87..2594a534 100644 --- a/docs-md/interfaces/GetOwnersForContractResponse.md +++ b/docs-md/interfaces/GetOwnersForContractResponse.md @@ -22,7 +22,7 @@ An array of owner addresses for the provided contract address #### Defined in -[src/types/nft-types.ts:327](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L327) +[src/types/nft-types.ts:327](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L327) ___ @@ -34,7 +34,7 @@ Optional page key that is returned when a collection has more than 50,000 owners #### Defined in -[src/types/nft-types.ts:335](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L335) +[src/types/nft-types.ts:335](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L335) ___ @@ -47,4 +47,4 @@ Total count of unique owners. Only present if #### Defined in -[src/types/nft-types.ts:332](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L332) +[src/types/nft-types.ts:332](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L332) diff --git a/docs-md/interfaces/GetOwnersForContractWithTokenBalancesOptions.md b/docs-md/interfaces/GetOwnersForContractWithTokenBalancesOptions.md index a227010f..960f0c58 100644 --- a/docs-md/interfaces/GetOwnersForContractWithTokenBalancesOptions.md +++ b/docs-md/interfaces/GetOwnersForContractWithTokenBalancesOptions.md @@ -25,7 +25,7 @@ The block number in hex or decimal to fetch owners for. #### Defined in -[src/types/nft-types.ts:1059](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1059) +[src/types/nft-types.ts:1059](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1059) ___ @@ -37,7 +37,7 @@ Optional page key to paginate the next page for large requests. #### Defined in -[src/types/nft-types.ts:1062](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1062) +[src/types/nft-types.ts:1062](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1062) ___ @@ -50,4 +50,4 @@ to false when omitted. #### Defined in -[src/types/nft-types.ts:1056](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1056) +[src/types/nft-types.ts:1056](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1056) diff --git a/docs-md/interfaces/GetOwnersForContractWithTokenBalancesResponse.md b/docs-md/interfaces/GetOwnersForContractWithTokenBalancesResponse.md index f73c85bc..50e13f48 100644 --- a/docs-md/interfaces/GetOwnersForContractWithTokenBalancesResponse.md +++ b/docs-md/interfaces/GetOwnersForContractWithTokenBalancesResponse.md @@ -21,7 +21,7 @@ An array of owner addresses for the provided contract address #### Defined in -[src/types/nft-types.ts:345](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L345) +[src/types/nft-types.ts:345](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L345) ___ @@ -33,4 +33,4 @@ Optional page key that is returned when a collection has more than 50,000 owners #### Defined in -[src/types/nft-types.ts:348](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L348) +[src/types/nft-types.ts:348](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L348) diff --git a/docs-md/interfaces/GetOwnersForNftOptions.md b/docs-md/interfaces/GetOwnersForNftOptions.md index 1d702c54..473c1646 100644 --- a/docs-md/interfaces/GetOwnersForNftOptions.md +++ b/docs-md/interfaces/GetOwnersForNftOptions.md @@ -24,7 +24,7 @@ Optional page key to paginate the next page for large requests. #### Defined in -[src/types/nft-types.ts:1075](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1075) +[src/types/nft-types.ts:1075](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1075) ___ @@ -36,4 +36,4 @@ Sets the total number of owners to return in the response. #### Defined in -[src/types/nft-types.ts:1080](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1080) +[src/types/nft-types.ts:1080](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1080) diff --git a/docs-md/interfaces/GetOwnersForNftResponse.md b/docs-md/interfaces/GetOwnersForNftResponse.md index a4384349..a165eb1c 100644 --- a/docs-md/interfaces/GetOwnersForNftResponse.md +++ b/docs-md/interfaces/GetOwnersForNftResponse.md @@ -21,7 +21,7 @@ An array of owner addresses for the provided token. #### Defined in -[src/types/nft-types.ts:314](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L314) +[src/types/nft-types.ts:314](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L314) ___ @@ -33,4 +33,4 @@ Optional The key for the next page of results, if applicable. #### Defined in -[src/types/nft-types.ts:317](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L317) +[src/types/nft-types.ts:317](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L317) diff --git a/docs-md/interfaces/GetSpamContractsResponse.md b/docs-md/interfaces/GetSpamContractsResponse.md index d2dfe8c0..2d3ae026 100644 --- a/docs-md/interfaces/GetSpamContractsResponse.md +++ b/docs-md/interfaces/GetSpamContractsResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/nft-types.ts:392](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L392) +[src/types/nft-types.ts:392](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L392) diff --git a/docs-md/interfaces/GetTokensForOwnerOptions.md b/docs-md/interfaces/GetTokensForOwnerOptions.md index 5dafe082..1f716983 100644 --- a/docs-md/interfaces/GetTokensForOwnerOptions.md +++ b/docs-md/interfaces/GetTokensForOwnerOptions.md @@ -22,7 +22,7 @@ List of contract addresses to filter by. If omitted, defaults to #### Defined in -[src/types/types.ts:182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L182) +[src/types/types.ts:182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L182) ___ @@ -35,4 +35,4 @@ pagination. #### Defined in -[src/types/types.ts:187](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L187) +[src/types/types.ts:187](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L187) diff --git a/docs-md/interfaces/GetTokensForOwnerResponse.md b/docs-md/interfaces/GetTokensForOwnerResponse.md index 88cb6aef..d9909ab4 100644 --- a/docs-md/interfaces/GetTokensForOwnerResponse.md +++ b/docs-md/interfaces/GetTokensForOwnerResponse.md @@ -21,7 +21,7 @@ Page key for the next page of results, if one exists. #### Defined in -[src/types/types.ts:197](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L197) +[src/types/types.ts:197](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L197) ___ @@ -33,4 +33,4 @@ Owned tokens for the provided addresses along with relevant metadata. #### Defined in -[src/types/types.ts:195](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L195) +[src/types/types.ts:195](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L195) diff --git a/docs-md/interfaces/GetTransfersForContractOptions.md b/docs-md/interfaces/GetTransfersForContractOptions.md index 4711a781..bc398a02 100644 --- a/docs-md/interfaces/GetTransfersForContractOptions.md +++ b/docs-md/interfaces/GetTransfersForContractOptions.md @@ -24,7 +24,7 @@ Starting block (inclusive) to get transfers from. #### Defined in -[src/types/nft-types.ts:585](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L585) +[src/types/nft-types.ts:585](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L585) ___ @@ -37,7 +37,7 @@ Defaults to ascending if omitted. #### Defined in -[src/types/nft-types.ts:592](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L592) +[src/types/nft-types.ts:592](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L592) ___ @@ -50,7 +50,7 @@ pagination. #### Defined in -[src/types/nft-types.ts:597](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L597) +[src/types/nft-types.ts:597](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L597) ___ @@ -62,4 +62,4 @@ Ending block (inclusive) to get transfers from. #### Defined in -[src/types/nft-types.ts:587](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L587) +[src/types/nft-types.ts:587](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L587) diff --git a/docs-md/interfaces/GetTransfersForOwnerOptions.md b/docs-md/interfaces/GetTransfersForOwnerOptions.md index 4809de1e..18ce410c 100644 --- a/docs-md/interfaces/GetTransfersForOwnerOptions.md +++ b/docs-md/interfaces/GetTransfersForOwnerOptions.md @@ -23,7 +23,7 @@ all contract addresses. #### Defined in -[src/types/types.ts:497](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L497) +[src/types/types.ts:497](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L497) ___ @@ -36,7 +36,7 @@ pagination. #### Defined in -[src/types/types.ts:509](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L509) +[src/types/types.ts:509](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L509) ___ @@ -49,4 +49,4 @@ NFTs. #### Defined in -[src/types/types.ts:503](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L503) +[src/types/types.ts:503](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L503) diff --git a/docs-md/interfaces/IsAirdropNftResponse.md b/docs-md/interfaces/IsAirdropNftResponse.md index 2fe1fbaf..2120f8bb 100644 --- a/docs-md/interfaces/IsAirdropNftResponse.md +++ b/docs-md/interfaces/IsAirdropNftResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/nft-types.ts:388](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L388) +[src/types/nft-types.ts:388](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L388) diff --git a/docs-md/interfaces/IsSpamContractResponse.md b/docs-md/interfaces/IsSpamContractResponse.md index ab367806..88f64989 100644 --- a/docs-md/interfaces/IsSpamContractResponse.md +++ b/docs-md/interfaces/IsSpamContractResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/nft-types.ts:384](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L384) +[src/types/nft-types.ts:384](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L384) diff --git a/docs-md/interfaces/MinedTransactionWebhook.md b/docs-md/interfaces/MinedTransactionWebhook.md index 60538366..094b4444 100644 --- a/docs-md/interfaces/MinedTransactionWebhook.md +++ b/docs-md/interfaces/MinedTransactionWebhook.md @@ -41,7 +41,7 @@ The app id of the app used for the webhook. This field is only present on #### Defined in -[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1037) +[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1037) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1018) +[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1018) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1026) +[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1026) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1020) +[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1020) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1030) +[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1030) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1028) +[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1028) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:1062](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1062) +[src/types/types.ts:1062](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1062) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1024) +[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1024) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1032) +[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1032) diff --git a/docs-md/interfaces/Nft.md b/docs-md/interfaces/Nft.md index 606c996f..b83253cc 100644 --- a/docs-md/interfaces/Nft.md +++ b/docs-md/interfaces/Nft.md @@ -45,7 +45,7 @@ request. #### Defined in -[src/types/nft-types.ts:1278](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1278) +[src/types/nft-types.ts:1278](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1278) ___ @@ -57,7 +57,7 @@ Collection metadata for the NFT, if available. #### Defined in -[src/types/nft-types.ts:1280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1280) +[src/types/nft-types.ts:1280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1280) ___ @@ -69,7 +69,7 @@ The NFT's underlying contract and relevant contract metadata. #### Defined in -[src/types/nft-types.ts:1256](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1256) +[src/types/nft-types.ts:1256](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1256) ___ @@ -81,7 +81,7 @@ The NFT description. #### Defined in -[src/types/nft-types.ts:1264](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1264) +[src/types/nft-types.ts:1264](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1264) ___ @@ -93,7 +93,7 @@ Media URLs and information for the NFT #### Defined in -[src/types/nft-types.ts:1266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1266) +[src/types/nft-types.ts:1266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1266) ___ @@ -105,7 +105,7 @@ Mint information for the NFT. #### Defined in -[src/types/nft-types.ts:1282](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1282) +[src/types/nft-types.ts:1282](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1282) ___ @@ -117,7 +117,7 @@ The NFT name. #### Defined in -[src/types/nft-types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1262) +[src/types/nft-types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1262) ___ @@ -129,7 +129,7 @@ The raw metadata for the NFT based on the metadata URI on the NFT contract. #### Defined in -[src/types/nft-types.ts:1268](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1268) +[src/types/nft-types.ts:1268](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1268) ___ @@ -141,7 +141,7 @@ When the NFT was last updated in the blockchain. Represented in ISO-8601 format. #### Defined in -[src/types/nft-types.ts:1272](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1272) +[src/types/nft-types.ts:1272](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1272) ___ @@ -153,7 +153,7 @@ The NFT token ID as an integer string. #### Defined in -[src/types/nft-types.ts:1258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1258) +[src/types/nft-types.ts:1258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1258) ___ @@ -165,7 +165,7 @@ The type of NFT. #### Defined in -[src/types/nft-types.ts:1260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1260) +[src/types/nft-types.ts:1260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1260) ___ @@ -177,4 +177,4 @@ URIs for accessing the NFT's metadata blob. #### Defined in -[src/types/nft-types.ts:1270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1270) +[src/types/nft-types.ts:1270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1270) diff --git a/docs-md/interfaces/NftActivityWebhook.md b/docs-md/interfaces/NftActivityWebhook.md index 6b53735b..1cf692a3 100644 --- a/docs-md/interfaces/NftActivityWebhook.md +++ b/docs-md/interfaces/NftActivityWebhook.md @@ -41,7 +41,7 @@ The app id of the app used for the webhook. This field is only present on #### Defined in -[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1037) +[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1037) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1018) +[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1018) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1026) +[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1026) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1020) +[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1020) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1030) +[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1030) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1028) +[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1028) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:1089](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1089) +[src/types/types.ts:1089](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1089) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1024) +[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1024) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1032) +[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1032) diff --git a/docs-md/interfaces/NftAttributeRarity.md b/docs-md/interfaces/NftAttributeRarity.md index 99d3f7b6..36160825 100644 --- a/docs-md/interfaces/NftAttributeRarity.md +++ b/docs-md/interfaces/NftAttributeRarity.md @@ -23,7 +23,7 @@ trait type in the current collection. #### Defined in -[src/types/nft-types.ts:870](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L870) +[src/types/nft-types.ts:870](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L870) ___ @@ -35,7 +35,7 @@ The type of NFT attribute. #### Defined in -[src/types/nft-types.ts:864](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L864) +[src/types/nft-types.ts:864](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L864) ___ @@ -47,4 +47,4 @@ Name of the NFT's attribute. #### Defined in -[src/types/nft-types.ts:861](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L861) +[src/types/nft-types.ts:861](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L861) diff --git a/docs-md/interfaces/NftAttributesResponse.md b/docs-md/interfaces/NftAttributesResponse.md index c9be418e..c4578bc2 100644 --- a/docs-md/interfaces/NftAttributesResponse.md +++ b/docs-md/interfaces/NftAttributesResponse.md @@ -22,7 +22,7 @@ The specified NFT contract's address. #### Defined in -[src/types/nft-types.ts:880](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L880) +[src/types/nft-types.ts:880](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L880) ___ @@ -35,7 +35,7 @@ provided NFT. #### Defined in -[src/types/nft-types.ts:889](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L889) +[src/types/nft-types.ts:889](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L889) ___ @@ -47,4 +47,4 @@ The specified NFT contract's total supply. #### Defined in -[src/types/nft-types.ts:883](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L883) +[src/types/nft-types.ts:883](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L883) diff --git a/docs-md/interfaces/NftCollection.md b/docs-md/interfaces/NftCollection.md index 09c562ef..40b00411 100644 --- a/docs-md/interfaces/NftCollection.md +++ b/docs-md/interfaces/NftCollection.md @@ -26,7 +26,7 @@ The description of the collection. #### Defined in -[src/types/nft-types.ts:1200](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1200) +[src/types/nft-types.ts:1200](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1200) ___ @@ -38,7 +38,7 @@ The Discord URL of the collection. #### Defined in -[src/types/nft-types.ts:1206](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1206) +[src/types/nft-types.ts:1206](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1206) ___ @@ -50,7 +50,7 @@ The homepage of the collection as determined by OpenSea. #### Defined in -[src/types/nft-types.ts:1202](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1202) +[src/types/nft-types.ts:1202](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1202) ___ @@ -62,7 +62,7 @@ The floor price of the collection #### Defined in -[src/types/nft-types.ts:1198](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1198) +[src/types/nft-types.ts:1198](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1198) ___ @@ -74,7 +74,7 @@ The name of the collection. #### Defined in -[src/types/nft-types.ts:1194](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1194) +[src/types/nft-types.ts:1194](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1194) ___ @@ -86,7 +86,7 @@ The OpenSea human-readable slug of the collection. #### Defined in -[src/types/nft-types.ts:1196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1196) +[src/types/nft-types.ts:1196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1196) ___ @@ -98,4 +98,4 @@ The Twitter handle of the collection. #### Defined in -[src/types/nft-types.ts:1204](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1204) +[src/types/nft-types.ts:1204](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1204) diff --git a/docs-md/interfaces/NftCollectionFloorPrice.md b/docs-md/interfaces/NftCollectionFloorPrice.md index 93cda90e..0c768edf 100644 --- a/docs-md/interfaces/NftCollectionFloorPrice.md +++ b/docs-md/interfaces/NftCollectionFloorPrice.md @@ -22,7 +22,7 @@ The floor price of the collection. #### Defined in -[src/types/nft-types.ts:1216](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1216) +[src/types/nft-types.ts:1216](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1216) ___ @@ -34,7 +34,7 @@ The marketplace where the floor price was determined. #### Defined in -[src/types/nft-types.ts:1214](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1214) +[src/types/nft-types.ts:1214](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1214) ___ @@ -46,4 +46,4 @@ The currency of the floor price. #### Defined in -[src/types/nft-types.ts:1218](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1218) +[src/types/nft-types.ts:1218](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1218) diff --git a/docs-md/interfaces/NftContract.md b/docs-md/interfaces/NftContract.md index b366812c..606fa568 100644 --- a/docs-md/interfaces/NftContract.md +++ b/docs-md/interfaces/NftContract.md @@ -39,7 +39,7 @@ The address of the NFT contract. #### Defined in -[src/types/nft-types.ts:1159](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1159) +[src/types/nft-types.ts:1159](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1159) ___ @@ -51,7 +51,7 @@ The address that deployed the NFT contract. #### Defined in -[src/types/nft-types.ts:1174](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1174) +[src/types/nft-types.ts:1174](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1174) ___ @@ -63,7 +63,7 @@ The block number the NFT contract deployed in. #### Defined in -[src/types/nft-types.ts:1176](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1176) +[src/types/nft-types.ts:1176](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1176) ___ @@ -75,7 +75,7 @@ The name of the contract. #### Defined in -[src/types/nft-types.ts:1163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1163) +[src/types/nft-types.ts:1163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1163) ___ @@ -87,7 +87,7 @@ OpenSea's metadata for the contract. #### Defined in -[src/types/nft-types.ts:1172](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1172) +[src/types/nft-types.ts:1172](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1172) ___ @@ -99,7 +99,7 @@ The symbol of the contract. #### Defined in -[src/types/nft-types.ts:1165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1165) +[src/types/nft-types.ts:1165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1165) ___ @@ -111,7 +111,7 @@ The type of the token in the contract. #### Defined in -[src/types/nft-types.ts:1161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1161) +[src/types/nft-types.ts:1161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1161) ___ @@ -124,4 +124,4 @@ available on ERC-721 contracts. #### Defined in -[src/types/nft-types.ts:1170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1170) +[src/types/nft-types.ts:1170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1170) diff --git a/docs-md/interfaces/NftContractBaseNftsResponse.md b/docs-md/interfaces/NftContractBaseNftsResponse.md index 0e23226f..753cae9a 100644 --- a/docs-md/interfaces/NftContractBaseNftsResponse.md +++ b/docs-md/interfaces/NftContractBaseNftsResponse.md @@ -22,7 +22,7 @@ An array of NFTs without metadata. #### Defined in -[src/types/nft-types.ts:1091](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1091) +[src/types/nft-types.ts:1091](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1091) ___ @@ -35,4 +35,4 @@ NFTs. If there is no page key, then there are no more NFTs to fetch. #### Defined in -[src/types/nft-types.ts:1097](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1097) +[src/types/nft-types.ts:1097](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1097) diff --git a/docs-md/interfaces/NftContractForNft.md b/docs-md/interfaces/NftContractForNft.md index 4a54b0e5..8fb6165a 100644 --- a/docs-md/interfaces/NftContractForNft.md +++ b/docs-md/interfaces/NftContractForNft.md @@ -39,7 +39,7 @@ The address of the NFT contract. #### Defined in -[src/types/nft-types.ts:1159](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1159) +[src/types/nft-types.ts:1159](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1159) ___ @@ -55,7 +55,7 @@ The address that deployed the NFT contract. #### Defined in -[src/types/nft-types.ts:1174](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1174) +[src/types/nft-types.ts:1174](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1174) ___ @@ -71,7 +71,7 @@ The block number the NFT contract deployed in. #### Defined in -[src/types/nft-types.ts:1176](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1176) +[src/types/nft-types.ts:1176](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1176) ___ @@ -83,7 +83,7 @@ Whether the NFT contract is marked as spam. #### Defined in -[src/types/nft-types.ts:1182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1182) +[src/types/nft-types.ts:1182](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1182) ___ @@ -99,7 +99,7 @@ The name of the contract. #### Defined in -[src/types/nft-types.ts:1163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1163) +[src/types/nft-types.ts:1163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1163) ___ @@ -115,7 +115,7 @@ OpenSea's metadata for the contract. #### Defined in -[src/types/nft-types.ts:1172](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1172) +[src/types/nft-types.ts:1172](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1172) ___ @@ -127,7 +127,7 @@ Potential reasons why an NFT Contract was classified as spam. #### Defined in -[src/types/nft-types.ts:1184](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1184) +[src/types/nft-types.ts:1184](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1184) ___ @@ -143,7 +143,7 @@ The symbol of the contract. #### Defined in -[src/types/nft-types.ts:1165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1165) +[src/types/nft-types.ts:1165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1165) ___ @@ -159,7 +159,7 @@ The type of the token in the contract. #### Defined in -[src/types/nft-types.ts:1161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1161) +[src/types/nft-types.ts:1161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1161) ___ @@ -176,4 +176,4 @@ available on ERC-721 contracts. #### Defined in -[src/types/nft-types.ts:1170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1170) +[src/types/nft-types.ts:1170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1170) diff --git a/docs-md/interfaces/NftContractForOwner.md b/docs-md/interfaces/NftContractForOwner.md index 6e9df6d8..80f59ad5 100644 --- a/docs-md/interfaces/NftContractForOwner.md +++ b/docs-md/interfaces/NftContractForOwner.md @@ -42,7 +42,7 @@ The address of the NFT contract. #### Defined in -[src/types/nft-types.ts:1159](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1159) +[src/types/nft-types.ts:1159](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1159) ___ @@ -58,7 +58,7 @@ The address that deployed the NFT contract. #### Defined in -[src/types/nft-types.ts:1174](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1174) +[src/types/nft-types.ts:1174](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1174) ___ @@ -74,7 +74,7 @@ The block number the NFT contract deployed in. #### Defined in -[src/types/nft-types.ts:1176](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1176) +[src/types/nft-types.ts:1176](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1176) ___ @@ -87,7 +87,7 @@ Use this to display a sample NFT for the contract. #### Defined in -[src/types/nft-types.ts:565](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L565) +[src/types/nft-types.ts:565](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L565) ___ @@ -99,7 +99,7 @@ Object containing different URLs for the NFT media. #### Defined in -[src/types/nft-types.ts:568](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L568) +[src/types/nft-types.ts:568](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L568) ___ @@ -111,7 +111,7 @@ Whether the NFT contract is considered spam. #### Defined in -[src/types/nft-types.ts:559](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L559) +[src/types/nft-types.ts:559](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L559) ___ @@ -127,7 +127,7 @@ The name of the contract. #### Defined in -[src/types/nft-types.ts:1163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1163) +[src/types/nft-types.ts:1163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1163) ___ @@ -141,7 +141,7 @@ holds some fungible ERC1155 tokens. #### Defined in -[src/types/nft-types.ts:556](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L556) +[src/types/nft-types.ts:556](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L556) ___ @@ -157,7 +157,7 @@ OpenSea's metadata for the contract. #### Defined in -[src/types/nft-types.ts:1172](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1172) +[src/types/nft-types.ts:1172](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1172) ___ @@ -173,7 +173,7 @@ The symbol of the contract. #### Defined in -[src/types/nft-types.ts:1165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1165) +[src/types/nft-types.ts:1165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1165) ___ @@ -189,7 +189,7 @@ The type of the token in the contract. #### Defined in -[src/types/nft-types.ts:1161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1161) +[src/types/nft-types.ts:1161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1161) ___ @@ -203,7 +203,7 @@ it may be higher if the user holds some fungible ERC1155 tokens. #### Defined in -[src/types/nft-types.ts:549](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L549) +[src/types/nft-types.ts:549](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L549) ___ @@ -220,4 +220,4 @@ available on ERC-721 contracts. #### Defined in -[src/types/nft-types.ts:1170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1170) +[src/types/nft-types.ts:1170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1170) diff --git a/docs-md/interfaces/NftContractNftsResponse.md b/docs-md/interfaces/NftContractNftsResponse.md index 142e58a4..cd7cd2ce 100644 --- a/docs-md/interfaces/NftContractNftsResponse.md +++ b/docs-md/interfaces/NftContractNftsResponse.md @@ -22,7 +22,7 @@ An array of NFTs with metadata. #### Defined in -[src/types/nft-types.ts:1108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1108) +[src/types/nft-types.ts:1108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1108) ___ @@ -35,4 +35,4 @@ NFTs. If there is no page key, then there are no more NFTs to fetch. #### Defined in -[src/types/nft-types.ts:1114](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1114) +[src/types/nft-types.ts:1114](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1114) diff --git a/docs-md/interfaces/NftContractOwner.md b/docs-md/interfaces/NftContractOwner.md index 869edea1..9c8cb7fd 100644 --- a/docs-md/interfaces/NftContractOwner.md +++ b/docs-md/interfaces/NftContractOwner.md @@ -22,7 +22,7 @@ The NFT's owner address. #### Defined in -[src/types/nft-types.ts:366](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L366) +[src/types/nft-types.ts:366](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L366) ___ @@ -34,4 +34,4 @@ A list of objects containing token balances for the provided NFT contract. #### Defined in -[src/types/nft-types.ts:369](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L369) +[src/types/nft-types.ts:369](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L369) diff --git a/docs-md/interfaces/NftContractTokenBalance.md b/docs-md/interfaces/NftContractTokenBalance.md index 14c82bb3..7d671ab2 100644 --- a/docs-md/interfaces/NftContractTokenBalance.md +++ b/docs-md/interfaces/NftContractTokenBalance.md @@ -22,7 +22,7 @@ The token id balance for the provided owner. #### Defined in -[src/types/nft-types.ts:380](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L380) +[src/types/nft-types.ts:380](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L380) ___ @@ -34,4 +34,4 @@ The token id owned in the NFT contract. #### Defined in -[src/types/nft-types.ts:378](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L378) +[src/types/nft-types.ts:378](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L378) diff --git a/docs-md/interfaces/NftFilter.md b/docs-md/interfaces/NftFilter.md index 7f073b92..e92b1485 100644 --- a/docs-md/interfaces/NftFilter.md +++ b/docs-md/interfaces/NftFilter.md @@ -21,7 +21,7 @@ The contract address of the NFT. #### Defined in -[src/types/types.ts:1205](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1205) +[src/types/types.ts:1205](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1205) ___ @@ -34,4 +34,4 @@ tracking all NFTs for the provided contract address. #### Defined in -[src/types/types.ts:1210](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1210) +[src/types/types.ts:1210](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1210) diff --git a/docs-md/interfaces/NftFiltersResponse.md b/docs-md/interfaces/NftFiltersResponse.md index 93120373..9be0cafd 100644 --- a/docs-md/interfaces/NftFiltersResponse.md +++ b/docs-md/interfaces/NftFiltersResponse.md @@ -22,7 +22,7 @@ The NFT filters on the provided webhook. #### Defined in -[src/types/types.ts:1216](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1216) +[src/types/types.ts:1216](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1216) ___ @@ -34,7 +34,7 @@ Optional page key used to fetch the remaining filters. #### Defined in -[src/types/types.ts:1220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1220) +[src/types/types.ts:1220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1220) ___ @@ -46,4 +46,4 @@ The total number of NFT filters on the webhook. #### Defined in -[src/types/types.ts:1218](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1218) +[src/types/types.ts:1218](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1218) diff --git a/docs-md/interfaces/NftImage.md b/docs-md/interfaces/NftImage.md index 9e415ccf..40a58d72 100644 --- a/docs-md/interfaces/NftImage.md +++ b/docs-md/interfaces/NftImage.md @@ -25,7 +25,7 @@ URL of the image stored in Alchemy's cache. #### Defined in -[src/types/nft-types.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L51) +[src/types/nft-types.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L51) ___ @@ -37,7 +37,7 @@ The type of the media image. #### Defined in -[src/types/nft-types.ts:57](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L57) +[src/types/nft-types.ts:57](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L57) ___ @@ -49,7 +49,7 @@ The original URL of the image as stored on the contract. #### Defined in -[src/types/nft-types.ts:61](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L61) +[src/types/nft-types.ts:61](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L61) ___ @@ -61,7 +61,7 @@ URL of the image in png format #### Defined in -[src/types/nft-types.ts:55](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L55) +[src/types/nft-types.ts:55](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L55) ___ @@ -73,7 +73,7 @@ The size of the media asset in bytes. #### Defined in -[src/types/nft-types.ts:59](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L59) +[src/types/nft-types.ts:59](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L59) ___ @@ -85,4 +85,4 @@ URL of a thumbnail sized image. #### Defined in -[src/types/nft-types.ts:53](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L53) +[src/types/nft-types.ts:53](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L53) diff --git a/docs-md/interfaces/NftMetadata.md b/docs-md/interfaces/NftMetadata.md index 44dc1137..78b331a2 100644 --- a/docs-md/interfaces/NftMetadata.md +++ b/docs-md/interfaces/NftMetadata.md @@ -32,7 +32,7 @@ The traits, attributes, and characteristics for the NFT asset. #### Defined in -[src/types/nft-types.ts:45](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L45) +[src/types/nft-types.ts:45](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L45) ___ @@ -44,7 +44,7 @@ Background color of the NFT item. Usually defined as a 6 character hex string. #### Defined in -[src/types/nft-types.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L42) +[src/types/nft-types.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L42) ___ @@ -56,7 +56,7 @@ A human-readable description of the NFT asset. #### Defined in -[src/types/nft-types.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L30) +[src/types/nft-types.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L30) ___ @@ -69,7 +69,7 @@ to be the highest resolution image. #### Defined in -[src/types/nft-types.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L39) +[src/types/nft-types.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L39) ___ @@ -81,7 +81,7 @@ URL to the NFT asset image. #### Defined in -[src/types/nft-types.ts:33](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L33) +[src/types/nft-types.ts:33](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L33) ___ @@ -93,4 +93,4 @@ Name of the NFT asset. #### Defined in -[src/types/nft-types.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L27) +[src/types/nft-types.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L27) diff --git a/docs-md/interfaces/NftMetadataBatchOptions.md b/docs-md/interfaces/NftMetadataBatchOptions.md index fc34a142..4c53e98b 100644 --- a/docs-md/interfaces/NftMetadataBatchOptions.md +++ b/docs-md/interfaces/NftMetadataBatchOptions.md @@ -22,7 +22,7 @@ the response. Defaults to false for faster response times. #### Defined in -[src/types/nft-types.ts:445](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L445) +[src/types/nft-types.ts:445](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L445) ___ @@ -37,4 +37,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/nft-types.ts:439](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L439) +[src/types/nft-types.ts:439](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L439) diff --git a/docs-md/interfaces/NftMetadataBatchToken.md b/docs-md/interfaces/NftMetadataBatchToken.md index 4120680c..c99d77e3 100644 --- a/docs-md/interfaces/NftMetadataBatchToken.md +++ b/docs-md/interfaces/NftMetadataBatchToken.md @@ -23,7 +23,7 @@ The NFT contract address. Limited to ERC721 and ERC1155 tokens. #### Defined in -[src/types/nft-types.ts:422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L422) +[src/types/nft-types.ts:422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L422) ___ @@ -35,7 +35,7 @@ The id of the NFT. #### Defined in -[src/types/nft-types.ts:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L425) +[src/types/nft-types.ts:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L425) ___ @@ -47,4 +47,4 @@ Optional field to specify the type of token to speed up the query. #### Defined in -[src/types/nft-types.ts:428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L428) +[src/types/nft-types.ts:428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L428) diff --git a/docs-md/interfaces/NftMetadataUpdateWebhook.md b/docs-md/interfaces/NftMetadataUpdateWebhook.md index c1b06e3e..ca50a113 100644 --- a/docs-md/interfaces/NftMetadataUpdateWebhook.md +++ b/docs-md/interfaces/NftMetadataUpdateWebhook.md @@ -41,7 +41,7 @@ The app id of the app used for the webhook. This field is only present on #### Defined in -[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1037) +[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1037) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1018) +[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1018) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1026) +[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1026) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1020) +[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1020) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1030) +[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1030) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1028) +[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1028) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:1098](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1098) +[src/types/types.ts:1098](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1098) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1024) +[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1024) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1032) +[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1032) diff --git a/docs-md/interfaces/NftMint.md b/docs-md/interfaces/NftMint.md index 82702172..51a8cbac 100644 --- a/docs-md/interfaces/NftMint.md +++ b/docs-md/interfaces/NftMint.md @@ -23,7 +23,7 @@ The block number that the NFT was minted on. #### Defined in -[src/types/nft-types.ts:825](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L825) +[src/types/nft-types.ts:825](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L825) ___ @@ -35,7 +35,7 @@ The address that the NFT was minted to. #### Defined in -[src/types/nft-types.ts:823](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L823) +[src/types/nft-types.ts:823](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L823) ___ @@ -47,7 +47,7 @@ The timestamp the NFT was minted on. #### Defined in -[src/types/nft-types.ts:827](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L827) +[src/types/nft-types.ts:827](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L827) ___ @@ -59,4 +59,4 @@ The transaction hash of the transaction that minted the NFT. #### Defined in -[src/types/nft-types.ts:829](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L829) +[src/types/nft-types.ts:829](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L829) diff --git a/docs-md/interfaces/NftRawMetadata.md b/docs-md/interfaces/NftRawMetadata.md index a58cb76c..d1d04b8f 100644 --- a/docs-md/interfaces/NftRawMetadata.md +++ b/docs-md/interfaces/NftRawMetadata.md @@ -22,7 +22,7 @@ Error message if the raw metadata could not be fetched. #### Defined in -[src/types/nft-types.ts:1308](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1308) +[src/types/nft-types.ts:1308](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1308) ___ @@ -34,7 +34,7 @@ The raw metadata parsed from the raw token URI. #### Defined in -[src/types/nft-types.ts:1306](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1306) +[src/types/nft-types.ts:1306](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1306) ___ @@ -46,4 +46,4 @@ The raw token URI on the NFT contract. #### Defined in -[src/types/nft-types.ts:1304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1304) +[src/types/nft-types.ts:1304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1304) diff --git a/docs-md/interfaces/NftSale.md b/docs-md/interfaces/NftSale.md index 0a53388b..aef9e34f 100644 --- a/docs-md/interfaces/NftSale.md +++ b/docs-md/interfaces/NftSale.md @@ -34,7 +34,7 @@ The block number the NFT sale took place in. #### Defined in -[src/types/nft-types.ts:762](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L762) +[src/types/nft-types.ts:762](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L762) ___ @@ -46,7 +46,7 @@ The index of the token within the bundle of NFTs sold in the sale. #### Defined in -[src/types/nft-types.ts:768](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L768) +[src/types/nft-types.ts:768](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L768) ___ @@ -58,7 +58,7 @@ The address of the buyer in the NFT sale. #### Defined in -[src/types/nft-types.ts:744](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L744) +[src/types/nft-types.ts:744](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L744) ___ @@ -70,7 +70,7 @@ The NFT contract address. #### Defined in -[src/types/nft-types.ts:735](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L735) +[src/types/nft-types.ts:735](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L735) ___ @@ -82,7 +82,7 @@ The log number of the sale event emitted within the block. #### Defined in -[src/types/nft-types.ts:765](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L765) +[src/types/nft-types.ts:765](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L765) ___ @@ -94,7 +94,7 @@ The marketplace the sale took place on. #### Defined in -[src/types/nft-types.ts:729](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L729) +[src/types/nft-types.ts:729](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L729) ___ @@ -106,7 +106,7 @@ The marketplace address the sale was on. #### Defined in -[src/types/nft-types.ts:732](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L732) +[src/types/nft-types.ts:732](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L732) ___ @@ -118,7 +118,7 @@ The payment from buyer to the marketplace. #### Defined in -[src/types/nft-types.ts:756](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L756) +[src/types/nft-types.ts:756](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L756) ___ @@ -130,7 +130,7 @@ The number of tokens sold in the sale as a decimal integer string. #### Defined in -[src/types/nft-types.ts:741](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L741) +[src/types/nft-types.ts:741](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L741) ___ @@ -142,7 +142,7 @@ The payment from buyer to the royalty address of the NFT collection. #### Defined in -[src/types/nft-types.ts:759](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L759) +[src/types/nft-types.ts:759](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L759) ___ @@ -154,7 +154,7 @@ The address of the seller in the NFT sale. #### Defined in -[src/types/nft-types.ts:747](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L747) +[src/types/nft-types.ts:747](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L747) ___ @@ -166,7 +166,7 @@ The payment from buyer to the seller. #### Defined in -[src/types/nft-types.ts:753](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L753) +[src/types/nft-types.ts:753](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L753) ___ @@ -178,7 +178,7 @@ Whether the price taker in the trade was the buyer or the seller. #### Defined in -[src/types/nft-types.ts:750](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L750) +[src/types/nft-types.ts:750](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L750) ___ @@ -190,7 +190,7 @@ The decimal token ID of the NFT being sold. #### Defined in -[src/types/nft-types.ts:738](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L738) +[src/types/nft-types.ts:738](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L738) ___ @@ -202,4 +202,4 @@ The transactionHash of the NFT sale. #### Defined in -[src/types/nft-types.ts:771](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L771) +[src/types/nft-types.ts:771](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L771) diff --git a/docs-md/interfaces/NftSaleFeeData.md b/docs-md/interfaces/NftSaleFeeData.md index 78fd6af0..bd6ad2ad 100644 --- a/docs-md/interfaces/NftSaleFeeData.md +++ b/docs-md/interfaces/NftSaleFeeData.md @@ -23,7 +23,7 @@ The fee payment amount as a decimal integer string. #### Defined in -[src/types/nft-types.ts:791](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L791) +[src/types/nft-types.ts:791](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L791) ___ @@ -35,7 +35,7 @@ The number of decimals of the token used for the payment. #### Defined in -[src/types/nft-types.ts:799](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L799) +[src/types/nft-types.ts:799](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L799) ___ @@ -47,7 +47,7 @@ The symbol of the token used for the payment. #### Defined in -[src/types/nft-types.ts:796](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L796) +[src/types/nft-types.ts:796](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L796) ___ @@ -57,4 +57,4 @@ ___ #### Defined in -[src/types/nft-types.ts:793](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L793) +[src/types/nft-types.ts:793](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L793) diff --git a/docs-md/interfaces/NftSaleValidAt.md b/docs-md/interfaces/NftSaleValidAt.md index e6f066ad..b46e3301 100644 --- a/docs-md/interfaces/NftSaleValidAt.md +++ b/docs-md/interfaces/NftSaleValidAt.md @@ -22,7 +22,7 @@ The block hash. Used to detect reorgs. #### Defined in -[src/types/nft-types.ts:779](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L779) +[src/types/nft-types.ts:779](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L779) ___ @@ -34,7 +34,7 @@ The block number the sale information is valid at. #### Defined in -[src/types/nft-types.ts:777](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L777) +[src/types/nft-types.ts:777](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L777) ___ @@ -46,4 +46,4 @@ The timestamp for the block. #### Defined in -[src/types/nft-types.ts:781](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L781) +[src/types/nft-types.ts:781](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L781) diff --git a/docs-md/interfaces/NftWebhookParams.md b/docs-md/interfaces/NftWebhookParams.md index 37a06183..3d7f4999 100644 --- a/docs-md/interfaces/NftWebhookParams.md +++ b/docs-md/interfaces/NftWebhookParams.md @@ -22,7 +22,7 @@ Array of NFT filters the webhook should track. #### Defined in -[src/types/types.ts:1166](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1166) +[src/types/types.ts:1166](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1166) ___ @@ -35,4 +35,4 @@ created on network of the app provided in the api key config. #### Defined in -[src/types/types.ts:1171](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1171) +[src/types/types.ts:1171](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1171) diff --git a/docs-md/interfaces/OpenSeaCollectionMetadata.md b/docs-md/interfaces/OpenSeaCollectionMetadata.md index 002d1ff6..8d7929bb 100644 --- a/docs-md/interfaces/OpenSeaCollectionMetadata.md +++ b/docs-md/interfaces/OpenSeaCollectionMetadata.md @@ -31,7 +31,7 @@ The banner image URL determined by OpenSea. #### Defined in -[src/types/nft-types.ts:1135](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1135) +[src/types/nft-types.ts:1135](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1135) ___ @@ -43,7 +43,7 @@ The name of the collection on OpenSea. #### Defined in -[src/types/nft-types.ts:1122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1122) +[src/types/nft-types.ts:1122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1122) ___ @@ -55,7 +55,7 @@ The slug of the collection on OpenSea. #### Defined in -[src/types/nft-types.ts:1124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1124) +[src/types/nft-types.ts:1124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1124) ___ @@ -67,7 +67,7 @@ The description of the collection on OpenSea. #### Defined in -[src/types/nft-types.ts:1137](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1137) +[src/types/nft-types.ts:1137](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1137) ___ @@ -79,7 +79,7 @@ The Discord URL of the collection. #### Defined in -[src/types/nft-types.ts:1143](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1143) +[src/types/nft-types.ts:1143](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1143) ___ @@ -91,7 +91,7 @@ The homepage of the collection as determined by OpenSea. #### Defined in -[src/types/nft-types.ts:1139](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1139) +[src/types/nft-types.ts:1139](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1139) ___ @@ -103,7 +103,7 @@ The floor price of the collection. #### Defined in -[src/types/nft-types.ts:1120](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1120) +[src/types/nft-types.ts:1120](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1120) ___ @@ -117,7 +117,7 @@ The banner image URL determined by OpenSea. #### Defined in -[src/types/nft-types.ts:1133](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1133) +[src/types/nft-types.ts:1133](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1133) ___ @@ -129,7 +129,7 @@ The image URL determined by OpenSea. #### Defined in -[src/types/nft-types.ts:1128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1128) +[src/types/nft-types.ts:1128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1128) ___ @@ -141,7 +141,7 @@ Timestamp of when the OpenSea metadata was last ingested by Alchemy. #### Defined in -[src/types/nft-types.ts:1145](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1145) +[src/types/nft-types.ts:1145](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1145) ___ @@ -153,7 +153,7 @@ The approval status of the collection on OpenSea. #### Defined in -[src/types/nft-types.ts:1126](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1126) +[src/types/nft-types.ts:1126](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1126) ___ @@ -165,4 +165,4 @@ The Twitter handle of the collection. #### Defined in -[src/types/nft-types.ts:1141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1141) +[src/types/nft-types.ts:1141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1141) diff --git a/docs-md/interfaces/OwnedBaseNft.md b/docs-md/interfaces/OwnedBaseNft.md index 335c470b..406a5155 100644 --- a/docs-md/interfaces/OwnedBaseNft.md +++ b/docs-md/interfaces/OwnedBaseNft.md @@ -28,7 +28,7 @@ The token balance of the NFT. #### Defined in -[src/types/nft-types.ts:294](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L294) +[src/types/nft-types.ts:294](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L294) ___ @@ -44,7 +44,7 @@ The contract address of the NFT. #### Defined in -[src/types/nft-types.ts:1240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1240) +[src/types/nft-types.ts:1240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1240) ___ @@ -60,4 +60,4 @@ The NFT token ID as an integer string. #### Defined in -[src/types/nft-types.ts:1242](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1242) +[src/types/nft-types.ts:1242](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1242) diff --git a/docs-md/interfaces/OwnedBaseNftsResponse.md b/docs-md/interfaces/OwnedBaseNftsResponse.md index 69cea18a..6ff04dc2 100644 --- a/docs-md/interfaces/OwnedBaseNftsResponse.md +++ b/docs-md/interfaces/OwnedBaseNftsResponse.md @@ -26,7 +26,7 @@ The NFTs owned by the provided address. #### Defined in -[src/types/nft-types.ts:260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L260) +[src/types/nft-types.ts:260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L260) ___ @@ -39,7 +39,7 @@ NFTs. If there is no page key, then there are no more NFTs to fetch. #### Defined in -[src/types/nft-types.ts:266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L266) +[src/types/nft-types.ts:266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L266) ___ @@ -51,7 +51,7 @@ The total count of NFTs owned by the provided address. #### Defined in -[src/types/nft-types.ts:269](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L269) +[src/types/nft-types.ts:269](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L269) ___ @@ -63,4 +63,4 @@ Block Information of the block as of which the corresponding data is valid #### Defined in -[src/types/nft-types.ts:274](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L274) +[src/types/nft-types.ts:274](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L274) diff --git a/docs-md/interfaces/OwnedNft.md b/docs-md/interfaces/OwnedNft.md index 1db212a8..f201c48c 100644 --- a/docs-md/interfaces/OwnedNft.md +++ b/docs-md/interfaces/OwnedNft.md @@ -44,7 +44,7 @@ request. #### Defined in -[src/types/nft-types.ts:1278](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1278) +[src/types/nft-types.ts:1278](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1278) ___ @@ -56,7 +56,7 @@ The token balance of the NFT. #### Defined in -[src/types/nft-types.ts:284](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L284) +[src/types/nft-types.ts:284](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L284) ___ @@ -72,7 +72,7 @@ Collection metadata for the NFT, if available. #### Defined in -[src/types/nft-types.ts:1280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1280) +[src/types/nft-types.ts:1280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1280) ___ @@ -88,7 +88,7 @@ The NFT's underlying contract and relevant contract metadata. #### Defined in -[src/types/nft-types.ts:1256](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1256) +[src/types/nft-types.ts:1256](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1256) ___ @@ -104,7 +104,7 @@ The NFT description. #### Defined in -[src/types/nft-types.ts:1264](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1264) +[src/types/nft-types.ts:1264](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1264) ___ @@ -120,7 +120,7 @@ Media URLs and information for the NFT #### Defined in -[src/types/nft-types.ts:1266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1266) +[src/types/nft-types.ts:1266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1266) ___ @@ -136,7 +136,7 @@ Mint information for the NFT. #### Defined in -[src/types/nft-types.ts:1282](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1282) +[src/types/nft-types.ts:1282](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1282) ___ @@ -152,7 +152,7 @@ The NFT name. #### Defined in -[src/types/nft-types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1262) +[src/types/nft-types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1262) ___ @@ -168,7 +168,7 @@ The raw metadata for the NFT based on the metadata URI on the NFT contract. #### Defined in -[src/types/nft-types.ts:1268](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1268) +[src/types/nft-types.ts:1268](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1268) ___ @@ -184,7 +184,7 @@ When the NFT was last updated in the blockchain. Represented in ISO-8601 format. #### Defined in -[src/types/nft-types.ts:1272](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1272) +[src/types/nft-types.ts:1272](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1272) ___ @@ -200,7 +200,7 @@ The NFT token ID as an integer string. #### Defined in -[src/types/nft-types.ts:1258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1258) +[src/types/nft-types.ts:1258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1258) ___ @@ -216,7 +216,7 @@ The type of NFT. #### Defined in -[src/types/nft-types.ts:1260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1260) +[src/types/nft-types.ts:1260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1260) ___ @@ -232,4 +232,4 @@ URIs for accessing the NFT's metadata blob. #### Defined in -[src/types/nft-types.ts:1270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1270) +[src/types/nft-types.ts:1270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1270) diff --git a/docs-md/interfaces/OwnedNftsResponse.md b/docs-md/interfaces/OwnedNftsResponse.md index b7d4a913..9c701fff 100644 --- a/docs-md/interfaces/OwnedNftsResponse.md +++ b/docs-md/interfaces/OwnedNftsResponse.md @@ -26,7 +26,7 @@ The NFTs owned by the provided address. #### Defined in -[src/types/nft-types.ts:233](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L233) +[src/types/nft-types.ts:233](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L233) ___ @@ -39,7 +39,7 @@ NFTs. If there is no page key, then there are no more NFTs to fetch. #### Defined in -[src/types/nft-types.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L239) +[src/types/nft-types.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L239) ___ @@ -51,7 +51,7 @@ The total count of NFTs owned by the provided address. #### Defined in -[src/types/nft-types.ts:242](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L242) +[src/types/nft-types.ts:242](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L242) ___ @@ -63,4 +63,4 @@ Block Information of the block as of which the corresponding data is valid #### Defined in -[src/types/nft-types.ts:247](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L247) +[src/types/nft-types.ts:247](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L247) diff --git a/docs-md/interfaces/OwnedNftsValidAt.md b/docs-md/interfaces/OwnedNftsValidAt.md index 26197dd9..d0a8e605 100644 --- a/docs-md/interfaces/OwnedNftsValidAt.md +++ b/docs-md/interfaces/OwnedNftsValidAt.md @@ -22,7 +22,7 @@ The block hash. Used to detect reorgs. #### Defined in -[src/types/nft-types.ts:302](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L302) +[src/types/nft-types.ts:302](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L302) ___ @@ -34,7 +34,7 @@ The block number the sale information is valid at. #### Defined in -[src/types/nft-types.ts:300](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L300) +[src/types/nft-types.ts:300](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L300) ___ @@ -46,4 +46,4 @@ The timestamp for the block. #### Defined in -[src/types/nft-types.ts:304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L304) +[src/types/nft-types.ts:304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L304) diff --git a/docs-md/interfaces/OwnedToken.md b/docs-md/interfaces/OwnedToken.md index 955424bd..468a3973 100644 --- a/docs-md/interfaces/OwnedToken.md +++ b/docs-md/interfaces/OwnedToken.md @@ -29,7 +29,7 @@ is undefined. #### Defined in -[src/types/types.ts:216](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L216) +[src/types/types.ts:216](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L216) ___ @@ -41,7 +41,7 @@ The contract address of the token. #### Defined in -[src/types/types.ts:205](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L205) +[src/types/types.ts:205](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L205) ___ @@ -54,7 +54,7 @@ contract and not available from other sources. #### Defined in -[src/types/types.ts:232](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L232) +[src/types/types.ts:232](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L232) ___ @@ -67,7 +67,7 @@ the other fields will be defined. #### Defined in -[src/types/types.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L239) +[src/types/types.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L239) ___ @@ -79,7 +79,7 @@ URL link to the token's logo. Is undefined if the logo is not available. #### Defined in -[src/types/types.ts:234](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L234) +[src/types/types.ts:234](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L234) ___ @@ -92,7 +92,7 @@ not available from other sources. #### Defined in -[src/types/types.ts:222](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L222) +[src/types/types.ts:222](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L222) ___ @@ -105,7 +105,7 @@ if the [error](OwnedToken.md#error) field is present. #### Defined in -[src/types/types.ts:210](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L210) +[src/types/types.ts:210](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L210) ___ @@ -118,4 +118,4 @@ and not available from other sources. #### Defined in -[src/types/types.ts:227](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L227) +[src/types/types.ts:227](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L227) diff --git a/docs-md/interfaces/RawContract.md b/docs-md/interfaces/RawContract.md index f7209246..330dcc60 100644 --- a/docs-md/interfaces/RawContract.md +++ b/docs-md/interfaces/RawContract.md @@ -23,7 +23,7 @@ The contract address. `null` if it was an internal or external transfer. #### Defined in -[src/types/nft-types.ts:938](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L938) +[src/types/nft-types.ts:938](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L938) ___ @@ -36,7 +36,7 @@ is not in the contract and not available from other sources. #### Defined in -[src/types/nft-types.ts:944](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L944) +[src/types/nft-types.ts:944](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L944) ___ @@ -49,4 +49,4 @@ ERC721 or ERC1155 token. #### Defined in -[src/types/nft-types.ts:935](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L935) +[src/types/nft-types.ts:935](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L935) diff --git a/docs-md/interfaces/RefreshContractResult.md b/docs-md/interfaces/RefreshContractResult.md index 1e634263..1c6f364e 100644 --- a/docs-md/interfaces/RefreshContractResult.md +++ b/docs-md/interfaces/RefreshContractResult.md @@ -22,7 +22,7 @@ The NFT contract address that was passed in to be refreshed. #### Defined in -[src/types/types.ts:525](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L525) +[src/types/types.ts:525](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L525) ___ @@ -35,7 +35,7 @@ Field can be null if the refresh has not occurred. #### Defined in -[src/types/types.ts:534](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L534) +[src/types/types.ts:534](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L534) ___ @@ -47,4 +47,4 @@ The current state of the refresh request. #### Defined in -[src/types/types.ts:528](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L528) +[src/types/types.ts:528](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L528) diff --git a/docs-md/interfaces/SearchContractMetadataResponse.md b/docs-md/interfaces/SearchContractMetadataResponse.md index be6afb20..eb85b60a 100644 --- a/docs-md/interfaces/SearchContractMetadataResponse.md +++ b/docs-md/interfaces/SearchContractMetadataResponse.md @@ -16,4 +16,4 @@ #### Defined in -[src/types/nft-types.ts:844](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L844) +[src/types/nft-types.ts:844](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L844) diff --git a/docs-md/interfaces/SendPrivateTransactionOptions.md b/docs-md/interfaces/SendPrivateTransactionOptions.md index 44de8bc0..b40f6ccc 100644 --- a/docs-md/interfaces/SendPrivateTransactionOptions.md +++ b/docs-md/interfaces/SendPrivateTransactionOptions.md @@ -25,4 +25,4 @@ more details. #### Defined in -[src/types/types.ts:732](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L732) +[src/types/types.ts:732](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L732) diff --git a/docs-md/interfaces/SimulateAssetChangesChange.md b/docs-md/interfaces/SimulateAssetChangesChange.md index cb359dc6..8195fa51 100644 --- a/docs-md/interfaces/SimulateAssetChangesChange.md +++ b/docs-md/interfaces/SimulateAssetChangesChange.md @@ -35,7 +35,7 @@ changes for NATIVE and ERC20 assets, or ERC721/ERC1155 disapprove changes #### Defined in -[src/types/types.ts:818](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L818) +[src/types/types.ts:818](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L818) ___ @@ -47,7 +47,7 @@ The type of asset from the transaction. #### Defined in -[src/types/types.ts:794](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L794) +[src/types/types.ts:794](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L794) ___ @@ -59,7 +59,7 @@ The type of change from the transaction. #### Defined in -[src/types/types.ts:797](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L797) +[src/types/types.ts:797](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L797) ___ @@ -72,7 +72,7 @@ ERC1155, NFT and SPECIAL_NFT transactions. #### Defined in -[src/types/types.ts:837](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L837) +[src/types/types.ts:837](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L837) ___ @@ -86,7 +86,7 @@ available from other sources. #### Defined in -[src/types/types.ts:831](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L831) +[src/types/types.ts:831](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L831) ___ @@ -98,7 +98,7 @@ The from address. #### Defined in -[src/types/types.ts:800](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L800) +[src/types/types.ts:800](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L800) ___ @@ -110,7 +110,7 @@ URL for the logo of the asset, if available. Only applicable to ERC20 transactio #### Defined in -[src/types/types.ts:842](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L842) +[src/types/types.ts:842](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L842) ___ @@ -122,7 +122,7 @@ The name of the asset transferred, if available. #### Defined in -[src/types/types.ts:821](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L821) +[src/types/types.ts:821](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L821) ___ @@ -136,7 +136,7 @@ NATIVE and ERC20 assets, or ERC721/ERC1155 disapprove changes (field set to #### Defined in -[src/types/types.ts:810](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L810) +[src/types/types.ts:810](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L810) ___ @@ -148,7 +148,7 @@ The symbol of the asset transferred if available. #### Defined in -[src/types/types.ts:824](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L824) +[src/types/types.ts:824](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L824) ___ @@ -160,7 +160,7 @@ The to address. #### Defined in -[src/types/types.ts:803](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L803) +[src/types/types.ts:803](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L803) ___ @@ -173,4 +173,4 @@ ERC1155 and SPECIAL_NFT NFTs. #### Defined in -[src/types/types.ts:848](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L848) +[src/types/types.ts:848](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L848) diff --git a/docs-md/interfaces/SimulateAssetChangesError.md b/docs-md/interfaces/SimulateAssetChangesError.md index b8d5a739..92f21c36 100644 --- a/docs-md/interfaces/SimulateAssetChangesError.md +++ b/docs-md/interfaces/SimulateAssetChangesError.md @@ -27,4 +27,4 @@ The error message. #### Defined in -[src/types/types.ts:785](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L785) +[src/types/types.ts:785](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L785) diff --git a/docs-md/interfaces/SimulateAssetChangesResponse.md b/docs-md/interfaces/SimulateAssetChangesResponse.md index f319d803..202cbda6 100644 --- a/docs-md/interfaces/SimulateAssetChangesResponse.md +++ b/docs-md/interfaces/SimulateAssetChangesResponse.md @@ -22,7 +22,7 @@ An array of asset changes that resulted from the transaction. #### Defined in -[src/types/types.ts:856](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L856) +[src/types/types.ts:856](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L856) ___ @@ -34,7 +34,7 @@ Optional error field that is present if an error occurred. #### Defined in -[src/types/types.ts:863](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L863) +[src/types/types.ts:863](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L863) ___ @@ -47,4 +47,4 @@ field is undefined if an error occurred. #### Defined in -[src/types/types.ts:861](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L861) +[src/types/types.ts:861](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L861) diff --git a/docs-md/interfaces/SimulateExecutionResponse.md b/docs-md/interfaces/SimulateExecutionResponse.md index a188125e..8f238789 100644 --- a/docs-md/interfaces/SimulateExecutionResponse.md +++ b/docs-md/interfaces/SimulateExecutionResponse.md @@ -22,7 +22,7 @@ of the transaction along with the decoded calls if available. #### Defined in -[src/types/types.ts:958](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L958) +[src/types/types.ts:958](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L958) ___ @@ -35,4 +35,4 @@ available. #### Defined in -[src/types/types.ts:964](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L964) +[src/types/types.ts:964](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L964) diff --git a/docs-md/interfaces/SimulationCallTrace.md b/docs-md/interfaces/SimulationCallTrace.md index 66b5031a..fa3436a0 100644 --- a/docs-md/interfaces/SimulationCallTrace.md +++ b/docs-md/interfaces/SimulationCallTrace.md @@ -35,7 +35,7 @@ A decoded version of the call. Provided on a best-effort basis. #### Defined in -[src/types/types.ts:921](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L921) +[src/types/types.ts:921](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L921) ___ @@ -51,7 +51,7 @@ Omit.error #### Defined in -[src/types/types.ts:1436](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1436) +[src/types/types.ts:1436](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1436) ___ @@ -67,7 +67,7 @@ Omit.from #### Defined in -[src/types/types.ts:1422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1422) +[src/types/types.ts:1422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1422) ___ @@ -83,7 +83,7 @@ Omit.gas #### Defined in -[src/types/types.ts:1428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1428) +[src/types/types.ts:1428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1428) ___ @@ -99,7 +99,7 @@ Omit.gasUsed #### Defined in -[src/types/types.ts:1430](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1430) +[src/types/types.ts:1430](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1430) ___ @@ -115,7 +115,7 @@ Omit.input #### Defined in -[src/types/types.ts:1432](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1432) +[src/types/types.ts:1432](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1432) ___ @@ -131,7 +131,7 @@ Omit.output #### Defined in -[src/types/types.ts:1434](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1434) +[src/types/types.ts:1434](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1434) ___ @@ -147,7 +147,7 @@ Omit.to #### Defined in -[src/types/types.ts:1424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1424) +[src/types/types.ts:1424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1424) ___ @@ -163,7 +163,7 @@ Omit.type #### Defined in -[src/types/types.ts:919](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L919) +[src/types/types.ts:919](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L919) ___ @@ -179,4 +179,4 @@ Omit.value #### Defined in -[src/types/types.ts:1426](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1426) +[src/types/types.ts:1426](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1426) diff --git a/docs-md/interfaces/SimulationDebugLog.md b/docs-md/interfaces/SimulationDebugLog.md index 4adbf00e..88cb8c8c 100644 --- a/docs-md/interfaces/SimulationDebugLog.md +++ b/docs-md/interfaces/SimulationDebugLog.md @@ -23,7 +23,7 @@ The address of the contract that generated the log. #### Defined in -[src/types/types.ts:945](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L945) +[src/types/types.ts:945](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L945) ___ @@ -35,7 +35,7 @@ The data included the log. #### Defined in -[src/types/types.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L947) +[src/types/types.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L947) ___ @@ -47,7 +47,7 @@ A decoded version of the log. Provided on a best-effort basis. #### Defined in -[src/types/types.ts:949](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L949) +[src/types/types.ts:949](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L949) ___ @@ -59,4 +59,4 @@ An array of topics in the log. #### Defined in -[src/types/types.ts:943](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L943) +[src/types/types.ts:943](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L943) diff --git a/docs-md/interfaces/TokenBalanceFailure.md b/docs-md/interfaces/TokenBalanceFailure.md index dfe74e19..a35c33a3 100644 --- a/docs-md/interfaces/TokenBalanceFailure.md +++ b/docs-md/interfaces/TokenBalanceFailure.md @@ -18,7 +18,7 @@ #### Defined in -[src/types/types.ts:169](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L169) +[src/types/types.ts:169](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L169) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[src/types/types.ts:171](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L171) +[src/types/types.ts:171](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L171) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[src/types/types.ts:170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L170) +[src/types/types.ts:170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L170) diff --git a/docs-md/interfaces/TokenBalanceSuccess.md b/docs-md/interfaces/TokenBalanceSuccess.md index b0aeb8b7..b4e63684 100644 --- a/docs-md/interfaces/TokenBalanceSuccess.md +++ b/docs-md/interfaces/TokenBalanceSuccess.md @@ -18,7 +18,7 @@ #### Defined in -[src/types/types.ts:162](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L162) +[src/types/types.ts:162](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L162) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[src/types/types.ts:164](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L164) +[src/types/types.ts:164](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L164) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[src/types/types.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L163) +[src/types/types.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L163) diff --git a/docs-md/interfaces/TokenBalancesOptionsDefaultTokens.md b/docs-md/interfaces/TokenBalancesOptionsDefaultTokens.md index bb4d2024..198e9d44 100644 --- a/docs-md/interfaces/TokenBalancesOptionsDefaultTokens.md +++ b/docs-md/interfaces/TokenBalancesOptionsDefaultTokens.md @@ -21,4 +21,4 @@ The top 100 token type. #### Defined in -[src/types/types.ts:136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L136) +[src/types/types.ts:136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L136) diff --git a/docs-md/interfaces/TokenBalancesOptionsErc20.md b/docs-md/interfaces/TokenBalancesOptionsErc20.md index 70ac3be1..9d40916e 100644 --- a/docs-md/interfaces/TokenBalancesOptionsErc20.md +++ b/docs-md/interfaces/TokenBalancesOptionsErc20.md @@ -22,7 +22,7 @@ Optional page key for pagination (only applicable to TokenBalanceType.ERC20) #### Defined in -[src/types/types.ts:127](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L127) +[src/types/types.ts:127](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L127) ___ @@ -34,4 +34,4 @@ The ERC-20 token type. #### Defined in -[src/types/types.ts:124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L124) +[src/types/types.ts:124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L124) diff --git a/docs-md/interfaces/TokenBalancesResponse.md b/docs-md/interfaces/TokenBalancesResponse.md index 8ec5e61e..14ada1af 100644 --- a/docs-md/interfaces/TokenBalancesResponse.md +++ b/docs-md/interfaces/TokenBalancesResponse.md @@ -23,7 +23,7 @@ #### Defined in -[src/types/types.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L153) +[src/types/types.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L153) ___ @@ -33,4 +33,4 @@ ___ #### Defined in -[src/types/types.ts:154](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L154) +[src/types/types.ts:154](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L154) diff --git a/docs-md/interfaces/TokenBalancesResponseErc20.md b/docs-md/interfaces/TokenBalancesResponseErc20.md index ff4dfa41..de7b5833 100644 --- a/docs-md/interfaces/TokenBalancesResponseErc20.md +++ b/docs-md/interfaces/TokenBalancesResponseErc20.md @@ -31,7 +31,7 @@ used. A page key may be returned if the provided address has many transfers. #### Defined in -[src/types/types.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L153) +[src/types/types.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L153) ___ @@ -44,7 +44,7 @@ of token balances. #### Defined in -[src/types/types.ts:148](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L148) +[src/types/types.ts:148](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L148) ___ @@ -58,4 +58,4 @@ ___ #### Defined in -[src/types/types.ts:154](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L154) +[src/types/types.ts:154](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L154) diff --git a/docs-md/interfaces/TokenMetadataResponse.md b/docs-md/interfaces/TokenMetadataResponse.md index 7091cd37..01b5737b 100644 --- a/docs-md/interfaces/TokenMetadataResponse.md +++ b/docs-md/interfaces/TokenMetadataResponse.md @@ -24,7 +24,7 @@ contract and not available from other sources. #### Defined in -[src/types/types.ts:264](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L264) +[src/types/types.ts:264](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L264) ___ @@ -36,7 +36,7 @@ URL link to the token's logo. Is `null` if the logo is not available. #### Defined in -[src/types/types.ts:267](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L267) +[src/types/types.ts:267](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L267) ___ @@ -49,7 +49,7 @@ not available from other sources. #### Defined in -[src/types/types.ts:252](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L252) +[src/types/types.ts:252](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L252) ___ @@ -62,4 +62,4 @@ and not available from other sources. #### Defined in -[src/types/types.ts:258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L258) +[src/types/types.ts:258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L258) diff --git a/docs-md/interfaces/TransactionReceiptsBlockHash.md b/docs-md/interfaces/TransactionReceiptsBlockHash.md index b9e99cf5..3a4932fd 100644 --- a/docs-md/interfaces/TransactionReceiptsBlockHash.md +++ b/docs-md/interfaces/TransactionReceiptsBlockHash.md @@ -20,4 +20,4 @@ The block hash to get transaction receipts for. #### Defined in -[src/types/types.ts:554](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L554) +[src/types/types.ts:554](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L554) diff --git a/docs-md/interfaces/TransactionReceiptsBlockNumber.md b/docs-md/interfaces/TransactionReceiptsBlockNumber.md index dd36729a..87eb6906 100644 --- a/docs-md/interfaces/TransactionReceiptsBlockNumber.md +++ b/docs-md/interfaces/TransactionReceiptsBlockNumber.md @@ -20,4 +20,4 @@ The block number to get transaction receipts for. #### Defined in -[src/types/types.ts:544](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L544) +[src/types/types.ts:544](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L544) diff --git a/docs-md/interfaces/TransactionReceiptsResponse.md b/docs-md/interfaces/TransactionReceiptsResponse.md index fb4fc7d2..9d5331cb 100644 --- a/docs-md/interfaces/TransactionReceiptsResponse.md +++ b/docs-md/interfaces/TransactionReceiptsResponse.md @@ -20,4 +20,4 @@ A list of transaction receipts for the queried block. #### Defined in -[src/types/types.ts:573](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L573) +[src/types/types.ts:573](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L573) diff --git a/docs-md/interfaces/TransactionWebhookParams.md b/docs-md/interfaces/TransactionWebhookParams.md index 9d273663..474ba6a0 100644 --- a/docs-md/interfaces/TransactionWebhookParams.md +++ b/docs-md/interfaces/TransactionWebhookParams.md @@ -28,4 +28,4 @@ The app id of the project to create the webhook on. #### Defined in -[src/types/types.ts:1157](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1157) +[src/types/types.ts:1157](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1157) diff --git a/docs-md/interfaces/TransferredNft.md b/docs-md/interfaces/TransferredNft.md index 51bc10c8..338be885 100644 --- a/docs-md/interfaces/TransferredNft.md +++ b/docs-md/interfaces/TransferredNft.md @@ -47,7 +47,7 @@ request. #### Defined in -[src/types/nft-types.ts:1278](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1278) +[src/types/nft-types.ts:1278](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1278) ___ @@ -59,7 +59,7 @@ The block number as a hex string of when the transfer or mint occurred. #### Defined in -[src/types/nft-types.ts:626](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L626) +[src/types/nft-types.ts:626](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L626) ___ @@ -75,7 +75,7 @@ Collection metadata for the NFT, if available. #### Defined in -[src/types/nft-types.ts:1280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1280) +[src/types/nft-types.ts:1280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1280) ___ @@ -91,7 +91,7 @@ The NFT's underlying contract and relevant contract metadata. #### Defined in -[src/types/nft-types.ts:1256](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1256) +[src/types/nft-types.ts:1256](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1256) ___ @@ -107,7 +107,7 @@ The NFT description. #### Defined in -[src/types/nft-types.ts:1264](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1264) +[src/types/nft-types.ts:1264](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1264) ___ @@ -120,7 +120,7 @@ The address the NFT was from. For minted NFTs, this field is the set to #### Defined in -[src/types/nft-types.ts:620](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L620) +[src/types/nft-types.ts:620](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L620) ___ @@ -136,7 +136,7 @@ Media URLs and information for the NFT #### Defined in -[src/types/nft-types.ts:1266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1266) +[src/types/nft-types.ts:1266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1266) ___ @@ -152,7 +152,7 @@ Mint information for the NFT. #### Defined in -[src/types/nft-types.ts:1282](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1282) +[src/types/nft-types.ts:1282](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1282) ___ @@ -168,7 +168,7 @@ The NFT name. #### Defined in -[src/types/nft-types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1262) +[src/types/nft-types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1262) ___ @@ -184,7 +184,7 @@ The raw metadata for the NFT based on the metadata URI on the NFT contract. #### Defined in -[src/types/nft-types.ts:1268](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1268) +[src/types/nft-types.ts:1268](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1268) ___ @@ -200,7 +200,7 @@ When the NFT was last updated in the blockchain. Represented in ISO-8601 format. #### Defined in -[src/types/nft-types.ts:1272](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1272) +[src/types/nft-types.ts:1272](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1272) ___ @@ -212,7 +212,7 @@ The address the NFT was sent or minted to. #### Defined in -[src/types/nft-types.ts:622](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L622) +[src/types/nft-types.ts:622](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L622) ___ @@ -228,7 +228,7 @@ The NFT token ID as an integer string. #### Defined in -[src/types/nft-types.ts:1258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1258) +[src/types/nft-types.ts:1258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1258) ___ @@ -244,7 +244,7 @@ The type of NFT. #### Defined in -[src/types/nft-types.ts:1260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1260) +[src/types/nft-types.ts:1260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1260) ___ @@ -260,7 +260,7 @@ URIs for accessing the NFT's metadata blob. #### Defined in -[src/types/nft-types.ts:1270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L1270) +[src/types/nft-types.ts:1270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L1270) ___ @@ -272,4 +272,4 @@ The transaction hash where the transfer or mint occurred. #### Defined in -[src/types/nft-types.ts:624](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L624) +[src/types/nft-types.ts:624](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L624) diff --git a/docs-md/interfaces/TransfersNftResponse.md b/docs-md/interfaces/TransfersNftResponse.md index 230bcfda..cc0cbcdd 100644 --- a/docs-md/interfaces/TransfersNftResponse.md +++ b/docs-md/interfaces/TransfersNftResponse.md @@ -23,7 +23,7 @@ An array of NFTs. #### Defined in -[src/types/nft-types.ts:607](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L607) +[src/types/nft-types.ts:607](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L607) ___ @@ -35,4 +35,4 @@ Optional page key to use to fetch the next group of NFTs. #### Defined in -[src/types/nft-types.ts:609](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/nft-types.ts#L609) +[src/types/nft-types.ts:609](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/nft-types.ts#L609) diff --git a/docs-md/interfaces/Webhook.md b/docs-md/interfaces/Webhook.md index bf7e471a..8e0ac049 100644 --- a/docs-md/interfaces/Webhook.md +++ b/docs-md/interfaces/Webhook.md @@ -45,7 +45,7 @@ The app id of the app used for the webhook. This field is only present on #### Defined in -[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1037) +[src/types/types.ts:1037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1037) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1018) +[src/types/types.ts:1018](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1018) ___ @@ -69,7 +69,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1026) +[src/types/types.ts:1026](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1026) ___ @@ -81,7 +81,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1020) +[src/types/types.ts:1020](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1020) ___ @@ -93,7 +93,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1030) +[src/types/types.ts:1030](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1030) ___ @@ -105,7 +105,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1028) +[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1028) ___ @@ -117,7 +117,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:1022](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1022) +[src/types/types.ts:1022](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1022) ___ @@ -129,7 +129,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1024) +[src/types/types.ts:1024](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1024) ___ @@ -141,4 +141,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1032) +[src/types/types.ts:1032](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1032) diff --git a/docs-md/interfaces/WebhookAddressOverride.md b/docs-md/interfaces/WebhookAddressOverride.md index 8f3e481d..af744c6f 100644 --- a/docs-md/interfaces/WebhookAddressOverride.md +++ b/docs-md/interfaces/WebhookAddressOverride.md @@ -21,4 +21,4 @@ The new addresses to track. Existing addresses will be removed. #### Defined in -[src/types/types.ts:1271](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1271) +[src/types/types.ts:1271](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1271) diff --git a/docs-md/interfaces/WebhookAddressUpdate.md b/docs-md/interfaces/WebhookAddressUpdate.md index 2379c86e..590beb3a 100644 --- a/docs-md/interfaces/WebhookAddressUpdate.md +++ b/docs-md/interfaces/WebhookAddressUpdate.md @@ -22,7 +22,7 @@ The addresses to additionally track. #### Defined in -[src/types/types.ts:1260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1260) +[src/types/types.ts:1260](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1260) ___ @@ -34,4 +34,4 @@ Existing addresses to remove. #### Defined in -[src/types/types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1262) +[src/types/types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1262) diff --git a/docs-md/interfaces/WebhookNftFilterUpdate.md b/docs-md/interfaces/WebhookNftFilterUpdate.md index 860c90a7..e7bfa427 100644 --- a/docs-md/interfaces/WebhookNftFilterUpdate.md +++ b/docs-md/interfaces/WebhookNftFilterUpdate.md @@ -22,7 +22,7 @@ The filters to additionally track. #### Defined in -[src/types/types.ts:1238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1238) +[src/types/types.ts:1238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1238) ___ @@ -34,4 +34,4 @@ Existing filters to remove. #### Defined in -[src/types/types.ts:1240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1240) +[src/types/types.ts:1240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1240) diff --git a/docs-md/interfaces/WebhookNftMetadataFilterUpdate.md b/docs-md/interfaces/WebhookNftMetadataFilterUpdate.md index 5cf47998..a1ccb137 100644 --- a/docs-md/interfaces/WebhookNftMetadataFilterUpdate.md +++ b/docs-md/interfaces/WebhookNftMetadataFilterUpdate.md @@ -22,7 +22,7 @@ The filters to additionally track. #### Defined in -[src/types/types.ts:1249](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1249) +[src/types/types.ts:1249](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1249) ___ @@ -34,4 +34,4 @@ Existing filters to remove. #### Defined in -[src/types/types.ts:1251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1251) +[src/types/types.ts:1251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1251) diff --git a/docs-md/interfaces/WebhookStatusUpdate.md b/docs-md/interfaces/WebhookStatusUpdate.md index c93c0124..fe87ef7b 100644 --- a/docs-md/interfaces/WebhookStatusUpdate.md +++ b/docs-md/interfaces/WebhookStatusUpdate.md @@ -21,4 +21,4 @@ Whether the webhook is active. #### Defined in -[src/types/types.ts:1229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1229) +[src/types/types.ts:1229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1229) diff --git a/docs-md/modules.md b/docs-md/modules.md index 7b3ccce4..2ac3c485 100644 --- a/docs-md/modules.md +++ b/docs-md/modules.md @@ -229,7 +229,7 @@ Params object when calling [NotifyNamespace.updateWebhook](classes/NotifyNamespa #### Defined in -[src/types/types.ts:1300](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1300) +[src/types/types.ts:1300](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1300) ___ @@ -242,7 +242,7 @@ filters compatible with other ethers events. #### Defined in -[src/types/types.ts:718](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L718) +[src/types/types.ts:718](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L718) ___ @@ -255,7 +255,7 @@ also include Alchemy's Subscription API. #### Defined in -[src/types/types.ts:712](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L712) +[src/types/types.ts:712](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L712) ___ @@ -268,7 +268,7 @@ least one of the fields to be set. #### Defined in -[src/types/types.ts:701](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L701) +[src/types/types.ts:701](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L701) ___ @@ -291,7 +291,7 @@ methods in the [DebugNamespace](classes/DebugNamespace.md). #### Defined in -[src/types/types.ts:1361](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1361) +[src/types/types.ts:1361](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1361) ___ @@ -314,7 +314,7 @@ Params object when calling [NotifyNamespace.updateWebhook](classes/NotifyNamespa #### Defined in -[src/types/types.ts:1294](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1294) +[src/types/types.ts:1294](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1294) ___ @@ -328,7 +328,7 @@ The keys are the addresses of the accounts, mapped to its corresponding state. #### Defined in -[src/types/types.ts:1478](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1478) +[src/types/types.ts:1478](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1478) ___ @@ -350,7 +350,7 @@ The level of verbosity for the logger. #### Defined in -[src/util/logger.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/util/logger.ts#L22) +[src/util/logger.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/util/logger.ts#L22) ___ @@ -363,7 +363,7 @@ Params object when calling [NotifyNamespace.updateWebhook](classes/NotifyNamespa #### Defined in -[src/types/types.ts:1286](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1286) +[src/types/types.ts:1286](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1286) ___ @@ -376,7 +376,7 @@ Params object when calling [NotifyNamespace.updateWebhook](classes/NotifyNamespa #### Defined in -[src/types/types.ts:1278](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1278) +[src/types/types.ts:1278](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1278) ___ @@ -394,7 +394,7 @@ Requires an array with at least one value. #### Defined in -[src/types/types.ts:1504](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1504) +[src/types/types.ts:1504](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1504) ___ @@ -415,7 +415,7 @@ Implementation copied over from #### Defined in -[src/types/types.ts:1498](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L1498) +[src/types/types.ts:1498](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L1498) ___ @@ -425,7 +425,7 @@ ___ #### Defined in -[src/types/types.ts:158](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L158) +[src/types/types.ts:158](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L158) ___ @@ -437,7 +437,7 @@ The parameters to use with the [CoreNamespace.getTransactionReceipts](classes/Co #### Defined in -[src/types/types.ts:562](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/types/types.ts#L562) +[src/types/types.ts:562](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/types/types.ts#L562) ___ @@ -488,7 +488,7 @@ Converts a hex string to a decimal number. #### Defined in -[src/api/util.ts:9](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/util.ts#L9) +[src/api/util.ts:9](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/util.ts#L9) ___ @@ -510,7 +510,7 @@ Checks if a value is a hex string. #### Defined in -[src/api/util.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/util.ts#L29) +[src/api/util.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/util.ts#L29) ___ @@ -532,7 +532,7 @@ Configures the verbosity of logging. The default log level is `info`. #### Defined in -[src/util/logger.ts:56](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/util/logger.ts#L56) +[src/util/logger.ts:56](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/util/logger.ts#L56) ___ @@ -554,4 +554,4 @@ Converts a number to a hex string. #### Defined in -[src/api/util.ts:19](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8c9409f/src/api/util.ts#L19) +[src/api/util.ts:19](https://github.com/alchemyplatform/alchemy-sdk-js/blob/89d639ce/src/api/util.ts#L19) diff --git a/docs/classes/Alchemy.html b/docs/classes/Alchemy.html index d0624a3c..cebb8374 100644 --- a/docs/classes/Alchemy.html +++ b/docs/classes/Alchemy.html @@ -3,23 +3,23 @@ APIs and separates functionality into different namespaces.

Each SDK instance is associated with a specific network and API key. To use a different network or API key, create a new instance of Alchemy.

-

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly config

config: AlchemyConfig
+

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly config

config: AlchemyConfig

Holds the setting information for the instance of the Alchemy SDK client and allows access to the underlying providers.

-

Readonly core

core: CoreNamespace
+

Readonly core

core: CoreNamespace

The core namespace contains the core eth json-rpc calls and Alchemy's Enhanced APIs.

-

Readonly debug

debug: DebugNamespace
+

Readonly debug

debug: DebugNamespace

The debug namespace contains methods for inspecting and debugging transactions.

-

Readonly nft

nft: NftNamespace
+

Readonly nft

nft: NftNamespace

The nft namespace contains methods for Alchemy's NFT API.

-

Readonly notify

notify: NotifyNamespace
+

Readonly notify

notify: NotifyNamespace

The notify namespace contains methods for creating and managing webhooks as part of the Notify API.

-

Readonly transact

transact: TransactNamespace
+

Readonly transact

transact: TransactNamespace

The transact namespace contains methods for sending transactions and checking on the state of submitted transasctions.

-

Readonly ws

ws: WebSocketNamespace
+

Readonly ws

ws: WebSocketNamespace

The ws namespace contains methods for using WebSockets and creating subscriptions.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/AlchemyConfig.html b/docs/classes/AlchemyConfig.html index 82edbf4e..18aab3b1 100644 --- a/docs/classes/AlchemyConfig.html +++ b/docs/classes/AlchemyConfig.html @@ -1,22 +1,22 @@ AlchemyConfig | alchemy-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlchemyConfig

This class holds the config information for the SDK client instance and exposes the underlying providers for more advanced use cases.

-

Hierarchy

  • AlchemyConfig

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly apiKey

apiKey: string
+

Hierarchy

  • AlchemyConfig

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly apiKey

apiKey: string

The Alchemy API key.

-

Optional Readonly authToken

authToken?: string
+

Optional Readonly authToken

authToken?: string

The optional Alchemy auth token to use when sending requests with the Notify API.

-

Readonly batchRequests

batchRequests: boolean
+

Readonly batchRequests

batchRequests: boolean

Setting to enable automatic batching on json-rpc requests. Defaults to false.

-

Readonly maxRetries

maxRetries: number
+

Readonly maxRetries

maxRetries: number

The maximum number of retries to perform.

-

Readonly network

network: Network
+

Readonly network

network: Network

The Network that this SDK is associated with.

-

Optional Readonly requestTimeout

requestTimeout?: number
+

Optional Readonly requestTimeout

requestTimeout?: number

The optional Request timeout provided in ms for NFT and NOTIFY API. Defaults to 0.

-

Optional Readonly url

url?: string
+

Optional Readonly url

url?: string

The optional hardcoded URL to send requests to instead of using the network and apiKey.

-

Methods

getProvider

Methods

getProvider

  • Returns an AlchemyProvider instance. Only one provider is created per Alchemy instance.

    The AlchemyProvider is a wrapper around ether's AlchemyProvider class and @@ -24,7 +24,7 @@

    Most common methods on the provider are available as top-level methods on the Alchemy instance, but the provider is exposed here to access other less-common methods.

    -

    Returns Promise<AlchemyProvider>

getWebSocketProvider

getWebSocketProvider

  • Returns an AlchemyWebsocketProvider instance. Only one provider is created per Alchemy instance.

    The AlchemyWebSocketProvider is a wrapper around ether's diff --git a/docs/classes/AlchemyProvider.html b/docs/classes/AlchemyProvider.html index f93e1766..37fe4db8 100644 --- a/docs/classes/AlchemyProvider.html +++ b/docs/classes/AlchemyProvider.html @@ -2,13 +2,13 @@

    SDK's custom implementation of ethers.js's 'AlchemyProvider'.

    Do not call this constructor directly. Instead, instantiate an instance of Alchemy and call {@link Alchemy.config.getProvider()}.

    -

Hierarchy

  • JsonRpcProvider
    • AlchemyProvider

Implements

  • CommunityResourcable

Index

Properties

Accessors

Methods

Properties

_bootstrapPoll

_bootstrapPoll: Timer

_emitted

_emitted: {}

Type declaration

  • [eventName: string]: number | "pending"

_eventLoopCache

_eventLoopCache: Record<string, Promise<any>>

_events

_events: Event[]

_fastBlockNumber

_fastBlockNumber: number

_fastBlockNumberPromise

_fastBlockNumberPromise: Promise<number>

_fastQueryDate

_fastQueryDate: number

_internalBlockNumber

_internalBlockNumber: Promise<{ blockNumber: number; reqTime: number; respTime: number }>

Readonly _isProvider

_isProvider: boolean

_lastBlockNumber

_lastBlockNumber: number

_maxFilterBlockRange

_maxFilterBlockRange: number

_maxInternalBlockNumber

_maxInternalBlockNumber: number

_network

_network: Network

_networkPromise

_networkPromise: Promise<Network>

_nextId

_nextId: number

_pendingFilter

_pendingFilter: Promise<number>

_poller

_poller: Timer

_pollingInterval

_pollingInterval: number

Readonly anyNetwork

anyNetwork: boolean

Readonly apiKey

apiKey: string

Readonly batchRequests

batchRequests: boolean

Readonly connection

connection: ConnectionInfo

disableCcipRead

disableCcipRead: boolean

formatter

formatter: Formatter

Readonly maxRetries

maxRetries: number

Accessors

_cache

  • get _cache(): Record<string, Promise<any>>

  • Returns Record<string, Promise<any>>

blockNumber

  • get blockNumber(): number

  • Returns number

network

  • get network(): Network

  • Returns Network

polling

  • get polling(): boolean
  • set polling(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

pollingInterval

  • get pollingInterval(): number
  • set pollingInterval(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

ready

  • get ready(): Promise<Network>

  • Returns Promise<Network>

Methods

_addEventListener

  • Parameters

    • eventName: EventType
    • listener: Listener
    • once: boolean

    Returns AlchemyProvider

_call

  • Parameters

    Returns Promise<string>

_getAddress

  • _getAddress(addressOrName: string | Promise<string>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>

    Returns Promise<string>

_getBlock

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>
    • Optional includeTransactions: boolean

    Returns Promise<Block | BlockWithTransactions>

_getBlockTag

  • Parameters

    Returns Promise<BlockTag>

_getFastBlockNumber

  • _getFastBlockNumber(): Promise<number>

  • Returns Promise<number>

_getFilter

  • _getFilter(filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>): Promise<Filter | FilterByBlockHash>

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Filter | FilterByBlockHash>

_getInternalBlockNumber

  • _getInternalBlockNumber(maxAge: number): Promise<number>

  • Parameters

    • maxAge: number

    Returns Promise<number>

_getResolver

  • _getResolver(name: string, operation?: string): Promise<string>

  • Parameters

    • name: string
    • Optional operation: string

    Returns Promise<string>

_getTransactionRequest

  • Parameters

    Returns Promise<Transaction>

_ready

  • _ready(): Promise<Network>

  • Returns Promise<Network>

_setFastBlockNumber

  • _setFastBlockNumber(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

_startEvent

  • _startEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

_startPending

  • _startPending(): void

_stopEvent

  • _stopEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

_uncachedDetectNetwork

  • _uncachedDetectNetwork(): Promise<Network>

  • Returns Promise<Network>

_waitForTransaction

  • _waitForTransaction(transactionHash: string, confirmations: number, timeout: number, replaceable: { data: string; from: string; nonce: number; startBlock: number; to: string; value: BigNumber }): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string
    • confirmations: number
    • timeout: number
    • replaceable: { data: string; from: string; nonce: number; startBlock: number; to: string; value: BigNumber }
      • data: string
      • from: string
      • nonce: number
      • startBlock: number
      • to: string
      • value: BigNumber

    Returns Promise<TransactionReceipt>

_wrapTransaction

  • Parameters

    • tx: Transaction
    • Optional hash: string
    • Optional startBlock: number

    Returns TransactionResponse

addListener

  • addListener(eventName: EventType, listener: Listener): Provider

  • Parameters

    Returns Provider

call

  • Parameters

    Returns Promise<string>

ccipReadFetch

  • ccipReadFetch(tx: Transaction, calldata: string, urls: string[]): Promise<null | string>

  • Parameters

    • tx: Transaction
    • calldata: string
    • urls: string[]

    Returns Promise<null | string>

detectNetwork

  • detectNetwork(): Promise<Network>

Hierarchy

  • JsonRpcProvider
    • AlchemyProvider

Implements

  • CommunityResourcable

Index

Properties

Accessors

Methods

Properties

_bootstrapPoll

_bootstrapPoll: Timer

_emitted

_emitted: {}

Type declaration

  • [eventName: string]: number | "pending"

_eventLoopCache

_eventLoopCache: Record<string, Promise<any>>

_events

_events: Event[]

_fastBlockNumber

_fastBlockNumber: number

_fastBlockNumberPromise

_fastBlockNumberPromise: Promise<number>

_fastQueryDate

_fastQueryDate: number

_internalBlockNumber

_internalBlockNumber: Promise<{ blockNumber: number; reqTime: number; respTime: number }>

Readonly _isProvider

_isProvider: boolean

_lastBlockNumber

_lastBlockNumber: number

_maxFilterBlockRange

_maxFilterBlockRange: number

_maxInternalBlockNumber

_maxInternalBlockNumber: number

_network

_network: Network

_networkPromise

_networkPromise: Promise<Network>

_nextId

_nextId: number

_pendingFilter

_pendingFilter: Promise<number>

_poller

_poller: Timer

_pollingInterval

_pollingInterval: number

Readonly anyNetwork

anyNetwork: boolean

Readonly apiKey

apiKey: string

Readonly batchRequests

batchRequests: boolean

Readonly connection

connection: ConnectionInfo

disableCcipRead

disableCcipRead: boolean

formatter

formatter: Formatter

Readonly maxRetries

maxRetries: number

Accessors

_cache

  • get _cache(): Record<string, Promise<any>>

  • Returns Record<string, Promise<any>>

blockNumber

  • get blockNumber(): number

  • Returns number

network

  • get network(): Network

  • Returns Network

polling

  • get polling(): boolean
  • set polling(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

pollingInterval

  • get pollingInterval(): number
  • set pollingInterval(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

ready

  • get ready(): Promise<Network>

  • Returns Promise<Network>

Methods

_addEventListener

  • Parameters

    • eventName: EventType
    • listener: Listener
    • once: boolean

    Returns AlchemyProvider

_call

  • Parameters

    Returns Promise<string>

_getAddress

  • _getAddress(addressOrName: string | Promise<string>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>

    Returns Promise<string>

_getBlock

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>
    • Optional includeTransactions: boolean

    Returns Promise<Block | BlockWithTransactions>

_getBlockTag

  • Parameters

    Returns Promise<BlockTag>

_getFastBlockNumber

  • _getFastBlockNumber(): Promise<number>

  • Returns Promise<number>

_getFilter

  • _getFilter(filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>): Promise<Filter | FilterByBlockHash>

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Filter | FilterByBlockHash>

_getInternalBlockNumber

  • _getInternalBlockNumber(maxAge: number): Promise<number>

  • Parameters

    • maxAge: number

    Returns Promise<number>

_getResolver

  • _getResolver(name: string, operation?: string): Promise<string>

  • Parameters

    • name: string
    • Optional operation: string

    Returns Promise<string>

_getTransactionRequest

  • Parameters

    Returns Promise<Transaction>

_ready

  • _ready(): Promise<Network>

  • Returns Promise<Network>

_setFastBlockNumber

  • _setFastBlockNumber(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

_startEvent

  • _startEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

_startPending

  • _startPending(): void

_stopEvent

  • _stopEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

_uncachedDetectNetwork

  • _uncachedDetectNetwork(): Promise<Network>

  • Returns Promise<Network>

_waitForTransaction

  • _waitForTransaction(transactionHash: string, confirmations: number, timeout: number, replaceable: { data: string; from: string; nonce: number; startBlock: number; to: string; value: BigNumber }): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string
    • confirmations: number
    • timeout: number
    • replaceable: { data: string; from: string; nonce: number; startBlock: number; to: string; value: BigNumber }
      • data: string
      • from: string
      • nonce: number
      • startBlock: number
      • to: string
      • value: BigNumber

    Returns Promise<TransactionReceipt>

_wrapTransaction

  • Parameters

    • tx: Transaction
    • Optional hash: string
    • Optional startBlock: number

    Returns TransactionResponse

addListener

  • addListener(eventName: EventType, listener: Listener): Provider

  • Parameters

    Returns Provider

call

  • Parameters

    Returns Promise<string>

ccipReadFetch

  • ccipReadFetch(tx: Transaction, calldata: string, urls: string[]): Promise<null | string>

  • Parameters

    • tx: Transaction
    • calldata: string
    • urls: string[]

    Returns Promise<null | string>

detectNetwork

  • detectNetwork(): Promise<Network>

  • Overrides the method in ethers.js's StaticJsonRpcProvider class. This method is called when calling methods on the parent class BaseProvider.

    -
    override

    Returns Promise<Network>

emit

  • emit(eventName: EventType, ...args: any[]): boolean

  • Parameters

    Returns boolean

estimateGas

  • Parameters

    Returns Promise<BigNumber>

getAvatar

  • getAvatar(nameOrAddress: string): Promise<null | string>

  • Parameters

    • nameOrAddress: string

    Returns Promise<null | string>

getBalance

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BigNumber>

getBlock

  • Parameters

    Returns Promise<Block>

getBlockNumber

  • getBlockNumber(): Promise<number>

  • Returns Promise<number>

getBlockWithTransactions

  • Parameters

    Returns Promise<BlockWithTransactions>

getCode

  • getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<string>

getEtherPrice

  • getEtherPrice(): Promise<number>

  • Returns Promise<number>

getFeeData

  • Returns Promise<FeeData>

getGasPrice

  • Returns Promise<BigNumber>

getLogs

  • getLogs(filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>): Promise<Log[]>

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Log[]>

getNetwork

  • getNetwork(): Promise<Network>

  • Returns Promise<Network>

getResolver

  • getResolver(name: string): Promise<null | Resolver>

  • Parameters

    • name: string

    Returns Promise<null | Resolver>

getSigner

  • getSigner(addressOrIndex?: string | number): JsonRpcSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns JsonRpcSigner

getStorageAt

  • Parameters

    Returns Promise<string>

getTransaction

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionResponse>

getTransactionCount

  • getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<number>

getTransactionReceipt

  • getTransactionReceipt(transactionHash: string | Promise<string>): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionReceipt>

getUncheckedSigner

  • getUncheckedSigner(addressOrIndex?: string | number): UncheckedJsonRpcSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns UncheckedJsonRpcSigner

isCommunityResource

  • isCommunityResource(): boolean

emit

  • emit(eventName: EventType, ...args: any[]): boolean

  • Parameters

    Returns boolean

estimateGas

  • Parameters

    Returns Promise<BigNumber>

getAvatar

  • getAvatar(nameOrAddress: string): Promise<null | string>

  • Parameters

    • nameOrAddress: string

    Returns Promise<null | string>

getBalance

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BigNumber>

getBlock

  • Parameters

    Returns Promise<Block>

getBlockNumber

  • getBlockNumber(): Promise<number>

  • Returns Promise<number>

getBlockWithTransactions

  • Parameters

    Returns Promise<BlockWithTransactions>

getCode

  • getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<string>

getEtherPrice

  • getEtherPrice(): Promise<number>

  • Returns Promise<number>

getFeeData

  • Returns Promise<FeeData>

getGasPrice

  • Returns Promise<BigNumber>

getLogs

  • getLogs(filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>): Promise<Log[]>

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Log[]>

getNetwork

  • getNetwork(): Promise<Network>

  • Returns Promise<Network>

getResolver

  • getResolver(name: string): Promise<null | Resolver>

  • Parameters

    • name: string

    Returns Promise<null | Resolver>

getSigner

  • getSigner(addressOrIndex?: string | number): JsonRpcSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns JsonRpcSigner

getStorageAt

  • Parameters

    Returns Promise<string>

getTransaction

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionResponse>

getTransactionCount

  • getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<number>

getTransactionReceipt

  • getTransactionReceipt(transactionHash: string | Promise<string>): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionReceipt>

getUncheckedSigner

  • getUncheckedSigner(addressOrIndex?: string | number): UncheckedJsonRpcSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns UncheckedJsonRpcSigner

isCommunityResource

  • isCommunityResource(): boolean

  • Overrides the ether's isCommunityResource() method. Returns true if the current api key is the default key.

    -
    override

    Returns boolean

listAccounts

  • listAccounts(): Promise<string[]>

  • Returns Promise<string[]>

listenerCount

  • Parameters

    Returns number

listeners

  • Parameters

    Returns Listener[]

lookupAddress

  • lookupAddress(address: string | Promise<string>): Promise<null | string>

  • Parameters

    • address: string | Promise<string>

    Returns Promise<null | string>

Private modifyFormatter

  • modifyFormatter(): void

listAccounts

  • listAccounts(): Promise<string[]>

  • Returns Promise<string[]>

listenerCount

  • Parameters

    Returns number

listeners

  • Parameters

    Returns Listener[]

lookupAddress

  • lookupAddress(address: string | Promise<string>): Promise<null | string>

  • Parameters

    • address: string | Promise<string>

    Returns Promise<null | string>

Private modifyFormatter

  • modifyFormatter(): void

  • Overrides the base Formatter class inherited from ethers to support returning custom fields in Ethers response types.

    For context, ethers has a Formatter class that is used to format the @@ -16,7 +16,7 @@ Formatter class are removed from the returned response. By modifying the Formatter class in this method, we can add support for fields that are not defined in ethers.

    -

    Returns void

off

  • Parameters

    • eventName: EventType
    • Optional listener: Listener

    Returns AlchemyProvider

on

  • Parameters

    Returns AlchemyProvider

once

  • Parameters

    Returns AlchemyProvider

perform

  • perform(method: string, params: any): Promise<any>

  • Parameters

    • method: string
    • params: any

    Returns Promise<any>

poll

  • poll(): Promise<void>

  • Returns Promise<void>

prepareRequest

  • prepareRequest(method: string, params: any): [string, any[]]

  • Parameters

    • method: string
    • params: any

    Returns [string, any[]]

removeAllListeners

  • Parameters

    Returns AlchemyProvider

removeListener

  • removeListener(eventName: EventType, listener: Listener): Provider

  • Parameters

    Returns Provider

resetEventsBlock

  • resetEventsBlock(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

resolveName

  • resolveName(name: string | Promise<string>): Promise<null | string>

  • Parameters

    • name: string | Promise<string>

    Returns Promise<null | string>

send

  • send(method: string, params: any[]): Promise<any>

off

  • Parameters

    • eventName: EventType
    • Optional listener: Listener

    Returns AlchemyProvider

on

  • Parameters

    Returns AlchemyProvider

once

  • Parameters

    Returns AlchemyProvider

perform

  • perform(method: string, params: any): Promise<any>

  • Parameters

    • method: string
    • params: any

    Returns Promise<any>

poll

  • poll(): Promise<void>

  • Returns Promise<void>

prepareRequest

  • prepareRequest(method: string, params: any): [string, any[]]

  • Parameters

    • method: string
    • params: any

    Returns [string, any[]]

removeAllListeners

  • Parameters

    Returns AlchemyProvider

removeListener

  • removeListener(eventName: EventType, listener: Listener): Provider

  • Parameters

    Returns Provider

resetEventsBlock

  • resetEventsBlock(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

resolveName

  • resolveName(name: string | Promise<string>): Promise<null | string>

  • Parameters

    • name: string | Promise<string>

    Returns Promise<null | string>

send

  • send(method: string, params: any[]): Promise<any>

  • Overrides the base {@link JsonRpcProvider.send} method to implement custom logic for sending requests to Alchemy.

    override

    Parameters

    • method: string
      diff --git a/docs/classes/AlchemyWebSocketProvider.html b/docs/classes/AlchemyWebSocketProvider.html index 1f77af0c..316171c5 100644 --- a/docs/classes/AlchemyWebSocketProvider.html +++ b/docs/classes/AlchemyWebSocketProvider.html @@ -2,61 +2,61 @@

      SDK's custom implementation fo the ethers.js's 'AlchemyWebSocketProvider'.

      Do not call this constructor directly. Instead, instantiate an instance of Alchemy and call {@link Alchemy.config.getWebSocketProvider()}.

      -

Hierarchy

  • WebSocketProvider
    • AlchemyWebSocketProvider

Implements

  • CommunityResourcable

Index

Properties

Accessors

Methods

Properties

_bootstrapPoll

_bootstrapPoll: Timer

Readonly _detectNetwork

_detectNetwork: Promise<Network>

_emitted

_emitted: {}

Type declaration

  • [eventName: string]: number | "pending"

_eventLoopCache

_eventLoopCache: Record<string, Promise<any>>

_events

_events: EthersEvent[] = []

_fastBlockNumber

_fastBlockNumber: number

_fastBlockNumberPromise

_fastBlockNumberPromise: Promise<number>

_fastQueryDate

_fastQueryDate: number

_internalBlockNumber

_internalBlockNumber: Promise<{ blockNumber: number; reqTime: number; respTime: number }>

Readonly _isProvider

_isProvider: boolean

_lastBlockNumber

_lastBlockNumber: number

_maxFilterBlockRange

_maxFilterBlockRange: number

_maxInternalBlockNumber

_maxInternalBlockNumber: number

_network

_network: Network

_networkPromise

_networkPromise: Promise<Network>

_nextId

_nextId: number

_pendingFilter

_pendingFilter: Promise<number>

_poller

_poller: Timer

_pollingInterval

_pollingInterval: number

Readonly _requests

_requests: {}

Type declaration

  • [name: string]: InflightRequest

Readonly _subIds

_subIds: {}

Type declaration

  • [tag: string]: Promise<string>

Readonly _subs

_subs: {}

Type declaration

  • [name: string]: Subscription

Readonly _websocket

_websocket: any

_wsReady

_wsReady: boolean

Readonly anyNetwork

anyNetwork: boolean

Readonly apiKey

apiKey: string

Readonly connection

connection: ConnectionInfo

disableCcipRead

disableCcipRead: boolean

formatter

formatter: Formatter

Accessors

_cache

  • get _cache(): Record<string, Promise<any>>

  • Returns Record<string, Promise<any>>

blockNumber

  • get blockNumber(): number

  • Returns number

network

  • get network(): Network

  • Returns Network

polling

  • set polling(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

pollingInterval

  • get pollingInterval(): number
  • set pollingInterval(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

ready

  • get ready(): Promise<Network>

  • Returns Promise<Network>

websocket

  • get websocket(): WebSocketLike

  • Returns WebSocketLike

Methods

_call

  • Parameters

    Returns Promise<string>

_getAddress

  • _getAddress(addressOrName: string | Promise<string>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>

    Returns Promise<string>

_getBlock

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>
    • Optional includeTransactions: boolean

    Returns Promise<Block | BlockWithTransactions>

_getBlockTag

  • Parameters

    Returns Promise<BlockTag>

_getFastBlockNumber

  • _getFastBlockNumber(): Promise<number>

  • Returns Promise<number>

_getFilter

  • _getFilter(filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>): Promise<Filter | FilterByBlockHash>

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Filter | FilterByBlockHash>

_getInternalBlockNumber

  • _getInternalBlockNumber(maxAge: number): Promise<number>

  • Parameters

    • maxAge: number

    Returns Promise<number>

_getResolver

  • _getResolver(name: string, operation?: string): Promise<string>

  • Parameters

    • name: string
    • Optional operation: string

    Returns Promise<string>

_getTransactionRequest

  • Parameters

    Returns Promise<Transaction>

Private _listenerCount

Hierarchy

  • WebSocketProvider
    • AlchemyWebSocketProvider

Implements

  • CommunityResourcable

Index

Properties

Accessors

Methods

Properties

_bootstrapPoll

_bootstrapPoll: Timer

Readonly _detectNetwork

_detectNetwork: Promise<Network>

_emitted

_emitted: {}

Type declaration

  • [eventName: string]: number | "pending"

_eventLoopCache

_eventLoopCache: Record<string, Promise<any>>

_events

_events: EthersEvent[] = []

_fastBlockNumber

_fastBlockNumber: number

_fastBlockNumberPromise

_fastBlockNumberPromise: Promise<number>

_fastQueryDate

_fastQueryDate: number

_internalBlockNumber

_internalBlockNumber: Promise<{ blockNumber: number; reqTime: number; respTime: number }>

Readonly _isProvider

_isProvider: boolean

_lastBlockNumber

_lastBlockNumber: number

_maxFilterBlockRange

_maxFilterBlockRange: number

_maxInternalBlockNumber

_maxInternalBlockNumber: number

_network

_network: Network

_networkPromise

_networkPromise: Promise<Network>

_nextId

_nextId: number

_pendingFilter

_pendingFilter: Promise<number>

_poller

_poller: Timer

_pollingInterval

_pollingInterval: number

Readonly _requests

_requests: {}

Type declaration

  • [name: string]: InflightRequest

Readonly _subIds

_subIds: {}

Type declaration

  • [tag: string]: Promise<string>

Readonly _subs

_subs: {}

Type declaration

  • [name: string]: Subscription

Readonly _websocket

_websocket: any

_wsReady

_wsReady: boolean

Readonly anyNetwork

anyNetwork: boolean

Readonly apiKey

apiKey: string

Readonly connection

connection: ConnectionInfo

disableCcipRead

disableCcipRead: boolean

formatter

formatter: Formatter

Accessors

_cache

  • get _cache(): Record<string, Promise<any>>

  • Returns Record<string, Promise<any>>

blockNumber

  • get blockNumber(): number

  • Returns number

network

  • get network(): Network

  • Returns Network

polling

  • set polling(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

pollingInterval

  • get pollingInterval(): number
  • set pollingInterval(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

ready

  • get ready(): Promise<Network>

  • Returns Promise<Network>

websocket

  • get websocket(): WebSocketLike

  • Returns WebSocketLike

Methods

_call

  • Parameters

    Returns Promise<string>

_getAddress

  • _getAddress(addressOrName: string | Promise<string>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>

    Returns Promise<string>

_getBlock

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>
    • Optional includeTransactions: boolean

    Returns Promise<Block | BlockWithTransactions>

_getBlockTag

  • Parameters

    Returns Promise<BlockTag>

_getFastBlockNumber

  • _getFastBlockNumber(): Promise<number>

  • Returns Promise<number>

_getFilter

  • _getFilter(filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>): Promise<Filter | FilterByBlockHash>

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Filter | FilterByBlockHash>

_getInternalBlockNumber

  • _getInternalBlockNumber(maxAge: number): Promise<number>

  • Parameters

    • maxAge: number

    Returns Promise<number>

_getResolver

  • _getResolver(name: string, operation?: string): Promise<string>

  • Parameters

    • name: string
    • Optional operation: string

    Returns Promise<string>

_getTransactionRequest

  • Parameters

    Returns Promise<Transaction>

Private _listenerCount

  • DO NOT MODIFY.

    Original code copied over from ether.js's BaseProvider.listenerCount().

    This method is copied over directly in order to implement Alchemy's unique subscription types. The only difference is that this method calls {@link getAlchemyEventTag} instead of the original getEventTag() method in order to parse the Alchemy subscription event.

    -

    Parameters

    Returns number

Private _listeners

Private _listeners

  • DO NOT MODIFY.

    Original code copied over from ether.js's BaseProvider.listeners().

    This method is copied over directly in order to implement Alchemy's unique subscription types. The only difference is that this method calls {@link getAlchemyEventTag} instead of the original getEventTag() method in order to parse the Alchemy subscription event.

    -

    Parameters

    Returns Listener[]

Private _off

Private _off

  • DO NOT MODIFY.

    Original code copied over from ether.js's BaseProvider.off().

    This method is copied over directly in order to implement Alchemy's unique subscription types. The only difference is that this method calls {@link getAlchemyEventTag} instead of the original getEventTag() method in order to parse the Alchemy subscription event.

    -

    Parameters

    Returns AlchemyWebSocketProvider

_ready

  • _ready(): Promise<Network>

  • Returns Promise<Network>

Private _removeAllListeners

_ready

  • _ready(): Promise<Network>

  • Returns Promise<Network>

Private _removeAllListeners

  • DO NOT MODIFY.

    Original code copied over from ether.js's BaseProvider.removeAllListeners().

    This method is copied over directly in order to implement Alchemy's unique subscription types. The only difference is that this method calls {@link getAlchemyEventTag} instead of the original getEventTag() method in order to parse the Alchemy subscription event.

    -

    Parameters

    Returns AlchemyWebSocketProvider

_setFastBlockNumber

  • _setFastBlockNumber(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

_startPending

  • _startPending(): void

  • Returns void

_uncachedDetectNetwork

  • _uncachedDetectNetwork(): Promise<Network>

  • Returns Promise<Network>

_waitForTransaction

  • _waitForTransaction(transactionHash: string, confirmations: number, timeout: number, replaceable: { data: string; from: string; nonce: number; startBlock: number; to: string; value: BigNumber }): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string
    • confirmations: number
    • timeout: number
    • replaceable: { data: string; from: string; nonce: number; startBlock: number; to: string; value: BigNumber }
      • data: string
      • from: string
      • nonce: number
      • startBlock: number
      • to: string
      • value: BigNumber

    Returns Promise<TransactionReceipt>

_wrapTransaction

  • Parameters

    • tx: Transaction
    • Optional hash: string
    • Optional startBlock: number

    Returns TransactionResponse

addListener

  • addListener(eventName: EventType, listener: Listener): Provider

  • Parameters

    Returns Provider

call

  • Parameters

    Returns Promise<string>

ccipReadFetch

  • ccipReadFetch(tx: Transaction, calldata: string, urls: string[]): Promise<null | string>

  • Parameters

    • tx: Transaction
    • calldata: string
    • urls: string[]

    Returns Promise<null | string>

destroy

  • destroy(): Promise<void>

detectNetwork

  • detectNetwork(): Promise<Network>

  • Returns Promise<Network>

Private emitEvent

  • emitEvent<T>(virtualId: string, result: T): void

estimateGas

  • Parameters

    Returns Promise<BigNumber>

getAvatar

  • getAvatar(nameOrAddress: string): Promise<null | string>

  • Parameters

    • nameOrAddress: string

    Returns Promise<null | string>

getBalance

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BigNumber>

getBlock

  • Parameters

    Returns Promise<Block>

getBlockNumber

  • getBlockNumber(): Promise<number>

  • Returns Promise<number>

getBlockWithTransactions

  • Parameters

    Returns Promise<BlockWithTransactions>

getCode

  • getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<string>

getEtherPrice

  • getEtherPrice(): Promise<number>

  • Returns Promise<number>

getFeeData

  • Returns Promise<FeeData>

getGasPrice

  • Returns Promise<BigNumber>

getLogs

  • getLogs(filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>): Promise<Log[]>

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Log[]>

getNetwork

  • getNetwork(): Promise<Network>

  • Returns Promise<Network>

getResolver

  • getResolver(name: string): Promise<null | Resolver>

  • Parameters

    • name: string

    Returns Promise<null | Resolver>

getSigner

  • getSigner(addressOrIndex?: string | number): JsonRpcSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns JsonRpcSigner

getStorageAt

  • Parameters

    Returns Promise<string>

getTransaction

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionResponse>

getTransactionCount

  • getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<number>

getTransactionReceipt

  • getTransactionReceipt(transactionHash: string | Promise<string>): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionReceipt>

getUncheckedSigner

  • getUncheckedSigner(addressOrIndex?: string | number): UncheckedJsonRpcSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns UncheckedJsonRpcSigner

isCommunityResource

  • isCommunityResource(): boolean

_setFastBlockNumber

  • _setFastBlockNumber(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

_startPending

  • _startPending(): void

  • Returns void

_uncachedDetectNetwork

  • _uncachedDetectNetwork(): Promise<Network>

  • Returns Promise<Network>

_waitForTransaction

  • _waitForTransaction(transactionHash: string, confirmations: number, timeout: number, replaceable: { data: string; from: string; nonce: number; startBlock: number; to: string; value: BigNumber }): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string
    • confirmations: number
    • timeout: number
    • replaceable: { data: string; from: string; nonce: number; startBlock: number; to: string; value: BigNumber }
      • data: string
      • from: string
      • nonce: number
      • startBlock: number
      • to: string
      • value: BigNumber

    Returns Promise<TransactionReceipt>

_wrapTransaction

  • Parameters

    • tx: Transaction
    • Optional hash: string
    • Optional startBlock: number

    Returns TransactionResponse

addListener

  • addListener(eventName: EventType, listener: Listener): Provider

  • Parameters

    Returns Provider

call

  • Parameters

    Returns Promise<string>

ccipReadFetch

  • ccipReadFetch(tx: Transaction, calldata: string, urls: string[]): Promise<null | string>

  • Parameters

    • tx: Transaction
    • calldata: string
    • urls: string[]

    Returns Promise<null | string>

destroy

  • destroy(): Promise<void>

detectNetwork

  • detectNetwork(): Promise<Network>

  • Returns Promise<Network>

Private emitEvent

  • emitEvent<T>(virtualId: string, result: T): void

estimateGas

  • Parameters

    Returns Promise<BigNumber>

getAvatar

  • getAvatar(nameOrAddress: string): Promise<null | string>

  • Parameters

    • nameOrAddress: string

    Returns Promise<null | string>

getBalance

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BigNumber>

getBlock

  • Parameters

    Returns Promise<Block>

getBlockNumber

  • getBlockNumber(): Promise<number>

  • Returns Promise<number>

getBlockWithTransactions

  • Parameters

    Returns Promise<BlockWithTransactions>

getCode

  • getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<string>

getEtherPrice

  • getEtherPrice(): Promise<number>

  • Returns Promise<number>

getFeeData

  • Returns Promise<FeeData>

getGasPrice

  • Returns Promise<BigNumber>

getLogs

  • getLogs(filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>): Promise<Log[]>

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Log[]>

getNetwork

  • getNetwork(): Promise<Network>

  • Returns Promise<Network>

getResolver

  • getResolver(name: string): Promise<null | Resolver>

  • Parameters

    • name: string

    Returns Promise<null | Resolver>

getSigner

  • getSigner(addressOrIndex?: string | number): JsonRpcSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns JsonRpcSigner

getStorageAt

  • Parameters

    Returns Promise<string>

getTransaction

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionResponse>

getTransactionCount

  • getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<number>

getTransactionReceipt

  • getTransactionReceipt(transactionHash: string | Promise<string>): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionReceipt>

getUncheckedSigner

  • getUncheckedSigner(addressOrIndex?: string | number): UncheckedJsonRpcSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns UncheckedJsonRpcSigner

isCommunityResource

  • isCommunityResource(): boolean

  • Overrides the ether's isCommunityResource() method. Returns true if the current api key is the default key.

    -
    override

    Returns boolean

listAccounts

  • listAccounts(): Promise<string[]>

  • Returns Promise<string[]>

listenerCount

listAccounts

  • listAccounts(): Promise<string[]>

  • Returns Promise<string[]>

listenerCount

  • Returns the number of listeners for the provided {@link eventName} event. If no event is provided, the total number of listeners for all events is returned.

    override

    Parameters

    • Optional eventName: AlchemyEventType

      The event to get the number of listeners for.

      -

    Returns number

listeners

Returns number

listeners

  • Returns an array of listeners for the provided {@link eventName} event. If no event is provided, all listeners will be included.

    override

    Parameters

    Returns Listener[]

lookupAddress

  • lookupAddress(address: string | Promise<string>): Promise<null | string>

  • Parameters

    • address: string | Promise<string>

    Returns Promise<null | string>

off

Returns Listener[]

lookupAddress

  • lookupAddress(address: string | Promise<string>): Promise<null | string>

  • Parameters

    • address: string | Promise<string>

    Returns Promise<null | string>

off

on

Returns AlchemyWebSocketProvider

on

once

Returns AlchemyWebSocketProvider

once

  • Overridden implementation of ethers that includes Alchemy based subscriptions. Adds a listener to the triggered for only the next {@link eventName} event, after which it will be removed.

    @@ -64,7 +64,7 @@

    Event to subscribe to

  • listener: Listener

    The listener function to call when the event is triggered.

    -

Returns AlchemyWebSocketProvider

perform

  • perform(method: string, params: any): Promise<any>

  • Parameters

    • method: string
    • params: any

    Returns Promise<any>

poll

  • poll(): Promise<void>

  • Returns Promise<void>

prepareRequest

  • prepareRequest(method: string, params: any): [string, any[]]

  • Parameters

    • method: string
    • params: any

    Returns [string, any[]]

removeAllListeners

Returns AlchemyWebSocketProvider

perform

  • perform(method: string, params: any): Promise<any>

  • Parameters

    • method: string
    • params: any

    Returns Promise<any>

poll

  • poll(): Promise<void>

  • Returns Promise<void>

prepareRequest

  • prepareRequest(method: string, params: any): [string, any[]]

  • Parameters

    • method: string
    • params: any

    Returns [string, any[]]

removeAllListeners

  • Remove all listeners for the provided {@link eventName} event. If no event is provided, all events and their listeners are removed.

    override

    Parameters

    • Optional eventName: AlchemyEventType
      diff --git a/docs/classes/CoreNamespace.html b/docs/classes/CoreNamespace.html index 22fc122b..3633e667 100644 --- a/docs/classes/CoreNamespace.html +++ b/docs/classes/CoreNamespace.html @@ -7,7 +7,7 @@

      Do not call this constructor directly. Instead, instantiate an Alchemy object with const alchemy = new Alchemy(config) and then access the core namespace via alchemy.core.

      -

Hierarchy

  • CoreNamespace

Index

Methods

Methods

call

Hierarchy

  • CoreNamespace

Index

Methods

Methods

call

  • Returns the result of executing the transaction, using call. A call does not require any ether, but cannot change any state. This is useful for calling getters on Contracts.

    @@ -15,7 +15,7 @@

    The transaction to execute.

  • Optional blockTag: BlockTag | Promise<BlockTag>

    The optional block number or hash to get the call for.

    -

Returns Promise<string>

estimateGas

Returns Promise<string>

estimateGas

findContractDeployer

  • findContractDeployer(contractAddress: string): Promise<DeployResult>

Returns Promise<BigNumber>

findContractDeployer

  • findContractDeployer(contractAddress: string): Promise<DeployResult>

  • Finds the address that deployed the provided contract and block number it was deployed in.

    NOTE: This method performs a binary search across all blocks since genesis @@ -33,7 +33,7 @@ with this information cached.

    beta

    Parameters

    • contractAddress: string

      The contract address to find the deployer for.

      -

    Returns Promise<DeployResult>

getAssetTransfers

Returns Promise<DeployResult>

getAssetTransfers

Returns Promise<AssetTransfersWithMetadataResponse>

  • Get transactions for specific addresses. See the web documentation for the full details: https://docs.alchemy.com/alchemy/enhanced-apis/transfers-api#alchemy_getassettransfers

    Parameters

    Returns Promise<AssetTransfersResponse>

    • getBalance

    Returns Promise<AssetTransfersResponse>

    getBalance

    • Returns the balance of a given address as of the provided block.

      Parameters

      • addressOrName: string | Promise<string>

        The address or name of the account to get the balance for.

      • Optional blockTag: BlockTag | Promise<BlockTag>

        The optional block number or hash to get the balance for. Defaults to 'latest' if unspecified.

        -

      Returns Promise<BigNumber>

    getBlock

    Returns Promise<BigNumber>

    getBlock

    • Returns the block from the network based on the provided block number or hash. Transactions on the block are represented as an array of transaction hashes. To get the full transaction details on the block, use getBlockWithTransactions instead.

      Parameters

      • blockHashOrBlockTag: BlockTag | Promise<BlockTag>

        The block number or hash to get the block for.

        -

      Returns Promise<Block>

    getBlockNumber

    • getBlockNumber(): Promise<number>

    Returns Promise<Block>

    getBlockNumber

    • getBlockNumber(): Promise<number>

    getBlockWithTransactions

    getBlockWithTransactions

    getCode

    • getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>

    Returns Promise<BlockWithTransactions>

    getCode

    • getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>

    • Returns the contract code of the provided address at the block. If there is no contract deployed, the result is 0x.

      Parameters

      • addressOrName: string | Promise<string>
        @@ -78,21 +78,21 @@
      • Optional blockTag: BlockTag | Promise<BlockTag>

        The optional block number or hash to get the code for. Defaults to 'latest' if unspecified.

        -

      Returns Promise<string>

    getFeeData

    Returns Promise<string>

    getFeeData

    • Returns the recommended fee data to use in a transaction.

      For an EIP-1559 transaction, the maxFeePerGas and maxPriorityFeePerGas should be used.

      For legacy transactions and networks which do not support EIP-1559, the gasPrice should be used.

      -

      Returns Promise<FeeData>

    getGasPrice

    getGasPrice

    getLogs

    getLogs

    getNetwork

    • getNetwork(): Promise<Network>

    Returns Promise<Log[]>

    getNetwork

    • getNetwork(): Promise<Network>

    getStorageAt

    getStorageAt

    • Return the value of the provided position at the provided address, at the provided block in Bytes32 format.

      Parameters

      • addressOrName: string | Promise<string>
        @@ -102,25 +102,25 @@
      • Optional blockTag: BlockTag | Promise<BlockTag>

        The optional block number or hash to get the code for. Defaults to 'latest' if unspecified.

        -

      Returns Promise<string>

    getTokenBalances

    Returns Promise<string>

    getTokenBalances

    Returns Promise<TokenBalancesResponseErc20>

  • Returns the token balances for a specific owner address given a list of contracts.

    Parameters

    • addressOrName: string

      The owner address to get the token balances for.

    • Optional contractAddresses: string[]

      A list of contract addresses to check. If omitted, all ERC-20 tokens will be checked.

      -

    Returns Promise<TokenBalancesResponse>

  • +

    • Returns Promise<TokenBalancesResponse>

  • Returns the ERC-20 token balances for a specific owner.

    This overload covers the erc-20 token type which includes a page key in the response.

    Parameters

    • addressOrName: string

      The owner address to get the token balances for.

    • options: TokenBalancesOptionsErc20

      Token type options set to ERC-20 with optional page key.

      -

    Returns Promise<TokenBalancesResponseErc20>

  • +

    • Returns Promise<TokenBalancesResponseErc20>

  • Returns the token balances for a specific owner, fetching from the top 100 tokens by 24 hour volume.

    This overload covers the default token type which includes a page key in @@ -129,18 +129,18 @@

    The owner address to get the token balances for.

  • options: TokenBalancesOptionsDefaultTokens

    Token type options set to ERC-20 with optional page key.

    -

    • Returns Promise<TokenBalancesResponse>

    getTokenMetadata

    Returns Promise<TokenBalancesResponse>

    getTokenMetadata

    getTokensForOwner

    Returns Promise<TokenMetadataResponse>

    getTokensForOwner

    getTransaction

    Returns Promise<GetTokensForOwnerResponse>

    getTransaction

    • Returns the transaction with hash or null if the transaction is unknown.

      If a transaction has not been mined, this method will search the transaction pool. Various backends may have more restrictive transaction @@ -149,7 +149,7 @@

      NOTE: This is an alias for TransactNamespace.getTransaction.

      Parameters

      • transactionHash: string | Promise<string>

        The hash of the transaction to get.

        -

      Returns Promise<null | TransactionResponse>

    getTransactionCount

    • getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>

    Returns Promise<null | TransactionResponse>

    getTransactionCount

    • getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>

    • Returns the number of transactions ever sent from the provided address, as of the provided block tag. This value is used as the nonce for the next transaction from the address sent to the network.

      @@ -157,50 +157,50 @@

      The address or name of the account to get the nonce for.

    • Optional blockTag: BlockTag | Promise<BlockTag>

      The optional block number or hash to get the nonce for.

      -

    Returns Promise<number>

    getTransactionReceipt

    • getTransactionReceipt(transactionHash: string | Promise<string>): Promise<null | TransactionReceipt>

    Returns Promise<number>

    getTransactionReceipt

    • getTransactionReceipt(transactionHash: string | Promise<string>): Promise<null | TransactionReceipt>

    • Returns the transaction receipt for hash or null if the transaction has not been mined.

      To stall until the transaction has been mined, consider the waitForTransaction method below.

      Parameters

      • transactionHash: string | Promise<string>

        The hash of the transaction to get.

        -

      Returns Promise<null | TransactionReceipt>

    getTransactionReceipts

    Returns Promise<null | TransactionReceipt>

    getTransactionReceipts

    isContractAddress

    • isContractAddress(address: string): Promise<boolean>

    Returns Promise<TransactionReceiptsResponse>

    isContractAddress

    • isContractAddress(address: string): Promise<boolean>

    • Checks if the provided address is a smart contract.

      Parameters

      • address: string

        The address to check type for.

        -

      Returns Promise<boolean>

    lookupAddress

    • lookupAddress(address: string): Promise<null | string>

    Returns Promise<boolean>

    lookupAddress

    • lookupAddress(address: string): Promise<null | string>

    • Performs a reverse lookup of the address in ENS using the Reverse Registrar. If the name does not exist, or the forward lookup does not match, null is returned.

      An ENS name requires additional configuration to setup a reverse record, so not all ENS addresses will map back to the original ENS domain.

      Parameters

      • address: string

        The address to look up the ENS domain name for.

        -

      Returns Promise<null | string>

    ready

    • ready(): Promise<Network>

    Returns Promise<null | string>

    ready

    • ready(): Promise<Network>

    • Returns a Promise which will stall until the network has heen established, ignoring errors due to the target node not being active yet.

      This can be used for testing or attaching scripts to wait until the node is up and running smoothly.

      -

      Returns Promise<Network>

    resolveName

    • resolveName(name: string): Promise<null | string>

    resolveName

    • resolveName(name: string): Promise<null | string>

    • Returns the underlying owner address for the provided ENS address, or null if the ENS name does not have an underlying address.

      Parameters

      • name: string

        The ENS address name to resolve.

        -

      Returns Promise<null | string>

    send

    • send(method: string, params: any[]): Promise<any>

    Returns Promise<null | string>

    send

    • send(method: string, params: any[]): Promise<any>

    • Allows sending a raw message to the Alchemy backend.

      Parameters

      • method: string

        The method to call.

      • params: any[]

        The parameters to pass to the method.

        -

      Returns Promise<any>

    sendTransaction

    Returns Promise<any>

    sendTransaction

    • Submits transaction to the network to be mined. The transaction must be signed, and be valid (i.e. the nonce is correct and the account has sufficient balance to pay for the transaction).

      NOTE: This is an alias for TransactNamespace.getTransaction.

      Parameters

      • signedTransaction: string | Promise<string>

        The signed transaction to send.

        -

      Returns Promise<TransactionResponse>

    waitForTransaction

    • waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<null | TransactionReceipt>

    Returns Promise<TransactionResponse>

    waitForTransaction

    • waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<null | TransactionReceipt>

    • Returns a promise which will not resolve until specified transaction hash is mined.

      If {@link confirmations} is 0, this method is non-blocking and if the transaction has not been mined returns null. Otherwise, this method will diff --git a/docs/classes/DebugNamespace.html b/docs/classes/DebugNamespace.html index fa0a75d6..7ad5a1f3 100644 --- a/docs/classes/DebugNamespace.html +++ b/docs/classes/DebugNamespace.html @@ -6,21 +6,21 @@

      Do not call this constructor directly. Instead, instantiate an Alchemy object with const alchemy = new Alchemy(config) and then access the debug namespace via alchemy.debug.

      -

    Hierarchy

    • DebugNamespace

    Index

    Methods

    Methods

    traceBlock

    Hierarchy

    • DebugNamespace

    Index

    Methods

    Methods

    traceBlock

    Returns Promise<DebugCallTrace>

  • Replays a block that has already been mined.

    Parameters

    • blockIdentifier: string | number

      The block to debug the transaction in. Can be a block hash, block number hex string, or commitment level.

    • tracer: DebugPrestateTracer

      Tracer type and configuration.

      -

    Returns Promise<DebugPrestateTrace>

    • traceCall

    Returns Promise<DebugPrestateTrace>

    traceCall

    Returns Promise<DebugCallTrace>

  • Runs an eth_call with the context of the provided block execution using the final state of the parent block as the base.

    Parameters

    Returns Promise<DebugPrestateTrace>

    • traceTransaction

    Returns Promise<DebugPrestateTrace>

    traceTransaction

    • Attempts to run the transaction in the exact same manner as it was executed on the network. It will replay any transaction that may have been executed prior to this one before it and will then attempt to execute the transaction @@ -54,7 +54,7 @@ default timeout of 5 seconds for JavaScript-based tracing calls. Max timeout is "10s". Valid time units are "ns", "us", "ms", "s" each with optional fraction, such as "300ms" or "2s45ms".

      -

    Returns Promise<DebugCallTrace>

  • +

    • Returns Promise<DebugCallTrace>

  • Attempts to run the transaction in the exact same manner as it was executed on the network. It will replay any transaction that may have been executed prior to this one before it and will then attempt to execute the transaction diff --git a/docs/classes/NftNamespace.html b/docs/classes/NftNamespace.html index f1d7edc0..c1c0734c 100644 --- a/docs/classes/NftNamespace.html +++ b/docs/classes/NftNamespace.html @@ -3,41 +3,41 @@

    Do not call this constructor directly. Instead, instantiate an Alchemy object with const alchemy = new Alchemy(config) and then access the core namespace via alchemy.nft.

    -

    • Hierarchy

    • NftNamespace

    Index

    Methods

    Methods

    computeRarity

    Hierarchy

    • NftNamespace

    Index

    Methods

    Methods

    computeRarity

    getCollectionMetadata

    • getCollectionMetadata(collectionSlug: string): Promise<NftCollection>

    Returns Promise<ComputeRarityResponse>

    getCollectionMetadata

    • getCollectionMetadata(collectionSlug: string): Promise<NftCollection>

    • Get the NFT collection metadata associated with the provided parameters.

      beta

      Parameters

      • collectionSlug: string

        The OpenSea collection slug of the NFT.

        -

      Returns Promise<NftCollection>

    getContractMetadata

    • getContractMetadata(contractAddress: string): Promise<NftContract>

    Returns Promise<NftCollection>

    getContractMetadata

    • getContractMetadata(contractAddress: string): Promise<NftContract>

    • Get the NFT contract metadata associated with the provided parameters.

      Parameters

      • contractAddress: string

        The contract address of the NFT.

        -

      Returns Promise<NftContract>

    getContractMetadataBatch

    Returns Promise<NftContract>

    getContractMetadataBatch

    getContractsForOwner

    Returns Promise<GetContractMetadataBatchResponse>

    getContractsForOwner

    getFloorPrice

    Returns Promise<GetContractsForOwnerResponse>

    getFloorPrice

    getMintedNfts

    Returns Promise<GetFloorPriceResponse>

    getMintedNfts

    getNftMetadata

    Returns Promise<TransfersNftResponse>

    getNftMetadata

    • Get the NFT metadata associated with the provided parameters.

      Parameters

      • contractAddress: string

        The contract address of the NFT.

        @@ -45,17 +45,17 @@

        Token id of the NFT.

      • Optional options: GetNftMetadataOptions

        Options for the request.

        -

      Returns Promise<Nft>

    getNftMetadataBatch

    Returns Promise<Nft>

    getNftMetadataBatch

    getNftSales

    Returns Promise<GetNftMetadataBatchResponse>

    getNftSales

    getNftsForContract

    Returns Promise<GetNftSalesResponse>

  • Parameters

    Returns Promise<GetNftSalesResponse>

    • getNftsForContract

    Returns Promise<NftContractNftsResponse>

  • +

    • Returns Promise<NftContractNftsResponse>

  • Get all base NFTs for a given contract address.

    This method returns the base NFTs that omit the associated metadata. To get all NFTs with their associated metadata, use GetNftsForContractOptions.

    @@ -72,7 +72,7 @@

    The contract address of the NFT contract.

  • Optional options: GetBaseNftsForContractOptions

    The optional parameters to use for the request.

    -

    • Returns Promise<NftContractBaseNftsResponse>

    getNftsForContractIterator

    Returns Promise<NftContractBaseNftsResponse>

    getNftsForContractIterator

    • Fetches all NFTs for a given contract address and yields them in an async iterable.

      This method returns the full NFTs in the contract and pages through all page keys until all NFTs have been fetched. To get all NFTs without their @@ -81,7 +81,7 @@

      The contract address of the NFT contract.

    • Optional options: GetNftsForContractOptions

      The optional parameters to use for the request.

      -

    Returns AsyncIterable<Nft>

  • +

    • Returns AsyncIterable<Nft>

  • Fetches all base NFTs for a given contract address and yields them in an async iterable.

    This method returns the base NFTs that omit the associated metadata and @@ -91,7 +91,7 @@

    The contract address of the NFT contract.

  • Optional options: GetBaseNftsForContractOptions

    The optional parameters to use for the request.

    -

    • Returns AsyncIterable<BaseNft>

    getNftsForOwner

    Returns AsyncIterable<BaseNft>

    getNftsForOwner

    Returns Promise<OwnedBaseNftsResponse>

  • +

    • Returns Promise<OwnedBaseNftsResponse>

  • Get all NFTs for an owner.

    This method returns the full NFTs in the contract. To get all NFTs without their associated metadata, use GetBaseNftsForOwnerOptions.

    @@ -107,7 +107,7 @@

    The address of the owner.

  • Optional options: GetNftsForOwnerOptions

    The optional parameters to use for the request.

    -

    • Returns Promise<OwnedNftsResponse>

    getNftsForOwnerIterator

    Returns Promise<OwnedNftsResponse>

    getNftsForOwnerIterator

    • Fetches all NFTs for a given owner and yields them in an async iterable.

      This method returns the full NFT for the owner and pages through all page keys until all NFTs have been fetched.

      @@ -115,7 +115,7 @@

      The address of the owner.

    • Optional options: GetNftsForOwnerOptions

      The optional parameters to use for the request.

      -

    Returns AsyncIterable<OwnedNft>

  • +

    • Returns AsyncIterable<OwnedNft>

  • Fetches all NFTs for a given owner and yields them in an async iterable.

    This method returns the base NFTs that omit the associated metadata and pages through all page keys until all NFTs have been fetched.

    @@ -123,13 +123,13 @@

    The address of the owner.

  • Optional options: GetBaseNftsForOwnerOptions

    The optional parameters to use for the request.

    -

    • Returns AsyncIterable<OwnedBaseNft>

    getOwnersForContract

    Returns AsyncIterable<OwnedBaseNft>

    getOwnersForContract

    Returns Promise<GetOwnersForContractWithTokenBalancesResponse>

  • Gets all the owners for a given NFT contract.

    Note that token balances are omitted by default. To include token balances for each owner, use GetOwnersForContractWithTokenBalancesOptions, @@ -138,7 +138,7 @@

    The NFT contract to get the owners for.

  • Optional options: GetOwnersForContractOptions

    Optional parameters to use for the request.

    -

    • Returns Promise<GetOwnersForContractResponse>

    getOwnersForNft

    Returns Promise<GetOwnersForContractResponse>

    getOwnersForNft

    getSpamContracts

    Returns Promise<GetOwnersForNftResponse>

    getSpamContracts

    getTransfersForContract

    getTransfersForContract

    Returns Promise<TransfersNftResponse>

    getTransfersForOwner

    Returns Promise<TransfersNftResponse>

    getTransfersForOwner

    isAirdropNft

    Returns Promise<TransfersNftResponse>

    isAirdropNft

    • Returns whether a token is marked as an airdrop or not. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address.

      @@ -174,13 +174,13 @@

      The contract address to check.

    • tokenId: string

      Token id of the NFT.

      -

    Returns Promise<IsAirdropNftResponse>

    isSpamContract

    Returns Promise<IsAirdropNftResponse>

    isSpamContract

    refreshContract

    Returns Promise<IsSpamContractResponse>

    refreshContract

    • Triggers a metadata refresh all NFTs in the provided contract address. This method is useful after an NFT collection is revealed.

      Refreshes are queued on the Alchemy backend and may take time to fully @@ -188,7 +188,7 @@ refreshNftMetadata method instead.

      beta

      Parameters

      • contractAddress: string

        The contract address of the NFT collection.

        -

      Returns Promise<RefreshContractResult>

    refreshNftMetadata

    • refreshNftMetadata(contractAddress: string, tokenId: BigNumberish): Promise<boolean>

    Returns Promise<RefreshContractResult>

    refreshNftMetadata

    • refreshNftMetadata(contractAddress: string, tokenId: BigNumberish): Promise<boolean>

    • Refreshes the cached metadata for a provided NFT contract address and token id. Returns a boolean value indicating whether the metadata was refreshed.

      This method is useful when you want to refresh the metadata for a NFT that @@ -201,28 +201,28 @@

      The contract address of the NFT.

    • tokenId: BigNumberish

      The token id of the NFT.

      -

    Returns Promise<boolean>

    reportSpam

    • reportSpam(contractAddress: string): Promise<void>

    Returns Promise<boolean>

    reportSpam

    • reportSpam(contractAddress: string): Promise<void>

    searchContractMetadata

    Returns Promise<void>

    searchContractMetadata

    summarizeNftAttributes

    Returns Promise<SearchContractMetadataResponse>

    summarizeNftAttributes

    verifyNftOwnership

    • verifyNftOwnership(owner: string, contractAddress: string): Promise<boolean>
    • verifyNftOwnership(owner: string, contractAddresses: string[]): Promise<{}>

    Returns Promise<NftAttributesResponse>

    verifyNftOwnership

    • verifyNftOwnership(owner: string, contractAddress: string): Promise<boolean>
    • verifyNftOwnership(owner: string, contractAddresses: string[]): Promise<{}>

    • Checks that the provided owner address owns one of more of the provided NFT. Returns a boolean indicating whether the owner address owns the provided NFT.

      Parameters

      • owner: string

        The owner address to check.

      • contractAddress: string

        An NFT contract address to check ownership for.

        -

      Returns Promise<boolean>

    • +

    Returns Promise<boolean>

  • Checks which of the provided NFTs the owner address owns. Returns a map of contract address to a boolean indicating whether the owner address owns the NFT.

    Parameters

    • owner: string
      diff --git a/docs/classes/NotifyNamespace.html b/docs/classes/NotifyNamespace.html index 7f56285c..be6dfc6d 100644 --- a/docs/classes/NotifyNamespace.html +++ b/docs/classes/NotifyNamespace.html @@ -10,7 +10,7 @@

      Do not call this constructor directly. Instead, instantiate an Alchemy object with const alchemy = new Alchemy(config) and then access the notify namespace via alchemy.notify.

      -

    • Hierarchy

    • NotifyNamespace

    Index

    Methods

    Methods

    createWebhook

    Hierarchy

    • NotifyNamespace

    Index

    Methods

    Methods

    createWebhook

    Returns Promise<MinedTransactionWebhook>

  • +

    • Returns Promise<MinedTransactionWebhook>

  • Create a new DroppedTransactionWebhook to track dropped transactions sent by the app associated with the app id.

    Note that the webhook will be created in the app network of the provided app id.

    @@ -30,7 +30,7 @@

    The type of webhook to create.

  • params: TransactionWebhookParams

    Parameters object containing the app id.

    -

    • Returns Promise<DroppedTransactionWebhook>

  • +

    • Returns Promise<DroppedTransactionWebhook>

  • Create a new NftActivityWebhook to track NFT transfers.

    Parameters

    • url: string

      The URL that the webhook should send events to.

      @@ -39,7 +39,7 @@
    • params: NftWebhookParams

      Parameters object containing the NFTs to track and the network the webhook should be created on.

      -

    Returns Promise<NftActivityWebhook>

  • Parameters

    Returns Promise<NftMetadataUpdateWebhook>

  • +

    • Returns Promise<NftActivityWebhook>

  • Parameters

    Returns Promise<NftMetadataUpdateWebhook>

  • Create a new CustomGraphqlWebhook to track any event on every block.

    Parameters

    • url: string

      The URL that the webhook should send events to.

      @@ -48,7 +48,7 @@
    • params: CustomGraphqlWebhookParams

      Parameters object containing the graphql query to be executed on every block

      -

    Returns Promise<CustomGraphqlWebhook>

  • +

    • Returns Promise<CustomGraphqlWebhook>

  • Create a new AddressActivityWebhook to track address activity.

    Parameters

    • url: string

      The URL that the webhook should send events to.

      @@ -57,21 +57,21 @@
    • params: AddressWebhookParams

      Parameters object containing the addresses to track and the network the webhook should be created on.

      -

    Returns Promise<AddressActivityWebhook>

    • deleteWebhook

    • deleteWebhook(webhook: Webhook): Promise<void>
    • deleteWebhook(webhookId: string): Promise<void>

    Returns Promise<AddressActivityWebhook>

    deleteWebhook

    • deleteWebhook(webhook: Webhook): Promise<void>
    • deleteWebhook(webhookId: string): Promise<void>

    Returns Promise<void>

  • Delete the provided webhook.

    Parameters

    • webhookId: string

      The id of the webhook to delete.

      -

    Returns Promise<void>

    • getAddresses

    Returns Promise<void>

    getAddresses

    Returns Promise<AddressActivityResponse>

  • Get all addresses tracked for the provided AddressActivityWebhook.

    Parameters

    • webhookId: string

      The id of the address activity webhook. Passing in an id @@ -79,28 +79,28 @@ no addresses.

    • Optional options: GetAddressesOptions

      Pagination options when fetching addresses.

      -

    Returns Promise<AddressActivityResponse>

    • getAllWebhooks

    Returns Promise<AddressActivityResponse>

    getAllWebhooks

    getGraphqlQuery

    getGraphqlQuery

    Returns Promise<CustomGraphqlWebhookConfig>

  • Get the graphql query used for the provided CustomGraphqlWebhook.

    Parameters

    • webhookId: string

      The id of the custom webhook. Passing in an id of a non-custom webhook will result in a response object with no graphql query.

      -

    Returns Promise<CustomGraphqlWebhookConfig>

    • getNftFilters

    Returns Promise<CustomGraphqlWebhookConfig>

    getNftFilters

    Returns Promise<NftFiltersResponse>

  • Get all NFT filters tracked for the provided NftActivityWebhook.

    Parameters

    • webhookId: string

      The id of the NFT activity webhook. Passing in an @@ -108,41 +108,41 @@ no filters.

    • Optional options: GetAddressesOptions

      Pagination options when fetching nft filters.

      -

    Returns Promise<NftFiltersResponse>

    • Private sendWebhookRequest

    • sendWebhookRequest<Response>(restApiName: string, methodName: string, params: {}, overrides?: AxiosRequestConfig<any>): Promise<Response>

    • Type parameters

      • Response

      Parameters

      • restApiName: string
      • methodName: string
      • params: {}
        • Optional overrides: AxiosRequestConfig<any>

        Returns Promise<Response>

      updateWebhook

      Returns Promise<NftFiltersResponse>

      Private sendWebhookRequest

      • sendWebhookRequest<Response>(restApiName: string, methodName: string, params: {}, overrides?: AxiosRequestConfig<any>): Promise<Response>

      • Type parameters

        • Response

        Parameters

        • restApiName: string
        • methodName: string
        • params: {}
          • Optional overrides: AxiosRequestConfig<any>

          Returns Promise<Response>

        updateWebhook

        Returns Promise<void>

      • Update a NftActivityWebhook's active status or NFT filters.

        Parameters

        • nftWebhookId: string

          The id of the NFT activity webhook.

        • update: NftWebhookUpdate

          Object containing the update.

          -

        Returns Promise<void>

      • +

        • Returns Promise<void>

      • Update a NftMetadataUpdateWebhook's active status or NFT filters.

        Parameters

        • nftMetadataWebhookId: string

          The id of the NFT activity webhook.

        • update: NftMetadataWebhookUpdate

          Object containing the update.

          -

        Returns Promise<void>

      • +

        • Returns Promise<void>

      • Update a CustomGraphqlWebhook's active status. The graphql query associated with the webhook is immutable.

        Parameters

        • customGraphqlWebhookId: string

          The id of the custom webhook.

        • update: WebhookStatusUpdate

          Object containing the update.

          -

        Returns Promise<void>

      • +

        • Returns Promise<void>

      • Update a AddressActivityWebhook's active status or addresses.

        Parameters

        Returns Promise<void>

      • +

        • Returns Promise<void>

      • Update a AddressActivityWebhook's active status or addresses.

        Parameters

        • addressWebhookId: string

          The id of the address activity webhook.

        • update: AddressWebhookUpdate

          Object containing the update.

          -

        Returns Promise<void>

        • Private verifyConfig

        • verifyConfig(): void

        Generated using TypeDoc

        \ No newline at end of file +

        Returns Promise<void>

        Private verifyConfig

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/classes/TransactNamespace.html b/docs/classes/TransactNamespace.html index 2007b1f9..e3052844 100644 --- a/docs/classes/TransactNamespace.html +++ b/docs/classes/TransactNamespace.html @@ -4,7 +4,7 @@

        Do not call this constructor directly. Instead, instantiate an Alchemy object with const alchemy = new Alchemy(config) and then access the transact namespace via alchemy.transact.

        -

        Hierarchy

        Index

        Methods

        Methods

        cancelPrivateTransaction

        Hierarchy

        Index

        Methods

        Methods

        cancelPrivateTransaction

        • cancelPrivateTransaction(transactionHash: string): Promise<boolean>

        • Stops the provided private transaction from being submitted for future blocks. A transaction can only be cancelled if the request is signed by the same key as the sendPrivateTransaction call submitting the @@ -13,7 +13,7 @@

          Returns a boolean indicating whether the cancellation was successful.

          Parameters

          • transactionHash: string

            Transaction hash of private tx to be cancelled

            -

          Returns Promise<boolean>

        estimateGas

        Returns Promise<boolean>

        estimateGas

        getMaxPriorityFeePerGas

        • getMaxPriorityFeePerGas(): Promise<number>

        Returns Promise<BigNumber>

        getMaxPriorityFeePerGas

        • getMaxPriorityFeePerGas(): Promise<number>

        • Returns a fee per gas (in wei) that is an estimate of how much you can pay as a priority fee, or "tip", to get a transaction included in the current block.

          This number is generally used to set the maxPriorityFeePerGas field in a transaction request.

          -

          Returns Promise<number>

        getTransaction

        getTransaction

        • Returns the transaction with hash or null if the transaction is unknown.

          If a transaction has not been mined, this method will search the transaction pool. Various backends may have more restrictive transaction @@ -36,7 +36,7 @@

          NOTE: This is an alias for CoreNamespace.getTransaction.

          Parameters

          • transactionHash: string | Promise<string>

            The hash of the transaction to get.

            -

          Returns Promise<null | TransactionResponse>

        sendPrivateTransaction

        Returns Promise<null | TransactionResponse>

        sendPrivateTransaction

        • Used to send a single transaction to Flashbots. Flashbots will attempt to send the transaction to miners for the next 25 blocks.

          Returns the transaction hash of the submitted transaction.

          @@ -47,14 +47,14 @@ transaction should be included.

        • Optional options: SendPrivateTransactionOptions

          Options to configure the request.

          -

        Returns Promise<string>

        sendTransaction

        Returns Promise<string>

        sendTransaction

        • Submits transaction to the network to be mined. The transaction must be signed, and be valid (i.e. the nonce is correct and the account has sufficient balance to pay for the transaction).

          NOTE: This is an alias for CoreNamespace.sendTransaction.

          Parameters

          • signedTransaction: string | Promise<string>

            The signed transaction to send.

            -

          Returns Promise<TransactionResponse>

        simulateAssetChanges

        Returns Promise<TransactionResponse>

        simulateAssetChanges

        • Simulates the asset changes resulting from a single transaction.

          Returns list of asset changes that occurred during the transaction simulation. Note that this method does not run the transaction on the @@ -64,7 +64,7 @@

        • Optional blockIdentifier: string

          Optional block identifier to simulate the transaction in.

          -

        Returns Promise<SimulateAssetChangesResponse>

        simulateAssetChangesBundle

        Returns Promise<SimulateAssetChangesResponse>

        simulateAssetChangesBundle

        • Simulates the asset changes resulting from a list of transactions simulated in sequence.

          Returns a list of asset changes for each transaction during simulation.

          @@ -73,7 +73,7 @@
        • Optional blockIdentifier: string

          Optional block identifier to simulate the transaction in.

          -

        Returns Promise<SimulateAssetChangesResponse[]>

        simulateExecution

        Returns Promise<SimulateAssetChangesResponse[]>

        simulateExecution

        • Simulates a single transaction and the resulting and returns list of decoded traces and logs that occurred during the transaction simulation.

          Note that this method does not run the transaction on the blockchain.

          @@ -82,7 +82,7 @@
        • Optional blockIdentifier: string

          Optional block identifier to simulate the transaction in.

          -

        Returns Promise<SimulateExecutionResponse>

        simulateExecutionBundle

        Returns Promise<SimulateExecutionResponse>

        simulateExecutionBundle

        • Simulates a list of transactions in sequence and returns list of decoded traces and logs that occurred for each transaction during simulation.

          Note that this method does not run any transactions on the blockchain.

          @@ -91,7 +91,7 @@
        • Optional blockIdentifier: string

          Optional block identifier to simulate the transaction in.

          -

        Returns Promise<SimulateExecutionResponse[]>

        waitForTransaction

        • waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<null | TransactionReceipt>

        Returns Promise<SimulateExecutionResponse[]>

        waitForTransaction

        • waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<null | TransactionReceipt>

        • Returns a promise which will not resolve until specified transaction hash is mined.

          If {@link confirmations} is 0, this method is non-blocking and if the transaction has not been mined returns null. Otherwise, this method will diff --git a/docs/classes/Wallet.html b/docs/classes/Wallet.html index 8871fe14..e3614cf4 100644 --- a/docs/classes/Wallet.html +++ b/docs/classes/Wallet.html @@ -5,53 +5,53 @@

          Primary difference from Ethers.js 'Wallet' is that you can pass in either a Provider or an Alchemy object. This implementation will intelligently detect the format and set the provider accordingly.

          -
          override

        Hierarchy

        • Wallet
          • Wallet

        Index

        Constructors

        Properties

        Accessors

        Methods

        Constructors

        constructor

        • new Wallet(privateKey: BytesLike | ExternallyOwnedAccount | SigningKey, alchemyOrProvider?: Alchemy | Provider): Wallet

        Hierarchy

        • Wallet
          • Wallet

        Index

        Constructors

        Properties

        Accessors

        Methods

        Constructors

        constructor

        • new Wallet(privateKey: BytesLike | ExternallyOwnedAccount | SigningKey, alchemyOrProvider?: Alchemy | Provider): Wallet

        • Overload permits users to pass in either a standard Provider or an Alchemy object. The constructor will detect the object type and handle appropriately.

          -
          override

          Parameters

          • privateKey: BytesLike | ExternallyOwnedAccount | SigningKey
          • Optional alchemyOrProvider: Alchemy | Provider

          Returns Wallet

        Properties

        Readonly _isSigner

        _isSigner: boolean

        Readonly _mnemonic

        _mnemonic: () => Mnemonic

        Type declaration

          • (): Mnemonic

          • Returns Mnemonic

        Readonly _signingKey

        _signingKey: () => SigningKey

        Type declaration

          • (): SigningKey

          • Returns SigningKey

        Readonly address

        address: string

        Private Optional alchemyProviderPromise

        alchemyProviderPromise?: Promise<Provider>

        Readonly provider

        provider: Provider

        Accessors

        mnemonic

        • get mnemonic(): Mnemonic

        • Returns Mnemonic

        privateKey

        • get privateKey(): string

        • Returns string

        publicKey

        • get publicKey(): string

        • Returns string

        Methods

        _checkProvider

        • _checkProvider(operation?: string): void

        • Parameters

          • Optional operation: string

          Returns void

        _signTypedData

        • _signTypedData(domain: TypedDataDomain, types: Record<string, TypedDataField[]>, value: Record<string, any>): Promise<string>

        • Parameters

          • domain: TypedDataDomain
          • types: Record<string, TypedDataField[]>
          • value: Record<string, any>

          Returns Promise<string>

        call

        Properties

        Readonly _isSigner

        _isSigner: boolean

        Readonly _mnemonic

        _mnemonic: () => Mnemonic

        Type declaration

          • (): Mnemonic

          • Returns Mnemonic

        Readonly _signingKey

        _signingKey: () => SigningKey

        Type declaration

          • (): SigningKey

          • Returns SigningKey

        Readonly address

        address: string

        Private Optional alchemyProviderPromise

        alchemyProviderPromise?: Promise<Provider>

        Readonly provider

        provider: Provider

        Accessors

        mnemonic

        • get mnemonic(): Mnemonic

        • Returns Mnemonic

        privateKey

        • get privateKey(): string

        • Returns string

        publicKey

        • get publicKey(): string

        • Returns string

        Methods

        _checkProvider

        • _checkProvider(operation?: string): void

        • Parameters

          • Optional operation: string

          Returns void

        _signTypedData

        • _signTypedData(domain: TypedDataDomain, types: Record<string, TypedDataField[]>, value: Record<string, any>): Promise<string>

        • Parameters

          • domain: TypedDataDomain
          • types: Record<string, TypedDataField[]>
          • value: Record<string, any>

          Returns Promise<string>

        call

        • Returns the result of calling using the transactionRequest, with this account address being used as the from field.

          override

          Parameters

          Returns Promise<string>

        checkTransaction

        • Parameters

          Returns Deferrable<TransactionRequest>

        connect

        • connect(provider: Provider): Wallet

        • Parameters

          • provider: Provider

          Returns Wallet

        encrypt

        • encrypt(password: string | Bytes, options?: any, progressCallback?: ProgressCallback): Promise<string>

        • Parameters

          • password: string | Bytes
          • Optional options: any
          • Optional progressCallback: ProgressCallback

          Returns Promise<string>

        estimateGas

        Returns Promise<string>

        checkTransaction

        • Parameters

          Returns Deferrable<TransactionRequest>

        connect

        • connect(provider: Provider): Wallet

        • Parameters

          • provider: Provider

          Returns Wallet

        encrypt

        • encrypt(password: string | Bytes, options?: any, progressCallback?: ProgressCallback): Promise<string>

        • Parameters

          • password: string | Bytes
          • Optional options: any
          • Optional progressCallback: ProgressCallback

          Returns Promise<string>

        estimateGas

        • Returns the result of estimating the cost to send the transactionRequest, with this account address being used as the from field.

          override

          Parameters

          Returns Promise<BigNumber>

        getAddress

        • getAddress(): Promise<string>

        • Returns Promise<string>

        getBalance

        Returns Promise<BigNumber>

        getAddress

        • getAddress(): Promise<string>

        • Returns Promise<string>

        getBalance

        • Returns the balance of this wallet at blockTag.

          override

          Parameters

          • Optional blockTag: BlockTag

            The block to check the balance of

            -

          Returns Promise<BigNumber>

        getChainId

        • getChainId(): Promise<number>

        Returns Promise<BigNumber>

        getChainId

        • getChainId(): Promise<number>

        • Returns the chain ID this wallet is connected to.

          -
          override

          Returns Promise<number>

        getFeeData

        getFeeData

        • Returns the current recommended FeeData to use in a transaction.

          For an EIP-1559 transaction, the maxFeePerGas and maxPriorityFeePerGas should be used.

          For legacy transactions and networks which do not support EIP-1559, the gasPrice should be used.

          -
          override

          Returns Promise<FeeData>

        getGasPrice

        getGasPrice

        getTransactionCount

        • getTransactionCount(blockTag?: BlockTag): Promise<number>

        getTransactionCount

        • getTransactionCount(blockTag?: BlockTag): Promise<number>

        • Returns the number of transactions this account has ever sent. This is the value required to be included in transactions as the nonce.

          override

          Parameters

          • Optional blockTag: BlockTag

            The block to check the transaction count on

            -

          Returns Promise<number>

        Private getWallet

        • getWallet(): Promise<Wallet>

        populateTransaction

        Returns Promise<number>

        Private getWallet

        • getWallet(): Promise<Wallet>

        populateTransaction

        • Populates ALL keys for a transaction and checks that from matches this Signer. Resolves ENS names and populates fields like gasPrice, gasLimit, nonce, and chainId if they are not provided.

          override

          Parameters

          Returns Promise<TransactionRequest>

        resolveName

        • resolveName(name: string): Promise<string>

        Returns Promise<TransactionRequest>

        resolveName

        • resolveName(name: string): Promise<string>

        • Looks up the address of name. If the name is not owned, or does not have a Resolver configured, or the Resolver does not have an address configured, null is returned.

          override

          Parameters

          • name: string

            Name of the ENS address

            -

          Returns Promise<string>

        sendTransaction

        Returns Promise<string>

        sendTransaction

        • Populates all fields in a transaction, signs it and sends it to the network

          override

          Parameters

          • transaction: Deferrable<TransactionRequest>

            The transaction to send.

            diff --git a/docs/classes/WebSocketNamespace.html b/docs/classes/WebSocketNamespace.html index cf8762d0..b2832fc4 100644 --- a/docs/classes/WebSocketNamespace.html +++ b/docs/classes/WebSocketNamespace.html @@ -6,24 +6,24 @@

            Do not call this constructor directly. Instead, instantiate an Alchemy object with const alchemy = new Alchemy(config) and then access the core namespace via alchemy.ws.

            -

        Hierarchy

        • WebSocketNamespace

        Index

        Methods

        Methods

        listenerCount

        Hierarchy

        • WebSocketNamespace

        Index

        Methods

        Methods

        listenerCount

        • Returns the number of listeners for the provided {@link eventName} event. If no event is provided, the total number of listeners for all events is returned.

          Parameters

          • Optional eventName: AlchemyEventType

            The event to get the number of listeners for.

            -

          Returns Promise<number>

        listeners

        Returns Promise<number>

        listeners

        • Returns an array of listeners for the provided {@link eventName} event. If no event is provided, all listeners will be included.

          Parameters

          Returns Promise<Listener[]>

        off

        Returns Promise<Listener[]>

        off

        on

        Returns WebSocketNamespace

        on

        • Adds a listener to be triggered for each {@link eventName} event. Also includes Alchemy's Subscription API events. See AlchemyEventType for how to use them.

          @@ -31,7 +31,7 @@

          The event to listen for.

        • listener: Listener

          The listener to call when the event is triggered.

          -

        Returns WebSocketNamespace

        once

        Returns WebSocketNamespace

        once

        • Adds a listener to be triggered for only the next {@link eventName} event, after which it will be removed. Also includes Alchemy's Subscription API events. See AlchemyEventType for how to use them.

          @@ -39,7 +39,7 @@

          The event to listen for.

        • listener: Listener

          The listener to call when the event is triggered.

          -

        Returns WebSocketNamespace

        removeAllListeners

        Returns WebSocketNamespace

        removeAllListeners

        • Remove all listeners for the provided {@link eventName} event. If no event is provided, all events and their listeners are removed.

          Parameters

          • Optional eventName: AlchemyEventType
            diff --git a/docs/enums/AlchemySubscription.html b/docs/enums/AlchemySubscription.html index 36c3cb54..34010806 100644 --- a/docs/enums/AlchemySubscription.html +++ b/docs/enums/AlchemySubscription.html @@ -2,4 +2,4 @@

            Method names for Alchemy's custom Subscription API endpoints.

            This value is provided in the method field when creating an event filter on the Websocket Namespace.

            -

        Index

        Enumeration members

        Enumeration members

        MINED_TRANSACTIONS

        MINED_TRANSACTIONS = "alchemy_minedTransactions"

        PENDING_TRANSACTIONS

        PENDING_TRANSACTIONS = "alchemy_pendingTransactions"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        MINED_TRANSACTIONS

        MINED_TRANSACTIONS = "alchemy_minedTransactions"

        PENDING_TRANSACTIONS

        PENDING_TRANSACTIONS = "alchemy_pendingTransactions"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/AssetTransfersCategory.html b/docs/enums/AssetTransfersCategory.html index 46002145..713dce19 100644 --- a/docs/enums/AssetTransfersCategory.html +++ b/docs/enums/AssetTransfersCategory.html @@ -1,20 +1,20 @@ AssetTransfersCategory | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration AssetTransfersCategory

        Categories of transfers to use with the AssetTransfersParams request object when using CoreNamespace.getAssetTransfers.

        -

        Index

        Enumeration members

        Enumeration members

        ERC1155

        ERC1155 = "erc1155"
        +

        Index

        Enumeration members

        Enumeration members

        ERC1155

        ERC1155 = "erc1155"

        ERC1155 transfers.

        -

        ERC20

        ERC20 = "erc20"
        +

        ERC20

        ERC20 = "erc20"

        ERC20 transfers.

        -

        ERC721

        ERC721 = "erc721"
        +

        ERC721

        ERC721 = "erc721"

        ERC721 transfers.

        -

        EXTERNAL

        EXTERNAL = "external"
        +

        EXTERNAL

        EXTERNAL = "external"

        Top level ETH transactions that occur where the fromAddress is an external user-created address. External addresses have private keys and are accessed by users.

        -

        INTERNAL

        INTERNAL = "internal"
        +

        INTERNAL

        INTERNAL = "internal"

        Top level ETH transactions that occur where the fromAddress is an internal, smart contract address. For example, a smart contract calling another smart contract or sending

        -

        SPECIALNFT

        SPECIALNFT = "specialnft"
        +

        SPECIALNFT

        SPECIALNFT = "specialnft"

        Special contracts that don't follow ERC 721/1155, (ex: CryptoKitties).

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/CommitmentLevel.html b/docs/enums/CommitmentLevel.html index 20f37339..1f18eb6a 100644 --- a/docs/enums/CommitmentLevel.html +++ b/docs/enums/CommitmentLevel.html @@ -1,20 +1,20 @@ CommitmentLevel | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration CommitmentLevel

        Commitment level of the target block with using methods in the DebugNamespace

        -

        Index

        Enumeration members

        Enumeration members

        EARLIEST

        EARLIEST = "earliest"
        +

        Index

        Enumeration members

        Enumeration members

        EARLIEST

        EARLIEST = "earliest"

        The lowest numbered block available that is usually the first block created.

        -

        FINALIZED

        FINALIZED = "finalized"
        +

        FINALIZED

        FINALIZED = "finalized"

        The most recent secure block that has been accepted by >2/3 of validators. This block is very unlikely to be re-orged. This is only available on Network.ETH_GOERLI and Network.ETH_SEPOLIA.

        -

        LATEST

        LATEST = "latest"
        +

        LATEST

        LATEST = "latest"

        The most recent block in the canonical chain observed by Alchemy. Note that this block may be re-orged out of the canonical chain.

        -

        PENDING

        PENDING = "pending"
        +

        PENDING

        PENDING = "pending"

        Sample next block inferred by Alchemy built on top of the latest block. This contains the set of transactions taken from the local mempool and is a proxy for blocks that have not been mined yet.

        -

        SAFE

        SAFE = "safe"
        +

        SAFE

        SAFE = "safe"

        The most recent crypto-economically secure block that cannot be re-orged outside of manual intervention driven by community coordination. This is only available on Network.ETH_GOERLI and Network.ETH_SEPOLIA.

        diff --git a/docs/enums/DebugCallType.html b/docs/enums/DebugCallType.html index 9de9bc57..21838c76 100644 --- a/docs/enums/DebugCallType.html +++ b/docs/enums/DebugCallType.html @@ -1,3 +1,3 @@ DebugCallType | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration DebugCallType

        The type of call in a debug call trace.

        -

        Index

        Enumeration members

        Enumeration members

        CALL

        CALL = "CALL"

        CREATE

        CREATE = "CREATE"

        DELEGATECALL

        DELEGATECALL = "DELEGATECALL"

        STATICCALL

        STATICCALL = "STATICCALL"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        CALL

        CALL = "CALL"

        CREATE

        CREATE = "CREATE"

        DELEGATECALL

        DELEGATECALL = "DELEGATECALL"

        STATICCALL

        STATICCALL = "STATICCALL"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/DebugTracerType.html b/docs/enums/DebugTracerType.html index 06408643..6e66c9f8 100644 --- a/docs/enums/DebugTracerType.html +++ b/docs/enums/DebugTracerType.html @@ -1,4 +1,4 @@ DebugTracerType | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration DebugTracerType

        The type of tracer to use when running debug methods in the DebugNamespace.

        -

        Index

        Enumeration members

        Enumeration members

        CALL_TRACER

        CALL_TRACER = "callTracer"

        PRESTATE_TRACER

        PRESTATE_TRACER = "prestateTracer"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        CALL_TRACER

        CALL_TRACER = "callTracer"

        PRESTATE_TRACER

        PRESTATE_TRACER = "prestateTracer"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/DecodingAuthority.html b/docs/enums/DecodingAuthority.html index 36bd1eac..3aa3d868 100644 --- a/docs/enums/DecodingAuthority.html +++ b/docs/enums/DecodingAuthority.html @@ -1,4 +1,4 @@ DecodingAuthority | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration DecodingAuthority

        Authority used to decode calls and logs when using the TransactNamespace.simulateExecution method.

        -

        Index

        Enumeration members

        Enumeration members

        ETHERSCAN

        ETHERSCAN = "ETHERSCAN"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        ETHERSCAN

        ETHERSCAN = "ETHERSCAN"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/GetTransfersForOwnerTransferType.html b/docs/enums/GetTransfersForOwnerTransferType.html index 43ac4fae..0a1c0e09 100644 --- a/docs/enums/GetTransfersForOwnerTransferType.html +++ b/docs/enums/GetTransfersForOwnerTransferType.html @@ -1,4 +1,4 @@ GetTransfersForOwnerTransferType | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration GetTransfersForOwnerTransferType

        The type of transfer for the request. Note that using TO will also include NFTs that were minted by the owner.

        -

        Index

        Enumeration members

        Enumeration members

        FROM

        FROM = "FROM"

        TO

        TO = "TO"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        FROM

        FROM = "FROM"

        TO

        TO = "TO"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/Network.html b/docs/enums/Network.html index 104793fe..6632d515 100644 --- a/docs/enums/Network.html +++ b/docs/enums/Network.html @@ -3,4 +3,4 @@ on all networks. Please refer to the Alchemy documentation for which APIs are available on which networks https://docs.alchemy.com/alchemy/apis/feature-support-by-chain

        -

        Index

        Enumeration members

        Enumeration members

        ARB_GOERLI

        ARB_GOERLI = "arb-goerli"

        ARB_MAINNET

        ARB_MAINNET = "arb-mainnet"

        ARB_SEPOLIA

        ARB_SEPOLIA = "arb-sepolia"

        ASTAR_MAINNET

        ASTAR_MAINNET = "astar-mainnet"

        BASE_GOERLI

        BASE_GOERLI = "base-goerli"

        BASE_MAINNET

        BASE_MAINNET = "base-mainnet"

        BASE_SEPOLIA

        BASE_SEPOLIA = "base-sepolia"

        ETH_GOERLI

        ETH_GOERLI = "eth-goerli"

        ETH_MAINNET

        ETH_MAINNET = "eth-mainnet"

        ETH_SEPOLIA

        ETH_SEPOLIA = "eth-sepolia"

        MATIC_AMOY

        MATIC_AMOY = "polygon-amoy"

        MATIC_MAINNET

        MATIC_MAINNET = "polygon-mainnet"

        MATIC_MUMBAI

        MATIC_MUMBAI = "polygon-mumbai"

        OPT_GOERLI

        OPT_GOERLI = "opt-goerli"

        OPT_MAINNET

        OPT_MAINNET = "opt-mainnet"

        OPT_SEPOLIA

        OPT_SEPOLIA = "opt-sepolia"

        POLYGONZKEVM_MAINNET

        POLYGONZKEVM_MAINNET = "polygonzkevm-mainnet"

        POLYGONZKEVM_TESTNET

        POLYGONZKEVM_TESTNET = "polygonzkevm-testnet"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        ARB_GOERLI

        ARB_GOERLI = "arb-goerli"

        ARB_MAINNET

        ARB_MAINNET = "arb-mainnet"

        ARB_SEPOLIA

        ARB_SEPOLIA = "arb-sepolia"

        ASTAR_MAINNET

        ASTAR_MAINNET = "astar-mainnet"

        BASE_GOERLI

        BASE_GOERLI = "base-goerli"

        BASE_MAINNET

        BASE_MAINNET = "base-mainnet"

        BASE_SEPOLIA

        BASE_SEPOLIA = "base-sepolia"

        ETH_GOERLI

        ETH_GOERLI = "eth-goerli"

        ETH_MAINNET

        ETH_MAINNET = "eth-mainnet"

        ETH_SEPOLIA

        ETH_SEPOLIA = "eth-sepolia"

        MATIC_AMOY

        MATIC_AMOY = "polygon-amoy"

        MATIC_MAINNET

        MATIC_MAINNET = "polygon-mainnet"

        MATIC_MUMBAI

        MATIC_MUMBAI = "polygon-mumbai"

        OPT_GOERLI

        OPT_GOERLI = "opt-goerli"

        OPT_MAINNET

        OPT_MAINNET = "opt-mainnet"

        OPT_SEPOLIA

        OPT_SEPOLIA = "opt-sepolia"

        POLYGONZKEVM_MAINNET

        POLYGONZKEVM_MAINNET = "polygonzkevm-mainnet"

        POLYGONZKEVM_TESTNET

        POLYGONZKEVM_TESTNET = "polygonzkevm-testnet"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftCollectionMarketplace.html b/docs/enums/NftCollectionMarketplace.html index 68b11919..2d46f99a 100644 --- a/docs/enums/NftCollectionMarketplace.html +++ b/docs/enums/NftCollectionMarketplace.html @@ -1,4 +1,4 @@ NftCollectionMarketplace | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration NftCollectionMarketplace

        Enum representing the supported NFT marketplaces on a NftCollectionFloorPrice object.

        -

        Index

        Enumeration members

        Enumeration members

        OPENSEA

        OPENSEA = "OpenSea"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        OPENSEA

        OPENSEA = "OpenSea"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftFilters.html b/docs/enums/NftFilters.html index 6b665ef8..36c0bcf0 100644 --- a/docs/enums/NftFilters.html +++ b/docs/enums/NftFilters.html @@ -1,8 +1,8 @@ NftFilters | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration NftFilters

        Enum of NFT filters that can be applied to a getNftsForOwner or a getContractsForOwner request.

        -
        beta

        Index

        Enumeration members

        Enumeration members

        AIRDROPS

        AIRDROPS = "AIRDROPS"
        +
        beta

        Index

        Enumeration members

        Enumeration members

        AIRDROPS

        AIRDROPS = "AIRDROPS"

        NFTs that have been airdropped to a user.

        -

        SPAM

        SPAM = "SPAM"
        +

        SPAM

        SPAM = "SPAM"

        NFTs that have been classified as spam.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftOrdering.html b/docs/enums/NftOrdering.html index 03e05636..257bc902 100644 --- a/docs/enums/NftOrdering.html +++ b/docs/enums/NftOrdering.html @@ -1,4 +1,4 @@ NftOrdering | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration NftOrdering

        Enum of ordering that can be applied to a getNftsForOwner or a getContractsForOwner response.

        -
        beta

        Index

        Enumeration members

        Enumeration members

        TRANSFERTIME

        TRANSFERTIME = "TRANSFERTIME"

        Generated using TypeDoc

        \ No newline at end of file +
        beta

        Index

        Enumeration members

        Enumeration members

        TRANSFERTIME

        TRANSFERTIME = "TRANSFERTIME"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftRefreshState.html b/docs/enums/NftRefreshState.html index c81c5d57..8ca7b543 100644 --- a/docs/enums/NftRefreshState.html +++ b/docs/enums/NftRefreshState.html @@ -1,15 +1,15 @@ NftRefreshState | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration NftRefreshState

        The current state of the NFT contract refresh process.

        -

        Index

        Enumeration members

        Enumeration members

        ALREADY_QUEUED

        ALREADY_QUEUED = "already_queued"
        +

        Index

        Enumeration members

        Enumeration members

        ALREADY_QUEUED

        ALREADY_QUEUED = "already_queued"

        The contract has already been queued for refresh.

        -

        DOES_NOT_EXIST

        DOES_NOT_EXIST = "does_not_exist"
        +

        DOES_NOT_EXIST

        DOES_NOT_EXIST = "does_not_exist"

        The provided contract is not an NFT or does not contain metadata.

        -

        FINISHED

        FINISHED = "finished"
        +

        FINISHED

        FINISHED = "finished"

        The contract refresh is complete.

        -

        IN_PROGRESS

        IN_PROGRESS = "in_progress"
        +

        IN_PROGRESS

        IN_PROGRESS = "in_progress"

        The contract is currently being refreshed.

        -

        QUEUED

        QUEUED = "queued"
        +

        QUEUED

        QUEUED = "queued"

        The contract refresh has been queued and await execution.

        -

        QUEUE_FAILED

        QUEUE_FAILED = "queue_failed"
        +

        QUEUE_FAILED

        QUEUE_FAILED = "queue_failed"

        The contract was unable to be queued due to an internal error.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftSaleMarketplace.html b/docs/enums/NftSaleMarketplace.html index 13617c42..0dbaf0ff 100644 --- a/docs/enums/NftSaleMarketplace.html +++ b/docs/enums/NftSaleMarketplace.html @@ -1,4 +1,4 @@ NftSaleMarketplace | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration NftSaleMarketplace

        Enum representing the supported NFT marketplaces by the NftNamespace.getNftSales method.

        -

        Index

        Enumeration members

        Enumeration members

        BLUR

        BLUR = "blur"

        CRYPTOPUNKS

        CRYPTOPUNKS = "cryptopunks"

        LOOKSRARE

        LOOKSRARE = "looksrare"

        SEAPORT

        SEAPORT = "seaport"

        UNKNOWN

        UNKNOWN = "unknown"

        WYVERN

        WYVERN = "wyvern"

        X2Y2

        X2Y2 = "x2y2"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        BLUR

        BLUR = "blur"

        CRYPTOPUNKS

        CRYPTOPUNKS = "cryptopunks"

        LOOKSRARE

        LOOKSRARE = "looksrare"

        SEAPORT

        SEAPORT = "seaport"

        UNKNOWN

        UNKNOWN = "unknown"

        WYVERN

        WYVERN = "wyvern"

        X2Y2

        X2Y2 = "x2y2"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftSaleTakerType.html b/docs/enums/NftSaleTakerType.html index 7ee986ab..58e8775f 100644 --- a/docs/enums/NftSaleTakerType.html +++ b/docs/enums/NftSaleTakerType.html @@ -1,4 +1,4 @@ NftSaleTakerType | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration NftSaleTakerType

        Enum for specifying the taker type for the NftNamespace.getNftSales method.

        -

        Index

        Enumeration members

        Enumeration members

        BUYER

        BUYER = "buyer"

        SELLER

        SELLER = "seller"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        BUYER

        BUYER = "buyer"

        SELLER

        SELLER = "seller"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftSpamClassification.html b/docs/enums/NftSpamClassification.html index 19517c71..f35e0e90 100644 --- a/docs/enums/NftSpamClassification.html +++ b/docs/enums/NftSpamClassification.html @@ -1,3 +1,3 @@ NftSpamClassification | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration NftSpamClassification

        Potential reasons why an NFT contract was classified as spam.

        -

        Index

        Enumeration members

        Enumeration members

        Erc721DishonestTotalSupply

        Erc721DishonestTotalSupply = "Erc721DishonestTotalSupply"

        Erc721TooManyOwners

        Erc721TooManyOwners = "Erc721TooManyOwners"

        Erc721TooManyTokens

        Erc721TooManyTokens = "Erc721TooManyTokens"

        HighAirdropPercent

        HighAirdropPercent = "HighAirdropPercent"

        HighHoneyPotOwnerPercent

        HighHoneyPotOwnerPercent = "HighHoneyPotOwnerPercent"

        HighHoneyPotPercent

        HighHoneyPotPercent = "HighHoneyPotPercent"

        HoneyPotsOwnMultipleTokens

        HoneyPotsOwnMultipleTokens = "HoneyPotsOwnMultipleTokens"

        LowDistinctOwnersPercent

        LowDistinctOwnersPercent = "LowDistinctOwnersPercent"

        MostlyHoneyPotOwners

        MostlyHoneyPotOwners = "MostlyHoneyPotOwners"

        NoSalesActivity

        NoSalesActivity = "NoSalesActivity"

        OwnedByMostHoneyPots

        OwnedByMostHoneyPots = "OwnedByMostHoneyPots"

        Unknown

        Unknown = "Unknown"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        Erc721DishonestTotalSupply

        Erc721DishonestTotalSupply = "Erc721DishonestTotalSupply"

        Erc721TooManyOwners

        Erc721TooManyOwners = "Erc721TooManyOwners"

        Erc721TooManyTokens

        Erc721TooManyTokens = "Erc721TooManyTokens"

        HighAirdropPercent

        HighAirdropPercent = "HighAirdropPercent"

        HighHoneyPotOwnerPercent

        HighHoneyPotOwnerPercent = "HighHoneyPotOwnerPercent"

        HighHoneyPotPercent

        HighHoneyPotPercent = "HighHoneyPotPercent"

        HoneyPotsOwnMultipleTokens

        HoneyPotsOwnMultipleTokens = "HoneyPotsOwnMultipleTokens"

        LowDistinctOwnersPercent

        LowDistinctOwnersPercent = "LowDistinctOwnersPercent"

        MostlyHoneyPotOwners

        MostlyHoneyPotOwners = "MostlyHoneyPotOwners"

        NoSalesActivity

        NoSalesActivity = "NoSalesActivity"

        OwnedByMostHoneyPots

        OwnedByMostHoneyPots = "OwnedByMostHoneyPots"

        Unknown

        Unknown = "Unknown"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftTokenType.html b/docs/enums/NftTokenType.html index f4580aa3..a8f00d9f 100644 --- a/docs/enums/NftTokenType.html +++ b/docs/enums/NftTokenType.html @@ -1,3 +1,3 @@ NftTokenType | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration NftTokenType

        An enum for specifying the token type on NFTs.

        -

        Index

        Enumeration members

        Enumeration members

        ERC1155

        ERC1155 = "ERC1155"

        ERC721

        ERC721 = "ERC721"

        NOT_A_CONTRACT

        NOT_A_CONTRACT = "NOT_A_CONTRACT"

        NO_SUPPORTED_NFT_STANDARD

        NO_SUPPORTED_NFT_STANDARD = "NO_SUPPORTED_NFT_STANDARD"

        UNKNOWN

        UNKNOWN = "UNKNOWN"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        ERC1155

        ERC1155 = "ERC1155"

        ERC721

        ERC721 = "ERC721"

        NOT_A_CONTRACT

        NOT_A_CONTRACT = "NOT_A_CONTRACT"

        NO_SUPPORTED_NFT_STANDARD

        NO_SUPPORTED_NFT_STANDARD = "NO_SUPPORTED_NFT_STANDARD"

        UNKNOWN

        UNKNOWN = "UNKNOWN"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/OpenSeaSafelistRequestStatus.html b/docs/enums/OpenSeaSafelistRequestStatus.html index 3f1c6039..d7db4340 100644 --- a/docs/enums/OpenSeaSafelistRequestStatus.html +++ b/docs/enums/OpenSeaSafelistRequestStatus.html @@ -1,11 +1,11 @@ OpenSeaSafelistRequestStatus | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration OpenSeaSafelistRequestStatus

        An OpenSea collection's approval status.

        -

        Index

        Enumeration members

        Enumeration members

        APPROVED

        APPROVED = "approved"
        +

        Index

        Enumeration members

        Enumeration members

        APPROVED

        APPROVED = "approved"

        Collections that are approved on open sea and can be found in search results.

        -

        NOT_REQUESTED

        NOT_REQUESTED = "not_requested"
        +

        NOT_REQUESTED

        NOT_REQUESTED = "not_requested"

        Brand new collections.

        -

        REQUESTED

        REQUESTED = "requested"
        +

        REQUESTED

        REQUESTED = "requested"

        Collections that requested safelisting on OpenSea.

        -

        VERIFIED

        VERIFIED = "verified"
        +

        VERIFIED

        VERIFIED = "verified"

        Verified collection.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/SimulateAssetType.html b/docs/enums/SimulateAssetType.html index ad770901..a67290bb 100644 --- a/docs/enums/SimulateAssetType.html +++ b/docs/enums/SimulateAssetType.html @@ -2,16 +2,16 @@

        Asset type returned when calling TransactNamespace.simulateAssetChanges. Allows you to determine if the assets approved or / and transferred are native, tokens or NFTs.

        -

        Index

        Enumeration members

        Enumeration members

        ERC1155

        ERC1155 = "ERC1155"
        +

        Index

        Enumeration members

        Enumeration members

        ERC1155

        ERC1155 = "ERC1155"

        ERC1155 approval or transfers.

        -

        ERC20

        ERC20 = "ERC20"
        +

        ERC20

        ERC20 = "ERC20"

        ERC20 approval or transfers.

        -

        ERC721

        ERC721 = "ERC721"
        +

        ERC721

        ERC721 = "ERC721"

        ERC721 approval or transfers.

        -

        NATIVE

        NATIVE = "NATIVE"
        +

        NATIVE

        NATIVE = "NATIVE"

        Native transfers that involve the currency of the chain the simulation is run on (ex: ETH for Ethereum, MATIC for Polygon, ETH for Arbitrum).

        -

        SPECIAL_NFT

        SPECIAL_NFT = "SPECIAL_NFT"
        +

        SPECIAL_NFT

        SPECIAL_NFT = "SPECIAL_NFT"

        Special contracts that don't follow ERC 721/1155.Currently limited to CryptoKitties and CryptoPunks.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/SimulateChangeType.html b/docs/enums/SimulateChangeType.html index 5ff0a88a..6032c90b 100644 --- a/docs/enums/SimulateChangeType.html +++ b/docs/enums/SimulateChangeType.html @@ -1,11 +1,11 @@ SimulateChangeType | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration SimulateChangeType

        Change type returned when calling TransactNamespace.simulateAssetChanges.

        -

        Index

        Enumeration members

        Enumeration members

        APPROVE

        APPROVE = "APPROVE"
        +

        Index

        Enumeration members

        Enumeration members

        APPROVE

        APPROVE = "APPROVE"

        Represents a transaction that approved or disapproved permissions for a contract.

        APPROVE without token ID → approve all tokens APPROVE without amount → approve all amount APPROVE with zero amount → approval being cleared

        -

        TRANSFER

        TRANSFER = "TRANSFER"
        +

        TRANSFER

        TRANSFER = "TRANSFER"

        Represents a transaction that transferred tokens from one address to another.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/SortingOrder.html b/docs/enums/SortingOrder.html index c0aab2b5..7e2b6111 100644 --- a/docs/enums/SortingOrder.html +++ b/docs/enums/SortingOrder.html @@ -1,3 +1,3 @@ SortingOrder | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration SortingOrder

        Enum for representing the supported sorting orders of the API.

        -

        Index

        Enumeration members

        Enumeration members

        ASCENDING

        ASCENDING = "asc"

        DESCENDING

        DESCENDING = "desc"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        ASCENDING

        ASCENDING = "asc"

        DESCENDING

        DESCENDING = "desc"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/TokenBalanceType.html b/docs/enums/TokenBalanceType.html index d3037180..be42c253 100644 --- a/docs/enums/TokenBalanceType.html +++ b/docs/enums/TokenBalanceType.html @@ -1,9 +1,9 @@ TokenBalanceType | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration TokenBalanceType

        Token Types for the getTokenBalances() endpoint.

        -

        Index

        Enumeration members

        Enumeration members

        DEFAULT_TOKENS

        DEFAULT_TOKENS = "DEFAULT_TOKENS"
        +

        Index

        Enumeration members

        Enumeration members

        DEFAULT_TOKENS

        DEFAULT_TOKENS = "DEFAULT_TOKENS"

        Option to fetch the top 100 tokens by 24-hour volume. This option is only available on Mainnet in Ethereum, Polygon, and Arbitrum.

        -

        ERC20

        ERC20 = "erc20"
        +

        ERC20

        ERC20 = "erc20"

        Option to fetch the set of ERC-20 tokens that the address as ever held. his list is produced by an address's historical transfer activity and includes all tokens that the address has ever received.

        diff --git a/docs/enums/WebhookType.html b/docs/enums/WebhookType.html index 1309921e..fe9d8fa3 100644 --- a/docs/enums/WebhookType.html +++ b/docs/enums/WebhookType.html @@ -1,3 +1,3 @@ WebhookType | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration WebhookType

        The type of Webhook.

        -

        Index

        Enumeration members

        Enumeration members

        ADDRESS_ACTIVITY

        ADDRESS_ACTIVITY = "ADDRESS_ACTIVITY"

        DROPPED_TRANSACTION

        DROPPED_TRANSACTION = "DROPPED_TRANSACTION"

        GRAPHQL

        GRAPHQL = "GRAPHQL"

        MINED_TRANSACTION

        MINED_TRANSACTION = "MINED_TRANSACTION"

        NFT_ACTIVITY

        NFT_ACTIVITY = "NFT_ACTIVITY"

        NFT_METADATA_UPDATE

        NFT_METADATA_UPDATE = "NFT_METADATA_UPDATE"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        ADDRESS_ACTIVITY

        ADDRESS_ACTIVITY = "ADDRESS_ACTIVITY"

        DROPPED_TRANSACTION

        DROPPED_TRANSACTION = "DROPPED_TRANSACTION"

        GRAPHQL

        GRAPHQL = "GRAPHQL"

        MINED_TRANSACTION

        MINED_TRANSACTION = "MINED_TRANSACTION"

        NFT_ACTIVITY

        NFT_ACTIVITY = "NFT_ACTIVITY"

        NFT_METADATA_UPDATE

        NFT_METADATA_UPDATE = "NFT_METADATA_UPDATE"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/WebhookVersion.html b/docs/enums/WebhookVersion.html index f906ab43..f1b842d3 100644 --- a/docs/enums/WebhookVersion.html +++ b/docs/enums/WebhookVersion.html @@ -1,3 +1,3 @@ WebhookVersion | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration WebhookVersion

        The version of the webhook. All newly created webhooks default to V2.

        -

        Index

        Enumeration members

        Enumeration members

        V1

        V1 = "V1"

        V2

        V2 = "V2"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        V1

        V1 = "V1"

        V2

        V2 = "V2"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AcquiredAt.html b/docs/interfaces/AcquiredAt.html index 30cdd342..f08dbbc5 100644 --- a/docs/interfaces/AcquiredAt.html +++ b/docs/interfaces/AcquiredAt.html @@ -1,7 +1,7 @@ AcquiredAt | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AcquiredAt

        Block time and number at which an NFT was acquired.

        -

        Hierarchy

        • AcquiredAt

        Index

        Properties

        Properties

        Optional blockNumber

        blockNumber?: number
        +

        Hierarchy

        • AcquiredAt

        Index

        Properties

        Properties

        Optional blockNumber

        blockNumber?: number

        Block number of the block at which an NFT was last acquired.

        -

        Optional blockTimestamp

        blockTimestamp?: string
        +

        Optional blockTimestamp

        blockTimestamp?: string

        Timestamp of the block at which an NFT was last acquired.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AddressActivityResponse.html b/docs/interfaces/AddressActivityResponse.html index 4a2b2f18..ac4d5244 100644 --- a/docs/interfaces/AddressActivityResponse.html +++ b/docs/interfaces/AddressActivityResponse.html @@ -1,9 +1,9 @@ AddressActivityResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AddressActivityResponse

        Response object for the NotifyNamespace.getAddresses method.

        -

        Hierarchy

        • AddressActivityResponse

        Index

        Properties

        Properties

        addresses

        addresses: string[]
        +

        Hierarchy

        • AddressActivityResponse

        Index

        Properties

        Properties

        addresses

        addresses: string[]

        The addresses for the webhook.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key used to fetch the remaining addresses.

        -

        totalCount

        totalCount: number
        +

        totalCount

        totalCount: number

        The total number of addresses.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AddressActivityWebhook.html b/docs/interfaces/AddressActivityWebhook.html index a4e5ed1c..ae016ec5 100644 --- a/docs/interfaces/AddressActivityWebhook.html +++ b/docs/interfaces/AddressActivityWebhook.html @@ -2,23 +2,23 @@

        An Address Activity Webhook tracks ETH, ERC20, ERC721, and ERC1155 transfers for the provided addresses. This can be used to notify your app with real-time state changes when your tracked addresses send or receive tokens.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string

        The app id of the app used for the webhook. This field is only present on MinedTransactionWebhook and DroppedTransactionWebhook

        -

        id

        id: string
        +

        id

        id: string

        The webhook's unique id.

        -

        isActive

        isActive: boolean
        +

        isActive

        isActive: boolean

        Whether the webhook is currently active

        -

        network

        network: Network
        +

        network

        network: Network

        The network the webhook is on.

        -

        signingKey

        signingKey: string
        +

        signingKey

        signingKey: string

        The signing key used to verify payloads for the webhook.

        -

        timeCreated

        timeCreated: string
        +

        timeCreated

        timeCreated: string

        The creation time of the webhook as an ISO string.

        -

        type

        type: ADDRESS_ACTIVITY
        +

        type

        type: ADDRESS_ACTIVITY

        The type of webhook.

        -

        url

        url: string
        +

        url

        url: string

        The url that the webhook sends its payload to.

        -

        version

        version: WebhookVersion
        +

        version

        version: WebhookVersion

        The webhook version. All newly created webhooks default to V2.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AddressWebhookParams.html b/docs/interfaces/AddressWebhookParams.html index 06b0b8de..6bdb75cf 100644 --- a/docs/interfaces/AddressWebhookParams.html +++ b/docs/interfaces/AddressWebhookParams.html @@ -1,9 +1,9 @@ AddressWebhookParams | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AddressWebhookParams

        Params to pass in when calling NotifyNamespace.createWebhook in order to create a AddressActivityWebhook.

        -

        Hierarchy

        • AddressWebhookParams

        Index

        Properties

        Properties

        addresses

        addresses: string[]
        +

        Hierarchy

        • AddressWebhookParams

        Index

        Properties

        Properties

        addresses

        addresses: string[]

        Array of addresses the webhook should activity for.

        -

        Optional network

        network?: Network
        +

        Optional network

        network?: Network

        Optional network to create the webhook on. If omitted, the webhook will be created on network of the app provided in the api key config.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AlchemyMinedTransactionsEventFilter.html b/docs/interfaces/AlchemyMinedTransactionsEventFilter.html index 97a14eab..fe6dd24c 100644 --- a/docs/interfaces/AlchemyMinedTransactionsEventFilter.html +++ b/docs/interfaces/AlchemyMinedTransactionsEventFilter.html @@ -7,14 +7,14 @@ https://docs.alchemy.com/reference/alchemy-minedtransactions

        Note that excluding all optional parameters will return transaction information for ALL mined transactions.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional addresses

        addresses?: NonEmptyArray<AlchemyMinedTransactionsAddress>
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional addresses

        addresses?: NonEmptyArray<AlchemyMinedTransactionsAddress>

        Address filters to subscribe to. Defaults to all transactions if omitted. Limit 100 address filters. Requires a non-empty array.

        -

        Optional hashesOnly

        hashesOnly?: boolean
        +

        Optional hashesOnly

        hashesOnly?: boolean

        Whether to only include transaction hashes and exclude the rest of the transaction response for a smaller payload. Defaults to false (by default, the entire transaction response is included).

        -

        Optional includeRemoved

        includeRemoved?: boolean
        +

        Optional includeRemoved

        includeRemoved?: boolean

        Whether to include transactions that were removed from the mempool. Defaults to false.

        -

        method

        method: MINED_TRANSACTIONS

        Generated using TypeDoc

        \ No newline at end of file +

        method

        method: MINED_TRANSACTIONS

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AlchemyPendingTransactionsEventFilter.html b/docs/interfaces/AlchemyPendingTransactionsEventFilter.html index 70710a1a..8edc3fbd 100644 --- a/docs/interfaces/AlchemyPendingTransactionsEventFilter.html +++ b/docs/interfaces/AlchemyPendingTransactionsEventFilter.html @@ -7,19 +7,19 @@ https://docs.alchemy.com/reference/alchemy-pendingtransactions

        Note that excluding all optional parameters will return transaction information for ALL pending transactions that are added to the mempool.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional fromAddress

        fromAddress?: string | string[]
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional fromAddress

        fromAddress?: string | string[]

        Filter pending transactions sent FROM the provided address or array of addresses.

        If a AlchemyPendingTransactionsEventFilter.toAddress is also present, then this filter will return transactions sent from the fromAddress OR transactions received by the toAddress.

        -

        Optional hashesOnly

        hashesOnly?: boolean
        +

        Optional hashesOnly

        hashesOnly?: boolean

        Whether to only include transaction hashes and exclude the rest of the transaction response for a smaller payload. Defaults to false (by default, the entire transaction response is included).

        Note that setting only hashesOnly to true will return the same response as subscribing to newPendingTransactions.

        -

        method

        method: PENDING_TRANSACTIONS

        Optional toAddress

        toAddress?: string | string[]
        +

        method

        method: PENDING_TRANSACTIONS

        Optional toAddress

        toAddress?: string | string[]

        Filter pending transactions sent TO the provided address or array of addresses.

        If a AlchemyPendingTransactionsEventFilter.fromAddress is also diff --git a/docs/interfaces/AlchemySettings.html b/docs/interfaces/AlchemySettings.html index 5959b15a..26f6a475 100644 --- a/docs/interfaces/AlchemySettings.html +++ b/docs/interfaces/AlchemySettings.html @@ -1,25 +1,25 @@ AlchemySettings | alchemy-sdk

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AlchemySettings

        Options object used to configure the Alchemy SDK.

        -

        Hierarchy

        • AlchemySettings

        Index

        Properties

        Properties

        Optional apiKey

        apiKey?: string
        +

        Hierarchy

        • AlchemySettings

        Index

        Properties

        Properties

        Optional apiKey

        apiKey?: string

        The Alchemy API key that can be found in the Alchemy dashboard.

        Defaults to: "demo" (a rate-limited public API key)

        -

        Optional authToken

        authToken?: string
        +

        Optional authToken

        authToken?: string

        Alchemy auth token required to use the Notify API. This token can be found in the Alchemy Dashboard on the Notify tab.

        -

        Optional batchRequests

        batchRequests?: boolean
        +

        Optional batchRequests

        batchRequests?: boolean

        Optional setting that automatically batches and sends json-rpc requests for higher throughput and reduced network IO. Defaults to false.

        This implementation is based on the JsonRpcBatchProvider in ethers.

        -

        Optional maxRetries

        maxRetries?: number
        +

        Optional maxRetries

        maxRetries?: number

        The maximum number of retries to attempt if a request fails. Defaults to 5.

        -

        Optional network

        network?: Network
        +

        Optional network

        network?: Network

        The name of the network. Once configured, the network cannot be changed. To use a different network, instantiate a new Alchemy instance.

        Defaults to: Network.ETH_MAINNET

        -

        Optional requestTimeout

        requestTimeout?: number
        +

        Optional requestTimeout

        requestTimeout?: number

        Optional Request timeout provided in ms while using NFT and NOTIFY API. Default to 0 (No timeout).

        -

        Optional url

        url?: string
        +

        Optional url

        url?: string

        Optional URL endpoint to use for all requests. Setting this field will override the URL generated by the network and apiKey fields.

        This field is useful for testing or for using a custom node endpoint. Note diff --git a/docs/interfaces/AssetTransfersMetadata.html b/docs/interfaces/AssetTransfersMetadata.html index db3014e8..273e6f96 100644 --- a/docs/interfaces/AssetTransfersMetadata.html +++ b/docs/interfaces/AssetTransfersMetadata.html @@ -1,6 +1,6 @@ AssetTransfersMetadata | alchemy-sdk

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AssetTransfersMetadata

        The metadata object for a AssetTransfersResult when the AssetTransfersParams.withMetadata field is set to true.

        -

        Hierarchy

        • AssetTransfersMetadata

        Index

        Properties

        Properties

        blockTimestamp

        blockTimestamp: string
        +

        Hierarchy

        • AssetTransfersMetadata

        Index

        Properties

        Properties

        blockTimestamp

        blockTimestamp: string

        Timestamp of the block from which the transaction event originated.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AssetTransfersParams.html b/docs/interfaces/AssetTransfersParams.html index eb337846..f6d75ab6 100644 --- a/docs/interfaces/AssetTransfersParams.html +++ b/docs/interfaces/AssetTransfersParams.html @@ -1,34 +1,34 @@ AssetTransfersParams | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AssetTransfersParams

        Parameters for the CoreNamespace.getAssetTransfers method.

        -

        Hierarchy

        Index

        Properties

        Properties

        category

        category: AssetTransfersCategory[]
        +

        Hierarchy

        Index

        Properties

        Properties

        category

        category: AssetTransfersCategory[]

        REQUIRED field. An array of categories to get transfers for.

        -

        Optional contractAddresses

        contractAddresses?: string[]
        +

        Optional contractAddresses

        contractAddresses?: string[]

        List of contract addresses to filter for - only applies to "erc20", "erc721", "erc1155" transfers. Defaults to all address if omitted.

        -

        Optional excludeZeroValue

        excludeZeroValue?: boolean
        +

        Optional excludeZeroValue

        excludeZeroValue?: boolean

        Whether to exclude transfers with zero value. Note that zero value is different than null value. Defaults to true if omitted.

        -

        Optional fromAddress

        fromAddress?: string
        +

        Optional fromAddress

        fromAddress?: string

        The from address to filter transfers by. This value defaults to a wildcard for all addresses if omitted.

        -

        Optional fromBlock

        fromBlock?: string
        +

        Optional fromBlock

        fromBlock?: string

        The starting block to check for transfers. This value is inclusive and defaults to 0x0 if omitted.

        -

        Optional maxCount

        maxCount?: number
        +

        Optional maxCount

        maxCount?: number

        The maximum number of results to return per page. Defaults to 1000 if omitted.

        -

        Optional order

        order?: SortingOrder
        +

        Optional order

        order?: SortingOrder

        Whether to return results in ascending or descending order by block number. Defaults to ascending if omitted.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing OwnedBaseNftsResponse AssetTransfersResultto use for pagination.

        -

        Optional toAddress

        toAddress?: string
        +

        Optional toAddress

        toAddress?: string

        The to address to filter transfers by. This value defaults to a wildcard for all address if omitted.

        -

        Optional toBlock

        toBlock?: string
        +

        Optional toBlock

        toBlock?: string

        The ending block to check for transfers. This value is inclusive and defaults to the latest block if omitted.

        -

        Optional withMetadata

        withMetadata?: boolean
        +

        Optional withMetadata

        withMetadata?: boolean

        Whether to include additional metadata about each transfer event. Defaults to false if omitted.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AssetTransfersResponse.html b/docs/interfaces/AssetTransfersResponse.html index 4d8e355f..ed1abd4f 100644 --- a/docs/interfaces/AssetTransfersResponse.html +++ b/docs/interfaces/AssetTransfersResponse.html @@ -1,5 +1,5 @@ AssetTransfersResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AssetTransfersResponse

        Response object for the CoreNamespace.getAssetTransfers method.

        -

        Hierarchy

        • AssetTransfersResponse

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string
        +

        Hierarchy

        • AssetTransfersResponse

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string

        Page key for the next page of results, if one exists.

        -

        transfers

        transfers: AssetTransfersResult[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        transfers

        transfers: AssetTransfersResult[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AssetTransfersResult.html b/docs/interfaces/AssetTransfersResult.html index 3b7c920d..b23318ae 100644 --- a/docs/interfaces/AssetTransfersResult.html +++ b/docs/interfaces/AssetTransfersResult.html @@ -1,31 +1,31 @@ AssetTransfersResult | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AssetTransfersResult

        Represents a transfer event that is returned in a AssetTransfersResponse.

        -

        Hierarchy

        Index

        Properties

        Properties

        asset

        asset: null | string
        +

        Hierarchy

        Index

        Properties

        Properties

        asset

        asset: null | string

        Returns the token's symbol or ETH for other transfers. null if the information was not available.

        -

        blockNum

        blockNum: string
        +

        blockNum

        blockNum: string

        The block number where the transfer occurred.

        -

        category

        category: AssetTransfersCategory
        +

        category

        category: AssetTransfersCategory

        The category of the transfer.

        -

        erc1155Metadata

        erc1155Metadata: null | ERC1155Metadata[]
        +

        erc1155Metadata

        erc1155Metadata: null | ERC1155Metadata[]

        A list of ERC1155 metadata objects if the asset transferred is an ERC1155 token. null if not an ERC1155 transfer.

        -

        erc721TokenId

        erc721TokenId: null | string
        +

        erc721TokenId

        erc721TokenId: null | string

        The raw ERC721 token id of the transfer as a hex string. null if not an ERC721 transfer.

        -

        from

        from: string
        +

        from

        from: string

        The from address of the transfer.

        -

        hash

        hash: string
        +

        hash

        hash: string

        The transaction hash of the transfer transaction.

        -

        rawContract

        rawContract: RawContract
        +

        rawContract

        rawContract: RawContract

        Information about the raw contract of the asset transferred.

        -

        to

        to: null | string
        +

        to

        to: null | string

        The to address of the transfer.

        -

        tokenId

        tokenId: null | string
        +

        tokenId

        tokenId: null | string

        The token id of the token transferred.

        -

        uniqueId

        uniqueId: string
        +

        uniqueId

        uniqueId: string

        The unique ID of the transfer.

        -

        value

        value: null | number
        +

        value

        value: null | number

        Converted asset transfer value as a number (raw value divided by contract decimal). null if ERC721 transfer or contract decimal not available.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AssetTransfersWithMetadataParams.html b/docs/interfaces/AssetTransfersWithMetadataParams.html index bd1fd4a6..c7cea561 100644 --- a/docs/interfaces/AssetTransfersWithMetadataParams.html +++ b/docs/interfaces/AssetTransfersWithMetadataParams.html @@ -1,35 +1,35 @@ AssetTransfersWithMetadataParams | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AssetTransfersWithMetadataParams

        Parameters for the CoreNamespace.getAssetTransfers method that includes metadata.

        -

        Hierarchy

        Index

        Properties

        Properties

        category

        category: AssetTransfersCategory[]
        +

        Hierarchy

        Index

        Properties

        Properties

        category

        category: AssetTransfersCategory[]

        REQUIRED field. An array of categories to get transfers for.

        -

        Optional contractAddresses

        contractAddresses?: string[]
        +

        Optional contractAddresses

        contractAddresses?: string[]

        List of contract addresses to filter for - only applies to "erc20", "erc721", "erc1155" transfers. Defaults to all address if omitted.

        -

        Optional excludeZeroValue

        excludeZeroValue?: boolean
        +

        Optional excludeZeroValue

        excludeZeroValue?: boolean

        Whether to exclude transfers with zero value. Note that zero value is different than null value. Defaults to true if omitted.

        -

        Optional fromAddress

        fromAddress?: string
        +

        Optional fromAddress

        fromAddress?: string

        The from address to filter transfers by. This value defaults to a wildcard for all addresses if omitted.

        -

        Optional fromBlock

        fromBlock?: string
        +

        Optional fromBlock

        fromBlock?: string

        The starting block to check for transfers. This value is inclusive and defaults to 0x0 if omitted.

        -

        Optional maxCount

        maxCount?: number
        +

        Optional maxCount

        maxCount?: number

        The maximum number of results to return per page. Defaults to 1000 if omitted.

        -

        Optional order

        order?: SortingOrder
        +

        Optional order

        order?: SortingOrder

        Whether to return results in ascending or descending order by block number. Defaults to ascending if omitted.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing OwnedBaseNftsResponse AssetTransfersResultto use for pagination.

        -

        Optional toAddress

        toAddress?: string
        +

        Optional toAddress

        toAddress?: string

        The to address to filter transfers by. This value defaults to a wildcard for all address if omitted.

        -

        Optional toBlock

        toBlock?: string
        +

        Optional toBlock

        toBlock?: string

        The ending block to check for transfers. This value is inclusive and defaults to the latest block if omitted.

        -

        withMetadata

        withMetadata: true
        +

        withMetadata

        withMetadata: true

        Whether to include additional metadata about each transfer event. Defaults to false if omitted.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AssetTransfersWithMetadataResponse.html b/docs/interfaces/AssetTransfersWithMetadataResponse.html index 0ff271bd..35075fa0 100644 --- a/docs/interfaces/AssetTransfersWithMetadataResponse.html +++ b/docs/interfaces/AssetTransfersWithMetadataResponse.html @@ -1,4 +1,4 @@ AssetTransfersWithMetadataResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AssetTransfersWithMetadataResponse

        Response object for the CoreNamespace.getAssetTransfers method when the AssetTransfersWithMetadataParams are used.

        -

        Hierarchy

        • AssetTransfersWithMetadataResponse

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string

        transfers

        transfers: AssetTransfersWithMetadataResult[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Hierarchy

        • AssetTransfersWithMetadataResponse

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string

        transfers

        transfers: AssetTransfersWithMetadataResult[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/AssetTransfersWithMetadataResult.html b/docs/interfaces/AssetTransfersWithMetadataResult.html index 46751cf1..f1ac1e7f 100644 --- a/docs/interfaces/AssetTransfersWithMetadataResult.html +++ b/docs/interfaces/AssetTransfersWithMetadataResult.html @@ -1,34 +1,34 @@ AssetTransfersWithMetadataResult | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface AssetTransfersWithMetadataResult

        Represents a transfer event that is returned in a AssetTransfersResponse when AssetTransfersWithMetadataParams are used.

        -

        Hierarchy

        Index

        Properties

        Properties

        asset

        asset: null | string
        +

        Hierarchy

        Index

        Properties

        Properties

        asset

        asset: null | string

        Returns the token's symbol or ETH for other transfers. null if the information was not available.

        -

        blockNum

        blockNum: string
        +

        blockNum

        blockNum: string

        The block number where the transfer occurred.

        -

        category

        category: AssetTransfersCategory
        +

        category

        category: AssetTransfersCategory

        The category of the transfer.

        -

        erc1155Metadata

        erc1155Metadata: null | ERC1155Metadata[]
        +

        erc1155Metadata

        erc1155Metadata: null | ERC1155Metadata[]

        A list of ERC1155 metadata objects if the asset transferred is an ERC1155 token. null if not an ERC1155 transfer.

        -

        erc721TokenId

        erc721TokenId: null | string
        +

        erc721TokenId

        erc721TokenId: null | string

        The raw ERC721 token id of the transfer as a hex string. null if not an ERC721 transfer.

        -

        from

        from: string
        +

        from

        from: string

        The from address of the transfer.

        -

        hash

        hash: string
        +

        hash

        hash: string

        The transaction hash of the transfer transaction.

        -

        metadata

        metadata: AssetTransfersMetadata
        +

        metadata

        metadata: AssetTransfersMetadata

        Additional metadata about the transfer event.

        -

        rawContract

        rawContract: RawContract
        +

        rawContract

        rawContract: RawContract

        Information about the raw contract of the asset transferred.

        -

        to

        to: null | string
        +

        to

        to: null | string

        The to address of the transfer.

        -

        tokenId

        tokenId: null | string
        +

        tokenId

        tokenId: null | string

        The token id of the token transferred.

        -

        uniqueId

        uniqueId: string
        +

        uniqueId

        uniqueId: string

        The unique ID of the transfer.

        -

        value

        value: null | number
        +

        value

        value: null | number

        Converted asset transfer value as a number (raw value divided by contract decimal). null if ERC721 transfer or contract decimal not available.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/BaseNft.html b/docs/interfaces/BaseNft.html index 780f1ab9..2a477d05 100644 --- a/docs/interfaces/BaseNft.html +++ b/docs/interfaces/BaseNft.html @@ -3,8 +3,8 @@

        The BaseNft object does not hold any metadata information and only contains the NFT contract and token ID. The Nft object additionally contains the NFT metadata, token URI information, and media.

        -

        Hierarchy

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string
        +

        Hierarchy

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        The contract address of the NFT.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/BaseNftCollection.html b/docs/interfaces/BaseNftCollection.html index 40ef9aa3..6fd1e7b7 100644 --- a/docs/interfaces/BaseNftCollection.html +++ b/docs/interfaces/BaseNftCollection.html @@ -1,11 +1,11 @@ BaseNftCollection | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface BaseNftCollection

        A base collection object as part of an Nft.

        -

        Hierarchy

        • BaseNftCollection

        Index

        Properties

        Properties

        Optional bannerImageUrl

        bannerImageUrl?: string
        +

        Hierarchy

        • BaseNftCollection

        Index

        Properties

        Properties

        Optional bannerImageUrl

        bannerImageUrl?: string

        The banner image URL for the collection.

        -

        Optional externalUrl

        externalUrl?: string
        +

        Optional externalUrl

        externalUrl?: string

        The external URL for the collection.

        -

        name

        name: string
        +

        name

        name: string

        The name of the collection.

        -

        Optional slug

        slug?: string
        +

        Optional slug

        slug?: string

        The OpenSea human-readable slug of the collection.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/ComputeRarityResponse.html b/docs/interfaces/ComputeRarityResponse.html index dcc5c0e0..6adac4ab 100644 --- a/docs/interfaces/ComputeRarityResponse.html +++ b/docs/interfaces/ComputeRarityResponse.html @@ -1,3 +1,3 @@ ComputeRarityResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ComputeRarityResponse

        Response object for the NftNamespace.computeRarity method.

        -

        Hierarchy

        • ComputeRarityResponse

        Index

        Properties

        Properties

        rarities

        rarities: NftAttributeRarity[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Hierarchy

        Index

        Properties

        Properties

        rarities

        rarities: NftAttributeRarity[]

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/CustomGraphqlWebhook.html b/docs/interfaces/CustomGraphqlWebhook.html index c2e4607c..1e678244 100644 --- a/docs/interfaces/CustomGraphqlWebhook.html +++ b/docs/interfaces/CustomGraphqlWebhook.html @@ -3,23 +3,23 @@ minting, burning, approvals, etc.) This can be used to notify your app with real time changes whenever an EOA or a smart contract performs any action on-chain.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string

        The app id of the app used for the webhook. This field is only present on MinedTransactionWebhook and DroppedTransactionWebhook

        -

        id

        id: string
        +

        id

        id: string

        The webhook's unique id.

        -

        isActive

        isActive: boolean
        +

        isActive

        isActive: boolean

        Whether the webhook is currently active

        -

        network

        network: Network
        +

        network

        network: Network

        The network the webhook is on.

        -

        signingKey

        signingKey: string
        +

        signingKey

        signingKey: string

        The signing key used to verify payloads for the webhook.

        -

        timeCreated

        timeCreated: string
        +

        timeCreated

        timeCreated: string

        The creation time of the webhook as an ISO string.

        -

        type

        type: GRAPHQL
        +

        type

        type: GRAPHQL

        The type of webhook.

        -

        url

        url: string
        +

        url

        url: string

        The url that the webhook sends its payload to.

        -

        version

        version: WebhookVersion
        +

        version

        version: WebhookVersion

        The webhook version. All newly created webhooks default to V2.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/CustomGraphqlWebhookConfig.html b/docs/interfaces/CustomGraphqlWebhookConfig.html index 31423755..b000d2cb 100644 --- a/docs/interfaces/CustomGraphqlWebhookConfig.html +++ b/docs/interfaces/CustomGraphqlWebhookConfig.html @@ -1,5 +1,5 @@ CustomGraphqlWebhookConfig | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface CustomGraphqlWebhookConfig

        Response object for the NotifyNamespace.getGraphqlQuery method.

        -

        Hierarchy

        • CustomGraphqlWebhookConfig

        Index

        Properties

        Properties

        graphqlQuery

        graphqlQuery: string
        +

        Hierarchy

        • CustomGraphqlWebhookConfig

        Index

        Properties

        Properties

        graphqlQuery

        graphqlQuery: string

        The graphql query for the webhook.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/CustomGraphqlWebhookParams.html b/docs/interfaces/CustomGraphqlWebhookParams.html index 70e69082..db66426d 100644 --- a/docs/interfaces/CustomGraphqlWebhookParams.html +++ b/docs/interfaces/CustomGraphqlWebhookParams.html @@ -1,9 +1,9 @@ CustomGraphqlWebhookParams | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface CustomGraphqlWebhookParams

        Params to pass in when calling NotifyNamespace.createWebhook in order to create a CustomGraphqlWebhook

        -

        Hierarchy

        • CustomGraphqlWebhookParams

        Index

        Properties

        Properties

        graphqlQuery

        graphqlQuery: string
        +

        Hierarchy

        • CustomGraphqlWebhookParams

        Index

        Properties

        Properties

        graphqlQuery

        graphqlQuery: string

        GraphQL query

        -

        Optional network

        network?: Network
        +

        Optional network

        network?: Network

        Optional network to create the webhook on. If omitted, the webhook will be created on network of the app provided in the api key config.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DebugCallTrace.html b/docs/interfaces/DebugCallTrace.html index 30ac6d83..9497de4c 100644 --- a/docs/interfaces/DebugCallTrace.html +++ b/docs/interfaces/DebugCallTrace.html @@ -1,25 +1,25 @@ DebugCallTrace | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DebugCallTrace

        Debug result returned when using a DebugCallTracer.

        -

        Hierarchy

        • DebugCallTrace

        Index

        Properties

        Properties

        Optional calls

        calls?: DebugCallTrace[]
        +

        Hierarchy

        • DebugCallTrace

        Index

        Properties

        Properties

        Optional calls

        calls?: DebugCallTrace[]

        Array of sub-calls executed as part of the original call.

        -

        Optional error

        error?: string
        +

        Optional error

        error?: string

        Optional error field.

        -

        from

        from: string
        +

        from

        from: string

        From address of the transaction.

        -

        gas

        gas: string
        +

        gas

        gas: string

        Gas provided for call as a hex string.

        -

        gasUsed

        gasUsed: string
        +

        gasUsed

        gasUsed: string

        Gas used during the call as a hex string.

        -

        input

        input: string
        +

        input

        input: string

        Call data.

        -

        output

        output: string
        +

        output

        output: string

        Return data.

        -

        Optional revertReason

        revertReason?: string
        +

        Optional revertReason

        revertReason?: string

        Solidity revert reason, if the call reverted.

        -

        to

        to: string
        +

        to

        to: string

        To address of the transaction.

        -

        type

        type: string
        +

        type

        type: string

        The type of call: CALL or CREATE for the top-level call.

        -

        value

        value: string
        +

        value

        value: string

        Amount of value transfer as a hex string.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DebugCallTracer.html b/docs/interfaces/DebugCallTracer.html index 7c7ce9eb..1a50b9cc 100644 --- a/docs/interfaces/DebugCallTracer.html +++ b/docs/interfaces/DebugCallTracer.html @@ -10,9 +10,9 @@
      • In case the top level frame reverts, its revertReason field will contain the parsed reason of revert as returned by the Solidity contract
        • -

        Hierarchy

        Index

        Properties

        Properties

        Optional onlyTopCall

        onlyTopCall?: boolean
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional onlyTopCall

        onlyTopCall?: boolean

        Whether to only trace the main (top-level) calls and ignore sub-calls. Defaults to false.

        -

        type

        type: CALL_TRACER
        +

        type

        type: CALL_TRACER

        Specified type is CALL_TRACER.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DebugPrestate.html b/docs/interfaces/DebugPrestate.html index 65925c65..b57af1a6 100644 --- a/docs/interfaces/DebugPrestate.html +++ b/docs/interfaces/DebugPrestate.html @@ -1,11 +1,11 @@ DebugPrestate | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DebugPrestate

        The

        -

        Hierarchy

        • DebugPrestate

        Index

        Properties

        Properties

        balance

        balance: string
        +

        Hierarchy

        • DebugPrestate

        Index

        Properties

        Properties

        balance

        balance: string

        Balance of the account in wei as a hex string.

        -

        code

        code: string
        +

        code

        code: string

        Hex-encoded bytecode.

        -

        nonce

        nonce: number
        +

        nonce

        nonce: number

        Nonce

        -

        storage

        storage: Record<string, string>
        +

        storage

        storage: Record<string, string>

        Storage slots of the contract.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DebugPrestateTracer.html b/docs/interfaces/DebugPrestateTracer.html index aa96365f..01ff4c04 100644 --- a/docs/interfaces/DebugPrestateTracer.html +++ b/docs/interfaces/DebugPrestateTracer.html @@ -5,9 +5,9 @@

        Returns a DebugPrestateTrace. This contains sufficient information to create a local execution of the transaction from a custom assembled genesis block.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional onlyTopCall

        onlyTopCall?: boolean
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional onlyTopCall

        onlyTopCall?: boolean

        Whether to only trace the main (top-level) calls and ignore sub-calls. Defaults to false.

        -

        type

        type: PRESTATE_TRACER
        +

        type

        type: PRESTATE_TRACER

        Specified type is PRESTATE_TRACER.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DebugTransaction.html b/docs/interfaces/DebugTransaction.html index faffa5a8..92af3219 100644 --- a/docs/interfaces/DebugTransaction.html +++ b/docs/interfaces/DebugTransaction.html @@ -1,15 +1,15 @@ DebugTransaction | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DebugTransaction

        Transaction object used in DebugNamespace.traceCall, TransactNamespace.simulateAssetChanges and TransactNamespace.simulateExecution.

        -

        Hierarchy

        • DebugTransaction

        Index

        Properties

        Properties

        Optional data

        data?: string
        +

        Hierarchy

        • DebugTransaction

        Index

        Properties

        Properties

        Optional data

        data?: string

        The data associated with the transaction.

        -

        Optional from

        from?: string
        +

        Optional from

        from?: string

        The address the transaction is sent from.

        -

        Optional gas

        gas?: string
        +

        Optional gas

        gas?: string

        The gas provided for the transaction execution, as a hex string.

        -

        Optional gasPrice

        gasPrice?: string
        +

        Optional gasPrice

        gasPrice?: string

        The gas price to use as a hex string.

        -

        Optional to

        to?: string
        +

        Optional to

        to?: string

        The address the transaction is directed to.

        -

        Optional value

        value?: string
        +

        Optional value

        value?: string

        The value associated with the transaction as a hex string.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DecodedCallParam.html b/docs/interfaces/DecodedCallParam.html index f46d315d..c4c44775 100644 --- a/docs/interfaces/DecodedCallParam.html +++ b/docs/interfaces/DecodedCallParam.html @@ -1,9 +1,9 @@ DecodedCallParam | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DecodedCallParam

        The input or output parameters from a DecodedDebugCallTrace.

        -

        Hierarchy

        Index

        Properties

        Properties

        name

        name: string
        +

        Hierarchy

        Index

        Properties

        Properties

        name

        name: string

        The name of the parameter.

        -

        type

        type: string
        +

        type

        type: string

        The type of the parameter.

        -

        value

        value: string
        +

        value

        value: string

        Value of the parameter.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DecodedDebugCallTrace.html b/docs/interfaces/DecodedDebugCallTrace.html index cbd073a5..e388ae98 100644 --- a/docs/interfaces/DecodedDebugCallTrace.html +++ b/docs/interfaces/DecodedDebugCallTrace.html @@ -1,12 +1,12 @@ DecodedDebugCallTrace | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DecodedDebugCallTrace

        Decoded representation of the call trace that is part of a SimulationCallTrace.

        -

        Hierarchy

        • DecodedDebugCallTrace

        Index

        Properties

        Properties

        authority

        authority: ETHERSCAN
        +

        Hierarchy

        • DecodedDebugCallTrace

        Index

        Properties

        Properties

        authority

        authority: ETHERSCAN

        The source used to provide the decoded call trace.

        -

        inputs

        inputs: DecodedCallParam[]
        +

        inputs

        inputs: DecodedCallParam[]

        Method inputs.

        -

        methodName

        methodName: string
        +

        methodName

        methodName: string

        The smart contract method called.

        -

        outputs

        outputs: DecodedCallParam[]
        +

        outputs

        outputs: DecodedCallParam[]

        Method outputs.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DecodedLog.html b/docs/interfaces/DecodedLog.html index 45aad9d3..10adc8a4 100644 --- a/docs/interfaces/DecodedLog.html +++ b/docs/interfaces/DecodedLog.html @@ -1,10 +1,10 @@ DecodedLog | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DecodedLog

        Decoded representation of the debug log that is part of a SimulationDebugLog.

        -

        Hierarchy

        • DecodedLog

        Index

        Properties

        Properties

        authority

        authority: ETHERSCAN
        +

        Hierarchy

        • DecodedLog

        Index

        Properties

        Properties

        authority

        authority: ETHERSCAN

        The source used to provide the decoded log.

        -

        eventName

        eventName: string
        +

        eventName

        eventName: string

        The decoded name of the log event.

        -

        inputs

        inputs: DecodedLogInput[]
        +

        inputs

        inputs: DecodedLogInput[]

        The decoded inputs to the log.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DecodedLogInput.html b/docs/interfaces/DecodedLogInput.html index 0a22b6cc..a21542eb 100644 --- a/docs/interfaces/DecodedLogInput.html +++ b/docs/interfaces/DecodedLogInput.html @@ -1,11 +1,11 @@ DecodedLogInput | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DecodedLogInput

        The input parameters from a DecodedLog.

        -

        Hierarchy

        Index

        Properties

        Properties

        indexed

        indexed: boolean
        +

        Hierarchy

        Index

        Properties

        Properties

        indexed

        indexed: boolean

        Whether the log is marked as indexed in the smart contract.

        -

        name

        name: string
        +

        name

        name: string

        The name of the parameter.

        -

        type

        type: string
        +

        type

        type: string

        The type of the parameter.

        -

        value

        value: string
        +

        value

        value: string

        Value of the parameter.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DeployResult.html b/docs/interfaces/DeployResult.html index 61b308f2..2c72dece 100644 --- a/docs/interfaces/DeployResult.html +++ b/docs/interfaces/DeployResult.html @@ -1,7 +1,7 @@ DeployResult | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DeployResult

        The response object for the findContractDeployer function.

        -

        Hierarchy

        • DeployResult

        Index

        Properties

        Properties

        blockNumber

        blockNumber: number
        +

        Hierarchy

        • DeployResult

        Index

        Properties

        Properties

        blockNumber

        blockNumber: number

        The block number the contract was deployed in.

        -

        Optional deployerAddress

        deployerAddress?: string
        +

        Optional deployerAddress

        deployerAddress?: string

        The address of the contract deployer, if it is available.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DisplayNftForContract.html b/docs/interfaces/DisplayNftForContract.html index 3bf6a469..5fd32c3a 100644 --- a/docs/interfaces/DisplayNftForContract.html +++ b/docs/interfaces/DisplayNftForContract.html @@ -1,7 +1,7 @@ DisplayNftForContract | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DisplayNftForContract

        Sample owned NFT on a NftContract, used to display placeholder info.

        -

        Hierarchy

        • DisplayNftForContract

        Index

        Properties

        Properties

        Optional name

        name?: string
        +

        Hierarchy

        • DisplayNftForContract

        Index

        Properties

        Properties

        Optional name

        name?: string

        The name of the NFT, if available.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        A token id of an NFT owned by the owner on the contract.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/DroppedTransactionWebhook.html b/docs/interfaces/DroppedTransactionWebhook.html index 990ba81b..1b1dedf6 100644 --- a/docs/interfaces/DroppedTransactionWebhook.html +++ b/docs/interfaces/DroppedTransactionWebhook.html @@ -2,23 +2,23 @@

        A Dropped Transaction webhook is used to notify your app whenever a transaction sent through your API key gets dropped. This can be useful if you want to notify customers that their transactions were dropped.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string

        The app id of the app used for the webhook. This field is only present on MinedTransactionWebhook and DroppedTransactionWebhook

        -

        id

        id: string
        +

        id

        id: string

        The webhook's unique id.

        -

        isActive

        isActive: boolean
        +

        isActive

        isActive: boolean

        Whether the webhook is currently active

        -

        network

        network: Network
        +

        network

        network: Network

        The network the webhook is on.

        -

        signingKey

        signingKey: string
        +

        signingKey

        signingKey: string

        The signing key used to verify payloads for the webhook.

        -

        timeCreated

        timeCreated: string
        +

        timeCreated

        timeCreated: string

        The creation time of the webhook as an ISO string.

        -

        type

        type: DROPPED_TRANSACTION
        +

        type

        type: DROPPED_TRANSACTION

        The type of webhook.

        -

        url

        url: string
        +

        url

        url: string

        The url that the webhook sends its payload to.

        -

        version

        version: WebhookVersion
        +

        version

        version: WebhookVersion

        The webhook version. All newly created webhooks default to V2.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/ERC1155Metadata.html b/docs/interfaces/ERC1155Metadata.html index 46d677de..72e52174 100644 --- a/docs/interfaces/ERC1155Metadata.html +++ b/docs/interfaces/ERC1155Metadata.html @@ -1,4 +1,4 @@ ERC1155Metadata | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ERC1155Metadata

        Metadata object returned in a AssetTransfersResult object if the asset transferred is an ERC1155.

        -

        Hierarchy

        • ERC1155Metadata

        Index

        Properties

        Properties

        tokenId

        tokenId: string

        value

        value: string

        Generated using TypeDoc

        \ No newline at end of file +

        Hierarchy

        Index

        Properties

        Properties

        tokenId

        tokenId: string

        value

        value: string

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/EventFilter.html b/docs/interfaces/EventFilter.html index 334bf779..f5112336 100644 --- a/docs/interfaces/EventFilter.html +++ b/docs/interfaces/EventFilter.html @@ -1,7 +1,7 @@ EventFilter | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface EventFilter

        Filter object used to filter logs by when using CoreNamespace.getLogs

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional address

        address?: string | string[]
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional address

        address?: string | string[]

        The address to filter by. If omitted, filters for all addresses.

        -

        Optional topics

        topics?: (null | string | string[])[]
        +

        Optional topics

        topics?: (null | string | string[])[]

        The topics to filter by, or null to match any topics.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/Filter.html b/docs/interfaces/Filter.html index a2b0929e..12d65890 100644 --- a/docs/interfaces/Filter.html +++ b/docs/interfaces/Filter.html @@ -1,12 +1,12 @@ Filter | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Filter

        Filter object used to filter logs by block number range when using CoreNamespace.getLogs

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional address

        address?: string | string[]
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional address

        address?: string | string[]

        The address to filter by. If omitted, filters for all addresses.

        -

        Optional fromBlock

        fromBlock?: BlockTag
        +

        Optional fromBlock

        fromBlock?: BlockTag

        The starting block (inclusive) to search for logs matching the filter.

        -

        Optional toBlock

        toBlock?: BlockTag
        +

        Optional toBlock

        toBlock?: BlockTag

        The end block (inclusive) to search for logs matching the filter.

        -

        Optional topics

        topics?: (null | string | string[])[]
        +

        Optional topics

        topics?: (null | string | string[])[]

        The topics to filter by, or null to match any topics.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/FilterByBlockHash.html b/docs/interfaces/FilterByBlockHash.html index e84f7882..30b69e18 100644 --- a/docs/interfaces/FilterByBlockHash.html +++ b/docs/interfaces/FilterByBlockHash.html @@ -1,10 +1,10 @@ FilterByBlockHash | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface FilterByBlockHash

        Filter object used to filter logs by a specific block hash when using CoreNamespace.getLogs.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional address

        address?: string | string[]
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional address

        address?: string | string[]

        The address to filter by. If omitted, filters for all addresses.

        -

        Optional blockHash

        blockHash?: string
        +

        Optional blockHash

        blockHash?: string

        The specific block hash to search for logs matching the filter.

        -

        Optional topics

        topics?: (null | string | string[])[]
        +

        Optional topics

        topics?: (null | string | string[])[]

        The topics to filter by, or null to match any topics.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/FloorPriceError.html b/docs/interfaces/FloorPriceError.html index a5062459..3575567e 100644 --- a/docs/interfaces/FloorPriceError.html +++ b/docs/interfaces/FloorPriceError.html @@ -1,6 +1,6 @@ FloorPriceError | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface FloorPriceError

        The failing object returned by the getFloorPrice call for each marketplace (e.g. looksRare).

        -

        Hierarchy

        • FloorPriceError

        Index

        Properties

        Properties

        error

        error: string
        +

        Hierarchy

        • FloorPriceError

        Index

        Properties

        Properties

        error

        error: string

        Error fetching floor prices from the given marketplace

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/FloorPriceMarketplace.html b/docs/interfaces/FloorPriceMarketplace.html index 24f91ff3..7f1483c9 100644 --- a/docs/interfaces/FloorPriceMarketplace.html +++ b/docs/interfaces/FloorPriceMarketplace.html @@ -1,12 +1,12 @@ FloorPriceMarketplace | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface FloorPriceMarketplace

        The successful object returned by the getFloorPrice call for each marketplace (e.g. looksRare).

        -

        Hierarchy

        • FloorPriceMarketplace

        Index

        Properties

        Properties

        collectionUrl

        collectionUrl: string
        +

        Hierarchy

        • FloorPriceMarketplace

        Index

        Properties

        Properties

        collectionUrl

        collectionUrl: string

        The link to the collection on the given marketplace

        -

        floorPrice

        floorPrice: number
        +

        floorPrice

        floorPrice: number

        The floor price of the collection on the given marketplace

        -

        priceCurrency

        priceCurrency: string
        +

        priceCurrency

        priceCurrency: string

        The currency in which the floor price is denominated

        -

        retrievedAt

        retrievedAt: string
        +

        retrievedAt

        retrievedAt: string

        UTC timestamp of when the floor price was retrieved from the marketplace

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetAddressesOptions.html b/docs/interfaces/GetAddressesOptions.html index 5e6a2d6e..9e63bcf0 100644 --- a/docs/interfaces/GetAddressesOptions.html +++ b/docs/interfaces/GetAddressesOptions.html @@ -1,7 +1,7 @@ GetAddressesOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetAddressesOptions

        Options object for the NotifyNamespace.getAddresses method.

        -

        Hierarchy

        • GetAddressesOptions

        Index

        Properties

        Properties

        Optional limit

        limit?: number
        +

        Hierarchy

        • GetAddressesOptions

        Index

        Properties

        Properties

        Optional limit

        limit?: number

        Number of addresses to fetch.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Page

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetAllWebhooksResponse.html b/docs/interfaces/GetAllWebhooksResponse.html index 7a1675c5..6bfc0c0e 100644 --- a/docs/interfaces/GetAllWebhooksResponse.html +++ b/docs/interfaces/GetAllWebhooksResponse.html @@ -1,7 +1,7 @@ GetAllWebhooksResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetAllWebhooksResponse

        The response for a NotifyNamespace.getAllWebhooks method.

        -

        Hierarchy

        • GetAllWebhooksResponse

        Index

        Properties

        Properties

        totalCount

        totalCount: number
        +

        Hierarchy

        • GetAllWebhooksResponse

        Index

        Properties

        Properties

        totalCount

        totalCount: number

        The total number of webhooks.

        -

        webhooks

        webhooks: Webhook[]
        +

        webhooks

        webhooks: Webhook[]

        All webhooks attached to the provided auth token.

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetBaseNftsForContractOptions.html b/docs/interfaces/GetBaseNftsForContractOptions.html index 9ee6eb89..62d1427f 100644 --- a/docs/interfaces/GetBaseNftsForContractOptions.html +++ b/docs/interfaces/GetBaseNftsForContractOptions.html @@ -3,15 +3,15 @@ getNftsForContractIterator functions.

        This interface is used to fetch NFTs without their associated metadata. To get Nfts with their associated metadata, use GetNftsForContractOptions.

        -

        Hierarchy

        Index

        Properties

        Properties

        omitMetadata

        omitMetadata: false
        +

        Hierarchy

        Index

        Properties

        Properties

        omitMetadata

        omitMetadata: false

        Optional boolean flag to omit NFT metadata. Defaults to false.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing NftContractBaseNftsResponse or NftContractNftsResponseto use for pagination.

        -

        Optional pageSize

        pageSize?: number
        +

        Optional pageSize

        pageSize?: number

        Sets the total number of NFTs to return in the response. Defaults to 100. Maximum page size is 100.

        -

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number
        +

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number

        No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any diff --git a/docs/interfaces/GetBaseNftsForOwnerOptions.html b/docs/interfaces/GetBaseNftsForOwnerOptions.html index b9e4f4b9..ff68300a 100644 --- a/docs/interfaces/GetBaseNftsForOwnerOptions.html +++ b/docs/interfaces/GetBaseNftsForOwnerOptions.html @@ -3,26 +3,26 @@ getNftsForOwnerIterator functions.

        This interface is used to fetch NFTs without their associated metadata. To get Nfts with their associated metadata, use GetNftsForOwnerOptions.

        -

        Hierarchy

        • GetBaseNftsForOwnerOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[]
        +

        Hierarchy

        • GetBaseNftsForOwnerOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[]

        Optional list of contract addresses to filter the results by. Limit is 20.

        -

        Optional excludeFilters

        excludeFilters?: NftFilters[]
        +

        Optional excludeFilters

        excludeFilters?: NftFilters[]

        Optional list of filters applied to the query. NFTs that match one or more of these filters are excluded from the response.

        -

        Optional includeFilters

        includeFilters?: NftFilters[]
        +

        Optional includeFilters

        includeFilters?: NftFilters[]

        Optional list of filters applied to the query. NFTs that match one or more of these filters are included in the response.

        -

        omitMetadata

        omitMetadata: true
        +

        omitMetadata

        omitMetadata: true

        Optional boolean flag to include NFT metadata. Defaults to false.

        -

        Optional orderBy

        orderBy?: TRANSFERTIME
        +

        Optional orderBy

        orderBy?: TRANSFERTIME

        Order in which to return results. By default, results are ordered by contract address and token ID in lexicographic order.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing OwnedBaseNftsResponse or OwnedNftsResponseto use for pagination.

        -

        Optional pageSize

        pageSize?: number
        +

        Optional pageSize

        pageSize?: number

        Sets the total number of NFTs to return in the response. Defaults to 100. Maximum page size is 100.

        -

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number
        +

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number

        No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any diff --git a/docs/interfaces/GetContractMetadataBatchResponse.html b/docs/interfaces/GetContractMetadataBatchResponse.html index ec9ce11d..6f293afd 100644 --- a/docs/interfaces/GetContractMetadataBatchResponse.html +++ b/docs/interfaces/GetContractMetadataBatchResponse.html @@ -1 +1 @@ -GetContractMetadataBatchResponse | alchemy-sdk

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetContractMetadataBatchResponse

        Hierarchy

        • GetContractMetadataBatchResponse

        Index

        Properties

        Properties

        contracts

        contracts: NftContract[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +GetContractMetadataBatchResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetContractMetadataBatchResponse

        Hierarchy

        • GetContractMetadataBatchResponse

        Index

        Properties

        Properties

        contracts

        contracts: NftContract[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetContractsForOwnerOptions.html b/docs/interfaces/GetContractsForOwnerOptions.html index 7edb3490..e81f4a4c 100644 --- a/docs/interfaces/GetContractsForOwnerOptions.html +++ b/docs/interfaces/GetContractsForOwnerOptions.html @@ -1,19 +1,19 @@ GetContractsForOwnerOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetContractsForOwnerOptions

        Optional parameters object for the getContractsForOwner method

        -

        Hierarchy

        • GetContractsForOwnerOptions

        Index

        Properties

        Properties

        Optional excludeFilters

        excludeFilters?: NftFilters[]
        +

        Hierarchy

        • GetContractsForOwnerOptions

        Index

        Properties

        Properties

        Optional excludeFilters

        excludeFilters?: NftFilters[]

        Optional list of filters applied to the query. NFTs that match one or more of these filters are excluded from the response. May not be used in conjunction with includeFilters

        -

        Optional includeFilters

        includeFilters?: NftFilters[]
        +

        Optional includeFilters

        includeFilters?: NftFilters[]

        Optional list of filters applied to the query. NFTs that match one or more of these filters are included in the response. May not be used in conjunction with excludeFilters.

        -

        Optional orderBy

        orderBy?: TRANSFERTIME
        +

        Optional orderBy

        orderBy?: TRANSFERTIME

        Order in which to return results. By default, results are ordered by contract address and token ID in lexicographic order.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Key for pagination to use to fetch results from the next page if available.

        -

        Optional pageSize

        pageSize?: number
        +

        Optional pageSize

        pageSize?: number

        Configure the number of NFTs to return in each response. Maximum pages size is 100. Defaults to 100.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetContractsForOwnerResponse.html b/docs/interfaces/GetContractsForOwnerResponse.html index 17e62ba2..32d5b02a 100644 --- a/docs/interfaces/GetContractsForOwnerResponse.html +++ b/docs/interfaces/GetContractsForOwnerResponse.html @@ -1,9 +1,9 @@ GetContractsForOwnerResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetContractsForOwnerResponse

        The response for the NftNamespace.getContractsForOwner method.

        -

        Hierarchy

        • GetContractsForOwnerResponse

        Index

        Properties

        Properties

        contracts

        contracts: NftContractForOwner[]
        +

        Hierarchy

        • GetContractsForOwnerResponse

        Index

        Properties

        Properties

        contracts

        contracts: NftContractForOwner[]

        The list of contracts, that match the query, held by the given address.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Key for pagination to use to fetch results from the next page if available.

        -

        totalCount

        totalCount: number
        +

        totalCount

        totalCount: number

        Total number of NFT contracts held by the given address.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetFloorPriceResponse.html b/docs/interfaces/GetFloorPriceResponse.html index 70441804..3cb0be45 100644 --- a/docs/interfaces/GetFloorPriceResponse.html +++ b/docs/interfaces/GetFloorPriceResponse.html @@ -1,6 +1,6 @@ GetFloorPriceResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetFloorPriceResponse

        The response object for the getFloorPrice method.

        -

        Hierarchy

        • GetFloorPriceResponse

        Index

        Properties

        Properties

        looksRare

        looksRare: FloorPriceMarketplace | FloorPriceError

        openSea

        openSea: FloorPriceMarketplace | FloorPriceError
        +

        Hierarchy

        • GetFloorPriceResponse

        Index

        Properties

        Properties

        looksRare

        looksRare: FloorPriceMarketplace | FloorPriceError

        openSea

        openSea: FloorPriceMarketplace | FloorPriceError

        Name of the NFT marketplace where the collection is listed. Current marketplaces supported: OpenSea, LooksRare

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetMintedNftsOptions.html b/docs/interfaces/GetMintedNftsOptions.html index c5eadb04..3ae91152 100644 --- a/docs/interfaces/GetMintedNftsOptions.html +++ b/docs/interfaces/GetMintedNftsOptions.html @@ -1,12 +1,12 @@ GetMintedNftsOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetMintedNftsOptions

        Optional parameters object for the NftNamespace.getMintedNfts method.

        -

        Hierarchy

        • GetMintedNftsOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[]
        +

        Hierarchy

        • GetMintedNftsOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[]

        List of NFT contract addresses to filter mints by. If omitted, defaults to all contract addresses.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing TransfersNftResponse to use for pagination.

        -

        Optional tokenType

        tokenType?: ERC721 | ERC1155
        +

        Optional tokenType

        tokenType?: ERC721 | ERC1155

        Filter mints by ERC721 vs ERC1155 contracts. If omitted, defaults to all NFTs.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetNftMetadataBatchResponse.html b/docs/interfaces/GetNftMetadataBatchResponse.html index 051a93cb..153af145 100644 --- a/docs/interfaces/GetNftMetadataBatchResponse.html +++ b/docs/interfaces/GetNftMetadataBatchResponse.html @@ -1,3 +1,3 @@ -GetNftMetadataBatchResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetNftMetadataBatchResponse

        Hierarchy

        • GetNftMetadataBatchResponse

        Index

        Properties

        Properties

        nfts

        nfts: Nft[]
        +GetNftMetadataBatchResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetNftMetadataBatchResponse

        Hierarchy

        • GetNftMetadataBatchResponse

        Index

        Properties

        Properties

        nfts

        nfts: Nft[]

        An array of NFT metadata objects.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetNftMetadataOptions.html b/docs/interfaces/GetNftMetadataOptions.html index d4a0fd97..7ff89cbd 100644 --- a/docs/interfaces/GetNftMetadataOptions.html +++ b/docs/interfaces/GetNftMetadataOptions.html @@ -1,11 +1,11 @@ GetNftMetadataOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetNftMetadataOptions

        Additional options for the NftNamespace.getNftMetadata method.

        -

        Hierarchy

        • GetNftMetadataOptions

        Index

        Properties

        Properties

        Optional refreshCache

        refreshCache?: boolean
        +

        Hierarchy

        • GetNftMetadataOptions

        Index

        Properties

        Properties

        Optional refreshCache

        refreshCache?: boolean

        Whether to refresh the metadata for the given NFT token before returning the response. Defaults to false for faster response times.

        -

        Optional tokenType

        tokenType?: NftTokenType
        +

        Optional tokenType

        tokenType?: NftTokenType

        Optional field to specify the type of token to speed up the query.

        -

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number
        +

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number

        No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any diff --git a/docs/interfaces/GetNftSalesOptions.html b/docs/interfaces/GetNftSalesOptions.html index b16d2e12..a46b79a5 100644 --- a/docs/interfaces/GetNftSalesOptions.html +++ b/docs/interfaces/GetNftSalesOptions.html @@ -1,23 +1,23 @@ GetNftSalesOptions | alchemy-sdk

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetNftSalesOptions

        Optional parameters object for the NftNamespace.getNftSales method.

        This interface is used to filter the NFT sales data.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional buyerAddress

        buyerAddress?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional buyerAddress

        buyerAddress?: string

        The address of the NFT buyer to filter sales by.

        -

        Optional fromBlock

        fromBlock?: number | "latest"
        +

        Optional fromBlock

        fromBlock?: number | "latest"

        The block number to start fetching NFT sales data from.

        -

        Optional limit

        limit?: number
        +

        Optional limit

        limit?: number

        The maximum number of NFT sales to return.

        -

        Optional marketplace

        marketplace?: NftSaleMarketplace
        +

        Optional marketplace

        marketplace?: NftSaleMarketplace

        The NFT marketplace to filter sales by.

        -

        Optional order

        order?: SortingOrder
        +

        Optional order

        order?: SortingOrder

        Whether to return the results in ascending or descending order by block number.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Key for pagination to use to fetch results from the next page if available.

        -

        Optional sellerAddress

        sellerAddress?: string
        +

        Optional sellerAddress

        sellerAddress?: string

        The address of the NFT seller to filter sales by.

        -

        Optional taker

        taker?: NftSaleTakerType
        +

        Optional taker

        taker?: NftSaleTakerType

        Filter by whether the buyer or seller was the taker in the NFT trade. Defaults to returning both buyer and seller taker trades.

        -

        Optional toBlock

        toBlock?: number | "latest"
        +

        Optional toBlock

        toBlock?: number | "latest"

        The block number limit to fetch NFT sales data from.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetNftSalesOptionsByContractAddress.html b/docs/interfaces/GetNftSalesOptionsByContractAddress.html index 2a4dcedd..6f1eacbf 100644 --- a/docs/interfaces/GetNftSalesOptionsByContractAddress.html +++ b/docs/interfaces/GetNftSalesOptionsByContractAddress.html @@ -2,27 +2,27 @@

        Alternative optional parameters object for the NftNamespace.getNftSales method that allows filtering results by contractAddress.

        This interface is used to filter the NFT sales data.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional buyerAddress

        buyerAddress?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional buyerAddress

        buyerAddress?: string

        The address of the NFT buyer to filter sales by.

        -

        contractAddress

        contractAddress: string
        +

        contractAddress

        contractAddress: string

        The contract address of a NFT collection to filter sales by.

        -

        Optional fromBlock

        fromBlock?: number | "latest"
        +

        Optional fromBlock

        fromBlock?: number | "latest"

        The block number to start fetching NFT sales data from.

        -

        Optional limit

        limit?: number
        +

        Optional limit

        limit?: number

        The maximum number of NFT sales to return.

        -

        Optional marketplace

        marketplace?: NftSaleMarketplace
        +

        Optional marketplace

        marketplace?: NftSaleMarketplace

        The NFT marketplace to filter sales by.

        -

        Optional order

        order?: SortingOrder
        +

        Optional order

        order?: SortingOrder

        Whether to return the results in ascending or descending order by block number.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Key for pagination to use to fetch results from the next page if available.

        -

        Optional sellerAddress

        sellerAddress?: string
        +

        Optional sellerAddress

        sellerAddress?: string

        The address of the NFT seller to filter sales by.

        -

        Optional taker

        taker?: NftSaleTakerType
        +

        Optional taker

        taker?: NftSaleTakerType

        Filter by whether the buyer or seller was the taker in the NFT trade. Defaults to returning both buyer and seller taker trades.

        -

        Optional toBlock

        toBlock?: number | "latest"
        +

        Optional toBlock

        toBlock?: number | "latest"

        The block number limit to fetch NFT sales data from.

        -

        Optional tokenId

        tokenId?: BigNumberish
        +

        Optional tokenId

        tokenId?: BigNumberish

        The token ID of an NFT within the specified contractAddress to filter sales by.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetNftSalesResponse.html b/docs/interfaces/GetNftSalesResponse.html index ba76ca92..30130bfe 100644 --- a/docs/interfaces/GetNftSalesResponse.html +++ b/docs/interfaces/GetNftSalesResponse.html @@ -1,9 +1,9 @@ GetNftSalesResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetNftSalesResponse

        The response for the NftNamespace.getNftSales method.

        -

        Hierarchy

        • GetNftSalesResponse

        Index

        Properties

        Properties

        nftSales

        nftSales: NftSale[]
        +

        Hierarchy

        • GetNftSalesResponse

        Index

        Properties

        Properties

        nftSales

        nftSales: NftSale[]

        List of NFT sales that match the query

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        The page key to use to fetch the next page if more results are available.

        -

        validAt

        validAt: NftSaleValidAt
        +

        validAt

        validAt: NftSaleValidAt

        Block Information of the block as of which the corresponding data is valid.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetNftsForContractOptions.html b/docs/interfaces/GetNftsForContractOptions.html index ce2203ae..9630b399 100644 --- a/docs/interfaces/GetNftsForContractOptions.html +++ b/docs/interfaces/GetNftsForContractOptions.html @@ -3,15 +3,15 @@ getNftsForContractIterator functions.

        This interface is used to fetch NFTs with their associated metadata. To get Nfts without their associated metadata, use GetBaseNftsForContractOptions.

        -

        Hierarchy

        • GetNftsForContractOptions

        Index

        Properties

        Properties

        Optional omitMetadata

        omitMetadata?: boolean
        +

        Hierarchy

        • GetNftsForContractOptions

        Index

        Properties

        Properties

        Optional omitMetadata

        omitMetadata?: boolean

        Optional boolean flag to omit NFT metadata. Defaults to false.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing NftContractBaseNftsResponse or NftContractNftsResponseto use for pagination.

        -

        Optional pageSize

        pageSize?: number
        +

        Optional pageSize

        pageSize?: number

        Sets the total number of NFTs to return in the response. Defaults to 100. Maximum page size is 100.

        -

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number
        +

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number

        No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any diff --git a/docs/interfaces/GetNftsForOwnerOptions.html b/docs/interfaces/GetNftsForOwnerOptions.html index 6cf11642..34d47e61 100644 --- a/docs/interfaces/GetNftsForOwnerOptions.html +++ b/docs/interfaces/GetNftsForOwnerOptions.html @@ -3,26 +3,26 @@ getNftsForOwnerIterator functions.

        This interface is used to fetch NFTs with their associated metadata. To get Nfts without their associated metadata, use GetBaseNftsForOwnerOptions.

        -

        Hierarchy

        • GetNftsForOwnerOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[]
        +

        Hierarchy

        • GetNftsForOwnerOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[]

        Optional list of contract addresses to filter the results by. Limit is 20.

        -

        Optional excludeFilters

        excludeFilters?: NftFilters[]
        +

        Optional excludeFilters

        excludeFilters?: NftFilters[]

        Optional list of filters applied to the query. NFTs that match one or more of these filters are excluded from the response.

        -

        Optional includeFilters

        includeFilters?: NftFilters[]
        +

        Optional includeFilters

        includeFilters?: NftFilters[]

        Optional list of filters applied to the query. NFTs that match one or more of these filters are included in the response.

        -

        Optional omitMetadata

        omitMetadata?: boolean
        +

        Optional omitMetadata

        omitMetadata?: boolean

        Optional boolean flag to omit NFT metadata. Defaults to false.

        -

        Optional orderBy

        orderBy?: TRANSFERTIME
        +

        Optional orderBy

        orderBy?: TRANSFERTIME

        Order in which to return results. By default, results are ordered by contract address and token ID in lexicographic order.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing OwnedBaseNftsResponse or OwnedNftsResponseto use for pagination.

        -

        Optional pageSize

        pageSize?: number
        +

        Optional pageSize

        pageSize?: number

        Sets the total number of NFTs to return in the response. Defaults to 100. Maximum page size is 100.

        -

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number
        +

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number

        No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any diff --git a/docs/interfaces/GetOwnersForContractOptions.html b/docs/interfaces/GetOwnersForContractOptions.html index 6551e302..ec09cf52 100644 --- a/docs/interfaces/GetOwnersForContractOptions.html +++ b/docs/interfaces/GetOwnersForContractOptions.html @@ -2,14 +2,14 @@

        Optional parameters object for the getNftsForContract method.

        This interface configures options when fetching the owner addresses of the provided contract.

        -

        Hierarchy

        • GetOwnersForContractOptions

        Index

        Properties

        Properties

        Optional block

        block?: string
        +

        Hierarchy

        • GetOwnersForContractOptions

        Index

        Properties

        Properties

        Optional block

        block?: string

        The block number in hex or decimal to fetch owners for.

        -

        Optional includeCount

        includeCount?: boolean
        +

        Optional includeCount

        includeCount?: boolean

        If true, include total count of owners in the response. Only applicable when withTokenBalances is not set to true.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key to paginate the next page for large requests.

        -

        Optional withTokenBalances

        withTokenBalances?: boolean
        +

        Optional withTokenBalances

        withTokenBalances?: boolean

        Whether to include the token balances per token id for each owner. Defaults to false when omitted.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetOwnersForContractResponse.html b/docs/interfaces/GetOwnersForContractResponse.html index cdb118ca..8eab4be2 100644 --- a/docs/interfaces/GetOwnersForContractResponse.html +++ b/docs/interfaces/GetOwnersForContractResponse.html @@ -1,10 +1,10 @@ GetOwnersForContractResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetOwnersForContractResponse

        The response object for the getOwnersForContract.

        -

        Hierarchy

        • GetOwnersForContractResponse

        Index

        Properties

        Properties

        owners

        owners: string[]
        +

        Hierarchy

        • GetOwnersForContractResponse

        Index

        Properties

        Properties

        owners

        owners: string[]

        An array of owner addresses for the provided contract address

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key that is returned when a collection has more than 50,000 owners.

        -

        Optional totalCount

        totalCount?: number
        +

        Optional totalCount

        totalCount?: number

        Total count of unique owners. Only present if GetOwnersForContractOptions.includeCount is true.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetOwnersForContractWithTokenBalancesOptions.html b/docs/interfaces/GetOwnersForContractWithTokenBalancesOptions.html index 6bfcaeef..cdce008f 100644 --- a/docs/interfaces/GetOwnersForContractWithTokenBalancesOptions.html +++ b/docs/interfaces/GetOwnersForContractWithTokenBalancesOptions.html @@ -2,11 +2,11 @@

        Optional parameters object for the getNftsForContract method.

        This interface configures options when fetching the owner addresses of the provided contract.

        -

        Hierarchy

        • GetOwnersForContractWithTokenBalancesOptions

        Index

        Properties

        Properties

        Optional block

        block?: string
        +

        Hierarchy

        • GetOwnersForContractWithTokenBalancesOptions

        Index

        Properties

        Properties

        Optional block

        block?: string

        The block number in hex or decimal to fetch owners for.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key to paginate the next page for large requests.

        -

        withTokenBalances

        withTokenBalances: true
        +

        withTokenBalances

        withTokenBalances: true

        Whether to include the token balances per token id for each owner. Defaults to false when omitted.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetOwnersForContractWithTokenBalancesResponse.html b/docs/interfaces/GetOwnersForContractWithTokenBalancesResponse.html index ce81333c..fd4d1329 100644 --- a/docs/interfaces/GetOwnersForContractWithTokenBalancesResponse.html +++ b/docs/interfaces/GetOwnersForContractWithTokenBalancesResponse.html @@ -1,7 +1,7 @@ GetOwnersForContractWithTokenBalancesResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetOwnersForContractWithTokenBalancesResponse

        The response object for the getOwnersForContract.

        -

        Hierarchy

        • GetOwnersForContractWithTokenBalancesResponse

        Index

        Properties

        Properties

        owners

        owners: NftContractOwner[]
        +

        Hierarchy

        • GetOwnersForContractWithTokenBalancesResponse

        Index

        Properties

        Properties

        owners

        owners: NftContractOwner[]

        An array of owner addresses for the provided contract address

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key that is returned when a collection has more than 50,000 owners.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetOwnersForNftOptions.html b/docs/interfaces/GetOwnersForNftOptions.html index 13a8515e..158d5df2 100644 --- a/docs/interfaces/GetOwnersForNftOptions.html +++ b/docs/interfaces/GetOwnersForNftOptions.html @@ -2,8 +2,8 @@

        Optional parameters object for the getOwnersForNft method.

        This interface configures options when fetching the owner addresses of the provided NFT contract.

        -

        Hierarchy

        • GetOwnersForNftOptions

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string
        +

        Hierarchy

        • GetOwnersForNftOptions

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string

        Optional page key to paginate the next page for large requests.

        -

        Optional pageSize

        pageSize?: number
        +

        Optional pageSize

        pageSize?: number

        Sets the total number of owners to return in the response.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetOwnersForNftResponse.html b/docs/interfaces/GetOwnersForNftResponse.html index 54d11816..305f8129 100644 --- a/docs/interfaces/GetOwnersForNftResponse.html +++ b/docs/interfaces/GetOwnersForNftResponse.html @@ -1,7 +1,7 @@ GetOwnersForNftResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetOwnersForNftResponse

        The response object for the getOwnersForNft.

        -

        Hierarchy

        • GetOwnersForNftResponse

        Index

        Properties

        Properties

        owners

        owners: string[]
        +

        Hierarchy

        • GetOwnersForNftResponse

        Index

        Properties

        Properties

        owners

        owners: string[]

        An array of owner addresses for the provided token.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional The key for the next page of results, if applicable.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetSpamContractsResponse.html b/docs/interfaces/GetSpamContractsResponse.html index 73fc0f6f..36ccee1e 100644 --- a/docs/interfaces/GetSpamContractsResponse.html +++ b/docs/interfaces/GetSpamContractsResponse.html @@ -1 +1 @@ -GetSpamContractsResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetSpamContractsResponse

        Hierarchy

        • GetSpamContractsResponse

        Index

        Properties

        Properties

        contractAddresses

        contractAddresses: string[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +GetSpamContractsResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetSpamContractsResponse

        Hierarchy

        • GetSpamContractsResponse

        Index

        Properties

        Properties

        contractAddresses

        contractAddresses: string[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetTokensForOwnerOptions.html b/docs/interfaces/GetTokensForOwnerOptions.html index 9455f7f2..60dc5e25 100644 --- a/docs/interfaces/GetTokensForOwnerOptions.html +++ b/docs/interfaces/GetTokensForOwnerOptions.html @@ -1,9 +1,9 @@ GetTokensForOwnerOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetTokensForOwnerOptions

        Optional params to pass into CoreNamespace.getTokensForOwner.

        -

        Hierarchy

        • GetTokensForOwnerOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[] | TokenBalanceType
        +

        Hierarchy

        • GetTokensForOwnerOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[] | TokenBalanceType

        List of contract addresses to filter by. If omitted, defaults to TokenBalanceType.ERC20.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing GetTokensForOwnerResponse to use for pagination.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetTokensForOwnerResponse.html b/docs/interfaces/GetTokensForOwnerResponse.html index da7655ea..fa1d8214 100644 --- a/docs/interfaces/GetTokensForOwnerResponse.html +++ b/docs/interfaces/GetTokensForOwnerResponse.html @@ -1,7 +1,7 @@ GetTokensForOwnerResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetTokensForOwnerResponse

        Response object for CoreNamespace.getTokensForOwner.

        -

        Hierarchy

        • GetTokensForOwnerResponse

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string
        +

        Hierarchy

        • GetTokensForOwnerResponse

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string

        Page key for the next page of results, if one exists.

        -

        tokens

        tokens: OwnedToken[]
        +

        tokens

        tokens: OwnedToken[]

        Owned tokens for the provided addresses along with relevant metadata.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetTransfersForContractOptions.html b/docs/interfaces/GetTransfersForContractOptions.html index d6fb7ce6..fb92ad0f 100644 --- a/docs/interfaces/GetTransfersForContractOptions.html +++ b/docs/interfaces/GetTransfersForContractOptions.html @@ -1,14 +1,14 @@ GetTransfersForContractOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetTransfersForContractOptions

        Optional parameters object for the NftNamespace.getTransfersForOwner method.

        -

        Hierarchy

        • GetTransfersForContractOptions

        Index

        Properties

        Properties

        Optional fromBlock

        fromBlock?: BlockTag
        +

        Hierarchy

        • GetTransfersForContractOptions

        Index

        Properties

        Properties

        Optional fromBlock

        fromBlock?: BlockTag

        Starting block (inclusive) to get transfers from.

        -

        Optional order

        order?: SortingOrder
        +

        Optional order

        order?: SortingOrder

        Whether to return results in ascending or descending order by block number. Defaults to ascending if omitted.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing TransfersNftResponse to use for pagination.

        -

        Optional toBlock

        toBlock?: BlockTag
        +

        Optional toBlock

        toBlock?: BlockTag

        Ending block (inclusive) to get transfers from.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/GetTransfersForOwnerOptions.html b/docs/interfaces/GetTransfersForOwnerOptions.html index 74ed8551..6cdd92a2 100644 --- a/docs/interfaces/GetTransfersForOwnerOptions.html +++ b/docs/interfaces/GetTransfersForOwnerOptions.html @@ -1,12 +1,12 @@ GetTransfersForOwnerOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetTransfersForOwnerOptions

        Optional parameters object for the NftNamespace.getTransfersForOwner method.

        -

        Hierarchy

        • GetTransfersForOwnerOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[]
        +

        Hierarchy

        • GetTransfersForOwnerOptions

        Index

        Properties

        Properties

        Optional contractAddresses

        contractAddresses?: string[]

        List of NFT contract addresses to filter mints by. If omitted, defaults to all contract addresses.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key from an existing TransfersNftResponse to use for pagination.

        -

        Optional tokenType

        tokenType?: ERC721 | ERC1155
        +

        Optional tokenType

        tokenType?: ERC721 | ERC1155

        Filter mints by ERC721 vs ERC1155 contracts. If omitted, defaults to all NFTs.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/IsAirdropNftResponse.html b/docs/interfaces/IsAirdropNftResponse.html index 694f8468..10232270 100644 --- a/docs/interfaces/IsAirdropNftResponse.html +++ b/docs/interfaces/IsAirdropNftResponse.html @@ -1 +1 @@ -IsAirdropNftResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface IsAirdropNftResponse

        Hierarchy

        • IsAirdropNftResponse

        Index

        Properties

        Properties

        isAirdrop

        isAirdrop: boolean

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +IsAirdropNftResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface IsAirdropNftResponse

        Hierarchy

        • IsAirdropNftResponse

        Index

        Properties

        Properties

        isAirdrop

        isAirdrop: boolean

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/IsSpamContractResponse.html b/docs/interfaces/IsSpamContractResponse.html index 0ce07d94..3426dd9b 100644 --- a/docs/interfaces/IsSpamContractResponse.html +++ b/docs/interfaces/IsSpamContractResponse.html @@ -1 +1 @@ -IsSpamContractResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface IsSpamContractResponse

        Hierarchy

        • IsSpamContractResponse

        Index

        Properties

        Properties

        isSpamContract

        isSpamContract: boolean

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +IsSpamContractResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface IsSpamContractResponse

        Hierarchy

        • IsSpamContractResponse

        Index

        Properties

        Properties

        isSpamContract

        isSpamContract: boolean

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/MinedTransactionWebhook.html b/docs/interfaces/MinedTransactionWebhook.html index d7ff8f4e..f35f2937 100644 --- a/docs/interfaces/MinedTransactionWebhook.html +++ b/docs/interfaces/MinedTransactionWebhook.html @@ -2,23 +2,23 @@

        A Mined Transaction Webhook is used to notify your app whenever a transaction sent through your API key gets successfully mined. This is useful if you want to notify customers that their transaction went through.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string

        The app id of the app used for the webhook. This field is only present on MinedTransactionWebhook and DroppedTransactionWebhook

        -

        id

        id: string
        +

        id

        id: string

        The webhook's unique id.

        -

        isActive

        isActive: boolean
        +

        isActive

        isActive: boolean

        Whether the webhook is currently active

        -

        network

        network: Network
        +

        network

        network: Network

        The network the webhook is on.

        -

        signingKey

        signingKey: string
        +

        signingKey

        signingKey: string

        The signing key used to verify payloads for the webhook.

        -

        timeCreated

        timeCreated: string
        +

        timeCreated

        timeCreated: string

        The creation time of the webhook as an ISO string.

        -

        type

        type: MINED_TRANSACTION
        +

        type

        type: MINED_TRANSACTION

        The type of webhook.

        -

        url

        url: string
        +

        url

        url: string

        The url that the webhook sends its payload to.

        -

        version

        version: WebhookVersion
        +

        version

        version: WebhookVersion

        The webhook version. All newly created webhooks default to V2.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/Nft.html b/docs/interfaces/Nft.html index d2296c35..5abe5d35 100644 --- a/docs/interfaces/Nft.html +++ b/docs/interfaces/Nft.html @@ -3,30 +3,30 @@

        The BaseNft object does not hold any metadata information and only contains the NFT contract and token ID. The Nft object additionally contains the NFT metadata, token URI information, and media.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional acquiredAt

        acquiredAt?: AcquiredAt
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional acquiredAt

        acquiredAt?: AcquiredAt

        Time at which the NFT was most recently acquired by the user. Only available when specifying orderBy: NftOrdering.TRANSFERTIME in the request.

        -

        Optional collection

        collection?: BaseNftCollection
        +

        Optional collection

        collection?: BaseNftCollection

        Collection metadata for the NFT, if available.

        -

        contract

        contract: NftContractForNft
        +

        contract

        contract: NftContractForNft

        The NFT's underlying contract and relevant contract metadata.

        -

        Optional description

        description?: string
        +

        Optional description

        description?: string

        The NFT description.

        -

        image

        image: NftImage
        +

        image

        image: NftImage

        Media URLs and information for the NFT

        -

        Optional mint

        mint?: NftMint
        +

        Optional mint

        mint?: NftMint

        Mint information for the NFT.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The NFT name.

        -

        raw

        raw: NftRawMetadata
        +

        raw

        raw: NftRawMetadata

        The raw metadata for the NFT based on the metadata URI on the NFT contract.

        -

        timeLastUpdated

        timeLastUpdated: string
        +

        timeLastUpdated

        timeLastUpdated: string

        When the NFT was last updated in the blockchain. Represented in ISO-8601 format.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of NFT.

        -

        Optional tokenUri

        tokenUri?: string
        +

        Optional tokenUri

        tokenUri?: string

        URIs for accessing the NFT's metadata blob.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftActivityWebhook.html b/docs/interfaces/NftActivityWebhook.html index 64384712..87a71eba 100644 --- a/docs/interfaces/NftActivityWebhook.html +++ b/docs/interfaces/NftActivityWebhook.html @@ -2,23 +2,23 @@

        The NFT Activity Webhook tracks all ERC721 and ERC1155 activity. This can be used to notify your app with real time state changes when an NFT is transferred between addresses.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string

        The app id of the app used for the webhook. This field is only present on MinedTransactionWebhook and DroppedTransactionWebhook

        -

        id

        id: string
        +

        id

        id: string

        The webhook's unique id.

        -

        isActive

        isActive: boolean
        +

        isActive

        isActive: boolean

        Whether the webhook is currently active

        -

        network

        network: Network
        +

        network

        network: Network

        The network the webhook is on.

        -

        signingKey

        signingKey: string
        +

        signingKey

        signingKey: string

        The signing key used to verify payloads for the webhook.

        -

        timeCreated

        timeCreated: string
        +

        timeCreated

        timeCreated: string

        The creation time of the webhook as an ISO string.

        -

        type

        type: NFT_ACTIVITY
        +

        type

        type: NFT_ACTIVITY

        The type of webhook.

        -

        url

        url: string
        +

        url

        url: string

        The url that the webhook sends its payload to.

        -

        version

        version: WebhookVersion
        +

        version

        version: WebhookVersion

        The webhook version. All newly created webhooks default to V2.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftAttributeRarity.html b/docs/interfaces/NftAttributeRarity.html index c8e60e06..05985f37 100644 --- a/docs/interfaces/NftAttributeRarity.html +++ b/docs/interfaces/NftAttributeRarity.html @@ -1,10 +1,10 @@ NftAttributeRarity | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftAttributeRarity

        Information about the rarity of an NFT's attribute in the specified collection.

        -

        Hierarchy

        • NftAttributeRarity

        Index

        Properties

        Properties

        prevalence

        prevalence: number
        +

        Hierarchy

        • NftAttributeRarity

        Index

        Properties

        Properties

        prevalence

        prevalence: number

        A number from 0 to 1 representing the prevalence of this value for this trait type in the current collection.

        -

        traitType

        traitType: string
        +

        traitType

        traitType: string

        The type of NFT attribute.

        -

        value

        value: string
        +

        value

        value: string

        Name of the NFT's attribute.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftAttributesResponse.html b/docs/interfaces/NftAttributesResponse.html index ff348b43..aec3d494 100644 --- a/docs/interfaces/NftAttributesResponse.html +++ b/docs/interfaces/NftAttributesResponse.html @@ -1,10 +1,10 @@ NftAttributesResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftAttributesResponse

        Summary of the attribute prevalence for the specified NFT contract.

        -

        Hierarchy

        • NftAttributesResponse

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string
        +

        Hierarchy

        • NftAttributesResponse

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        The specified NFT contract's address.

        -

        summary

        summary: Record<string, Record<string, number>>
        +

        summary

        summary: Record<string, Record<string, number>>

        The attribute prevalence of each trait grouped by the trait type for the provided NFT.

        -

        totalSupply

        totalSupply: string
        +

        totalSupply

        totalSupply: string

        The specified NFT contract's total supply.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftCollection.html b/docs/interfaces/NftCollection.html index 32f8eaa2..e79a3e7e 100644 --- a/docs/interfaces/NftCollection.html +++ b/docs/interfaces/NftCollection.html @@ -1,17 +1,17 @@ NftCollection | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftCollection

        Alchemy representation of an NFT collection

        -

        Hierarchy

        • NftCollection

        Index

        Properties

        Properties

        Optional description

        description?: string
        +

        Hierarchy

        • NftCollection

        Index

        Properties

        Properties

        Optional description

        description?: string

        The description of the collection.

        -

        Optional discordUrl

        discordUrl?: string
        +

        Optional discordUrl

        discordUrl?: string

        The Discord URL of the collection.

        -

        Optional externalUrl

        externalUrl?: string
        +

        Optional externalUrl

        externalUrl?: string

        The homepage of the collection as determined by OpenSea.

        -

        Optional floorPrice

        floorPrice?: NftCollectionFloorPrice
        +

        Optional floorPrice

        floorPrice?: NftCollectionFloorPrice

        The floor price of the collection

        -

        name

        name: string
        +

        name

        name: string

        The name of the collection.

        -

        Optional slug

        slug?: string
        +

        Optional slug

        slug?: string

        The OpenSea human-readable slug of the collection.

        -

        Optional twitterUsername

        twitterUsername?: string
        +

        Optional twitterUsername

        twitterUsername?: string

        The Twitter handle of the collection.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftCollectionFloorPrice.html b/docs/interfaces/NftCollectionFloorPrice.html index ea929503..309d7111 100644 --- a/docs/interfaces/NftCollectionFloorPrice.html +++ b/docs/interfaces/NftCollectionFloorPrice.html @@ -1,9 +1,9 @@ NftCollectionFloorPrice | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftCollectionFloorPrice

        Floor price object for an NFT collection.

        -

        Hierarchy

        • NftCollectionFloorPrice

        Index

        Properties

        Properties

        Optional floorPrice

        floorPrice?: number
        +

        Hierarchy

        • NftCollectionFloorPrice

        Index

        Properties

        Properties

        Optional floorPrice

        floorPrice?: number

        The floor price of the collection.

        -

        Optional marketplace

        marketplace?: OPENSEA
        +

        Optional marketplace

        marketplace?: OPENSEA

        The marketplace where the floor price was determined.

        -

        Optional priceCurrency

        priceCurrency?: string
        +

        Optional priceCurrency

        priceCurrency?: string

        The currency of the floor price.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftContract.html b/docs/interfaces/NftContract.html index 76fe87f3..d0cf9ccd 100644 --- a/docs/interfaces/NftContract.html +++ b/docs/interfaces/NftContract.html @@ -3,21 +3,21 @@

        The BaseNftContract does not hold any metadata information and only contains the address. The NftContract additionally contains the tokenType, name, symbol, and more.

        -

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string
        +

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string

        The address of the NFT contract.

        -

        Optional contractDeployer

        contractDeployer?: string
        +

        Optional contractDeployer

        contractDeployer?: string

        The address that deployed the NFT contract.

        -

        Optional deployedBlockNumber

        deployedBlockNumber?: number
        +

        Optional deployedBlockNumber

        deployedBlockNumber?: number

        The block number the NFT contract deployed in.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The name of the contract.

        -

        openSeaMetadata

        openSeaMetadata: OpenSeaCollectionMetadata
        +

        openSeaMetadata

        openSeaMetadata: OpenSeaCollectionMetadata

        OpenSea's metadata for the contract.

        -

        Optional symbol

        symbol?: string
        +

        Optional symbol

        symbol?: string

        The symbol of the contract.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of the token in the contract.

        -

        Optional totalSupply

        totalSupply?: string
        +

        Optional totalSupply

        totalSupply?: string

        The number of NFTs in the contract as an integer string. This field is only available on ERC-721 contracts.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftContractBaseNftsResponse.html b/docs/interfaces/NftContractBaseNftsResponse.html index be39a3b5..a447f9f4 100644 --- a/docs/interfaces/NftContractBaseNftsResponse.html +++ b/docs/interfaces/NftContractBaseNftsResponse.html @@ -1,9 +1,9 @@ NftContractBaseNftsResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftContractBaseNftsResponse

        The response object for the getNftsForContract function. The object contains the NFTs without metadata inside the NFT contract.

        -

        Hierarchy

        • NftContractBaseNftsResponse

        Index

        Properties

        Properties

        nfts

        nfts: BaseNft[]
        +

        Hierarchy

        • NftContractBaseNftsResponse

        Index

        Properties

        Properties

        nfts

        nfts: BaseNft[]

        An array of NFTs without metadata.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Pagination token that can be passed into another request to fetch the next NFTs. If there is no page key, then there are no more NFTs to fetch.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftContractForNft.html b/docs/interfaces/NftContractForNft.html index d3f4bb33..91f4bc47 100644 --- a/docs/interfaces/NftContractForNft.html +++ b/docs/interfaces/NftContractForNft.html @@ -1,24 +1,24 @@ NftContractForNft | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftContractForNft

        NFT contract metadata with spam information.

        -

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string
        +

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string

        The address of the NFT contract.

        -

        Optional contractDeployer

        contractDeployer?: string
        +

        Optional contractDeployer

        contractDeployer?: string

        The address that deployed the NFT contract.

        -

        Optional deployedBlockNumber

        deployedBlockNumber?: number
        +

        Optional deployedBlockNumber

        deployedBlockNumber?: number

        The block number the NFT contract deployed in.

        -

        Optional isSpam

        isSpam?: boolean
        +

        Optional isSpam

        isSpam?: boolean

        Whether the NFT contract is marked as spam.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The name of the contract.

        -

        openSeaMetadata

        openSeaMetadata: OpenSeaCollectionMetadata
        +

        openSeaMetadata

        openSeaMetadata: OpenSeaCollectionMetadata

        OpenSea's metadata for the contract.

        -

        spamClassifications

        spamClassifications: NftSpamClassification[]
        +

        spamClassifications

        spamClassifications: NftSpamClassification[]

        Potential reasons why an NFT Contract was classified as spam.

        -

        Optional symbol

        symbol?: string
        +

        Optional symbol

        symbol?: string

        The symbol of the contract.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of the token in the contract.

        -

        Optional totalSupply

        totalSupply?: string
        +

        Optional totalSupply

        totalSupply?: string

        The number of NFTs in the contract as an integer string. This field is only available on ERC-721 contracts.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftContractForOwner.html b/docs/interfaces/NftContractForOwner.html index 443b8d7c..740a1b47 100644 --- a/docs/interfaces/NftContractForOwner.html +++ b/docs/interfaces/NftContractForOwner.html @@ -1,35 +1,35 @@ NftContractForOwner | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftContractForOwner

        Represents a single NFT contract data in the GetContractsForOwnerResponse.

        -

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string
        +

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string

        The address of the NFT contract.

        -

        Optional contractDeployer

        contractDeployer?: string
        +

        Optional contractDeployer

        contractDeployer?: string

        The address that deployed the NFT contract.

        -

        Optional deployedBlockNumber

        deployedBlockNumber?: number
        +

        Optional deployedBlockNumber

        deployedBlockNumber?: number

        The block number the NFT contract deployed in.

        -

        displayNft

        displayNft: DisplayNftForContract
        +

        displayNft

        displayNft: DisplayNftForContract

        Object containing an NFT owned by the owner for this particular contract. Use this to display a sample NFT for the contract.

        -

        image

        image: NftImage
        +

        image

        image: NftImage

        Object containing different URLs for the NFT media.

        -

        isSpam

        isSpam: boolean
        +

        isSpam

        isSpam: boolean

        Whether the NFT contract is considered spam.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The name of the contract.

        -

        numDistinctTokensOwned

        numDistinctTokensOwned: string
        +

        numDistinctTokensOwned

        numDistinctTokensOwned: string

        Number of distinct token IDs held by the owner. For non-fungible tokens this will be equal to the totalBalance, but it may be lower if the user holds some fungible ERC1155 tokens.

        -

        openSeaMetadata

        openSeaMetadata: OpenSeaCollectionMetadata
        +

        openSeaMetadata

        openSeaMetadata: OpenSeaCollectionMetadata

        OpenSea's metadata for the contract.

        -

        Optional symbol

        symbol?: string
        +

        Optional symbol

        symbol?: string

        The symbol of the contract.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of the token in the contract.

        -

        totalBalance

        totalBalance: string
        +

        totalBalance

        totalBalance: string

        Sum of NFT balances across all token IDs held by the owner. For non-fungible tokens this will be equal to the numDistinctTokensOwned, but it may be higher if the user holds some fungible ERC1155 tokens.

        -

        Optional totalSupply

        totalSupply?: string
        +

        Optional totalSupply

        totalSupply?: string

        The number of NFTs in the contract as an integer string. This field is only available on ERC-721 contracts.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftContractNftsResponse.html b/docs/interfaces/NftContractNftsResponse.html index 273fbef9..73f633e7 100644 --- a/docs/interfaces/NftContractNftsResponse.html +++ b/docs/interfaces/NftContractNftsResponse.html @@ -1,9 +1,9 @@ NftContractNftsResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftContractNftsResponse

        The response object for the getNftsForContract function. The object contains the NFTs with metadata inside the NFT contract.

        -

        Hierarchy

        • NftContractNftsResponse

        Index

        Properties

        Properties

        nfts

        nfts: Nft[]
        +

        Hierarchy

        • NftContractNftsResponse

        Index

        Properties

        Properties

        nfts

        nfts: Nft[]

        An array of NFTs with metadata.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Pagination token that can be passed into another request to fetch the next NFTs. If there is no page key, then there are no more NFTs to fetch.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftContractOwner.html b/docs/interfaces/NftContractOwner.html index 7279a7b1..e632c938 100644 --- a/docs/interfaces/NftContractOwner.html +++ b/docs/interfaces/NftContractOwner.html @@ -1,8 +1,8 @@ NftContractOwner | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftContractOwner

        An object representing the owner of an NFT and its corresponding token balances in a GetOwnersForContractWithTokenBalancesResponse object.

        -

        Hierarchy

        • NftContractOwner

        Index

        Properties

        Properties

        ownerAddress

        ownerAddress: string
        +

        Hierarchy

        • NftContractOwner

        Index

        Properties

        Properties

        ownerAddress

        ownerAddress: string

        The NFT's owner address.

        -

        tokenBalances

        tokenBalances: NftContractTokenBalance[]
        +

        tokenBalances

        tokenBalances: NftContractTokenBalance[]

        A list of objects containing token balances for the provided NFT contract.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftContractTokenBalance.html b/docs/interfaces/NftContractTokenBalance.html index f49c5658..b69fe29a 100644 --- a/docs/interfaces/NftContractTokenBalance.html +++ b/docs/interfaces/NftContractTokenBalance.html @@ -1,8 +1,8 @@ NftContractTokenBalance | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftContractTokenBalance

        An object representing the owned token and balance values in a GetOwnersForContractWithTokenBalancesResponse object.

        -

        Hierarchy

        • NftContractTokenBalance

        Index

        Properties

        Properties

        balance

        balance: string
        +

        Hierarchy

        • NftContractTokenBalance

        Index

        Properties

        Properties

        balance

        balance: string

        The token id balance for the provided owner.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The token id owned in the NFT contract.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftFilter.html b/docs/interfaces/NftFilter.html index 94d7e894..83e94812 100644 --- a/docs/interfaces/NftFilter.html +++ b/docs/interfaces/NftFilter.html @@ -1,8 +1,8 @@ NftFilter | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftFilter

        NFT to track on a NftActivityWebhook or NftMetadataUpdateWebhook.

        -

        Hierarchy

        • NftFilter

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string
        +

        Hierarchy

        • NftFilter

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        The contract address of the NFT.

        -

        Optional tokenId

        tokenId?: BigNumberish
        +

        Optional tokenId

        tokenId?: BigNumberish

        The token id of the NFT to track. If this field is omitted, defaults to tracking all NFTs for the provided contract address.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftFiltersResponse.html b/docs/interfaces/NftFiltersResponse.html index b162e2b6..bfa19f4a 100644 --- a/docs/interfaces/NftFiltersResponse.html +++ b/docs/interfaces/NftFiltersResponse.html @@ -1,9 +1,9 @@ NftFiltersResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftFiltersResponse

        Response object for the NotifyNamespace.getNftFilters method.

        -

        Hierarchy

        • NftFiltersResponse

        Index

        Properties

        Properties

        filters

        filters: NftFilter[]
        +

        Hierarchy

        • NftFiltersResponse

        Index

        Properties

        Properties

        filters

        filters: NftFilter[]

        The NFT filters on the provided webhook.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key used to fetch the remaining filters.

        -

        totalCount

        totalCount: number
        +

        totalCount

        totalCount: number

        The total number of NFT filters on the webhook.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftImage.html b/docs/interfaces/NftImage.html index 5723ef94..1d2f9c21 100644 --- a/docs/interfaces/NftImage.html +++ b/docs/interfaces/NftImage.html @@ -1,15 +1,15 @@ NftImage | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftImage

        Media URLs and information for an NFT.

        -

        Hierarchy

        • NftImage

        Index

        Properties

        Properties

        Optional cachedUrl

        cachedUrl?: string
        +

        Hierarchy

        • NftImage

        Index

        Properties

        Properties

        Optional cachedUrl

        cachedUrl?: string

        URL of the image stored in Alchemy's cache.

        -

        Optional contentType

        contentType?: string
        +

        Optional contentType

        contentType?: string

        The type of the media image.

        -

        Optional originalUrl

        originalUrl?: string
        +

        Optional originalUrl

        originalUrl?: string

        The original URL of the image as stored on the contract.

        -

        Optional pngUrl

        pngUrl?: string
        +

        Optional pngUrl

        pngUrl?: string

        URL of the image in png format

        -

        Optional size

        size?: number
        +

        Optional size

        size?: number

        The size of the media asset in bytes.

        -

        Optional thumbnailUrl

        thumbnailUrl?: string
        +

        Optional thumbnailUrl

        thumbnailUrl?: string

        URL of a thumbnail sized image.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftMetadata.html b/docs/interfaces/NftMetadata.html index c3c612f3..a09b5b59 100644 --- a/docs/interfaces/NftMetadata.html +++ b/docs/interfaces/NftMetadata.html @@ -1,17 +1,17 @@ NftMetadata | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftMetadata

        Represents NFT metadata that holds fields. Note that since there is no standard metadata format, the fields are not guaranteed to be present.

        -

        Hierarchy

        • Record<string, any>
          • NftMetadata

        Index

        Properties

        Properties

        Optional attributes

        attributes?: Record<string, any>[]
        +

        Hierarchy

        • Record<string, any>
          • NftMetadata

        Index

        Properties

        Properties

        Optional attributes

        attributes?: Record<string, any>[]

        The traits, attributes, and characteristics for the NFT asset.

        -

        Optional background_color

        background_color?: string
        +

        Optional background_color

        background_color?: string

        Background color of the NFT item. Usually defined as a 6 character hex string.

        -

        Optional description

        description?: string
        +

        Optional description

        description?: string

        A human-readable description of the NFT asset.

        -

        Optional external_url

        external_url?: string
        +

        Optional external_url

        external_url?: string

        The image URL that appears along the top of the NFT asset page. This tends to be the highest resolution image.

        -

        Optional image

        image?: string
        +

        Optional image

        image?: string

        URL to the NFT asset image.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        Name of the NFT asset.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftMetadataBatchOptions.html b/docs/interfaces/NftMetadataBatchOptions.html index bbd19d84..17c59801 100644 --- a/docs/interfaces/NftMetadataBatchOptions.html +++ b/docs/interfaces/NftMetadataBatchOptions.html @@ -1,9 +1,9 @@ NftMetadataBatchOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftMetadataBatchOptions

        Additional options for the NftNamespace.getNftMetadataBatch method.

        -

        Hierarchy

        • NftMetadataBatchOptions

        Index

        Properties

        Properties

        Optional refreshCache

        refreshCache?: boolean
        +

        Hierarchy

        • NftMetadataBatchOptions

        Index

        Properties

        Properties

        Optional refreshCache

        refreshCache?: boolean

        Whether to refresh the metadata for the given NFT token before returning the response. Defaults to false for faster response times.

        -

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number
        +

        Optional tokenUriTimeoutInMs

        tokenUriTimeoutInMs?: number

        No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any diff --git a/docs/interfaces/NftMetadataBatchToken.html b/docs/interfaces/NftMetadataBatchToken.html index b014ff2c..23befda1 100644 --- a/docs/interfaces/NftMetadataBatchToken.html +++ b/docs/interfaces/NftMetadataBatchToken.html @@ -1,10 +1,10 @@ NftMetadataBatchToken | alchemy-sdk

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftMetadataBatchToken

        Represents an NFT token to fetch metadata for in a NftNamespace.getNftMetadataBatch method.

        -

        Hierarchy

        • NftMetadataBatchToken

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string
        +

        Hierarchy

        • NftMetadataBatchToken

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        The NFT contract address. Limited to ERC721 and ERC1155 tokens.

        -

        tokenId

        tokenId: BigNumberish
        +

        tokenId

        tokenId: BigNumberish

        The id of the NFT.

        -

        Optional tokenType

        tokenType?: ERC721 | ERC1155
        +

        Optional tokenType

        tokenType?: ERC721 | ERC1155

        Optional field to specify the type of token to speed up the query.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftMetadataUpdateWebhook.html b/docs/interfaces/NftMetadataUpdateWebhook.html index ea842771..8de4013a 100644 --- a/docs/interfaces/NftMetadataUpdateWebhook.html +++ b/docs/interfaces/NftMetadataUpdateWebhook.html @@ -2,23 +2,23 @@

        The NFT Metadata Update Webhook tracks all ERC721 and ERC1155 metadata updates. This can be used to notify your app with real time state changes when an NFT's metadata changes.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string

        The app id of the app used for the webhook. This field is only present on MinedTransactionWebhook and DroppedTransactionWebhook

        -

        id

        id: string
        +

        id

        id: string

        The webhook's unique id.

        -

        isActive

        isActive: boolean
        +

        isActive

        isActive: boolean

        Whether the webhook is currently active

        -

        network

        network: Network
        +

        network

        network: Network

        The network the webhook is on.

        -

        signingKey

        signingKey: string
        +

        signingKey

        signingKey: string

        The signing key used to verify payloads for the webhook.

        -

        timeCreated

        timeCreated: string
        +

        timeCreated

        timeCreated: string

        The creation time of the webhook as an ISO string.

        -

        type

        type: NFT_METADATA_UPDATE
        +

        type

        type: NFT_METADATA_UPDATE

        The type of webhook.

        -

        url

        url: string
        +

        url

        url: string

        The url that the webhook sends its payload to.

        -

        version

        version: WebhookVersion
        +

        version

        version: WebhookVersion

        The webhook version. All newly created webhooks default to V2.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftMint.html b/docs/interfaces/NftMint.html index 8d131799..f948baf3 100644 --- a/docs/interfaces/NftMint.html +++ b/docs/interfaces/NftMint.html @@ -1,11 +1,11 @@ NftMint | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftMint

        Mint information for the NFT.

        -

        Hierarchy

        • NftMint

        Index

        Properties

        Properties

        Optional blockNumber

        blockNumber?: number
        +

        Hierarchy

        • NftMint

        Index

        Properties

        Properties

        Optional blockNumber

        blockNumber?: number

        The block number that the NFT was minted on.

        -

        Optional mintAddress

        mintAddress?: string
        +

        Optional mintAddress

        mintAddress?: string

        The address that the NFT was minted to.

        -

        Optional timestamp

        timestamp?: string
        +

        Optional timestamp

        timestamp?: string

        The timestamp the NFT was minted on.

        -

        Optional transactionHash

        transactionHash?: string
        +

        Optional transactionHash

        transactionHash?: string

        The transaction hash of the transaction that minted the NFT.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftRawMetadata.html b/docs/interfaces/NftRawMetadata.html index cd4b1851..69d7a2c5 100644 --- a/docs/interfaces/NftRawMetadata.html +++ b/docs/interfaces/NftRawMetadata.html @@ -1,9 +1,9 @@ NftRawMetadata | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftRawMetadata

        The raw metadata for the NFT based on the metadata URI on the NFT contract.

        -

        Hierarchy

        • NftRawMetadata

        Index

        Properties

        Properties

        Optional error

        error?: string
        +

        Hierarchy

        • NftRawMetadata

        Index

        Properties

        Properties

        Optional error

        error?: string

        Error message if the raw metadata could not be fetched.

        -

        metadata

        metadata: Record<string, any>
        +

        metadata

        metadata: Record<string, any>

        The raw metadata parsed from the raw token URI.

        -

        Optional tokenUri

        tokenUri?: string
        +

        Optional tokenUri

        tokenUri?: string

        The raw token URI on the NFT contract.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftSale.html b/docs/interfaces/NftSale.html index 1bb04313..ba6b702d 100644 --- a/docs/interfaces/NftSale.html +++ b/docs/interfaces/NftSale.html @@ -1,33 +1,33 @@ NftSale | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftSale

        Represents a single NFT sale data in the GetNftSalesResponse.

        -

        Hierarchy

        • NftSale

        Index

        Properties

        Properties

        blockNumber

        blockNumber: number
        +

        Hierarchy

        • NftSale

        Index

        Properties

        Properties

        blockNumber

        blockNumber: number

        The block number the NFT sale took place in.

        -

        bundleIndex

        bundleIndex: number
        +

        bundleIndex

        bundleIndex: number

        The index of the token within the bundle of NFTs sold in the sale.

        -

        buyerAddress

        buyerAddress: string
        +

        buyerAddress

        buyerAddress: string

        The address of the buyer in the NFT sale.

        -

        contractAddress

        contractAddress: string
        +

        contractAddress

        contractAddress: string

        The NFT contract address.

        -

        logIndex

        logIndex: number
        +

        logIndex

        logIndex: number

        The log number of the sale event emitted within the block.

        -

        marketplace

        marketplace: NftSaleMarketplace
        +

        marketplace

        marketplace: NftSaleMarketplace

        The marketplace the sale took place on.

        -

        marketplaceAddress

        marketplaceAddress: string
        +

        marketplaceAddress

        marketplaceAddress: string

        The marketplace address the sale was on.

        -

        protocolFee

        protocolFee: NftSaleFeeData
        +

        protocolFee

        protocolFee: NftSaleFeeData

        The payment from buyer to the marketplace.

        -

        quantity

        quantity: string
        +

        quantity

        quantity: string

        The number of tokens sold in the sale as a decimal integer string.

        -

        royaltyFee

        royaltyFee: NftSaleFeeData
        +

        royaltyFee

        royaltyFee: NftSaleFeeData

        The payment from buyer to the royalty address of the NFT collection.

        -

        sellerAddress

        sellerAddress: string
        +

        sellerAddress

        sellerAddress: string

        The address of the seller in the NFT sale.

        -

        sellerFee

        sellerFee: NftSaleFeeData
        +

        sellerFee

        sellerFee: NftSaleFeeData

        The payment from buyer to the seller.

        -

        taker

        taker: NftSaleTakerType
        +

        taker

        taker: NftSaleTakerType

        Whether the price taker in the trade was the buyer or the seller.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The decimal token ID of the NFT being sold.

        -

        transactionHash

        transactionHash: string
        +

        transactionHash

        transactionHash: string

        The transactionHash of the NFT sale.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftSaleFeeData.html b/docs/interfaces/NftSaleFeeData.html index 3e1080a2..fdfb6d96 100644 --- a/docs/interfaces/NftSaleFeeData.html +++ b/docs/interfaces/NftSaleFeeData.html @@ -1,9 +1,9 @@ NftSaleFeeData | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftSaleFeeData

        Fee detail for an NFT sale.

        -

        Hierarchy

        • NftSaleFeeData

        Index

        Properties

        Properties

        Optional amount

        amount?: string
        +

        Hierarchy

        • NftSaleFeeData

        Index

        Properties

        Properties

        Optional amount

        amount?: string

        The fee payment amount as a decimal integer string.

        -

        Optional decimals

        decimals?: number
        +

        Optional decimals

        decimals?: number

        The number of decimals of the token used for the payment.

        -

        Optional symbol

        symbol?: string
        +

        Optional symbol

        symbol?: string

        The symbol of the token used for the payment.

        -

        Optional tokenAddress

        tokenAddress?: string

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Optional tokenAddress

        tokenAddress?: string

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftSaleValidAt.html b/docs/interfaces/NftSaleValidAt.html index 6c2e6883..4636004c 100644 --- a/docs/interfaces/NftSaleValidAt.html +++ b/docs/interfaces/NftSaleValidAt.html @@ -1,9 +1,9 @@ NftSaleValidAt | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftSaleValidAt

        The block information at which the NFT sale information is valid at.

        -

        Hierarchy

        • NftSaleValidAt

        Index

        Properties

        Properties

        Optional blockHash

        blockHash?: string
        +

        Hierarchy

        • NftSaleValidAt

        Index

        Properties

        Properties

        Optional blockHash

        blockHash?: string

        The block hash. Used to detect reorgs.

        -

        blockNumber

        blockNumber: number
        +

        blockNumber

        blockNumber: number

        The block number the sale information is valid at.

        -

        Optional blockTimestamp

        blockTimestamp?: string
        +

        Optional blockTimestamp

        blockTimestamp?: string

        The timestamp for the block.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/NftWebhookParams.html b/docs/interfaces/NftWebhookParams.html index 9a8672dc..0289f10a 100644 --- a/docs/interfaces/NftWebhookParams.html +++ b/docs/interfaces/NftWebhookParams.html @@ -1,9 +1,9 @@ NftWebhookParams | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface NftWebhookParams

        Params to pass in when calling NotifyNamespace.createWebhook in order to create a NftActivityWebhook or NftMetadataUpdateWebhook.

        -

        Hierarchy

        • NftWebhookParams

        Index

        Properties

        Properties

        filters

        filters: NftFilter[]
        +

        Hierarchy

        • NftWebhookParams

        Index

        Properties

        Properties

        filters

        filters: NftFilter[]

        Array of NFT filters the webhook should track.

        -

        Optional network

        network?: Network
        +

        Optional network

        network?: Network

        Optional network to create the webhook on. If omitted, the webhook will be created on network of the app provided in the api key config.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/OpenSeaCollectionMetadata.html b/docs/interfaces/OpenSeaCollectionMetadata.html index a216ba0a..a2267923 100644 --- a/docs/interfaces/OpenSeaCollectionMetadata.html +++ b/docs/interfaces/OpenSeaCollectionMetadata.html @@ -1,28 +1,28 @@ OpenSeaCollectionMetadata | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface OpenSeaCollectionMetadata

        OpenSea's metadata for an NFT collection.

        -

        Hierarchy

        • OpenSeaCollectionMetadata

        Index

        Properties

        Properties

        Optional bannerImageUrl

        bannerImageUrl?: string
        +

        Hierarchy

        • OpenSeaCollectionMetadata

        Index

        Properties

        Properties

        Optional bannerImageUrl

        bannerImageUrl?: string

        The banner image URL determined by OpenSea.

        -

        Optional collectionName

        collectionName?: string
        +

        Optional collectionName

        collectionName?: string

        The name of the collection on OpenSea.

        -

        Optional collectionSlug

        collectionSlug?: string
        +

        Optional collectionSlug

        collectionSlug?: string

        The slug of the collection on OpenSea.

        -

        Optional description

        description?: string
        +

        Optional description

        description?: string

        The description of the collection on OpenSea.

        -

        Optional discordUrl

        discordUrl?: string
        +

        Optional discordUrl

        discordUrl?: string

        The Discord URL of the collection.

        -

        Optional externalUrl

        externalUrl?: string
        +

        Optional externalUrl

        externalUrl?: string

        The homepage of the collection as determined by OpenSea.

        -

        Optional floorPrice

        floorPrice?: number
        +

        Optional floorPrice

        floorPrice?: number

        The floor price of the collection.

        -

        Optional imageBannerUrl

        imageBannerUrl?: string
        +

        Optional imageBannerUrl

        imageBannerUrl?: string

        The banner image URL determined by OpenSea.

        deprecated

        Use bannerImageUrl instead.

        -

        Optional imageUrl

        imageUrl?: string
        +

        Optional imageUrl

        imageUrl?: string

        The image URL determined by OpenSea.

        -

        lastIngestedAt

        lastIngestedAt: string
        +

        lastIngestedAt

        lastIngestedAt: string

        Timestamp of when the OpenSea metadata was last ingested by Alchemy.

        -

        Optional safelistRequestStatus

        safelistRequestStatus?: OpenSeaSafelistRequestStatus
        +

        Optional safelistRequestStatus

        safelistRequestStatus?: OpenSeaSafelistRequestStatus

        The approval status of the collection on OpenSea.

        -

        Optional twitterUsername

        twitterUsername?: string
        +

        Optional twitterUsername

        twitterUsername?: string

        The Twitter handle of the collection.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/OwnedBaseNft.html b/docs/interfaces/OwnedBaseNft.html index 1191cafd..61485283 100644 --- a/docs/interfaces/OwnedBaseNft.html +++ b/docs/interfaces/OwnedBaseNft.html @@ -1,9 +1,9 @@ OwnedBaseNft | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface OwnedBaseNft

        Represents an NFT without metadata owned by an address.

        -

        Hierarchy

        Index

        Properties

        Properties

        balance

        balance: string
        +

        Hierarchy

        Index

        Properties

        Properties

        balance

        balance: string

        The token balance of the NFT.

        -

        contractAddress

        contractAddress: string
        +

        contractAddress

        contractAddress: string

        The contract address of the NFT.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/OwnedBaseNftsResponse.html b/docs/interfaces/OwnedBaseNftsResponse.html index eca77af4..557abb0b 100644 --- a/docs/interfaces/OwnedBaseNftsResponse.html +++ b/docs/interfaces/OwnedBaseNftsResponse.html @@ -3,13 +3,13 @@ getNftsForOwnerIterator functions. The object contains the NFTs without metadata owned by the provided address, along with pagination information and the total count.

        -

        Hierarchy

        • OwnedBaseNftsResponse

        Index

        Properties

        Properties

        ownedNfts

        ownedNfts: OwnedBaseNft[]
        +

        Hierarchy

        • OwnedBaseNftsResponse

        Index

        Properties

        Properties

        ownedNfts

        ownedNfts: OwnedBaseNft[]

        The NFTs owned by the provided address.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Pagination token that can be passed into another request to fetch the next NFTs. If there is no page key, then there are no more NFTs to fetch.

        -

        totalCount

        totalCount: number
        +

        totalCount

        totalCount: number

        The total count of NFTs owned by the provided address.

        -

        validAt

        validAt: OwnedNftsValidAt
        +

        validAt

        validAt: OwnedNftsValidAt

        Block Information of the block as of which the corresponding data is valid

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/OwnedNft.html b/docs/interfaces/OwnedNft.html index b7d8a258..759421b2 100644 --- a/docs/interfaces/OwnedNft.html +++ b/docs/interfaces/OwnedNft.html @@ -1,31 +1,31 @@ OwnedNft | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface OwnedNft

        Represents an NFT with metadata owned by an address.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional acquiredAt

        acquiredAt?: AcquiredAt
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional acquiredAt

        acquiredAt?: AcquiredAt

        Time at which the NFT was most recently acquired by the user. Only available when specifying orderBy: NftOrdering.TRANSFERTIME in the request.

        -

        balance

        balance: string
        +

        balance

        balance: string

        The token balance of the NFT.

        -

        Optional collection

        collection?: BaseNftCollection
        +

        Optional collection

        collection?: BaseNftCollection

        Collection metadata for the NFT, if available.

        -

        contract

        contract: NftContractForNft
        +

        contract

        contract: NftContractForNft

        The NFT's underlying contract and relevant contract metadata.

        -

        Optional description

        description?: string
        +

        Optional description

        description?: string

        The NFT description.

        -

        image

        image: NftImage
        +

        image

        image: NftImage

        Media URLs and information for the NFT

        -

        Optional mint

        mint?: NftMint
        +

        Optional mint

        mint?: NftMint

        Mint information for the NFT.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The NFT name.

        -

        raw

        raw: NftRawMetadata
        +

        raw

        raw: NftRawMetadata

        The raw metadata for the NFT based on the metadata URI on the NFT contract.

        -

        timeLastUpdated

        timeLastUpdated: string
        +

        timeLastUpdated

        timeLastUpdated: string

        When the NFT was last updated in the blockchain. Represented in ISO-8601 format.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of NFT.

        -

        Optional tokenUri

        tokenUri?: string
        +

        Optional tokenUri

        tokenUri?: string

        URIs for accessing the NFT's metadata blob.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/OwnedNftsResponse.html b/docs/interfaces/OwnedNftsResponse.html index bf372d41..39fcabd3 100644 --- a/docs/interfaces/OwnedNftsResponse.html +++ b/docs/interfaces/OwnedNftsResponse.html @@ -3,13 +3,13 @@ getNftsForOwnerIterator functions. The object contains the NFTs with metadata owned by the provided address, along with pagination information and the total count.

        -

        Hierarchy

        • OwnedNftsResponse

        Index

        Properties

        Properties

        ownedNfts

        ownedNfts: OwnedNft[]
        +

        Hierarchy

        • OwnedNftsResponse

        Index

        Properties

        Properties

        ownedNfts

        ownedNfts: OwnedNft[]

        The NFTs owned by the provided address.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Pagination token that can be passed into another request to fetch the next NFTs. If there is no page key, then there are no more NFTs to fetch.

        -

        totalCount

        totalCount: number
        +

        totalCount

        totalCount: number

        The total count of NFTs owned by the provided address.

        -

        validAt

        validAt: OwnedNftsValidAt
        +

        validAt

        validAt: OwnedNftsValidAt

        Block Information of the block as of which the corresponding data is valid

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/OwnedNftsValidAt.html b/docs/interfaces/OwnedNftsValidAt.html index fe1e8ca2..aae397ea 100644 --- a/docs/interfaces/OwnedNftsValidAt.html +++ b/docs/interfaces/OwnedNftsValidAt.html @@ -1,9 +1,9 @@ OwnedNftsValidAt | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface OwnedNftsValidAt

        The block information at which the NFT sale information is valid at.

        -

        Hierarchy

        • OwnedNftsValidAt

        Index

        Properties

        Properties

        blockHash

        blockHash: string
        +

        Hierarchy

        • OwnedNftsValidAt

        Index

        Properties

        Properties

        blockHash

        blockHash: string

        The block hash. Used to detect reorgs.

        -

        Optional blockNumber

        blockNumber?: number
        +

        Optional blockNumber

        blockNumber?: number

        The block number the sale information is valid at.

        -

        Optional blockTimestamp

        blockTimestamp?: string
        +

        Optional blockTimestamp

        blockTimestamp?: string

        The timestamp for the block.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/OwnedToken.html b/docs/interfaces/OwnedToken.html index 9e15fee8..afaeb1cb 100644 --- a/docs/interfaces/OwnedToken.html +++ b/docs/interfaces/OwnedToken.html @@ -1,26 +1,26 @@ OwnedToken | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface OwnedToken

        Represents an owned token on a GetTokensForOwnerResponse.

        -

        Hierarchy

        • OwnedToken

        Index

        Properties

        Properties

        Optional balance

        balance?: string
        +

        Hierarchy

        • OwnedToken

        Index

        Properties

        Properties

        Optional balance

        balance?: string

        The formatted value of the balance field as a hex string. This value is undefined if the error field is present, or if the decimals field= is undefined.

        -

        contractAddress

        contractAddress: string
        +

        contractAddress

        contractAddress: string

        The contract address of the token.

        -

        Optional decimals

        decimals?: number
        +

        Optional decimals

        decimals?: number

        The number of decimals of the token. Is undefined if not defined in the contract and not available from other sources.

        -

        Optional error

        error?: string
        +

        Optional error

        error?: string

        Error from fetching the token balances. If this field is defined, none of the other fields will be defined.

        -

        Optional logo

        logo?: string
        +

        Optional logo

        logo?: string

        URL link to the token's logo. Is undefined if the logo is not available.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The token's name. Is undefined if the name is not defined in the contract and not available from other sources.

        -

        Optional rawBalance

        rawBalance?: string
        +

        Optional rawBalance

        rawBalance?: string

        The raw value of the balance field as a hex string. This value is undefined if the error field is present.

        -

        Optional symbol

        symbol?: string
        +

        Optional symbol

        symbol?: string

        The token's symbol. Is undefined if the symbol is not defined in the contract and not available from other sources.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/RawContract.html b/docs/interfaces/RawContract.html index 9855336c..2286f8f6 100644 --- a/docs/interfaces/RawContract.html +++ b/docs/interfaces/RawContract.html @@ -1,12 +1,12 @@ RawContract | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface RawContract

        Information about the underlying contract for the asset that was transferred in a AssetTransfersResult object.

        -

        Hierarchy

        • RawContract

        Index

        Properties

        Properties

        address

        address: null | string
        +

        Hierarchy

        • RawContract

        Index

        Properties

        Properties

        address

        address: null | string

        The contract address. null if it was an internal or external transfer.

        -

        decimal

        decimal: null | string
        +

        decimal

        decimal: null | string

        The number of decimals in the contract as a hex string. null if the value is not in the contract and not available from other sources.

        -

        value

        value: null | string
        +

        value

        value: null | string

        The raw transfer value as a hex string. null if the transfer was for an ERC721 or ERC1155 token.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/RefreshContractResult.html b/docs/interfaces/RefreshContractResult.html index 9cc1a79a..865e3152 100644 --- a/docs/interfaces/RefreshContractResult.html +++ b/docs/interfaces/RefreshContractResult.html @@ -1,10 +1,10 @@ RefreshContractResult | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface RefreshContractResult

        The refresh result response object returned by refreshContract.

        -

        Hierarchy

        • RefreshContractResult

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string
        +

        Hierarchy

        • RefreshContractResult

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        The NFT contract address that was passed in to be refreshed.

        -

        progress

        progress: null | string
        +

        progress

        progress: null | string

        Percentage of tokens currently refreshed, represented as an integer string. Field can be null if the refresh has not occurred.

        -

        refreshState

        refreshState: NftRefreshState
        +

        refreshState

        refreshState: NftRefreshState

        The current state of the refresh request.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/SearchContractMetadataResponse.html b/docs/interfaces/SearchContractMetadataResponse.html index c7dee657..6a0e24a1 100644 --- a/docs/interfaces/SearchContractMetadataResponse.html +++ b/docs/interfaces/SearchContractMetadataResponse.html @@ -1 +1 @@ -SearchContractMetadataResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SearchContractMetadataResponse

        Hierarchy

        • SearchContractMetadataResponse

        Index

        Properties

        Properties

        contracts

        contracts: NftContract[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +SearchContractMetadataResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SearchContractMetadataResponse

        Hierarchy

        • SearchContractMetadataResponse

        Index

        Properties

        Properties

        contracts

        contracts: NftContract[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/SendPrivateTransactionOptions.html b/docs/interfaces/SendPrivateTransactionOptions.html index ebe031ba..abd57569 100644 --- a/docs/interfaces/SendPrivateTransactionOptions.html +++ b/docs/interfaces/SendPrivateTransactionOptions.html @@ -1,6 +1,6 @@ SendPrivateTransactionOptions | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SendPrivateTransactionOptions

        Options for the TransactNamespace.sendPrivateTransaction method.

        -

        Hierarchy

        • SendPrivateTransactionOptions

        Index

        Properties

        Properties

        fast

        fast: boolean
        +

        Hierarchy

        • SendPrivateTransactionOptions

        Index

        Properties

        Properties

        fast

        fast: boolean

        Whether to use fast-mode. Defaults to false. Please note that fast mode transactions cannot be cancelled using TransactNamespace.cancelPrivateTransaction. method.

        diff --git a/docs/interfaces/SimulateAssetChangesChange.html b/docs/interfaces/SimulateAssetChangesChange.html index 1e4f0703..a2421c8e 100644 --- a/docs/interfaces/SimulateAssetChangesChange.html +++ b/docs/interfaces/SimulateAssetChangesChange.html @@ -1,37 +1,37 @@ SimulateAssetChangesChange | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SimulateAssetChangesChange

        Represents an asset change from a call to TransactNamespace.simulateAssetChanges.

        -

        Hierarchy

        • SimulateAssetChangesChange

        Index

        Properties

        Properties

        Optional amount

        amount?: string
        +

        Hierarchy

        • SimulateAssetChangesChange

        Index

        Properties

        Properties

        Optional amount

        amount?: string

        The amount as an integer string. This value is calculated by applying the decimals field to the rawAmount field. Only available on TRANSFER changes for NATIVE and ERC20 assets, or ERC721/ERC1155 disapprove changes (field set to '0').

        -

        assetType

        assetType: SimulateAssetType
        +

        assetType

        assetType: SimulateAssetType

        The type of asset from the transaction.

        -

        changeType

        changeType: SimulateChangeType
        +

        changeType

        changeType: SimulateChangeType

        The type of change from the transaction.

        -

        Optional contractAddress

        contractAddress?: string
        +

        Optional contractAddress

        contractAddress?: string

        The contract address of the asset. Only applicable to ERC20, ERC721, ERC1155, NFT and SPECIAL_NFT transactions.

        -

        Optional decimals

        decimals?: number
        +

        Optional decimals

        decimals?: number

        The number of decimals used by the ERC20 token. Set to 0 for APPROVE changes. Field is undefined if it's not defined in the contract and not available from other sources.

        -

        from

        from: string
        +

        from

        from: string

        The from address.

        -

        Optional logo

        logo?: string
        +

        Optional logo

        logo?: string

        URL for the logo of the asset, if available. Only applicable to ERC20 transactions.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The name of the asset transferred, if available.

        -

        Optional rawAmount

        rawAmount?: string
        +

        Optional rawAmount

        rawAmount?: string

        The raw amount as an integer string. Only available on TRANSFER changes for NATIVE and ERC20 assets, or ERC721/ERC1155 disapprove changes (field set to '0').

        -

        Optional symbol

        symbol?: string
        +

        Optional symbol

        symbol?: string

        The symbol of the asset transferred if available.

        -

        to

        to: string
        +

        to

        to: string

        The to address.

        -

        Optional tokenId

        tokenId?: string
        +

        Optional tokenId

        tokenId?: string

        The token id of the asset transferred. Only applicable to ERC721, ERC1155 and SPECIAL_NFT NFTs.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/SimulateAssetChangesError.html b/docs/interfaces/SimulateAssetChangesError.html index bff6d526..d0e9bd2e 100644 --- a/docs/interfaces/SimulateAssetChangesError.html +++ b/docs/interfaces/SimulateAssetChangesError.html @@ -1,6 +1,6 @@ SimulateAssetChangesError | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SimulateAssetChangesError

        The error field returned in a SimulateAssetChangesResponse if the simulation failed.

        -

        Hierarchy

        • Record<string, any>
          • SimulateAssetChangesError

        Index

        Properties

        Properties

        message

        message: string
        +

        Hierarchy

        • Record<string, any>
          • SimulateAssetChangesError

        Index

        Properties

        Properties

        message

        message: string

        The error message.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/SimulateAssetChangesResponse.html b/docs/interfaces/SimulateAssetChangesResponse.html index 18be410c..5644cddc 100644 --- a/docs/interfaces/SimulateAssetChangesResponse.html +++ b/docs/interfaces/SimulateAssetChangesResponse.html @@ -1,10 +1,10 @@ SimulateAssetChangesResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SimulateAssetChangesResponse

        Response object for the TransactNamespace.simulateAssetChanges method.

        -

        Hierarchy

        • SimulateAssetChangesResponse

        Index

        Properties

        Properties

        changes

        changes: SimulateAssetChangesChange[]
        +

        Hierarchy

        • SimulateAssetChangesResponse

        Index

        Properties

        Properties

        changes

        changes: SimulateAssetChangesChange[]

        An array of asset changes that resulted from the transaction.

        -

        Optional error

        error?: SimulateAssetChangesError
        +

        Optional error

        error?: SimulateAssetChangesError

        Optional error field that is present if an error occurred.

        -

        Optional gasUsed

        gasUsed?: string
        +

        Optional gasUsed

        gasUsed?: string

        The amount of gas used by the transaction represented as a hex string. The field is undefined if an error occurred.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/SimulateExecutionResponse.html b/docs/interfaces/SimulateExecutionResponse.html index 60ffe63a..b722d4e9 100644 --- a/docs/interfaces/SimulateExecutionResponse.html +++ b/docs/interfaces/SimulateExecutionResponse.html @@ -1,9 +1,9 @@ SimulateExecutionResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SimulateExecutionResponse

        Response object for the TransactNamespace.simulateExecution method.

        -

        Hierarchy

        • SimulateExecutionResponse

        Index

        Properties

        Properties

        calls

        calls: SimulationCallTrace[]
        +

        Hierarchy

        • SimulateExecutionResponse

        Index

        Properties

        Properties

        calls

        calls: SimulationCallTrace[]

        An array of traces generated during simulation that represent the execution of the transaction along with the decoded calls if available.

        -

        logs

        logs: SimulationDebugLog[]
        +

        logs

        logs: SimulationDebugLog[]

        An array of logs emitted during simulation along with the decoded logs if available.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/SimulationCallTrace.html b/docs/interfaces/SimulationCallTrace.html index db099ae8..bbe61f4f 100644 --- a/docs/interfaces/SimulationCallTrace.html +++ b/docs/interfaces/SimulationCallTrace.html @@ -1,23 +1,23 @@ SimulationCallTrace | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SimulationCallTrace

        Debug call trace in a SimulateExecutionResponse.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional decoded

        decoded?: DecodedDebugCallTrace
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional decoded

        decoded?: DecodedDebugCallTrace

        A decoded version of the call. Provided on a best-effort basis.

        -

        Optional error

        error?: string
        +

        Optional error

        error?: string

        Optional error field.

        -

        from

        from: string
        +

        from

        from: string

        From address of the transaction.

        -

        gas

        gas: string
        +

        gas

        gas: string

        Gas provided for call as a hex string.

        -

        gasUsed

        gasUsed: string
        +

        gasUsed

        gasUsed: string

        Gas used during the call as a hex string.

        -

        input

        input: string
        +

        input

        input: string

        Call data.

        -

        output

        output: string
        +

        output

        output: string

        Return data.

        -

        to

        to: string
        +

        to

        to: string

        To address of the transaction.

        -

        type

        type: DebugCallType
        +

        type

        type: DebugCallType

        The type of call.

        -

        value

        value: string
        +

        value

        value: string

        Amount of value transfer as a hex string.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/SimulationDebugLog.html b/docs/interfaces/SimulationDebugLog.html index a4dc7206..0ab6ad85 100644 --- a/docs/interfaces/SimulationDebugLog.html +++ b/docs/interfaces/SimulationDebugLog.html @@ -1,11 +1,11 @@ SimulationDebugLog | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SimulationDebugLog

        Debug log in a SimulateExecutionResponse.

        -

        Hierarchy

        • SimulationDebugLog

        Index

        Properties

        Properties

        address

        address: string
        +

        Hierarchy

        • SimulationDebugLog

        Index

        Properties

        Properties

        address

        address: string

        The address of the contract that generated the log.

        -

        data

        data: string
        +

        data

        data: string

        The data included the log.

        -

        Optional decoded

        decoded?: DecodedLog
        +

        Optional decoded

        decoded?: DecodedLog

        A decoded version of the log. Provided on a best-effort basis.

        -

        topics

        topics: string[]
        +

        topics

        topics: string[]

        An array of topics in the log.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TokenBalanceFailure.html b/docs/interfaces/TokenBalanceFailure.html index cf77cb52..31c4e7e4 100644 --- a/docs/interfaces/TokenBalanceFailure.html +++ b/docs/interfaces/TokenBalanceFailure.html @@ -1 +1 @@ -TokenBalanceFailure | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalanceFailure

        Hierarchy

        • TokenBalanceFailure

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        error

        error: string

        tokenBalance

        tokenBalance: null

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TokenBalanceFailure | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalanceFailure

        Hierarchy

        • TokenBalanceFailure

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        error

        error: string

        tokenBalance

        tokenBalance: null

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TokenBalanceSuccess.html b/docs/interfaces/TokenBalanceSuccess.html index 7652aff4..37f7d366 100644 --- a/docs/interfaces/TokenBalanceSuccess.html +++ b/docs/interfaces/TokenBalanceSuccess.html @@ -1 +1 @@ -TokenBalanceSuccess | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalanceSuccess

        Hierarchy

        • TokenBalanceSuccess

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        error

        error: null

        tokenBalance

        tokenBalance: string

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TokenBalanceSuccess | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalanceSuccess

        Hierarchy

        • TokenBalanceSuccess

        Index

        Properties

        Properties

        contractAddress

        contractAddress: string

        error

        error: null

        tokenBalance

        tokenBalance: string

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TokenBalancesOptionsDefaultTokens.html b/docs/interfaces/TokenBalancesOptionsDefaultTokens.html index 3503d452..cf97196b 100644 --- a/docs/interfaces/TokenBalancesOptionsDefaultTokens.html +++ b/docs/interfaces/TokenBalancesOptionsDefaultTokens.html @@ -1,6 +1,6 @@ TokenBalancesOptionsDefaultTokens | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalancesOptionsDefaultTokens

        Optional params to pass into getTokenBalances() to fetch the top 100 tokens instead of passing in an array of contract addresses to fetch balances for.

        -

        Hierarchy

        • TokenBalancesOptionsDefaultTokens

        Index

        Properties

        Properties

        type

        type: DEFAULT_TOKENS
        +

        Hierarchy

        • TokenBalancesOptionsDefaultTokens

        Index

        Properties

        Properties

        type

        type: DEFAULT_TOKENS

        The top 100 token type.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TokenBalancesOptionsErc20.html b/docs/interfaces/TokenBalancesOptionsErc20.html index 4b4452e8..17624d36 100644 --- a/docs/interfaces/TokenBalancesOptionsErc20.html +++ b/docs/interfaces/TokenBalancesOptionsErc20.html @@ -1,8 +1,8 @@ TokenBalancesOptionsErc20 | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalancesOptionsErc20

        Optional params to pass into getTokenBalances() to fetch all ERC-20 tokens instead of passing in an array of contract addresses to fetch balances for.

        -

        Hierarchy

        • TokenBalancesOptionsErc20

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string
        +

        Hierarchy

        • TokenBalancesOptionsErc20

        Index

        Properties

        Properties

        Optional pageKey

        pageKey?: string

        Optional page key for pagination (only applicable to TokenBalanceType.ERC20)

        -

        type

        type: ERC20
        +

        type

        type: ERC20

        The ERC-20 token type.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TokenBalancesResponse.html b/docs/interfaces/TokenBalancesResponse.html index 606a9bf7..607ab917 100644 --- a/docs/interfaces/TokenBalancesResponse.html +++ b/docs/interfaces/TokenBalancesResponse.html @@ -1 +1 @@ -TokenBalancesResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalancesResponse

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string

        tokenBalances

        tokenBalances: TokenBalance[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +TokenBalancesResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalancesResponse

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string

        tokenBalances

        tokenBalances: TokenBalance[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TokenBalancesResponseErc20.html b/docs/interfaces/TokenBalancesResponseErc20.html index a4ec6185..2c15ee3b 100644 --- a/docs/interfaces/TokenBalancesResponseErc20.html +++ b/docs/interfaces/TokenBalancesResponseErc20.html @@ -1,7 +1,7 @@ TokenBalancesResponseErc20 | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenBalancesResponseErc20

        Response object for when the TokenBalancesOptionsErc20 options are used. A page key may be returned if the provided address has many transfers.

        -

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string

        Optional pageKey

        pageKey?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        address

        address: string

        Optional pageKey

        pageKey?: string

        An optional page key to passed into the next request to fetch the next page of token balances.

        -

        tokenBalances

        tokenBalances: TokenBalance[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        tokenBalances

        tokenBalances: TokenBalance[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TokenMetadataResponse.html b/docs/interfaces/TokenMetadataResponse.html index 63905327..7c798f50 100644 --- a/docs/interfaces/TokenMetadataResponse.html +++ b/docs/interfaces/TokenMetadataResponse.html @@ -1,14 +1,14 @@ TokenMetadataResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenMetadataResponse

        Response object for the CoreNamespace.getTokenMetadata method.

        -

        Hierarchy

        • TokenMetadataResponse

        Index

        Properties

        Properties

        decimals

        decimals: null | number
        +

        Hierarchy

        • TokenMetadataResponse

        Index

        Properties

        Properties

        decimals

        decimals: null | number

        The number of decimals of the token. Returns null if not defined in the contract and not available from other sources.

        -

        logo

        logo: null | string
        +

        logo

        logo: null | string

        URL link to the token's logo. Is null if the logo is not available.

        -

        name

        name: null | string
        +

        name

        name: null | string

        The token's name. Is null if the name is not defined in the contract and not available from other sources.

        -

        symbol

        symbol: null | string
        +

        symbol

        symbol: null | string

        The token's symbol. Is null if the symbol is not defined in the contract and not available from other sources.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TransactionReceiptsBlockHash.html b/docs/interfaces/TransactionReceiptsBlockHash.html index 976e9642..49066d9e 100644 --- a/docs/interfaces/TransactionReceiptsBlockHash.html +++ b/docs/interfaces/TransactionReceiptsBlockHash.html @@ -1,5 +1,5 @@ TransactionReceiptsBlockHash | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TransactionReceiptsBlockHash

        The parameter field of TransactionReceiptsParams.

        -

        Hierarchy

        • TransactionReceiptsBlockHash

        Index

        Properties

        Properties

        blockHash

        blockHash: string
        +

        Hierarchy

        • TransactionReceiptsBlockHash

        Index

        Properties

        Properties

        blockHash

        blockHash: string

        The block hash to get transaction receipts for.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TransactionReceiptsBlockNumber.html b/docs/interfaces/TransactionReceiptsBlockNumber.html index 904da94d..b0ddee21 100644 --- a/docs/interfaces/TransactionReceiptsBlockNumber.html +++ b/docs/interfaces/TransactionReceiptsBlockNumber.html @@ -1,5 +1,5 @@ TransactionReceiptsBlockNumber | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TransactionReceiptsBlockNumber

        The parameter field of TransactionReceiptsParams.

        -

        Hierarchy

        • TransactionReceiptsBlockNumber

        Index

        Properties

        Properties

        blockNumber

        blockNumber: string
        +

        Hierarchy

        • TransactionReceiptsBlockNumber

        Index

        Properties

        Properties

        blockNumber

        blockNumber: string

        The block number to get transaction receipts for.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TransactionReceiptsResponse.html b/docs/interfaces/TransactionReceiptsResponse.html index f01c6150..71838d8f 100644 --- a/docs/interfaces/TransactionReceiptsResponse.html +++ b/docs/interfaces/TransactionReceiptsResponse.html @@ -1,5 +1,5 @@ TransactionReceiptsResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TransactionReceiptsResponse

        Response object for a CoreNamespace.getTransactionReceipts call.

        -

        Hierarchy

        • TransactionReceiptsResponse

        Index

        Properties

        Properties

        receipts

        receipts: null | TransactionReceipt[]
        +

        Hierarchy

        • TransactionReceiptsResponse

        Index

        Properties

        Properties

        receipts

        receipts: null | TransactionReceipt[]

        A list of transaction receipts for the queried block.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TransactionWebhookParams.html b/docs/interfaces/TransactionWebhookParams.html index 11cf08cd..6f3e502e 100644 --- a/docs/interfaces/TransactionWebhookParams.html +++ b/docs/interfaces/TransactionWebhookParams.html @@ -6,6 +6,6 @@ After clicking on an app, the app id is the string in the URL following 'apps/'.

        This is a temporary workaround for now. We're planning on detecting the app id from the provided api key directly. Stay tuned!

        -

        Hierarchy

        • TransactionWebhookParams

        Index

        Properties

        Properties

        appId

        appId: string
        +

        Hierarchy

        • TransactionWebhookParams

        Index

        Properties

        Properties

        appId

        appId: string

        The app id of the project to create the webhook on.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TransferredNft.html b/docs/interfaces/TransferredNft.html index 9a62ad15..2bbc267c 100644 --- a/docs/interfaces/TransferredNft.html +++ b/docs/interfaces/TransferredNft.html @@ -1,38 +1,38 @@ TransferredNft | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TransferredNft

        NFT with extra data for a single NFT that was transferred or minted.

        -

        Hierarchy

        • Nft
          • TransferredNft

        Index

        Properties

        Properties

        Optional acquiredAt

        acquiredAt?: AcquiredAt
        +

        Hierarchy

        • Nft
          • TransferredNft

        Index

        Properties

        Properties

        Optional acquiredAt

        acquiredAt?: AcquiredAt

        Time at which the NFT was most recently acquired by the user. Only available when specifying orderBy: NftOrdering.TRANSFERTIME in the request.

        -

        blockNumber

        blockNumber: string
        +

        blockNumber

        blockNumber: string

        The block number as a hex string of when the transfer or mint occurred.

        -

        Optional collection

        collection?: BaseNftCollection
        +

        Optional collection

        collection?: BaseNftCollection

        Collection metadata for the NFT, if available.

        -

        contract

        contract: NftContractForNft
        +

        contract

        contract: NftContractForNft

        The NFT's underlying contract and relevant contract metadata.

        -

        Optional description

        description?: string
        +

        Optional description

        description?: string

        The NFT description.

        -

        from

        from: string
        +

        from

        from: string

        The address the NFT was from. For minted NFTs, this field is the set to 0x0000000000000000000000000000000000000000.

        -

        image

        image: NftImage
        +

        image

        image: NftImage

        Media URLs and information for the NFT

        -

        Optional mint

        mint?: NftMint
        +

        Optional mint

        mint?: NftMint

        Mint information for the NFT.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The NFT name.

        -

        raw

        raw: NftRawMetadata
        +

        raw

        raw: NftRawMetadata

        The raw metadata for the NFT based on the metadata URI on the NFT contract.

        -

        timeLastUpdated

        timeLastUpdated: string
        +

        timeLastUpdated

        timeLastUpdated: string

        When the NFT was last updated in the blockchain. Represented in ISO-8601 format.

        -

        Optional to

        to?: string
        +

        Optional to

        to?: string

        The address the NFT was sent or minted to.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of NFT.

        -

        Optional tokenUri

        tokenUri?: string
        +

        Optional tokenUri

        tokenUri?: string

        URIs for accessing the NFT's metadata blob.

        -

        transactionHash

        transactionHash: string
        +

        transactionHash

        transactionHash: string

        The transaction hash where the transfer or mint occurred.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/TransfersNftResponse.html b/docs/interfaces/TransfersNftResponse.html index 37b7b981..ce1c7af2 100644 --- a/docs/interfaces/TransfersNftResponse.html +++ b/docs/interfaces/TransfersNftResponse.html @@ -2,8 +2,8 @@

        Response object for NFT methods that fetch NFTs that were transferred or minted (ex: NftNamespace.getTransfersForOwner or NftNamespace.getMintedNfts).

        -

        Hierarchy

        • TransfersNftResponse

        Index

        Properties

        Properties

        nfts

        nfts: TransferredNft[]
        +

        Hierarchy

        • TransfersNftResponse

        Index

        Properties

        Properties

        nfts

        nfts: TransferredNft[]

        An array of NFTs.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Optional page key to use to fetch the next group of NFTs.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/Webhook.html b/docs/interfaces/Webhook.html index 273fa59f..2e06daaa 100644 --- a/docs/interfaces/Webhook.html +++ b/docs/interfaces/Webhook.html @@ -1,22 +1,22 @@ Webhook | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Webhook

        SDK representation of a Webhook in the Notify API.

        -

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string
        +

        Hierarchy

        Index

        Properties

        Properties

        Optional appId

        appId?: string

        The app id of the app used for the webhook. This field is only present on MinedTransactionWebhook and DroppedTransactionWebhook

        -

        id

        id: string
        +

        id

        id: string

        The webhook's unique id.

        -

        isActive

        isActive: boolean
        +

        isActive

        isActive: boolean

        Whether the webhook is currently active

        -

        network

        network: Network
        +

        network

        network: Network

        The network the webhook is on.

        -

        signingKey

        signingKey: string
        +

        signingKey

        signingKey: string

        The signing key used to verify payloads for the webhook.

        -

        timeCreated

        timeCreated: string
        +

        timeCreated

        timeCreated: string

        The creation time of the webhook as an ISO string.

        -

        type

        type: WebhookType
        +

        type

        type: WebhookType

        The type of webhook.

        -

        url

        url: string
        +

        url

        url: string

        The url that the webhook sends its payload to.

        -

        version

        version: WebhookVersion
        +

        version

        version: WebhookVersion

        The webhook version. All newly created webhooks default to V2.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/WebhookAddressOverride.html b/docs/interfaces/WebhookAddressOverride.html index 21c97eb5..9b8c4871 100644 --- a/docs/interfaces/WebhookAddressOverride.html +++ b/docs/interfaces/WebhookAddressOverride.html @@ -1,6 +1,6 @@ WebhookAddressOverride | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface WebhookAddressOverride

        Params object when calling NotifyNamespace.updateWebhook to replace all existing addresses for a AddressActivityWebhook.

        -

        Hierarchy

        • WebhookAddressOverride

        Index

        Properties

        Properties

        newAddresses

        newAddresses: string[]
        +

        Hierarchy

        • WebhookAddressOverride

        Index

        Properties

        Properties

        newAddresses

        newAddresses: string[]

        The new addresses to track. Existing addresses will be removed.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/WebhookAddressUpdate.html b/docs/interfaces/WebhookAddressUpdate.html index 0c361e94..49bb75ec 100644 --- a/docs/interfaces/WebhookAddressUpdate.html +++ b/docs/interfaces/WebhookAddressUpdate.html @@ -1,8 +1,8 @@ WebhookAddressUpdate | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface WebhookAddressUpdate

        Params object when calling NotifyNamespace.updateWebhook to add and remove addresses for a AddressActivityWebhook.

        -

        Hierarchy

        • WebhookAddressUpdate

        Index

        Properties

        Properties

        addAddresses

        addAddresses: string[]
        +

        Hierarchy

        • WebhookAddressUpdate

        Index

        Properties

        Properties

        addAddresses

        addAddresses: string[]

        The addresses to additionally track.

        -

        removeAddresses

        removeAddresses: string[]
        +

        removeAddresses

        removeAddresses: string[]

        Existing addresses to remove.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/WebhookNftFilterUpdate.html b/docs/interfaces/WebhookNftFilterUpdate.html index d61e19c8..e47e3424 100644 --- a/docs/interfaces/WebhookNftFilterUpdate.html +++ b/docs/interfaces/WebhookNftFilterUpdate.html @@ -1,8 +1,8 @@ WebhookNftFilterUpdate | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface WebhookNftFilterUpdate

        Params object when calling NotifyNamespace.updateWebhook to add and remove NFT filters for a NftActivityWebhook.

        -

        Hierarchy

        • WebhookNftFilterUpdate

        Index

        Properties

        Properties

        addFilters

        addFilters: NftFilter[]
        +

        Hierarchy

        • WebhookNftFilterUpdate

        Index

        Properties

        Properties

        addFilters

        addFilters: NftFilter[]

        The filters to additionally track.

        -

        removeFilters

        removeFilters: NftFilter[]
        +

        removeFilters

        removeFilters: NftFilter[]

        Existing filters to remove.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/WebhookNftMetadataFilterUpdate.html b/docs/interfaces/WebhookNftMetadataFilterUpdate.html index 5f16d690..594e0a4c 100644 --- a/docs/interfaces/WebhookNftMetadataFilterUpdate.html +++ b/docs/interfaces/WebhookNftMetadataFilterUpdate.html @@ -1,8 +1,8 @@ WebhookNftMetadataFilterUpdate | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface WebhookNftMetadataFilterUpdate

        Params object when calling NotifyNamespace.updateWebhook to add and remove NFT filters for a NftMetadataUpdateWebhook.

        -

        Hierarchy

        • WebhookNftMetadataFilterUpdate

        Index

        Properties

        Properties

        addMetadataFilters

        addMetadataFilters: NftFilter[]
        +

        Hierarchy

        • WebhookNftMetadataFilterUpdate

        Index

        Properties

        Properties

        addMetadataFilters

        addMetadataFilters: NftFilter[]

        The filters to additionally track.

        -

        removeMetadataFilters

        removeMetadataFilters: NftFilter[]
        +

        removeMetadataFilters

        removeMetadataFilters: NftFilter[]

        Existing filters to remove.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/WebhookStatusUpdate.html b/docs/interfaces/WebhookStatusUpdate.html index 2fbf1991..35589484 100644 --- a/docs/interfaces/WebhookStatusUpdate.html +++ b/docs/interfaces/WebhookStatusUpdate.html @@ -1,6 +1,6 @@ WebhookStatusUpdate | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface WebhookStatusUpdate

        Params object when calling NotifyNamespace.updateWebhook to mark a webhook as active or inactive.

        -

        Hierarchy

        • WebhookStatusUpdate

        Index

        Properties

        Properties

        isActive

        isActive: boolean
        +

        Hierarchy

        • WebhookStatusUpdate

        Index

        Properties

        Properties

        isActive

        isActive: boolean

        Whether the webhook is active.

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property
        • Inherited constructor

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index b80ffca3..5ad740d8 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,49 +1,49 @@ -alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        alchemy-sdk

        Index

        Namespaces

        Enumerations

        Classes

        Interfaces

        Type aliases

        Functions

        Type aliases

        AddressWebhookUpdate

        AddressWebhookUpdate: WebhookStatusUpdate | RequireAtLeastOne<WebhookAddressUpdate> | WebhookAddressOverride
        +alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        alchemy-sdk

        Index

        Namespaces

        Enumerations

        Classes

        Interfaces

        Type aliases

        Functions

        Type aliases

        AddressWebhookUpdate

        AddressWebhookUpdate: WebhookStatusUpdate | RequireAtLeastOne<WebhookAddressUpdate> | WebhookAddressOverride

        Params object when calling NotifyNamespace.updateWebhook to update a AddressActivityWebhook.

        -

        AlchemyEventFilter

        AlchemyEventFilter: AlchemyMinedTransactionsEventFilter | AlchemyPendingTransactionsEventFilter
        +

        AlchemyEventFilter

        AlchemyEventFilter: AlchemyMinedTransactionsEventFilter | AlchemyPendingTransactionsEventFilter

        This type represents the Alchemy's Subscription API endpoints as event filters compatible with other ethers events.

        -

        AlchemyEventType

        AlchemyEventType: EventType | AlchemyEventFilter
        +

        AlchemyEventType

        AlchemyEventType: EventType | AlchemyEventFilter

        Alchemy's event type that extends the default EventType interface to also include Alchemy's Subscription API.

        -

        AlchemyMinedTransactionsAddress

        AlchemyMinedTransactionsAddress: RequireAtLeastOne<{ from?: string; to?: string }>
        +

        AlchemyMinedTransactionsAddress

        AlchemyMinedTransactionsAddress: RequireAtLeastOne<{ from?: string; to?: string }>

        Address filters for AlchemyMinedTransactionsEventFilter. Requires at least one of the fields to be set.

        -

        BigNumberish

        BigNumberish: BigNumber | Bytes | bigint | string | number

        BlockIdentifier

        BlockIdentifier: string | CommitmentLevel
        +

        BigNumberish

        BigNumberish: BigNumber | Bytes | bigint | string | number

        BlockIdentifier

        BlockIdentifier: string | CommitmentLevel

        The block identifier to specify which block to run a debug call in, used for methods in the DebugNamespace.

        -

        BlockTag

        BlockTag: string | number

        CustomGraphqlWebhookUpdate

        CustomGraphqlWebhookUpdate: WebhookStatusUpdate
        +

        BlockTag

        BlockTag: string | number

        CustomGraphqlWebhookUpdate

        CustomGraphqlWebhookUpdate: WebhookStatusUpdate

        Params object when calling NotifyNamespace.updateWebhook to update a CustomGraphqlWebhook.

        -

        DebugPrestateTrace

        DebugPrestateTrace: Record<string, DebugPrestate>
        +

        DebugPrestateTrace

        DebugPrestateTrace: Record<string, DebugPrestate>

        Debug result returned by a DebugPrestateTracer.

        The keys are the addresses of the accounts, mapped to its corresponding state.

        -

        EventType

        EventType: string | (string | string[])[] | EventFilter | ForkEvent

        LogLevel

        LogLevel: "debug" | "info" | "warn" | "error" | "silent"
        +

        EventType

        EventType: string | (string | string[])[] | EventFilter | ForkEvent

        LogLevel

        LogLevel: "debug" | "info" | "warn" | "error" | "silent"

        The level of verbosity for the logger.

        -

        NftMetadataWebhookUpdate

        NftMetadataWebhookUpdate: WebhookStatusUpdate | RequireAtLeastOne<WebhookNftMetadataFilterUpdate>
        +

        NftMetadataWebhookUpdate

        NftMetadataWebhookUpdate: WebhookStatusUpdate | RequireAtLeastOne<WebhookNftMetadataFilterUpdate>

        Params object when calling NotifyNamespace.updateWebhook to update a NftMetadataUpdateWebhook.

        -

        NftWebhookUpdate

        NftWebhookUpdate: WebhookStatusUpdate | RequireAtLeastOne<WebhookNftFilterUpdate>
        +

        NftWebhookUpdate

        NftWebhookUpdate: WebhookStatusUpdate | RequireAtLeastOne<WebhookNftFilterUpdate>

        Params object when calling NotifyNamespace.updateWebhook to update a NftActivityWebhook.

        -

        NonEmptyArray

        NonEmptyArray<T>: [T, ...T[]]
        +

        NonEmptyArray

        NonEmptyArray<T>: [T, ...T[]]

        Requires an array with at least one value.

        -

        Type parameters

        • T

        RequireAtLeastOne

        RequireAtLeastOne<T>: { [ K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>> }[keyof T]
        +

        Type parameters

        • T

        RequireAtLeastOne

        RequireAtLeastOne<T>: { [ K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>> }[keyof T]

        Requires at least one of the properties to be set.

        Type parameters

        • T

        TokenBalance

        TokenBalance: TokenBalanceSuccess | TokenBalanceFailure

        TransactionReceiptsParams

        TransactionReceiptsParams: TransactionReceiptsBlockNumber | TransactionReceiptsBlockHash
        +

        Type parameters

        • T

        TokenBalance

        TokenBalance: TokenBalanceSuccess | TokenBalanceFailure

        TransactionReceiptsParams

        TransactionReceiptsParams: TransactionReceiptsBlockNumber | TransactionReceiptsBlockHash

        The parameters to use with the CoreNamespace.getTransactionReceipts method.

        -

        TransactionRequest

        TransactionRequest: { accessList?: AccessListish; ccipReadEnabled?: boolean; chainId?: number; customData?: Record<string, any>; data?: BytesLike; from?: string; gasLimit?: BigNumberish; gasPrice?: BigNumberish; maxFeePerGas?: BigNumberish; maxPriorityFeePerGas?: BigNumberish; nonce?: BigNumberish; to?: string; type?: number; value?: BigNumberish }

        Type declaration

        • Optional accessList?: AccessListish
        • Optional ccipReadEnabled?: boolean
        • Optional chainId?: number
        • Optional customData?: Record<string, any>
        • Optional data?: BytesLike
        • Optional from?: string
        • Optional gasLimit?: BigNumberish
        • Optional gasPrice?: BigNumberish
        • Optional maxFeePerGas?: BigNumberish
        • Optional maxPriorityFeePerGas?: BigNumberish
        • Optional nonce?: BigNumberish
        • Optional to?: string
        • Optional type?: number
        • Optional value?: BigNumberish

        Functions

        fromHex

        • fromHex(hexString: string): number

        TransactionRequest

        TransactionRequest: { accessList?: AccessListish; ccipReadEnabled?: boolean; chainId?: number; customData?: Record<string, any>; data?: BytesLike; from?: string; gasLimit?: BigNumberish; gasPrice?: BigNumberish; maxFeePerGas?: BigNumberish; maxPriorityFeePerGas?: BigNumberish; nonce?: BigNumberish; to?: string; type?: number; value?: BigNumberish }

        Type declaration

        • Optional accessList?: AccessListish
        • Optional ccipReadEnabled?: boolean
        • Optional chainId?: number
        • Optional customData?: Record<string, any>
        • Optional data?: BytesLike
        • Optional from?: string
        • Optional gasLimit?: BigNumberish
        • Optional gasPrice?: BigNumberish
        • Optional maxFeePerGas?: BigNumberish
        • Optional maxPriorityFeePerGas?: BigNumberish
        • Optional nonce?: BigNumberish
        • Optional to?: string
        • Optional type?: number
        • Optional value?: BigNumberish

        Functions

        fromHex

        • fromHex(hexString: string): number

        • Converts a hex string to a decimal number.

          Parameters

          • hexString: string

            The hex string to convert.

            -

          Returns number

        isHex

        • isHex(possibleHexString: string): boolean

        Returns number

        isHex

        • isHex(possibleHexString: string): boolean

        • Checks if a value is a hex string.

          Parameters

          • possibleHexString: string

            The value to check.

            -

          Returns boolean

        setLogLevel

        Returns boolean

        setLogLevel

        • Configures the verbosity of logging. The default log level is info.

          Parameters

          • logLevel: LogLevel

            The verbosity of logging. Can be any of the following values:

            @@ -54,7 +54,7 @@
          • error: A logging level for critical issues.
          • silent: Turn off all logging.
          -

        Returns void

        toHex

        • toHex(num: number): string

        Returns void

        toHex

        • toHex(num: number): string

        • Converts a number to a hex string.

          Parameters

          • num: number

            The number to convert to hex.

            diff --git a/package.json b/package.json index c5082acd..d53f2a1d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "alchemy-sdk", - "version": "3.2.0", + "version": "3.2.1", "description": "Extended Ethers.js SDK for Alchemy APIs", "author": "Alchemy", "license": "MIT", diff --git a/src/version.ts b/src/version.ts index fe1e9184..649283d2 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1,3 +1,3 @@ // This file is autogenerated by injectVersion.js. Any changes will be // overwritten on commit! -export const VERSION = '3.2.0'; +export const VERSION = '3.2.1';