From c469c3bea52cf6e64c2407818df6b1517d12402a Mon Sep 17 00:00:00 2001 From: Brian Chen Date: Tue, 25 Apr 2023 11:25:54 -0500 Subject: [PATCH] v2.8.1 (#312) * v2.8.1 * docs --- CHANGELOG.md | 6 ++ docs-md/classes/Alchemy.md | 16 ++--- docs-md/classes/AlchemyConfig.md | 20 +++--- docs-md/classes/AlchemyProvider.md | 14 ++-- docs-md/classes/AlchemyWebSocketProvider.md | 30 ++++----- docs-md/classes/CoreNamespace.md | 62 ++++++++--------- docs-md/classes/DebugNamespace.md | 12 ++-- docs-md/classes/NftNamespace.md | 66 +++++++++---------- docs-md/classes/NotifyNamespace.md | 46 ++++++------- docs-md/classes/TransactNamespace.md | 22 +++---- docs-md/classes/Wallet.md | 24 +++---- docs-md/classes/WebSocketNamespace.md | 12 ++-- docs-md/enums/AlchemySubscription.md | 4 +- docs-md/enums/AssetTransfersCategory.md | 12 ++-- docs-md/enums/AssetTransfersOrder.md | 4 +- docs-md/enums/CommitmentLevel.md | 10 +-- docs-md/enums/DebugCallType.md | 8 +-- docs-md/enums/DebugTracerType.md | 4 +- docs-md/enums/DecodingAuthority.md | 2 +- .../enums/GetTransfersForOwnerTransferType.md | 4 +- docs-md/enums/Network.md | 34 +++++----- docs-md/enums/NftExcludeFilters.md | 4 +- docs-md/enums/NftFilters.md | 4 +- docs-md/enums/NftOrdering.md | 2 +- docs-md/enums/NftSaleMarketplace.md | 12 ++-- docs-md/enums/NftSaleTakerType.md | 4 +- docs-md/enums/NftSpamClassification.md | 10 +-- docs-md/enums/NftTokenType.md | 10 +-- docs-md/enums/OpenSeaSafelistRequestStatus.md | 8 +-- docs-md/enums/RefreshState.md | 12 ++-- docs-md/enums/SimulateAssetType.md | 10 +-- docs-md/enums/SimulateChangeType.md | 4 +- docs-md/enums/SortingOrder.md | 4 +- docs-md/enums/TokenBalanceType.md | 4 +- docs-md/enums/WebhookType.md | 12 ++-- docs-md/enums/WebhookVersion.md | 4 +- docs-md/interfaces/AddressActivityResponse.md | 6 +- docs-md/interfaces/AddressActivityWebhook.md | 18 ++--- docs-md/interfaces/AddressWebhookParams.md | 4 +- .../AlchemyMinedTransactionsEventFilter.md | 8 +-- .../AlchemyPendingTransactionsEventFilter.md | 8 +-- docs-md/interfaces/AlchemySettings.md | 14 ++-- docs-md/interfaces/AssetTransfersMetadata.md | 2 +- docs-md/interfaces/AssetTransfersParams.md | 22 +++---- docs-md/interfaces/AssetTransfersResponse.md | 4 +- docs-md/interfaces/AssetTransfersResult.md | 24 +++---- .../AssetTransfersWithMetadataParams.md | 22 +++---- .../AssetTransfersWithMetadataResponse.md | 4 +- .../AssetTransfersWithMetadataResult.md | 26 ++++---- docs-md/interfaces/BaseNft.md | 6 +- docs-md/interfaces/BaseNftContract.md | 2 +- docs-md/interfaces/ContractForOwner.md | 28 ++++---- docs-md/interfaces/CustomGraphqlWebhook.md | 18 ++--- .../interfaces/CustomGraphqlWebhookConfig.md | 2 +- .../interfaces/CustomGraphqlWebhookParams.md | 4 +- docs-md/interfaces/DebugCallTrace.md | 22 +++---- docs-md/interfaces/DebugCallTracer.md | 4 +- docs-md/interfaces/DebugPrestate.md | 8 +-- docs-md/interfaces/DebugPrestateTracer.md | 4 +- docs-md/interfaces/DebugTransaction.md | 12 ++-- docs-md/interfaces/DecodedCallParam.md | 6 +- docs-md/interfaces/DecodedDebugCallTrace.md | 8 +-- docs-md/interfaces/DecodedLog.md | 6 +- docs-md/interfaces/DecodedLogInput.md | 8 +-- docs-md/interfaces/DeployResult.md | 4 +- .../interfaces/DroppedTransactionWebhook.md | 18 ++--- docs-md/interfaces/ERC1155Metadata.md | 4 +- docs-md/interfaces/EventFilter.md | 4 +- docs-md/interfaces/Filter.md | 8 +-- docs-md/interfaces/FilterByBlockHash.md | 6 +- docs-md/interfaces/FloorPriceError.md | 2 +- docs-md/interfaces/FloorPriceMarketplace.md | 8 +-- docs-md/interfaces/GetAddressesOptions.md | 4 +- docs-md/interfaces/GetAllWebhooksResponse.md | 4 +- .../GetBaseNftsForContractOptions.md | 8 +-- .../interfaces/GetBaseNftsForOwnerOptions.md | 16 ++--- .../interfaces/GetContractsForOwnerOptions.md | 10 +-- .../GetContractsForOwnerResponse.md | 6 +- docs-md/interfaces/GetFloorPriceResponse.md | 4 +- docs-md/interfaces/GetMintedNftsOptions.md | 6 +- docs-md/interfaces/GetMintedNftsResponse.md | 4 +- docs-md/interfaces/GetNftMetadataOptions.md | 6 +- docs-md/interfaces/GetNftSalesOptions.md | 18 ++--- .../GetNftSalesOptionsByContractAddress.md | 22 +++---- docs-md/interfaces/GetNftSalesResponse.md | 4 +- .../interfaces/GetNftsForContractOptions.md | 8 +-- docs-md/interfaces/GetNftsForOwnerOptions.md | 16 ++--- .../interfaces/GetOwnersForContractOptions.md | 6 +- .../GetOwnersForContractResponse.md | 2 +- ...nersForContractWithTokenBalancesOptions.md | 6 +- ...ersForContractWithTokenBalancesResponse.md | 4 +- docs-md/interfaces/GetOwnersForNftOptions.md | 4 +- docs-md/interfaces/GetOwnersForNftResponse.md | 4 +- .../interfaces/GetTokensForOwnerOptions.md | 4 +- .../interfaces/GetTokensForOwnerResponse.md | 4 +- .../GetTransfersForContractOptions.md | 8 +-- .../interfaces/GetTransfersForOwnerOptions.md | 6 +- docs-md/interfaces/Media.md | 12 ++-- docs-md/interfaces/MinedTransactionWebhook.md | 18 ++--- docs-md/interfaces/Nft.md | 22 +++---- docs-md/interfaces/NftActivityWebhook.md | 18 ++--- docs-md/interfaces/NftAttributeRarity.md | 6 +- docs-md/interfaces/NftAttributesResponse.md | 6 +- docs-md/interfaces/NftContract.md | 16 ++--- .../interfaces/NftContractBaseNftsResponse.md | 4 +- docs-md/interfaces/NftContractNftsResponse.md | 4 +- docs-md/interfaces/NftContractOwner.md | 4 +- docs-md/interfaces/NftContractTokenBalance.md | 4 +- docs-md/interfaces/NftFilter.md | 4 +- docs-md/interfaces/NftFiltersResponse.md | 6 +- docs-md/interfaces/NftMetadata.md | 12 ++-- docs-md/interfaces/NftMetadataBatchOptions.md | 4 +- docs-md/interfaces/NftMetadataBatchToken.md | 6 +- .../interfaces/NftMetadataUpdateWebhook.md | 18 ++--- docs-md/interfaces/NftSale.md | 30 ++++----- docs-md/interfaces/NftSaleFeeData.md | 6 +- docs-md/interfaces/NftWebhookParams.md | 4 +- .../interfaces/OpenSeaCollectionMetadata.md | 18 ++--- docs-md/interfaces/OwnedBaseNft.md | 8 +-- docs-md/interfaces/OwnedBaseNftsResponse.md | 8 +-- docs-md/interfaces/OwnedNft.md | 24 +++---- docs-md/interfaces/OwnedNftsResponse.md | 8 +-- docs-md/interfaces/OwnedToken.md | 16 ++--- docs-md/interfaces/RawContract.md | 6 +- docs-md/interfaces/RefreshContractResult.md | 6 +- .../SendPrivateTransactionOptions.md | 2 +- .../interfaces/SimulateAssetChangesChange.md | 24 +++---- .../interfaces/SimulateAssetChangesError.md | 2 +- .../SimulateAssetChangesResponse.md | 6 +- .../interfaces/SimulateExecutionResponse.md | 4 +- docs-md/interfaces/SimulationCallTrace.md | 20 +++--- docs-md/interfaces/SimulationDebugLog.md | 8 +-- docs-md/interfaces/SpamInfo.md | 4 +- docs-md/interfaces/TokenBalanceFailure.md | 6 +- docs-md/interfaces/TokenBalanceSuccess.md | 6 +- .../TokenBalancesOptionsDefaultTokens.md | 2 +- .../interfaces/TokenBalancesOptionsErc20.md | 4 +- docs-md/interfaces/TokenBalancesResponse.md | 4 +- .../interfaces/TokenBalancesResponseErc20.md | 6 +- docs-md/interfaces/TokenMetadataResponse.md | 8 +-- docs-md/interfaces/TokenUri.md | 4 +- .../TransactionReceiptsBlockHash.md | 2 +- .../TransactionReceiptsBlockNumber.md | 2 +- .../interfaces/TransactionReceiptsResponse.md | 2 +- .../interfaces/TransactionWebhookParams.md | 2 +- docs-md/interfaces/TransferredNft.md | 30 ++++----- docs-md/interfaces/TransfersNftResponse.md | 4 +- docs-md/interfaces/Webhook.md | 18 ++--- docs-md/interfaces/WebhookAddressOverride.md | 2 +- docs-md/interfaces/WebhookAddressUpdate.md | 4 +- docs-md/interfaces/WebhookNftFilterUpdate.md | 4 +- .../WebhookNftMetadataFilterUpdate.md | 4 +- docs-md/interfaces/WebhookStatusUpdate.md | 2 +- docs-md/modules.md | 36 +++++----- docs/classes/Alchemy.html | 14 ++-- docs/classes/AlchemyConfig.html | 18 ++--- docs/classes/AlchemyProvider.html | 6 +- docs/classes/AlchemyWebSocketProvider.html | 22 +++---- docs/classes/CoreNamespace.html | 62 ++++++++--------- docs/classes/DebugNamespace.html | 12 ++-- docs/classes/NftNamespace.html | 64 +++++++++--------- docs/classes/NotifyNamespace.html | 42 ++++++------ docs/classes/TransactNamespace.html | 22 +++---- docs/classes/Wallet.html | 20 +++--- docs/classes/WebSocketNamespace.html | 12 ++-- docs/enums/AlchemySubscription.html | 2 +- docs/enums/AssetTransfersCategory.html | 12 ++-- docs/enums/AssetTransfersOrder.html | 2 +- docs/enums/CommitmentLevel.html | 10 +-- docs/enums/DebugCallType.html | 2 +- docs/enums/DebugTracerType.html | 2 +- docs/enums/DecodingAuthority.html | 2 +- .../GetTransfersForOwnerTransferType.html | 2 +- docs/enums/Network.html | 12 ++-- docs/enums/NftExcludeFilters.html | 4 +- docs/enums/NftFilters.html | 4 +- docs/enums/NftOrdering.html | 2 +- docs/enums/NftSaleMarketplace.html | 2 +- docs/enums/NftSaleTakerType.html | 2 +- docs/enums/NftSpamClassification.html | 2 +- docs/enums/NftTokenType.html | 2 +- docs/enums/OpenSeaSafelistRequestStatus.html | 8 +-- docs/enums/RefreshState.html | 12 ++-- docs/enums/SimulateAssetType.html | 10 +-- docs/enums/SimulateChangeType.html | 4 +- docs/enums/SortingOrder.html | 2 +- docs/enums/TokenBalanceType.html | 4 +- docs/enums/WebhookType.html | 2 +- docs/enums/WebhookVersion.html | 2 +- docs/interfaces/AddressActivityResponse.html | 6 +- docs/interfaces/AddressActivityWebhook.html | 18 ++--- docs/interfaces/AddressWebhookParams.html | 4 +- .../AlchemyMinedTransactionsEventFilter.html | 8 +-- ...AlchemyPendingTransactionsEventFilter.html | 6 +- docs/interfaces/AlchemySettings.html | 14 ++-- docs/interfaces/AssetTransfersMetadata.html | 2 +- docs/interfaces/AssetTransfersParams.html | 22 +++---- docs/interfaces/AssetTransfersResponse.html | 4 +- docs/interfaces/AssetTransfersResult.html | 24 +++---- .../AssetTransfersWithMetadataParams.html | 22 +++---- .../AssetTransfersWithMetadataResponse.html | 2 +- .../AssetTransfersWithMetadataResult.html | 26 ++++---- docs/interfaces/BaseNft.html | 4 +- docs/interfaces/BaseNftContract.html | 2 +- docs/interfaces/ContractForOwner.html | 26 ++++---- docs/interfaces/CustomGraphqlWebhook.html | 18 ++--- .../CustomGraphqlWebhookConfig.html | 2 +- .../CustomGraphqlWebhookParams.html | 4 +- docs/interfaces/DebugCallTrace.html | 22 +++---- docs/interfaces/DebugCallTracer.html | 4 +- docs/interfaces/DebugPrestate.html | 8 +-- docs/interfaces/DebugPrestateTracer.html | 4 +- docs/interfaces/DebugTransaction.html | 12 ++-- docs/interfaces/DecodedCallParam.html | 6 +- docs/interfaces/DecodedDebugCallTrace.html | 8 +-- docs/interfaces/DecodedLog.html | 6 +- docs/interfaces/DecodedLogInput.html | 8 +-- docs/interfaces/DeployResult.html | 4 +- .../interfaces/DroppedTransactionWebhook.html | 18 ++--- docs/interfaces/ERC1155Metadata.html | 2 +- docs/interfaces/EventFilter.html | 4 +- docs/interfaces/Filter.html | 8 +-- docs/interfaces/FilterByBlockHash.html | 6 +- docs/interfaces/FloorPriceError.html | 2 +- docs/interfaces/FloorPriceMarketplace.html | 8 +-- docs/interfaces/GetAddressesOptions.html | 4 +- docs/interfaces/GetAllWebhooksResponse.html | 4 +- .../GetBaseNftsForContractOptions.html | 8 +-- .../GetBaseNftsForOwnerOptions.html | 16 ++--- .../GetContractsForOwnerOptions.html | 10 +-- .../GetContractsForOwnerResponse.html | 6 +- docs/interfaces/GetFloorPriceResponse.html | 2 +- docs/interfaces/GetMintedNftsOptions.html | 6 +- docs/interfaces/GetMintedNftsResponse.html | 4 +- docs/interfaces/GetNftMetadataOptions.html | 6 +- docs/interfaces/GetNftSalesOptions.html | 18 ++--- .../GetNftSalesOptionsByContractAddress.html | 22 +++---- docs/interfaces/GetNftSalesResponse.html | 4 +- .../interfaces/GetNftsForContractOptions.html | 8 +-- docs/interfaces/GetNftsForOwnerOptions.html | 16 ++--- .../GetOwnersForContractOptions.html | 6 +- .../GetOwnersForContractResponse.html | 2 +- ...rsForContractWithTokenBalancesOptions.html | 6 +- ...sForContractWithTokenBalancesResponse.html | 4 +- docs/interfaces/GetOwnersForNftOptions.html | 4 +- docs/interfaces/GetOwnersForNftResponse.html | 4 +- docs/interfaces/GetTokensForOwnerOptions.html | 4 +- .../interfaces/GetTokensForOwnerResponse.html | 4 +- .../GetTransfersForContractOptions.html | 8 +-- .../GetTransfersForOwnerOptions.html | 6 +- docs/interfaces/Media.html | 12 ++-- docs/interfaces/MinedTransactionWebhook.html | 18 ++--- docs/interfaces/Nft.html | 22 +++---- docs/interfaces/NftActivityWebhook.html | 18 ++--- docs/interfaces/NftAttributeRarity.html | 6 +- docs/interfaces/NftAttributesResponse.html | 6 +- docs/interfaces/NftContract.html | 16 ++--- .../NftContractBaseNftsResponse.html | 4 +- docs/interfaces/NftContractNftsResponse.html | 4 +- docs/interfaces/NftContractOwner.html | 4 +- docs/interfaces/NftContractTokenBalance.html | 4 +- docs/interfaces/NftFilter.html | 4 +- docs/interfaces/NftFiltersResponse.html | 6 +- docs/interfaces/NftMetadata.html | 12 ++-- docs/interfaces/NftMetadataBatchOptions.html | 4 +- docs/interfaces/NftMetadataBatchToken.html | 6 +- docs/interfaces/NftMetadataUpdateWebhook.html | 18 ++--- docs/interfaces/NftSale.html | 30 ++++----- docs/interfaces/NftSaleFeeData.html | 6 +- docs/interfaces/NftWebhookParams.html | 4 +- .../interfaces/OpenSeaCollectionMetadata.html | 18 ++--- docs/interfaces/OwnedBaseNft.html | 6 +- docs/interfaces/OwnedBaseNftsResponse.html | 8 +-- docs/interfaces/OwnedNft.html | 24 +++---- docs/interfaces/OwnedNftsResponse.html | 8 +-- docs/interfaces/OwnedToken.html | 16 ++--- docs/interfaces/RawContract.html | 6 +- docs/interfaces/RefreshContractResult.html | 6 +- .../SendPrivateTransactionOptions.html | 2 +- .../SimulateAssetChangesChange.html | 24 +++---- .../interfaces/SimulateAssetChangesError.html | 2 +- .../SimulateAssetChangesResponse.html | 6 +- .../interfaces/SimulateExecutionResponse.html | 4 +- docs/interfaces/SimulationCallTrace.html | 20 +++--- docs/interfaces/SimulationDebugLog.html | 8 +-- docs/interfaces/SpamInfo.html | 4 +- docs/interfaces/TokenBalanceFailure.html | 2 +- docs/interfaces/TokenBalanceSuccess.html | 2 +- .../TokenBalancesOptionsDefaultTokens.html | 2 +- .../interfaces/TokenBalancesOptionsErc20.html | 4 +- docs/interfaces/TokenBalancesResponse.html | 2 +- .../TokenBalancesResponseErc20.html | 4 +- docs/interfaces/TokenMetadataResponse.html | 8 +-- docs/interfaces/TokenUri.html | 4 +- .../TransactionReceiptsBlockHash.html | 2 +- .../TransactionReceiptsBlockNumber.html | 2 +- .../TransactionReceiptsResponse.html | 2 +- docs/interfaces/TransactionWebhookParams.html | 2 +- docs/interfaces/TransferredNft.html | 30 ++++----- docs/interfaces/TransfersNftResponse.html | 4 +- docs/interfaces/Webhook.html | 18 ++--- docs/interfaces/WebhookAddressOverride.html | 2 +- docs/interfaces/WebhookAddressUpdate.html | 4 +- docs/interfaces/WebhookNftFilterUpdate.html | 4 +- .../WebhookNftMetadataFilterUpdate.html | 4 +- docs/interfaces/WebhookStatusUpdate.html | 2 +- docs/modules.html | 34 +++++----- package.json | 2 +- src/version.ts | 2 +- 309 files changed, 1508 insertions(+), 1502 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9e906f8e..5aa8febb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ ### Minor Changes +## 2.8.1 + +### Major Changes + +### Minor Changes + - Fixed a bug where the SDK was not compatible with `moduleResolution: bundler` when using `typescript` at `v5.0`(#302). Thanks @florrdv! - Fixed a bug with `getTransfersForOwner()` and `getTransfersForContract()` methods in the `NftNamespace`, where some NFTs would not be returned if the NFT was transferred multiple times. diff --git a/docs-md/classes/Alchemy.md b/docs-md/classes/Alchemy.md index 81ec4326..cb5957dd 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/85196e8/src/api/alchemy.ts#L63) +[src/api/alchemy.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy.ts#L42) +[src/api/alchemy.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy.ts#L24) +[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy.ts#L54) +[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy.ts#L27) +[src/api/alchemy.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy.ts#L48) +[src/api/alchemy.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy.ts#L36) +[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy.ts#L30) +[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy.ts#L30) diff --git a/docs-md/classes/AlchemyConfig.md b/docs-md/classes/AlchemyConfig.md index 8a1d628c..2c36934b 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/85196e8/src/api/alchemy-config.ts#L64) +[src/api/alchemy-config.ts:64](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L23) +[src/api/alchemy-config.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L41) +[src/api/alchemy-config.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L32) +[src/api/alchemy-config.ts:32](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L29) +[src/api/alchemy-config.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L26) +[src/api/alchemy-config.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L46) +[src/api/alchemy-config.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L38) +[src/api/alchemy-config.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L107) +[src/api/alchemy-config.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-config.ts#L129) +[src/api/alchemy-config.ts:129](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-config.ts#L129) diff --git a/docs-md/classes/AlchemyProvider.md b/docs-md/classes/AlchemyProvider.md index 56de859b..a542be36 100644 --- a/docs-md/classes/AlchemyProvider.md +++ b/docs-md/classes/AlchemyProvider.md @@ -401,7 +401,7 @@ ___ #### Defined in -[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-provider.ts#L41) +[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-provider.ts#L41) ___ @@ -411,7 +411,7 @@ ___ #### Defined in -[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-provider.ts#L43) +[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-provider.ts#L43) ___ @@ -463,7 +463,7 @@ ___ #### Defined in -[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-provider.ts#L42) +[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-provider.ts#L42) ## Accessors @@ -935,7 +935,7 @@ JsonRpcProvider.\_startPending #### Defined in -[src/api/alchemy-provider.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-provider.ts#L209) +[src/api/alchemy-provider.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-provider.ts#L209) ___ @@ -1135,7 +1135,7 @@ JsonRpcProvider.detectNetwork #### Defined in -[src/api/alchemy-provider.ts:197](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-provider.ts#L197) +[src/api/alchemy-provider.ts:197](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-provider.ts#L197) ___ @@ -1614,7 +1614,7 @@ CommunityResourcable.isCommunityResource #### Defined in -[src/api/alchemy-provider.ts:219](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-provider.ts#L219) +[src/api/alchemy-provider.ts:219](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-provider.ts#L219) ___ @@ -1974,7 +1974,7 @@ JsonRpcProvider.send #### Defined in -[src/api/alchemy-provider.ts:233](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-provider.ts#L233) +[src/api/alchemy-provider.ts:233](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-provider.ts#L233) ___ diff --git a/docs-md/classes/AlchemyWebSocketProvider.md b/docs-md/classes/AlchemyWebSocketProvider.md index 68f9b6c4..fe409170 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/85196e8/src/api/alchemy-websocket-provider.ts#L81) +[src/api/alchemy-websocket-provider.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L82) +[src/api/alchemy-websocket-provider.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L947) +[src/api/alchemy-websocket-provider.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L970) +[src/api/alchemy-websocket-provider.ts:970](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L871) +[src/api/alchemy-websocket-provider.ts:871](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L911) +[src/api/alchemy-websocket-provider.ts:911](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L407) +[src/api/alchemy-websocket-provider.ts:407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L703) +[src/api/alchemy-websocket-provider.ts:703](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L419) +[src/api/alchemy-websocket-provider.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L223) +[src/api/alchemy-websocket-provider.ts:223](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L239) +[src/api/alchemy-websocket-provider.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L191) +[src/api/alchemy-websocket-provider.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L163) +[src/api/alchemy-websocket-provider.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L178) +[src/api/alchemy-websocket-provider.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-websocket-provider.ts#L207) +[src/api/alchemy-websocket-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-websocket-provider.ts#L207) ___ diff --git a/docs-md/classes/CoreNamespace.md b/docs-md/classes/CoreNamespace.md index 5008b292..2c99469d 100644 --- a/docs-md/classes/CoreNamespace.md +++ b/docs-md/classes/CoreNamespace.md @@ -67,7 +67,7 @@ calling getters on Contracts. #### Defined in -[src/api/core-namespace.ts:229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L229) +[src/api/core-namespace.ts:229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L229) ___ @@ -96,7 +96,7 @@ This is an alias for [TransactNamespace.estimateGas](TransactNamespace.md#estima #### Defined in -[src/api/core-namespace.ts:250](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L250) +[src/api/core-namespace.ts:250](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L250) ___ @@ -126,7 +126,7 @@ with this information cached. #### Defined in -[src/api/core-namespace.ts:371](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L371) +[src/api/core-namespace.ts:371](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L371) ___ @@ -154,7 +154,7 @@ response object. #### Defined in -[src/api/core-namespace.ts:588](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L588) +[src/api/core-namespace.ts:588](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L588) ▸ **getAssetTransfers**(`params`): `Promise`<[`AssetTransfersResponse`](../interfaces/AssetTransfersResponse.md)\> @@ -174,7 +174,7 @@ https://docs.alchemy.com/alchemy/enhanced-apis/transfers-api#alchemy_getassettra #### Defined in -[src/api/core-namespace.ts:600](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L600) +[src/api/core-namespace.ts:600](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L600) ___ @@ -197,7 +197,7 @@ Returns the balance of a given address as of the provided block. #### Defined in -[src/api/core-namespace.ts:68](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L68) +[src/api/core-namespace.ts:68](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L68) ___ @@ -222,7 +222,7 @@ hashes. To get the full transaction details on the block, use #### Defined in -[src/api/core-namespace.ts:138](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L138) +[src/api/core-namespace.ts:138](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L138) ___ @@ -238,7 +238,7 @@ Returns the block number of the most recently mined block. #### Defined in -[src/api/core-namespace.ts:175](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L175) +[src/api/core-namespace.ts:175](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L175) ___ @@ -262,7 +262,7 @@ hash. Transactions on the block are represented as an array of #### Defined in -[src/api/core-namespace.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L153) +[src/api/core-namespace.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L153) ___ @@ -286,7 +286,7 @@ no contract deployed, the result is `0x`. #### Defined in -[src/api/core-namespace.ts:85](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L85) +[src/api/core-namespace.ts:85](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L85) ___ @@ -308,7 +308,7 @@ gasPrice should be used. #### Defined in -[src/api/core-namespace.ts:201](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L201) +[src/api/core-namespace.ts:201](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L201) ___ @@ -324,7 +324,7 @@ Returns the best guess of the current gas price to use in a transaction. #### Defined in -[src/api/core-namespace.ts:185](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L185) +[src/api/core-namespace.ts:185](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L185) ___ @@ -346,7 +346,7 @@ Returns an array of logs that match the provided filter. #### Defined in -[src/api/core-namespace.ts:341](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L341) +[src/api/core-namespace.ts:341](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L341) ___ @@ -362,7 +362,7 @@ Returns the {@link EthersNetworkAlias} Alchemy is connected to. #### Defined in -[src/api/core-namespace.ts:165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L165) +[src/api/core-namespace.ts:165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L165) ___ @@ -387,7 +387,7 @@ provided block in `Bytes32` format. #### Defined in -[src/api/core-namespace.ts:103](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L103) +[src/api/core-namespace.ts:103](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L103) ___ @@ -409,7 +409,7 @@ Returns the ERC-20 token balances for a specific owner address. #### Defined in -[src/api/core-namespace.ts:412](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L412) +[src/api/core-namespace.ts:412](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L412) ▸ **getTokenBalances**(`addressOrName`, `contractAddresses?`): `Promise`<[`TokenBalancesResponse`](../interfaces/TokenBalancesResponse.md)\> @@ -428,7 +428,7 @@ Returns the token balances for a specific owner address given a list of contract #### Defined in -[src/api/core-namespace.ts:424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L424) +[src/api/core-namespace.ts:424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L424) ▸ **getTokenBalances**(`addressOrName`, `options`): `Promise`<[`TokenBalancesResponseErc20`](../interfaces/TokenBalancesResponseErc20.md)\> @@ -449,7 +449,7 @@ This overload covers the erc-20 token type which includes a page key in the resp #### Defined in -[src/api/core-namespace.ts:438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L438) +[src/api/core-namespace.ts:438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L438) ▸ **getTokenBalances**(`addressOrName`, `options`): `Promise`<[`TokenBalancesResponse`](../interfaces/TokenBalancesResponse.md)\> @@ -472,7 +472,7 @@ the response. #### Defined in -[src/api/core-namespace.ts:454](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L454) +[src/api/core-namespace.ts:454](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L454) ___ @@ -494,7 +494,7 @@ Returns metadata for a given token contract address. #### Defined in -[src/api/core-namespace.ts:567](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L567) +[src/api/core-namespace.ts:567](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L567) ___ @@ -518,7 +518,7 @@ of each token and the relevant metadata. #### Defined in -[src/api/core-namespace.ts:512](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L512) +[src/api/core-namespace.ts:512](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L512) ___ @@ -547,7 +547,7 @@ NOTE: This is an alias for [TransactNamespace.getTransaction](TransactNamespace. #### Defined in -[src/api/core-namespace.ts:270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L270) +[src/api/core-namespace.ts:270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L270) ___ @@ -572,7 +572,7 @@ transaction from the address sent to the network. #### Defined in -[src/api/core-namespace.ts:121](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L121) +[src/api/core-namespace.ts:121](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L121) ___ @@ -598,7 +598,7 @@ waitForTransaction method below. #### Defined in -[src/api/core-namespace.ts:287](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L287) +[src/api/core-namespace.ts:287](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L287) ___ @@ -620,7 +620,7 @@ Gets all transaction receipts for a given block by number or block hash. #### Defined in -[src/api/core-namespace.ts:615](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L615) +[src/api/core-namespace.ts:615](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L615) ___ @@ -644,7 +644,7 @@ An ENS name requires additional configuration to setup a reverse record, so not #### Defined in -[src/api/core-namespace.ts:639](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L639) +[src/api/core-namespace.ts:639](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L639) ___ @@ -664,7 +664,7 @@ up and running smoothly. #### Defined in -[src/api/core-namespace.ts:215](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L215) +[src/api/core-namespace.ts:215](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L215) ___ @@ -687,7 +687,7 @@ if the ENS name does not have an underlying address. #### Defined in -[src/api/core-namespace.ts:627](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L627) +[src/api/core-namespace.ts:627](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L627) ___ @@ -710,7 +710,7 @@ Allows sending a raw message to the Alchemy backend. #### Defined in -[src/api/core-namespace.ts:354](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L354) +[src/api/core-namespace.ts:354](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L354) ___ @@ -736,7 +736,7 @@ NOTE: This is an alias for [TransactNamespace.getTransaction](TransactNamespace. #### Defined in -[src/api/core-namespace.ts:304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L304) +[src/api/core-namespace.ts:304](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L304) ___ @@ -767,4 +767,4 @@ NOTE: This is an alias for [TransactNamespace.getTransaction](TransactNamespace. #### Defined in -[src/api/core-namespace.ts:326](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/core-namespace.ts#L326) +[src/api/core-namespace.ts:326](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/core-namespace.ts#L326) diff --git a/docs-md/classes/DebugNamespace.md b/docs-md/classes/DebugNamespace.md index 51db9489..80694b3e 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/85196e8/src/api/debug-namespace.ts#L120) +[src/api/debug-namespace.ts:120](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/debug-namespace.ts#L131) +[src/api/debug-namespace.ts:131](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/debug-namespace.ts#L36) +[src/api/debug-namespace.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/debug-namespace.ts#L51) +[src/api/debug-namespace.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/debug-namespace.ts#L79) +[src/api/debug-namespace.ts:79](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/debug-namespace.ts#L98) +[src/api/debug-namespace.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/debug-namespace.ts#L98) diff --git a/docs-md/classes/NftNamespace.md b/docs-md/classes/NftNamespace.md index 03954724..c71880e0 100644 --- a/docs-md/classes/NftNamespace.md +++ b/docs-md/classes/NftNamespace.md @@ -63,7 +63,7 @@ provided NFTs. #### Defined in -[src/api/nft-namespace.ts:435](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L435) +[src/api/nft-namespace.ts:435](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L435) ___ @@ -86,7 +86,7 @@ Get the rarity of each attribute of an NFT. #### Defined in -[src/api/nft-namespace.ts:524](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L524) +[src/api/nft-namespace.ts:524](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L524) ___ @@ -108,7 +108,7 @@ Get the NFT contract metadata associated with the provided parameters. #### Defined in -[src/api/nft-namespace.ts:155](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L155) +[src/api/nft-namespace.ts:155](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L155) ___ @@ -130,7 +130,7 @@ Get the NFT contract metadata for multiple NFT contracts in a single request. #### Defined in -[src/api/nft-namespace.ts:164](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L164) +[src/api/nft-namespace.ts:164](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L164) ___ @@ -153,7 +153,7 @@ Gets all NFT contracts held by the specified owner address. #### Defined in -[src/api/nft-namespace.ts:375](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L375) +[src/api/nft-namespace.ts:375](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L375) ___ @@ -177,7 +177,7 @@ Returns the floor prices of a NFT contract by marketplace. #### Defined in -[src/api/nft-namespace.ts:498](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L498) +[src/api/nft-namespace.ts:498](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L498) ___ @@ -200,7 +200,7 @@ Get all the NFTs minted by a specified owner address. #### Defined in -[src/api/nft-namespace.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L419) +[src/api/nft-namespace.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L419) ___ @@ -228,7 +228,7 @@ will be removed in a subsequent release. #### Defined in -[src/api/nft-namespace.ts:94](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L94) +[src/api/nft-namespace.ts:94](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L94) ▸ **getNftMetadata**(`contractAddress`, `tokenId`, `options?`): `Promise`<[`Nft`](../interfaces/Nft.md)\> @@ -248,7 +248,7 @@ Get the NFT metadata associated with the provided parameters. #### Defined in -[src/api/nft-namespace.ts:109](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L109) +[src/api/nft-namespace.ts:109](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L109) ___ @@ -271,7 +271,7 @@ Gets the NFT metadata for multiple NFT tokens. #### Defined in -[src/api/nft-namespace.ts:142](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L142) +[src/api/nft-namespace.ts:142](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L142) ___ @@ -295,7 +295,7 @@ Returns NFT sales that have happened through on-chain marketplaces. #### Defined in -[src/api/nft-namespace.ts:508](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L508) +[src/api/nft-namespace.ts:508](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L508) ▸ **getNftSales**(`options?`): `Promise`<[`GetNftSalesResponse`](../interfaces/GetNftSalesResponse.md)\> @@ -311,7 +311,7 @@ Returns NFT sales that have happened through on-chain marketplaces. #### Defined in -[src/api/nft-namespace.ts:509](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L509) +[src/api/nft-namespace.ts:509](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L509) ___ @@ -339,7 +339,7 @@ their associated metadata, use [GetBaseNftsForContractOptions](../interfaces/Get #### Defined in -[src/api/nft-namespace.ts:251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L251) +[src/api/nft-namespace.ts:251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L251) ▸ **getNftsForContract**(`contractAddress`, `options?`): `Promise`<[`NftContractBaseNftsResponse`](../interfaces/NftContractBaseNftsResponse.md)\> @@ -363,7 +363,7 @@ all NFTs with their associated metadata, use [GetNftsForContractOptions](../inte #### Defined in -[src/api/nft-namespace.ts:265](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L265) +[src/api/nft-namespace.ts:265](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L265) ___ @@ -392,7 +392,7 @@ associated metadata, use [GetBaseNftsForContractOptions](../interfaces/GetBaseNf #### Defined in -[src/api/nft-namespace.ts:287](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L287) +[src/api/nft-namespace.ts:287](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L287) ▸ **getNftsForContractIterator**(`contractAddress`, `options?`): `AsyncIterable`<[`BaseNft`](../interfaces/BaseNft.md)\> @@ -418,7 +418,7 @@ NFTs with their associated metadata, use [GetNftsForContractOptions](../interfac #### Defined in -[src/api/nft-namespace.ts:303](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L303) +[src/api/nft-namespace.ts:303](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L303) ___ @@ -444,7 +444,7 @@ their associated metadata, use [GetBaseNftsForOwnerOptions](../interfaces/GetBas #### Defined in -[src/api/nft-namespace.ts:215](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L215) +[src/api/nft-namespace.ts:215](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L215) ▸ **getNftsForOwner**(`owner`, `options?`): `Promise`<[`OwnedBaseNftsResponse`](../interfaces/OwnedBaseNftsResponse.md)\> @@ -466,7 +466,7 @@ all NFTs with their associated metadata, use [GetNftsForOwnerOptions](../interfa #### Defined in -[src/api/nft-namespace.ts:229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L229) +[src/api/nft-namespace.ts:229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L229) ___ @@ -492,7 +492,7 @@ keys until all NFTs have been fetched. #### Defined in -[src/api/nft-namespace.ts:180](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L180) +[src/api/nft-namespace.ts:180](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L180) ▸ **getNftsForOwnerIterator**(`owner`, `options?`): `AsyncIterable`<[`OwnedBaseNft`](../interfaces/OwnedBaseNft.md)\> @@ -514,7 +514,7 @@ pages through all page keys until all NFTs have been fetched. #### Defined in -[src/api/nft-namespace.ts:194](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L194) +[src/api/nft-namespace.ts:194](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L194) ___ @@ -537,7 +537,7 @@ Gets all the owners for a given NFT contract along with the token balance. #### Defined in -[src/api/nft-namespace.ts:321](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L321) +[src/api/nft-namespace.ts:321](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L321) ▸ **getOwnersForContract**(`contractAddress`, `options?`): `Promise`<[`GetOwnersForContractResponse`](../interfaces/GetOwnersForContractResponse.md)\> @@ -560,7 +560,7 @@ which has the `withTokenBalances` field set to `true`. #### Defined in -[src/api/nft-namespace.ts:337](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L337) +[src/api/nft-namespace.ts:337](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L337) ___ @@ -586,7 +586,7 @@ Gets all the owners for a given NFT contract address and token ID. #### Defined in -[src/api/nft-namespace.ts:360](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L360) +[src/api/nft-namespace.ts:360](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L360) ___ @@ -606,7 +606,7 @@ https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-clas #### Defined in -[src/api/nft-namespace.ts:488](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L488) +[src/api/nft-namespace.ts:488](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L488) ___ @@ -632,7 +632,7 @@ block range, use [GetTransfersForContractOptions](../interfaces/GetTransfersForC #### Defined in -[src/api/nft-namespace.ts:406](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L406) +[src/api/nft-namespace.ts:406](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L406) ___ @@ -656,7 +656,7 @@ Gets all NFT transfers for a given owner's address. #### Defined in -[src/api/nft-namespace.ts:389](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L389) +[src/api/nft-namespace.ts:389](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L389) ___ @@ -682,7 +682,7 @@ https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-clas #### Defined in -[src/api/nft-namespace.ts:477](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L477) +[src/api/nft-namespace.ts:477](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L477) ___ @@ -711,7 +711,7 @@ process. To refresh the metadata for a specific token, use the #### Defined in -[src/api/nft-namespace.ts:584](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L584) +[src/api/nft-namespace.ts:584](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L584) ___ @@ -743,7 +743,7 @@ To trigger a refresh for all NFTs in a contract, use [refreshContract](NftNamesp #### Defined in -[src/api/nft-namespace.ts:566](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L566) +[src/api/nft-namespace.ts:566](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L566) ___ @@ -765,7 +765,7 @@ Search for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts #### Defined in -[src/api/nft-namespace.ts:536](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L536) +[src/api/nft-namespace.ts:536](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L536) ___ @@ -787,7 +787,7 @@ Get a summary of attribute prevalence for an NFT collection. #### Defined in -[src/api/nft-namespace.ts:545](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L545) +[src/api/nft-namespace.ts:545](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L545) ___ @@ -811,7 +811,7 @@ NFT. Returns a boolean indicating whether the owner address owns the provided NF #### Defined in -[src/api/nft-namespace.ts:449](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L449) +[src/api/nft-namespace.ts:449](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L449) ▸ **verifyNftOwnership**(`owner`, `contractAddresses`): `Promise`<{ `[contractAddress: string]`: `boolean`; }\> @@ -831,4 +831,4 @@ contract address to a boolean indicating whether the owner address owns the NFT. #### Defined in -[src/api/nft-namespace.ts:458](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft-namespace.ts#L458) +[src/api/nft-namespace.ts:458](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft-namespace.ts#L458) diff --git a/docs-md/classes/NotifyNamespace.md b/docs-md/classes/NotifyNamespace.md index 83cee531..1c9e4257 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/85196e8/src/api/notify-namespace.ts#L360) +[src/api/notify-namespace.ts:360](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L377) +[src/api/notify-namespace.ts:377](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L391) +[src/api/notify-namespace.ts:391](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L397) +[src/api/notify-namespace.ts:397](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L411) +[src/api/notify-namespace.ts:411](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L425) +[src/api/notify-namespace.ts:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L545) +[src/api/notify-namespace.ts:545](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L552) +[src/api/notify-namespace.ts:552](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L91) +[src/api/notify-namespace.ts:91](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L104) +[src/api/notify-namespace.ts:104](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L72) +[src/api/notify-namespace.ts:72](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L132) +[src/api/notify-namespace.ts:132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L143) +[src/api/notify-namespace.ts:143](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L167) +[src/api/notify-namespace.ts:167](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L180) +[src/api/notify-namespace.ts:180](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L584) +[src/api/notify-namespace.ts:584](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L209) +[src/api/notify-namespace.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L220) +[src/api/notify-namespace.ts:220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L228) +[src/api/notify-namespace.ts:228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L240) +[src/api/notify-namespace.ts:240](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L251) +[src/api/notify-namespace.ts:251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L262) +[src/api/notify-namespace.ts:262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/notify-namespace.ts#L575) +[src/api/notify-namespace.ts:575](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/notify-namespace.ts#L575) diff --git a/docs-md/classes/TransactNamespace.md b/docs-md/classes/TransactNamespace.md index 3ed377f1..7cedc6a8 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/85196e8/src/api/transact-namespace.ts#L86) +[src/api/transact-namespace.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L258) +[src/api/transact-namespace.ts:258](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L274) +[src/api/transact-namespace.ts:274](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L221) +[src/api/transact-namespace.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L54) +[src/api/transact-namespace.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L238) +[src/api/transact-namespace.ts:238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L137) +[src/api/transact-namespace.ts:137](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L109) +[src/api/transact-namespace.ts:109](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L191) +[src/api/transact-namespace.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L164) +[src/api/transact-namespace.ts:164](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/transact-namespace.ts#L299) +[src/api/transact-namespace.ts:299](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/transact-namespace.ts#L299) diff --git a/docs-md/classes/Wallet.md b/docs-md/classes/Wallet.md index 2a367b18..c0827f7f 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/85196e8/src/api/alchemy-wallet.ts#L39) +[src/api/alchemy-wallet.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-wallet.ts#L31) +[src/api/alchemy-wallet.ts:31](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-wallet.ts#L102) +[src/api/alchemy-wallet.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-wallet.ts#L90) +[src/api/alchemy-wallet.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/alchemy-wallet.ts#L66) +[src/api/alchemy-wallet.ts:66](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-wallet.ts#L66) ___ @@ -492,7 +492,7 @@ EthersWallet.getChainId #### Defined in -[src/api/alchemy-wallet.ts:125](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-wallet.ts#L125) +[src/api/alchemy-wallet.ts:125](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-wallet.ts#L125) ___ @@ -520,7 +520,7 @@ EthersWallet.getFeeData #### Defined in -[src/api/alchemy-wallet.ts:149](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-wallet.ts#L149) +[src/api/alchemy-wallet.ts:149](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-wallet.ts#L149) ___ @@ -542,7 +542,7 @@ EthersWallet.getGasPrice #### Defined in -[src/api/alchemy-wallet.ts:134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-wallet.ts#L134) +[src/api/alchemy-wallet.ts:134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-wallet.ts#L134) ___ @@ -571,7 +571,7 @@ EthersWallet.getTransactionCount #### Defined in -[src/api/alchemy-wallet.ts:77](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-wallet.ts#L77) +[src/api/alchemy-wallet.ts:77](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-wallet.ts#L77) ___ @@ -585,7 +585,7 @@ ___ #### Defined in -[src/api/alchemy-wallet.ts:165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-wallet.ts#L165) +[src/api/alchemy-wallet.ts:165](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-wallet.ts#L165) ___ @@ -639,7 +639,7 @@ EthersWallet.resolveName #### Defined in -[src/api/alchemy-wallet.ts:161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-wallet.ts#L161) +[src/api/alchemy-wallet.ts:161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-wallet.ts#L161) ___ @@ -667,7 +667,7 @@ EthersWallet.sendTransaction #### Defined in -[src/api/alchemy-wallet.ts:114](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/alchemy-wallet.ts#L114) +[src/api/alchemy-wallet.ts:114](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/alchemy-wallet.ts#L114) ___ diff --git a/docs-md/classes/WebSocketNamespace.md b/docs-md/classes/WebSocketNamespace.md index a1692d82..19bbbff7 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/85196e8/src/api/websocket-namespace.ts#L104) +[src/api/websocket-namespace.ts:104](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/websocket-namespace.ts#L118) +[src/api/websocket-namespace.ts:118](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/websocket-namespace.ts#L70) +[src/api/websocket-namespace.ts:70](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/websocket-namespace.ts#L35) +[src/api/websocket-namespace.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/websocket-namespace.ts#L53) +[src/api/websocket-namespace.ts:53](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/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/85196e8/src/api/websocket-namespace.ts#L86) +[src/api/websocket-namespace.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/websocket-namespace.ts#L86) diff --git a/docs-md/enums/AlchemySubscription.md b/docs-md/enums/AlchemySubscription.md index dc51c650..a7d75fb8 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:1713](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1713) +[src/types/types.ts:1713](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1713) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[src/types/types.ts:1712](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1712) +[src/types/types.ts:1712](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1712) diff --git a/docs-md/enums/AssetTransfersCategory.md b/docs-md/enums/AssetTransfersCategory.md index 2687e4d7..e28a81a5 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:374](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L374) +[src/types/types.ts:374](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L374) ___ @@ -38,7 +38,7 @@ ERC20 transfers. #### Defined in -[src/types/types.ts:368](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L368) +[src/types/types.ts:368](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L368) ___ @@ -50,7 +50,7 @@ ERC721 transfers. #### Defined in -[src/types/types.ts:371](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L371) +[src/types/types.ts:371](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L371) ___ @@ -64,7 +64,7 @@ accessed by users. #### Defined in -[src/types/types.ts:358](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L358) +[src/types/types.ts:358](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L358) ___ @@ -78,7 +78,7 @@ another smart contract or sending #### Defined in -[src/types/types.ts:365](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L365) +[src/types/types.ts:365](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L365) ___ @@ -90,4 +90,4 @@ Special contracts that don't follow ERC 721/1155, (ex: CryptoKitties). #### Defined in -[src/types/types.ts:377](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L377) +[src/types/types.ts:377](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L377) diff --git a/docs-md/enums/AssetTransfersOrder.md b/docs-md/enums/AssetTransfersOrder.md index b9fa7f06..5ee00b81 100644 --- a/docs-md/enums/AssetTransfersOrder.md +++ b/docs-md/enums/AssetTransfersOrder.md @@ -23,7 +23,7 @@ using [CoreNamespace.getAssetTransfers](../classes/CoreNamespace.md#getassettran #### Defined in -[src/types/types.ts:389](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L389) +[src/types/types.ts:389](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L389) ___ @@ -33,4 +33,4 @@ ___ #### Defined in -[src/types/types.ts:390](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L390) +[src/types/types.ts:390](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L390) diff --git a/docs-md/enums/CommitmentLevel.md b/docs-md/enums/CommitmentLevel.md index f17ae7f6..9552c90e 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:2458](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2458) +[src/types/types.ts:2458](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2458) ___ @@ -39,7 +39,7 @@ This block is very unlikely to be re-orged. This is only available on #### Defined in -[src/types/types.ts:2454](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2454) +[src/types/types.ts:2454](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2454) ___ @@ -52,7 +52,7 @@ this block may be re-orged out of the canonical chain. #### Defined in -[src/types/types.ts:2442](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2442) +[src/types/types.ts:2442](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2442) ___ @@ -66,7 +66,7 @@ is a proxy for blocks that have not been mined yet. #### Defined in -[src/types/types.ts:2437](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2437) +[src/types/types.ts:2437](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2437) ___ @@ -80,4 +80,4 @@ only available on [Network.ETH_GOERLI](Network.md#eth_goerli) and [Network.ETH_S #### Defined in -[src/types/types.ts:2448](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2448) +[src/types/types.ts:2448](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2448) diff --git a/docs-md/enums/DebugCallType.md b/docs-md/enums/DebugCallType.md index dba6fa06..b17e193f 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:2012](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2012) +[src/types/types.ts:2012](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2012) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[src/types/types.ts:2011](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2011) +[src/types/types.ts:2011](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2011) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/types/types.ts:2014](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2014) +[src/types/types.ts:2014](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2014) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[src/types/types.ts:2013](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2013) +[src/types/types.ts:2013](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2013) diff --git a/docs-md/enums/DebugTracerType.md b/docs-md/enums/DebugTracerType.md index ac595762..4138b50a 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:2472](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2472) +[src/types/types.ts:2472](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2472) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/types.ts:2473](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2473) +[src/types/types.ts:2473](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2473) diff --git a/docs-md/enums/DecodingAuthority.md b/docs-md/enums/DecodingAuthority.md index 77d8f1eb..c674d57c 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:1975](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1975) +[src/types/types.ts:1975](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1975) diff --git a/docs-md/enums/GetTransfersForOwnerTransferType.md b/docs-md/enums/GetTransfersForOwnerTransferType.md index 17968b84..112d5a23 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:1065](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1065) +[src/types/types.ts:1065](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1065) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/types.ts:1064](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1064) +[src/types/types.ts:1064](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1064) diff --git a/docs-md/enums/Network.md b/docs-md/enums/Network.md index 7692fe19..1a260536 100644 --- a/docs-md/enums/Network.md +++ b/docs-md/enums/Network.md @@ -37,7 +37,7 @@ available on which networks #### Defined in -[src/types/types.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L93) +[src/types/types.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L93) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[src/types/types.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L90) +[src/types/types.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L90) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[src/types/types.ts:92](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L92) +[src/types/types.ts:92](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L92) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[src/types/types.ts:96](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L96) +[src/types/types.ts:96](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L96) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[src/types/types.ts:80](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L80) +[src/types/types.ts:80](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L80) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[src/types/types.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L82) +[src/types/types.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L82) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[src/types/types.ts:77](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L77) +[src/types/types.ts:77](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L77) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -[src/types/types.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L84) +[src/types/types.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L84) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[src/types/types.ts:79](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L79) +[src/types/types.ts:79](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L79) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[src/types/types.ts:85](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L85) +[src/types/types.ts:85](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L85) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[src/types/types.ts:94](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L94) +[src/types/types.ts:94](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L94) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -[src/types/types.ts:95](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L95) +[src/types/types.ts:95](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L95) ___ @@ -165,7 +165,7 @@ ___ #### Defined in -[src/types/types.ts:89](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L89) +[src/types/types.ts:89](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L89) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -[src/types/types.ts:88](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L88) +[src/types/types.ts:88](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L88) ___ @@ -187,7 +187,7 @@ ___ #### Defined in -[src/types/types.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L86) +[src/types/types.ts:86](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L86) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -[src/types/types.ts:97](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L97) +[src/types/types.ts:97](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L97) ___ @@ -207,4 +207,4 @@ ___ #### Defined in -[src/types/types.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L98) +[src/types/types.ts:98](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L98) diff --git a/docs-md/enums/NftExcludeFilters.md b/docs-md/enums/NftExcludeFilters.md index 7d520fe3..ee07aeca 100644 --- a/docs-md/enums/NftExcludeFilters.md +++ b/docs-md/enums/NftExcludeFilters.md @@ -27,7 +27,7 @@ Exclude NFTs that have been airdropped to a user. #### Defined in -[src/types/types.ts:727](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L727) +[src/types/types.ts:727](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L727) ___ @@ -39,4 +39,4 @@ Exclude NFTs that have been classified as spam. #### Defined in -[src/types/types.ts:724](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L724) +[src/types/types.ts:724](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L724) diff --git a/docs-md/enums/NftFilters.md b/docs-md/enums/NftFilters.md index 90d7dc4e..5cf06f1a 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/types.ts:741](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L741) +[src/types/types.ts:741](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L741) ___ @@ -36,4 +36,4 @@ NFTs that have been classified as spam. #### Defined in -[src/types/types.ts:738](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L738) +[src/types/types.ts:738](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L738) diff --git a/docs-md/enums/NftOrdering.md b/docs-md/enums/NftOrdering.md index 0a7da2f5..8b087e4e 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/types.ts:751](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L751) +[src/types/types.ts:751](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L751) diff --git a/docs-md/enums/NftSaleMarketplace.md b/docs-md/enums/NftSaleMarketplace.md index 6862f244..71fc6892 100644 --- a/docs-md/enums/NftSaleMarketplace.md +++ b/docs-md/enums/NftSaleMarketplace.md @@ -24,7 +24,7 @@ Enum representing the supported NFT marketplaces by the #### Defined in -[src/types/types.ts:1332](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1332) +[src/types/types.ts:1332](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1332) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/types/types.ts:1329](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1329) +[src/types/types.ts:1329](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1329) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[src/types/types.ts:1328](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1328) +[src/types/types.ts:1328](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1328) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[src/types/types.ts:1333](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1333) +[src/types/types.ts:1333](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1333) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[src/types/types.ts:1331](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1331) +[src/types/types.ts:1331](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1331) ___ @@ -74,4 +74,4 @@ ___ #### Defined in -[src/types/types.ts:1330](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1330) +[src/types/types.ts:1330](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1330) diff --git a/docs-md/enums/NftSaleTakerType.md b/docs-md/enums/NftSaleTakerType.md index 0da877a7..423dae4d 100644 --- a/docs-md/enums/NftSaleTakerType.md +++ b/docs-md/enums/NftSaleTakerType.md @@ -20,7 +20,7 @@ method. #### Defined in -[src/types/types.ts:1343](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1343) +[src/types/types.ts:1343](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1343) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/types.ts:1344](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1344) +[src/types/types.ts:1344](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1344) diff --git a/docs-md/enums/NftSpamClassification.md b/docs-md/enums/NftSpamClassification.md index f4dd0daf..4e060d43 100644 --- a/docs-md/enums/NftSpamClassification.md +++ b/docs-md/enums/NftSpamClassification.md @@ -22,7 +22,7 @@ Potential reasons why an NFT contract was classified as spam. #### Defined in -[src/types/types.ts:590](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L590) +[src/types/types.ts:590](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L590) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[src/types/types.ts:588](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L588) +[src/types/types.ts:588](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L588) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/types/types.ts:589](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L589) +[src/types/types.ts:589](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L589) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/types/types.ts:591](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L591) +[src/types/types.ts:591](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L591) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[src/types/types.ts:592](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L592) +[src/types/types.ts:592](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L592) diff --git a/docs-md/enums/NftTokenType.md b/docs-md/enums/NftTokenType.md index dbfb1e3d..cc54aa5e 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/types.ts:400](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L400) +[src/types/types.ts:400](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L400) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[src/types/types.ts:399](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L399) +[src/types/types.ts:399](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L399) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/types/types.ts:402](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L402) +[src/types/types.ts:402](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L402) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/types/types.ts:401](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L401) +[src/types/types.ts:401](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L401) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[src/types/types.ts:403](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L403) +[src/types/types.ts:403](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L403) diff --git a/docs-md/enums/OpenSeaSafelistRequestStatus.md b/docs-md/enums/OpenSeaSafelistRequestStatus.md index 5a2f7a03..1d8a2dc0 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:1685](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1685) +[src/types/types.ts:1685](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1685) ___ @@ -35,7 +35,7 @@ Brand new collections. #### Defined in -[src/types/types.ts:1689](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1689) +[src/types/types.ts:1689](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1689) ___ @@ -47,7 +47,7 @@ Collections that requested safelisting on OpenSea. #### Defined in -[src/types/types.ts:1687](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1687) +[src/types/types.ts:1687](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1687) ___ @@ -59,4 +59,4 @@ Verified collection. #### Defined in -[src/types/types.ts:1683](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1683) +[src/types/types.ts:1683](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1683) diff --git a/docs-md/enums/RefreshState.md b/docs-md/enums/RefreshState.md index 799e89c5..664d9efb 100644 --- a/docs-md/enums/RefreshState.md +++ b/docs-md/enums/RefreshState.md @@ -25,7 +25,7 @@ The contract has already been queued for refresh. #### Defined in -[src/types/types.ts:1406](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1406) +[src/types/types.ts:1406](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1406) ___ @@ -37,7 +37,7 @@ The provided contract is not an NFT or does not contain metadata. #### Defined in -[src/types/types.ts:1403](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1403) +[src/types/types.ts:1403](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1403) ___ @@ -49,7 +49,7 @@ The contract refresh is complete. #### Defined in -[src/types/types.ts:1412](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1412) +[src/types/types.ts:1412](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1412) ___ @@ -61,7 +61,7 @@ The contract is currently being refreshed. #### Defined in -[src/types/types.ts:1409](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1409) +[src/types/types.ts:1409](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1409) ___ @@ -73,7 +73,7 @@ The contract refresh has been queued and await execution. #### Defined in -[src/types/types.ts:1415](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1415) +[src/types/types.ts:1415](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1415) ___ @@ -85,4 +85,4 @@ The contract was unable to be queued due to an internal error. #### Defined in -[src/types/types.ts:1418](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1418) +[src/types/types.ts:1418](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1418) diff --git a/docs-md/enums/SimulateAssetType.md b/docs-md/enums/SimulateAssetType.md index b5bc9580..a0c5b658 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:1855](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1855) +[src/types/types.ts:1855](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1855) ___ @@ -38,7 +38,7 @@ ERC20 approval or transfers. #### Defined in -[src/types/types.ts:1851](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1851) +[src/types/types.ts:1851](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1851) ___ @@ -50,7 +50,7 @@ ERC721 approval or transfers. #### Defined in -[src/types/types.ts:1853](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1853) +[src/types/types.ts:1853](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1853) ___ @@ -63,7 +63,7 @@ run on (ex: ETH for Ethereum, MATIC for Polygon, ETH for Arbitrum). #### Defined in -[src/types/types.ts:1849](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1849) +[src/types/types.ts:1849](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1849) ___ @@ -76,4 +76,4 @@ CryptoKitties and CryptoPunks. #### Defined in -[src/types/types.ts:1860](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1860) +[src/types/types.ts:1860](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1860) diff --git a/docs-md/enums/SimulateChangeType.md b/docs-md/enums/SimulateChangeType.md index 33ff9251..d7dcb51a 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:1875](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1875) +[src/types/types.ts:1875](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1875) ___ @@ -38,4 +38,4 @@ Represents a transaction that transferred tokens from one address to another. #### Defined in -[src/types/types.ts:1880](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1880) +[src/types/types.ts:1880](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1880) diff --git a/docs-md/enums/SortingOrder.md b/docs-md/enums/SortingOrder.md index a8cd40a2..7f8c5805 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:1317](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1317) +[src/types/types.ts:1317](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1317) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[src/types/types.ts:1318](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1318) +[src/types/types.ts:1318](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1318) diff --git a/docs-md/enums/TokenBalanceType.md b/docs-md/enums/TokenBalanceType.md index 1cbbed98..f2e53ac6 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:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L107) +[src/types/types.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L107) ___ @@ -36,4 +36,4 @@ all tokens that the address has ever received. #### Defined in -[src/types/types.ts:114](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L114) +[src/types/types.ts:114](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L114) diff --git a/docs-md/enums/WebhookType.md b/docs-md/enums/WebhookType.md index 7ac549f8..a00b262d 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:2154](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2154) +[src/types/types.ts:2154](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2154) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[src/types/types.ts:2153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2153) +[src/types/types.ts:2153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2153) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[src/types/types.ts:2157](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2157) +[src/types/types.ts:2157](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2157) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[src/types/types.ts:2152](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2152) +[src/types/types.ts:2152](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2152) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[src/types/types.ts:2155](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2155) +[src/types/types.ts:2155](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2155) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[src/types/types.ts:2156](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2156) +[src/types/types.ts:2156](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2156) diff --git a/docs-md/enums/WebhookVersion.md b/docs-md/enums/WebhookVersion.md index ac98344d..d30d0d7b 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:2146](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2146) +[src/types/types.ts:2146](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2146) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[src/types/types.ts:2147](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2147) +[src/types/types.ts:2147](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2147) diff --git a/docs-md/interfaces/AddressActivityResponse.md b/docs-md/interfaces/AddressActivityResponse.md index 62b79c29..256bbde7 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:2235](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2235) +[src/types/types.ts:2235](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2235) ___ @@ -34,7 +34,7 @@ Optional page key used to fetch the remaining addresses. #### Defined in -[src/types/types.ts:2239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2239) +[src/types/types.ts:2239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2239) ___ @@ -46,4 +46,4 @@ The total number of addresses. #### Defined in -[src/types/types.ts:2237](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2237) +[src/types/types.ts:2237](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2237) diff --git a/docs-md/interfaces/AddressActivityWebhook.md b/docs-md/interfaces/AddressActivityWebhook.md index 398856a1..df6dd4e4 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:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2141) +[src/types/types.ts:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2141) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2122) +[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2122) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2130) +[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2130) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2124) +[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2124) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2134) +[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2134) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2132) +[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2132) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:2184](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2184) +[src/types/types.ts:2184](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2184) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2128) +[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2128) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2136) +[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2136) diff --git a/docs-md/interfaces/AddressWebhookParams.md b/docs-md/interfaces/AddressWebhookParams.md index 2c493240..ae9eabdf 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:2298](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2298) +[src/types/types.ts:2298](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2298) ___ @@ -35,4 +35,4 @@ created on network of the app provided in the api key config. #### Defined in -[src/types/types.ts:2303](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2303) +[src/types/types.ts:2303](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2303) diff --git a/docs-md/interfaces/AlchemyMinedTransactionsEventFilter.md b/docs-md/interfaces/AlchemyMinedTransactionsEventFilter.md index bcdcf276..b9a22a8a 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:1785](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1785) +[src/types/types.ts:1785](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1785) ___ @@ -47,7 +47,7 @@ the entire transaction response is included). #### Defined in -[src/types/types.ts:1798](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1798) +[src/types/types.ts:1798](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1798) ___ @@ -60,7 +60,7 @@ Defaults to false. #### Defined in -[src/types/types.ts:1791](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1791) +[src/types/types.ts:1791](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1791) ___ @@ -70,4 +70,4 @@ ___ #### Defined in -[src/types/types.ts:1779](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1779) +[src/types/types.ts:1779](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1779) diff --git a/docs-md/interfaces/AlchemyPendingTransactionsEventFilter.md b/docs-md/interfaces/AlchemyPendingTransactionsEventFilter.md index 86b48080..fce66f3e 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:1741](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1741) +[src/types/types.ts:1741](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1741) ___ @@ -54,7 +54,7 @@ response as subscribing to `newPendingTransactions`. #### Defined in -[src/types/types.ts:1761](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1761) +[src/types/types.ts:1761](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1761) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[src/types/types.ts:1731](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1731) +[src/types/types.ts:1731](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1731) ___ @@ -81,4 +81,4 @@ present, then this filter will return transactions sent from the #### Defined in -[src/types/types.ts:1751](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1751) +[src/types/types.ts:1751](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1751) diff --git a/docs-md/interfaces/AlchemySettings.md b/docs-md/interfaces/AlchemySettings.md index 4227ceb8..21bff058 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:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L25) +[src/types/types.ts:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L25) ___ @@ -41,7 +41,7 @@ in the Alchemy Dashboard on the Notify tab. #### Defined in -[src/types/types.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L51) +[src/types/types.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L51) ___ @@ -56,7 +56,7 @@ This implementation is based on the `JsonRpcBatchProvider` in ethers. #### Defined in -[src/types/types.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L65) +[src/types/types.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L65) ___ @@ -68,7 +68,7 @@ The maximum number of retries to attempt if a request fails. Defaults to 5. #### Defined in -[src/types/types.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L36) +[src/types/types.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L36) ___ @@ -83,7 +83,7 @@ Defaults to: Network.ETH_MAINNET #### Defined in -[src/types/types.ts:33](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L33) +[src/types/types.ts:33](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L33) ___ @@ -96,7 +96,7 @@ Default to 0 (No timeout). #### Defined in -[src/types/types.ts:57](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L57) +[src/types/types.ts:57](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L57) ___ @@ -112,4 +112,4 @@ that not all methods will work with custom URLs. #### Defined in -[src/types/types.ts:45](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L45) +[src/types/types.ts:45](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L45) diff --git a/docs-md/interfaces/AssetTransfersMetadata.md b/docs-md/interfaces/AssetTransfersMetadata.md index 81761dd7..f77c1958 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:502](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L502) +[src/types/types.ts:502](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L502) diff --git a/docs-md/interfaces/AssetTransfersParams.md b/docs-md/interfaces/AssetTransfersParams.md index 6bd83f3d..b4e15e67 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:318](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L318) +[src/types/types.ts:318](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L318) ___ @@ -49,7 +49,7 @@ List of contract addresses to filter for - only applies to "erc20", #### Defined in -[src/types/types.ts:309](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L309) +[src/types/types.ts:309](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L309) ___ @@ -62,7 +62,7 @@ different than null value. Defaults to `true` if omitted. #### Defined in -[src/types/types.ts:315](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L315) +[src/types/types.ts:315](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L315) ___ @@ -75,7 +75,7 @@ for all addresses if omitted. #### Defined in -[src/types/types.ts:297](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L297) +[src/types/types.ts:297](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L297) ___ @@ -88,7 +88,7 @@ defaults to `0x0` if omitted. #### Defined in -[src/types/types.ts:279](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L279) +[src/types/types.ts:279](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L279) ___ @@ -100,7 +100,7 @@ The maximum number of results to return per page. Defaults to 1000 if omitted. #### Defined in -[src/types/types.ts:321](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L321) +[src/types/types.ts:321](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L321) ___ @@ -113,7 +113,7 @@ Defaults to ascending if omitted. #### Defined in -[src/types/types.ts:291](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L291) +[src/types/types.ts:291](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L291) ___ @@ -126,7 +126,7 @@ Optional page key from an existing [OwnedBaseNftsResponse](OwnedBaseNftsResponse #### Defined in -[src/types/types.ts:327](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L327) +[src/types/types.ts:327](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L327) ___ @@ -139,7 +139,7 @@ for all address if omitted. #### Defined in -[src/types/types.ts:303](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L303) +[src/types/types.ts:303](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L303) ___ @@ -152,7 +152,7 @@ defaults to the latest block if omitted. #### Defined in -[src/types/types.ts:285](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L285) +[src/types/types.ts:285](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L285) ___ @@ -165,4 +165,4 @@ to `false` if omitted. #### Defined in -[src/types/types.ts:333](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L333) +[src/types/types.ts:333](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L333) diff --git a/docs-md/interfaces/AssetTransfersResponse.md b/docs-md/interfaces/AssetTransfersResponse.md index b95ae60c..ccb66f74 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:414](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L414) +[src/types/types.ts:414](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L414) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[src/types/types.ts:412](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L412) +[src/types/types.ts:412](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L412) diff --git a/docs-md/interfaces/AssetTransfersResult.md b/docs-md/interfaces/AssetTransfersResult.md index b58e227c..e9ee3d11 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:474](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L474) +[src/types/types.ts:474](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L474) ___ @@ -50,7 +50,7 @@ The block number where the transfer occurred. #### Defined in -[src/types/types.ts:441](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L441) +[src/types/types.ts:441](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L441) ___ @@ -62,7 +62,7 @@ The category of the transfer. #### Defined in -[src/types/types.ts:438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L438) +[src/types/types.ts:438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L438) ___ @@ -75,7 +75,7 @@ token. `null` if not an ERC1155 transfer. #### Defined in -[src/types/types.ts:465](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L465) +[src/types/types.ts:465](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L465) ___ @@ -88,7 +88,7 @@ ERC721 transfer. #### Defined in -[src/types/types.ts:459](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L459) +[src/types/types.ts:459](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L459) ___ @@ -100,7 +100,7 @@ The from address of the transfer. #### Defined in -[src/types/types.ts:444](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L444) +[src/types/types.ts:444](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L444) ___ @@ -112,7 +112,7 @@ The transaction hash of the transfer transaction. #### Defined in -[src/types/types.ts:477](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L477) +[src/types/types.ts:477](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L477) ___ @@ -124,7 +124,7 @@ Information about the raw contract of the asset transferred. #### Defined in -[src/types/types.ts:480](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L480) +[src/types/types.ts:480](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L480) ___ @@ -136,7 +136,7 @@ The to address of the transfer. #### Defined in -[src/types/types.ts:447](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L447) +[src/types/types.ts:447](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L447) ___ @@ -148,7 +148,7 @@ The token id of the token transferred. #### Defined in -[src/types/types.ts:468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L468) +[src/types/types.ts:468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L468) ___ @@ -160,7 +160,7 @@ The unique ID of the transfer. #### Defined in -[src/types/types.ts:435](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L435) +[src/types/types.ts:435](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L435) ___ @@ -173,4 +173,4 @@ decimal). `null` if ERC721 transfer or contract decimal not available. #### Defined in -[src/types/types.ts:453](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L453) +[src/types/types.ts:453](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L453) diff --git a/docs-md/interfaces/AssetTransfersWithMetadataParams.md b/docs-md/interfaces/AssetTransfersWithMetadataParams.md index 9553173a..93e33cc5 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:318](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L318) +[src/types/types.ts:318](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L318) ___ @@ -58,7 +58,7 @@ List of contract addresses to filter for - only applies to "erc20", #### Defined in -[src/types/types.ts:309](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L309) +[src/types/types.ts:309](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L309) ___ @@ -75,7 +75,7 @@ different than null value. Defaults to `true` if omitted. #### Defined in -[src/types/types.ts:315](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L315) +[src/types/types.ts:315](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L315) ___ @@ -92,7 +92,7 @@ for all addresses if omitted. #### Defined in -[src/types/types.ts:297](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L297) +[src/types/types.ts:297](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L297) ___ @@ -109,7 +109,7 @@ defaults to `0x0` if omitted. #### Defined in -[src/types/types.ts:279](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L279) +[src/types/types.ts:279](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L279) ___ @@ -125,7 +125,7 @@ The maximum number of results to return per page. Defaults to 1000 if omitted. #### Defined in -[src/types/types.ts:321](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L321) +[src/types/types.ts:321](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L321) ___ @@ -142,7 +142,7 @@ Defaults to ascending if omitted. #### Defined in -[src/types/types.ts:291](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L291) +[src/types/types.ts:291](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L291) ___ @@ -159,7 +159,7 @@ Optional page key from an existing [OwnedBaseNftsResponse](OwnedBaseNftsResponse #### Defined in -[src/types/types.ts:327](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L327) +[src/types/types.ts:327](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L327) ___ @@ -176,7 +176,7 @@ for all address if omitted. #### Defined in -[src/types/types.ts:303](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L303) +[src/types/types.ts:303](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L303) ___ @@ -193,7 +193,7 @@ defaults to the latest block if omitted. #### Defined in -[src/types/types.ts:285](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L285) +[src/types/types.ts:285](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L285) ___ @@ -210,4 +210,4 @@ to `false` if omitted. #### Defined in -[src/types/types.ts:343](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L343) +[src/types/types.ts:343](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L343) diff --git a/docs-md/interfaces/AssetTransfersWithMetadataResponse.md b/docs-md/interfaces/AssetTransfersWithMetadataResponse.md index 1045c585..210fc934 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:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L425) +[src/types/types.ts:425](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L425) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/types.ts:424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L424) +[src/types/types.ts:424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L424) diff --git a/docs-md/interfaces/AssetTransfersWithMetadataResult.md b/docs-md/interfaces/AssetTransfersWithMetadataResult.md index 6e5c2bc9..4e2ab6c1 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:474](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L474) +[src/types/types.ts:474](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L474) ___ @@ -60,7 +60,7 @@ The block number where the transfer occurred. #### Defined in -[src/types/types.ts:441](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L441) +[src/types/types.ts:441](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L441) ___ @@ -76,7 +76,7 @@ The category of the transfer. #### Defined in -[src/types/types.ts:438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L438) +[src/types/types.ts:438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L438) ___ @@ -93,7 +93,7 @@ token. `null` if not an ERC1155 transfer. #### Defined in -[src/types/types.ts:465](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L465) +[src/types/types.ts:465](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L465) ___ @@ -110,7 +110,7 @@ ERC721 transfer. #### Defined in -[src/types/types.ts:459](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L459) +[src/types/types.ts:459](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L459) ___ @@ -126,7 +126,7 @@ The from address of the transfer. #### Defined in -[src/types/types.ts:444](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L444) +[src/types/types.ts:444](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L444) ___ @@ -142,7 +142,7 @@ The transaction hash of the transfer transaction. #### Defined in -[src/types/types.ts:477](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L477) +[src/types/types.ts:477](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L477) ___ @@ -154,7 +154,7 @@ Additional metadata about the transfer event. #### Defined in -[src/types/types.ts:491](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L491) +[src/types/types.ts:491](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L491) ___ @@ -170,7 +170,7 @@ Information about the raw contract of the asset transferred. #### Defined in -[src/types/types.ts:480](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L480) +[src/types/types.ts:480](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L480) ___ @@ -186,7 +186,7 @@ The to address of the transfer. #### Defined in -[src/types/types.ts:447](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L447) +[src/types/types.ts:447](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L447) ___ @@ -202,7 +202,7 @@ The token id of the token transferred. #### Defined in -[src/types/types.ts:468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L468) +[src/types/types.ts:468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L468) ___ @@ -218,7 +218,7 @@ The unique ID of the transfer. #### Defined in -[src/types/types.ts:435](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L435) +[src/types/types.ts:435](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L435) ___ @@ -235,4 +235,4 @@ decimal). `null` if ERC721 transfer or contract decimal not available. #### Defined in -[src/types/types.ts:453](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L453) +[src/types/types.ts:453](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L453) diff --git a/docs-md/interfaces/BaseNft.md b/docs-md/interfaces/BaseNft.md index 4c10d11c..d050a0b3 100644 --- a/docs-md/interfaces/BaseNft.md +++ b/docs-md/interfaces/BaseNft.md @@ -32,7 +32,7 @@ metadata, token URI information, and media. #### Defined in -[src/api/nft.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L63) +[src/api/nft.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L63) ___ @@ -44,7 +44,7 @@ The NFT token ID as an integer string. #### Defined in -[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L65) +[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L65) ___ @@ -56,4 +56,4 @@ The type of ERC token, if known. #### Defined in -[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L67) +[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L67) diff --git a/docs-md/interfaces/BaseNftContract.md b/docs-md/interfaces/BaseNftContract.md index 6dd77d37..f9d0c8a8 100644 --- a/docs-md/interfaces/BaseNftContract.md +++ b/docs-md/interfaces/BaseNftContract.md @@ -30,4 +30,4 @@ The address of the contract. #### Defined in -[src/api/nft.ts:21](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L21) +[src/api/nft.ts:21](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L21) diff --git a/docs-md/interfaces/ContractForOwner.md b/docs-md/interfaces/ContractForOwner.md index 34a077e9..886e2119 100644 --- a/docs-md/interfaces/ContractForOwner.md +++ b/docs-md/interfaces/ContractForOwner.md @@ -43,7 +43,7 @@ The address of the contract. #### Defined in -[src/api/nft.ts:21](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L21) +[src/api/nft.ts:21](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L21) ___ @@ -59,7 +59,7 @@ The address that deployed the NFT contract. #### Defined in -[src/api/nft.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L48) +[src/api/nft.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L48) ___ @@ -75,7 +75,7 @@ The block number the NFT contract deployed in. #### Defined in -[src/api/nft.ts:50](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L50) +[src/api/nft.ts:50](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L50) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[src/types/types.ts:1050](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1050) +[src/types/types.ts:1050](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1050) ___ @@ -97,7 +97,7 @@ Alternative NFT metadata for this contract to be parsed manually. #### Defined in -[src/types/types.ts:1056](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1056) +[src/types/types.ts:1056](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1056) ___ @@ -113,7 +113,7 @@ The name of the contract. #### Defined in -[src/api/nft.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L37) +[src/api/nft.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L37) ___ @@ -127,7 +127,7 @@ holds some fungible ERC1155 tokens. #### Defined in -[src/types/types.ts:1048](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1048) +[src/types/types.ts:1048](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1048) ___ @@ -143,7 +143,7 @@ OpenSea's metadata for the contract. #### Defined in -[src/api/nft.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L46) +[src/api/nft.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L46) ___ @@ -159,7 +159,7 @@ The symbol of the contract. #### Defined in -[src/api/nft.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L39) +[src/api/nft.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L39) ___ @@ -171,7 +171,7 @@ The title of the token held by the owner. #### Defined in -[src/types/types.ts:1041](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1041) +[src/types/types.ts:1041](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1041) ___ @@ -183,7 +183,7 @@ One of the tokens from this contract held by the owner. #### Defined in -[src/types/types.ts:1053](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1053) +[src/types/types.ts:1053](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1053) ___ @@ -199,7 +199,7 @@ The type of the token in the contract. #### Defined in -[src/api/nft.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L35) +[src/api/nft.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L35) ___ @@ -213,7 +213,7 @@ it may be higher if the user holds some fungible ERC1155 tokens. #### Defined in -[src/types/types.ts:1038](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1038) +[src/types/types.ts:1038](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1038) ___ @@ -230,4 +230,4 @@ available on ERC-721 contracts. #### Defined in -[src/api/nft.ts:44](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L44) +[src/api/nft.ts:44](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L44) diff --git a/docs-md/interfaces/CustomGraphqlWebhook.md b/docs-md/interfaces/CustomGraphqlWebhook.md index 92b8a04d..39a5da11 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:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2141) +[src/types/types.ts:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2141) ___ @@ -58,7 +58,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2122) +[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2122) ___ @@ -74,7 +74,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2130) +[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2130) ___ @@ -90,7 +90,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2124) +[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2124) ___ @@ -106,7 +106,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2134) +[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2134) ___ @@ -122,7 +122,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2132) +[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2132) ___ @@ -138,7 +138,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:2212](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2212) +[src/types/types.ts:2212](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2212) ___ @@ -154,7 +154,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2128) +[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2128) ___ @@ -170,4 +170,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2136) +[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2136) diff --git a/docs-md/interfaces/CustomGraphqlWebhookConfig.md b/docs-md/interfaces/CustomGraphqlWebhookConfig.md index c29e3ef2..b7bf59f3 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:2245](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2245) +[src/types/types.ts:2245](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2245) diff --git a/docs-md/interfaces/CustomGraphqlWebhookParams.md b/docs-md/interfaces/CustomGraphqlWebhookParams.md index 8cc6d93d..949e47c8 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:2284](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2284) +[src/types/types.ts:2284](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2284) ___ @@ -35,4 +35,4 @@ created on network of the app provided in the api key config. #### Defined in -[src/types/types.ts:2289](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2289) +[src/types/types.ts:2289](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2289) diff --git a/docs-md/interfaces/DebugCallTrace.md b/docs-md/interfaces/DebugCallTrace.md index 94aa1acc..e14691da 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:2544](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2544) +[src/types/types.ts:2544](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2544) ___ @@ -42,7 +42,7 @@ Optional error field. #### Defined in -[src/types/types.ts:2540](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2540) +[src/types/types.ts:2540](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2540) ___ @@ -54,7 +54,7 @@ From address of the transaction. #### Defined in -[src/types/types.ts:2526](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2526) +[src/types/types.ts:2526](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2526) ___ @@ -66,7 +66,7 @@ Gas provided for call as a hex string. #### Defined in -[src/types/types.ts:2532](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2532) +[src/types/types.ts:2532](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2532) ___ @@ -78,7 +78,7 @@ Gas used during the call as a hex string. #### Defined in -[src/types/types.ts:2534](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2534) +[src/types/types.ts:2534](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2534) ___ @@ -90,7 +90,7 @@ Call data. #### Defined in -[src/types/types.ts:2536](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2536) +[src/types/types.ts:2536](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2536) ___ @@ -102,7 +102,7 @@ Return data. #### Defined in -[src/types/types.ts:2538](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2538) +[src/types/types.ts:2538](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2538) ___ @@ -114,7 +114,7 @@ Solidity revert reason, if the call reverted. #### Defined in -[src/types/types.ts:2542](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2542) +[src/types/types.ts:2542](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2542) ___ @@ -126,7 +126,7 @@ To address of the transaction. #### Defined in -[src/types/types.ts:2528](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2528) +[src/types/types.ts:2528](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2528) ___ @@ -138,7 +138,7 @@ The type of call: `CALL` or `CREATE` for the top-level call. #### Defined in -[src/types/types.ts:2524](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2524) +[src/types/types.ts:2524](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2524) ___ @@ -150,4 +150,4 @@ Amount of value transfer as a hex string. #### Defined in -[src/types/types.ts:2530](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2530) +[src/types/types.ts:2530](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2530) diff --git a/docs-md/interfaces/DebugCallTracer.md b/docs-md/interfaces/DebugCallTracer.md index a3c76e5a..1954ab85 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:2496](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2496) +[src/types/types.ts:2496](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2496) ___ @@ -44,4 +44,4 @@ Specified type is `CALL_TRACER`. #### Defined in -[src/types/types.ts:2491](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2491) +[src/types/types.ts:2491](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2491) diff --git a/docs-md/interfaces/DebugPrestate.md b/docs-md/interfaces/DebugPrestate.md index f5e6ac8b..cc408c46 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:2587](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2587) +[src/types/types.ts:2587](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2587) ___ @@ -35,7 +35,7 @@ Hex-encoded bytecode. #### Defined in -[src/types/types.ts:2591](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2591) +[src/types/types.ts:2591](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2591) ___ @@ -47,7 +47,7 @@ Nonce #### Defined in -[src/types/types.ts:2589](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2589) +[src/types/types.ts:2589](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2589) ___ @@ -59,4 +59,4 @@ Storage slots of the contract. #### Defined in -[src/types/types.ts:2593](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2593) +[src/types/types.ts:2593](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2593) diff --git a/docs-md/interfaces/DebugPrestateTracer.md b/docs-md/interfaces/DebugPrestateTracer.md index 22405e73..c178d65d 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:2516](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2516) +[src/types/types.ts:2516](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2516) ___ @@ -41,4 +41,4 @@ Specified type is `PRESTATE_TRACER`. #### Defined in -[src/types/types.ts:2511](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2511) +[src/types/types.ts:2511](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2511) diff --git a/docs-md/interfaces/DebugTransaction.md b/docs-md/interfaces/DebugTransaction.md index b6d343de..d9c7b7f8 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:2424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2424) +[src/types/types.ts:2424](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2424) ___ @@ -37,7 +37,7 @@ The address the transaction is sent from. #### Defined in -[src/types/types.ts:2416](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2416) +[src/types/types.ts:2416](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2416) ___ @@ -49,7 +49,7 @@ The gas provided for the transaction execution, as a hex string. #### Defined in -[src/types/types.ts:2418](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2418) +[src/types/types.ts:2418](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2418) ___ @@ -61,7 +61,7 @@ The gas price to use as a hex string. #### Defined in -[src/types/types.ts:2420](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2420) +[src/types/types.ts:2420](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2420) ___ @@ -73,7 +73,7 @@ The address the transaction is directed to. #### Defined in -[src/types/types.ts:2414](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2414) +[src/types/types.ts:2414](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2414) ___ @@ -85,4 +85,4 @@ The value associated with the transaction as a hex string. #### Defined in -[src/types/types.ts:2422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2422) +[src/types/types.ts:2422](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2422) diff --git a/docs-md/interfaces/DecodedCallParam.md b/docs-md/interfaces/DecodedCallParam.md index 4187089f..77f735de 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:1983](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1983) +[src/types/types.ts:1983](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1983) ___ @@ -40,7 +40,7 @@ The type of the parameter. #### Defined in -[src/types/types.ts:1985](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1985) +[src/types/types.ts:1985](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1985) ___ @@ -52,4 +52,4 @@ Value of the parameter. #### Defined in -[src/types/types.ts:1981](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1981) +[src/types/types.ts:1981](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1981) diff --git a/docs-md/interfaces/DecodedDebugCallTrace.md b/docs-md/interfaces/DecodedDebugCallTrace.md index 2b657240..d4a0804c 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:2006](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2006) +[src/types/types.ts:2006](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2006) ___ @@ -36,7 +36,7 @@ Method inputs. #### Defined in -[src/types/types.ts:2002](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2002) +[src/types/types.ts:2002](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2002) ___ @@ -48,7 +48,7 @@ The smart contract method called. #### Defined in -[src/types/types.ts:2000](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2000) +[src/types/types.ts:2000](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2000) ___ @@ -60,4 +60,4 @@ Method outputs. #### Defined in -[src/types/types.ts:2004](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2004) +[src/types/types.ts:2004](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2004) diff --git a/docs-md/interfaces/DecodedLog.md b/docs-md/interfaces/DecodedLog.md index 98fea2cc..0dfc3fbf 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:2039](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2039) +[src/types/types.ts:2039](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2039) ___ @@ -35,7 +35,7 @@ The decoded name of the log event. #### Defined in -[src/types/types.ts:2035](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2035) +[src/types/types.ts:2035](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2035) ___ @@ -47,4 +47,4 @@ The decoded inputs to the log. #### Defined in -[src/types/types.ts:2037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2037) +[src/types/types.ts:2037](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2037) diff --git a/docs-md/interfaces/DecodedLogInput.md b/docs-md/interfaces/DecodedLogInput.md index 71e9c11d..4417cd4b 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:1991](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1991) +[src/types/types.ts:1991](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1991) ___ @@ -45,7 +45,7 @@ The name of the parameter. #### Defined in -[src/types/types.ts:1983](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1983) +[src/types/types.ts:1983](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1983) ___ @@ -61,7 +61,7 @@ The type of the parameter. #### Defined in -[src/types/types.ts:1985](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1985) +[src/types/types.ts:1985](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1985) ___ @@ -77,4 +77,4 @@ Value of the parameter. #### Defined in -[src/types/types.ts:1981](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1981) +[src/types/types.ts:1981](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1981) diff --git a/docs-md/interfaces/DeployResult.md b/docs-md/interfaces/DeployResult.md index 8704a8a6..eb630316 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:1702](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1702) +[src/types/types.ts:1702](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1702) ___ @@ -33,4 +33,4 @@ The address of the contract deployer, if it is available. #### Defined in -[src/types/types.ts:1699](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1699) +[src/types/types.ts:1699](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1699) diff --git a/docs-md/interfaces/DroppedTransactionWebhook.md b/docs-md/interfaces/DroppedTransactionWebhook.md index 443300cf..ed813198 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:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2141) +[src/types/types.ts:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2141) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2122) +[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2122) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2130) +[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2130) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2124) +[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2124) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2134) +[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2134) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2132) +[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2132) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:2175](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2175) +[src/types/types.ts:2175](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2175) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2128) +[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2128) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2136) +[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2136) diff --git a/docs-md/interfaces/ERC1155Metadata.md b/docs-md/interfaces/ERC1155Metadata.md index 831731a8..c12ea455 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/types.ts:1467](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1467) +[src/types/types.ts:1467](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1467) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/types/types.ts:1468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1468) +[src/types/types.ts:1468](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1468) diff --git a/docs-md/interfaces/EventFilter.md b/docs-md/interfaces/EventFilter.md index b0771e49..77f96ca0 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:2572](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2572) +[src/types/types.ts:2572](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2572) ___ @@ -41,4 +41,4 @@ The topics to filter by, or null to match any topics. #### Defined in -[src/types/types.ts:2574](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2574) +[src/types/types.ts:2574](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2574) diff --git a/docs-md/interfaces/Filter.md b/docs-md/interfaces/Filter.md index 2c8d5903..337cb519 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:2572](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2572) +[src/types/types.ts:2572](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2572) ___ @@ -46,7 +46,7 @@ The starting block (inclusive) to search for logs matching the filter. #### Defined in -[src/types/types.ts:2562](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2562) +[src/types/types.ts:2562](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2562) ___ @@ -58,7 +58,7 @@ The end block (inclusive) to search for logs matching the filter. #### Defined in -[src/types/types.ts:2564](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2564) +[src/types/types.ts:2564](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2564) ___ @@ -74,4 +74,4 @@ The topics to filter by, or null to match any topics. #### Defined in -[src/types/types.ts:2574](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2574) +[src/types/types.ts:2574](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2574) diff --git a/docs-md/interfaces/FilterByBlockHash.md b/docs-md/interfaces/FilterByBlockHash.md index 6363eefe..2950369d 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:2572](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2572) +[src/types/types.ts:2572](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2572) ___ @@ -45,7 +45,7 @@ The specific block hash to search for logs matching the filter. #### Defined in -[src/types/types.ts:2553](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2553) +[src/types/types.ts:2553](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2553) ___ @@ -61,4 +61,4 @@ The topics to filter by, or null to match any topics. #### Defined in -[src/types/types.ts:2574](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2574) +[src/types/types.ts:2574](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2574) diff --git a/docs-md/interfaces/FloorPriceError.md b/docs-md/interfaces/FloorPriceError.md index 31d70b5c..9ba22348 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/types.ts:962](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L962) +[src/types/types.ts:962](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L962) diff --git a/docs-md/interfaces/FloorPriceMarketplace.md b/docs-md/interfaces/FloorPriceMarketplace.md index d29982dd..e8f2c47f 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/types.ts:949](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L949) +[src/types/types.ts:949](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L949) ___ @@ -36,7 +36,7 @@ The floor price of the collection on the given marketplace #### Defined in -[src/types/types.ts:945](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L945) +[src/types/types.ts:945](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L945) ___ @@ -48,7 +48,7 @@ The currency in which the floor price is denominated #### Defined in -[src/types/types.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L947) +[src/types/types.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L947) ___ @@ -60,4 +60,4 @@ UTC timestamp of when the floor price was retrieved from the marketplace #### Defined in -[src/types/types.ts:951](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L951) +[src/types/types.ts:951](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L951) diff --git a/docs-md/interfaces/GetAddressesOptions.md b/docs-md/interfaces/GetAddressesOptions.md index 52c3d0ba..3df796b1 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:2226](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2226) +[src/types/types.ts:2226](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2226) ___ @@ -33,4 +33,4 @@ Page #### Defined in -[src/types/types.ts:2229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2229) +[src/types/types.ts:2229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2229) diff --git a/docs-md/interfaces/GetAllWebhooksResponse.md b/docs-md/interfaces/GetAllWebhooksResponse.md index 53427743..577826a5 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:2220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2220) +[src/types/types.ts:2220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2220) ___ @@ -33,4 +33,4 @@ All webhooks attached to the provided auth token. #### Defined in -[src/types/types.ts:2218](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2218) +[src/types/types.ts:2218](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2218) diff --git a/docs-md/interfaces/GetBaseNftsForContractOptions.md b/docs-md/interfaces/GetBaseNftsForContractOptions.md index 7da1a8cb..b19880e3 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/types.ts:1545](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1545) +[src/types/types.ts:1545](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1545) ___ @@ -40,7 +40,7 @@ Optional page key from an existing [NftContractBaseNftsResponse](NftContractBase #### Defined in -[src/types/types.ts:1542](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1542) +[src/types/types.ts:1542](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1542) ___ @@ -53,7 +53,7 @@ Maximum page size is 100. #### Defined in -[src/types/types.ts:1551](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1551) +[src/types/types.ts:1551](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1551) ___ @@ -68,4 +68,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/types.ts:1559](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1559) +[src/types/types.ts:1559](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1559) diff --git a/docs-md/interfaces/GetBaseNftsForOwnerOptions.md b/docs-md/interfaces/GetBaseNftsForOwnerOptions.md index 3cd881af..29da32a7 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/types.ts:675](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L675) +[src/types/types.ts:675](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L675) ___ @@ -44,7 +44,7 @@ of these filters are excluded from the response. #### Defined in -[src/types/types.ts:681](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L681) +[src/types/types.ts:681](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L681) ___ @@ -57,7 +57,7 @@ of these filters are included in the response. #### Defined in -[src/types/types.ts:687](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L687) +[src/types/types.ts:687](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L687) ___ @@ -69,7 +69,7 @@ Optional boolean flag to include NFT metadata. Defaults to `false`. #### Defined in -[src/types/types.ts:696](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L696) +[src/types/types.ts:696](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L696) ___ @@ -82,7 +82,7 @@ contract address and token ID in lexicographic order. #### Defined in -[src/types/types.ts:710](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L710) +[src/types/types.ts:710](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L710) ___ @@ -95,7 +95,7 @@ Optional page key from an existing [OwnedBaseNftsResponse](OwnedBaseNftsResponse #### Defined in -[src/types/types.ts:672](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L672) +[src/types/types.ts:672](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L672) ___ @@ -108,7 +108,7 @@ Maximum page size is 100. #### Defined in -[src/types/types.ts:693](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L693) +[src/types/types.ts:693](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L693) ___ @@ -123,4 +123,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/types.ts:704](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L704) +[src/types/types.ts:704](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L704) diff --git a/docs-md/interfaces/GetContractsForOwnerOptions.md b/docs-md/interfaces/GetContractsForOwnerOptions.md index 66336121..0f58d99e 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/types.ts:1006](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1006) +[src/types/types.ts:1006](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1006) ___ @@ -40,7 +40,7 @@ conjunction with [excludeFilters](GetContractsForOwnerOptions.md#excludefilters) #### Defined in -[src/types/types.ts:999](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L999) +[src/types/types.ts:999](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L999) ___ @@ -53,7 +53,7 @@ contract address and token ID in lexicographic order. #### Defined in -[src/types/types.ts:1012](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1012) +[src/types/types.ts:1012](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1012) ___ @@ -65,7 +65,7 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/types.ts:986](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L986) +[src/types/types.ts:986](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L986) ___ @@ -78,4 +78,4 @@ is 100. Defaults to 100. #### Defined in -[src/types/types.ts:992](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L992) +[src/types/types.ts:992](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L992) diff --git a/docs-md/interfaces/GetContractsForOwnerResponse.md b/docs-md/interfaces/GetContractsForOwnerResponse.md index b2b375e6..03978052 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/types.ts:1022](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1022) +[src/types/types.ts:1022](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1022) ___ @@ -34,7 +34,7 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/types.ts:1025](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1025) +[src/types/types.ts:1025](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1025) ___ @@ -46,4 +46,4 @@ Total number of NFT contracts held by the given address. #### Defined in -[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1028) +[src/types/types.ts:1028](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1028) diff --git a/docs-md/interfaces/GetFloorPriceResponse.md b/docs-md/interfaces/GetFloorPriceResponse.md index f94cc190..59eefee6 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/types.ts:976](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L976) +[src/types/types.ts:976](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L976) ___ @@ -32,4 +32,4 @@ marketplaces supported: OpenSea, LooksRare #### Defined in -[src/types/types.ts:975](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L975) +[src/types/types.ts:975](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L975) diff --git a/docs-md/interfaces/GetMintedNftsOptions.md b/docs-md/interfaces/GetMintedNftsOptions.md index 277ba2de..088e94d0 100644 --- a/docs-md/interfaces/GetMintedNftsOptions.md +++ b/docs-md/interfaces/GetMintedNftsOptions.md @@ -23,7 +23,7 @@ all contract addresses. #### Defined in -[src/types/types.ts:1149](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1149) +[src/types/types.ts:1149](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1149) ___ @@ -36,7 +36,7 @@ pagination. #### Defined in -[src/types/types.ts:1161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1161) +[src/types/types.ts:1161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1161) ___ @@ -49,4 +49,4 @@ NFTs. #### Defined in -[src/types/types.ts:1155](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1155) +[src/types/types.ts:1155](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1155) diff --git a/docs-md/interfaces/GetMintedNftsResponse.md b/docs-md/interfaces/GetMintedNftsResponse.md index f77d9c46..b811c2b2 100644 --- a/docs-md/interfaces/GetMintedNftsResponse.md +++ b/docs-md/interfaces/GetMintedNftsResponse.md @@ -21,7 +21,7 @@ An array of the minted NFTs for the provided owner address. #### Defined in -[src/types/types.ts:1169](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1169) +[src/types/types.ts:1169](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1169) ___ @@ -33,4 +33,4 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/types.ts:1172](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1172) +[src/types/types.ts:1172](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1172) diff --git a/docs-md/interfaces/GetNftMetadataOptions.md b/docs-md/interfaces/GetNftMetadataOptions.md index c3dc34ce..40aaef8e 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/types.ts:902](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L902) +[src/types/types.ts:902](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L902) ___ @@ -35,7 +35,7 @@ Optional field to specify the type of token to speed up the query. #### Defined in -[src/types/types.ts:889](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L889) +[src/types/types.ts:889](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L889) ___ @@ -50,4 +50,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/types.ts:896](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L896) +[src/types/types.ts:896](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L896) diff --git a/docs-md/interfaces/GetNftSalesOptions.md b/docs-md/interfaces/GetNftSalesOptions.md index 18bca710..a823a6c7 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/types.ts:1196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1196) +[src/types/types.ts:1196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1196) ___ @@ -48,7 +48,7 @@ The block number to start fetching NFT sales data from. #### Defined in -[src/types/types.ts:1184](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1184) +[src/types/types.ts:1184](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1184) ___ @@ -60,7 +60,7 @@ The maximum number of NFT sales to return. #### Defined in -[src/types/types.ts:1208](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1208) +[src/types/types.ts:1208](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1208) ___ @@ -72,7 +72,7 @@ The NFT marketplace to filter sales by. #### Defined in -[src/types/types.ts:1193](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1193) +[src/types/types.ts:1193](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1193) ___ @@ -84,7 +84,7 @@ Whether to return the results in ascending or descending order by block number. #### Defined in -[src/types/types.ts:1190](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1190) +[src/types/types.ts:1190](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1190) ___ @@ -96,7 +96,7 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/types.ts:1211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1211) +[src/types/types.ts:1211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1211) ___ @@ -108,7 +108,7 @@ The address of the NFT seller to filter sales by. #### Defined in -[src/types/types.ts:1199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1199) +[src/types/types.ts:1199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1199) ___ @@ -121,7 +121,7 @@ Defaults to returning both buyer and seller taker trades. #### Defined in -[src/types/types.ts:1205](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1205) +[src/types/types.ts:1205](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1205) ___ @@ -133,4 +133,4 @@ The block number limit to fetch NFT sales data from. #### Defined in -[src/types/types.ts:1187](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1187) +[src/types/types.ts:1187](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1187) diff --git a/docs-md/interfaces/GetNftSalesOptionsByContractAddress.md b/docs-md/interfaces/GetNftSalesOptionsByContractAddress.md index 37e9cc89..af0f617f 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/types.ts:1196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1196) +[src/types/types.ts:1196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1196) ___ @@ -55,7 +55,7 @@ The contract address of a NFT collection to filter sales by. #### Defined in -[src/types/types.ts:1225](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1225) +[src/types/types.ts:1225](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1225) ___ @@ -71,7 +71,7 @@ The block number to start fetching NFT sales data from. #### Defined in -[src/types/types.ts:1184](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1184) +[src/types/types.ts:1184](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1184) ___ @@ -87,7 +87,7 @@ The maximum number of NFT sales to return. #### Defined in -[src/types/types.ts:1208](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1208) +[src/types/types.ts:1208](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1208) ___ @@ -103,7 +103,7 @@ The NFT marketplace to filter sales by. #### Defined in -[src/types/types.ts:1193](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1193) +[src/types/types.ts:1193](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1193) ___ @@ -119,7 +119,7 @@ Whether to return the results in ascending or descending order by block number. #### Defined in -[src/types/types.ts:1190](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1190) +[src/types/types.ts:1190](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1190) ___ @@ -135,7 +135,7 @@ Key for pagination to use to fetch results from the next page if available. #### Defined in -[src/types/types.ts:1211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1211) +[src/types/types.ts:1211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1211) ___ @@ -151,7 +151,7 @@ The address of the NFT seller to filter sales by. #### Defined in -[src/types/types.ts:1199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1199) +[src/types/types.ts:1199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1199) ___ @@ -168,7 +168,7 @@ Defaults to returning both buyer and seller taker trades. #### Defined in -[src/types/types.ts:1205](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1205) +[src/types/types.ts:1205](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1205) ___ @@ -184,7 +184,7 @@ The block number limit to fetch NFT sales data from. #### Defined in -[src/types/types.ts:1187](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1187) +[src/types/types.ts:1187](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1187) ___ @@ -196,4 +196,4 @@ The token ID of an NFT within the specified contractAddress to filter sales by. #### Defined in -[src/types/types.ts:1228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1228) +[src/types/types.ts:1228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1228) diff --git a/docs-md/interfaces/GetNftSalesResponse.md b/docs-md/interfaces/GetNftSalesResponse.md index a9dcf073..428d1c03 100644 --- a/docs-md/interfaces/GetNftSalesResponse.md +++ b/docs-md/interfaces/GetNftSalesResponse.md @@ -21,7 +21,7 @@ List of NFT sales that match the query #### Defined in -[src/types/types.ts:1241](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1241) +[src/types/types.ts:1241](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1241) ___ @@ -33,4 +33,4 @@ The page key to use to fetch the next page if more results are available. #### Defined in -[src/types/types.ts:1238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1238) +[src/types/types.ts:1238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1238) diff --git a/docs-md/interfaces/GetNftsForContractOptions.md b/docs-md/interfaces/GetNftsForContractOptions.md index 6a86967f..99ced4b0 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/types.ts:1511](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1511) +[src/types/types.ts:1511](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1511) ___ @@ -40,7 +40,7 @@ Optional page key from an existing [NftContractBaseNftsResponse](NftContractBase #### Defined in -[src/types/types.ts:1508](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1508) +[src/types/types.ts:1508](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1508) ___ @@ -53,7 +53,7 @@ Maximum page size is 100. #### Defined in -[src/types/types.ts:1517](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1517) +[src/types/types.ts:1517](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1517) ___ @@ -68,4 +68,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/types.ts:1525](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1525) +[src/types/types.ts:1525](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1525) diff --git a/docs-md/interfaces/GetNftsForOwnerOptions.md b/docs-md/interfaces/GetNftsForOwnerOptions.md index a68041b7..98c92791 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/types.ts:620](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L620) +[src/types/types.ts:620](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L620) ___ @@ -44,7 +44,7 @@ of these filters are excluded from the response. #### Defined in -[src/types/types.ts:626](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L626) +[src/types/types.ts:626](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L626) ___ @@ -57,7 +57,7 @@ of these filters are included in the response. #### Defined in -[src/types/types.ts:632](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L632) +[src/types/types.ts:632](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L632) ___ @@ -69,7 +69,7 @@ Optional boolean flag to omit NFT metadata. Defaults to `false`. #### Defined in -[src/types/types.ts:641](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L641) +[src/types/types.ts:641](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L641) ___ @@ -82,7 +82,7 @@ contract address and token ID in lexicographic order. #### Defined in -[src/types/types.ts:655](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L655) +[src/types/types.ts:655](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L655) ___ @@ -95,7 +95,7 @@ Optional page key from an existing [OwnedBaseNftsResponse](OwnedBaseNftsResponse #### Defined in -[src/types/types.ts:617](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L617) +[src/types/types.ts:617](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L617) ___ @@ -108,7 +108,7 @@ Maximum page size is 100. #### Defined in -[src/types/types.ts:638](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L638) +[src/types/types.ts:638](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L638) ___ @@ -123,4 +123,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/types.ts:649](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L649) +[src/types/types.ts:649](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L649) diff --git a/docs-md/interfaces/GetOwnersForContractOptions.md b/docs-md/interfaces/GetOwnersForContractOptions.md index fa2050d8..2cda8b70 100644 --- a/docs-md/interfaces/GetOwnersForContractOptions.md +++ b/docs-md/interfaces/GetOwnersForContractOptions.md @@ -25,7 +25,7 @@ The block number in hex or decimal to fetch owners for. #### Defined in -[src/types/types.ts:1578](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1578) +[src/types/types.ts:1578](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1578) ___ @@ -37,7 +37,7 @@ Optional page key to paginate the next page for large requests. #### Defined in -[src/types/types.ts:1581](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1581) +[src/types/types.ts:1581](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1581) ___ @@ -50,4 +50,4 @@ to false when omitted. #### Defined in -[src/types/types.ts:1575](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1575) +[src/types/types.ts:1575](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1575) diff --git a/docs-md/interfaces/GetOwnersForContractResponse.md b/docs-md/interfaces/GetOwnersForContractResponse.md index eba325f1..81c57cef 100644 --- a/docs-md/interfaces/GetOwnersForContractResponse.md +++ b/docs-md/interfaces/GetOwnersForContractResponse.md @@ -20,4 +20,4 @@ An array of owner addresses for the provided contract address #### Defined in -[src/types/types.ts:844](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L844) +[src/types/types.ts:844](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L844) diff --git a/docs-md/interfaces/GetOwnersForContractWithTokenBalancesOptions.md b/docs-md/interfaces/GetOwnersForContractWithTokenBalancesOptions.md index 08d760fa..330e7500 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/types.ts:1600](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1600) +[src/types/types.ts:1600](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1600) ___ @@ -37,7 +37,7 @@ Optional page key to paginate the next page for large requests. #### Defined in -[src/types/types.ts:1603](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1603) +[src/types/types.ts:1603](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1603) ___ @@ -50,4 +50,4 @@ to false when omitted. #### Defined in -[src/types/types.ts:1597](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1597) +[src/types/types.ts:1597](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1597) diff --git a/docs-md/interfaces/GetOwnersForContractWithTokenBalancesResponse.md b/docs-md/interfaces/GetOwnersForContractWithTokenBalancesResponse.md index ea762d53..a78fad1d 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/types.ts:854](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L854) +[src/types/types.ts:854](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L854) ___ @@ -33,4 +33,4 @@ Optional page key that is returned when a collection has more than 50,000 owners #### Defined in -[src/types/types.ts:857](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L857) +[src/types/types.ts:857](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L857) diff --git a/docs-md/interfaces/GetOwnersForNftOptions.md b/docs-md/interfaces/GetOwnersForNftOptions.md index 419d68d4..afd1360f 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/types.ts:1616](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1616) +[src/types/types.ts:1616](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1616) ___ @@ -36,4 +36,4 @@ Sets the total number of owners to return in the response. #### Defined in -[src/types/types.ts:1621](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1621) +[src/types/types.ts:1621](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1621) diff --git a/docs-md/interfaces/GetOwnersForNftResponse.md b/docs-md/interfaces/GetOwnersForNftResponse.md index 5b3808ce..859472b9 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/types.ts:831](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L831) +[src/types/types.ts:831](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L831) ___ @@ -33,4 +33,4 @@ Optional The key for the next page of results, if applicable. #### Defined in -[src/types/types.ts:834](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L834) +[src/types/types.ts:834](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L834) diff --git a/docs-md/interfaces/GetTokensForOwnerOptions.md b/docs-md/interfaces/GetTokensForOwnerOptions.md index dbdc093b..1ec6c5e6 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:181](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L181) +[src/types/types.ts:181](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L181) ___ @@ -35,4 +35,4 @@ pagination. #### Defined in -[src/types/types.ts:186](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L186) +[src/types/types.ts:186](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L186) diff --git a/docs-md/interfaces/GetTokensForOwnerResponse.md b/docs-md/interfaces/GetTokensForOwnerResponse.md index c45f6f57..63f8124e 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:196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L196) +[src/types/types.ts:196](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L196) ___ @@ -33,4 +33,4 @@ Owned tokens for the provided addresses along with relevant metadata. #### Defined in -[src/types/types.ts:194](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L194) +[src/types/types.ts:194](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L194) diff --git a/docs-md/interfaces/GetTransfersForContractOptions.md b/docs-md/interfaces/GetTransfersForContractOptions.md index 2149db19..02bdeeec 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/types.ts:1097](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1097) +[src/types/types.ts:1097](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1097) ___ @@ -37,7 +37,7 @@ Defaults to ascending if omitted. #### Defined in -[src/types/types.ts:1104](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1104) +[src/types/types.ts:1104](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1104) ___ @@ -50,7 +50,7 @@ pagination. #### Defined in -[src/types/types.ts:1109](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1109) +[src/types/types.ts:1109](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1109) ___ @@ -62,4 +62,4 @@ Ending block (inclusive) to get transfers from. #### Defined in -[src/types/types.ts:1099](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1099) +[src/types/types.ts:1099](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1099) diff --git a/docs-md/interfaces/GetTransfersForOwnerOptions.md b/docs-md/interfaces/GetTransfersForOwnerOptions.md index 797a0fe6..8ff5061f 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:1076](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1076) +[src/types/types.ts:1076](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1076) ___ @@ -36,7 +36,7 @@ pagination. #### Defined in -[src/types/types.ts:1088](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1088) +[src/types/types.ts:1088](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1088) ___ @@ -49,4 +49,4 @@ NFTs. #### Defined in -[src/types/types.ts:1082](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1082) +[src/types/types.ts:1082](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1082) diff --git a/docs-md/interfaces/Media.md b/docs-md/interfaces/Media.md index 9db4d573..74dcb78c 100644 --- a/docs-md/interfaces/Media.md +++ b/docs-md/interfaces/Media.md @@ -25,7 +25,7 @@ The size of the media asset in bytes. #### Defined in -[src/types/types.ts:583](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L583) +[src/types/types.ts:583](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L583) ___ @@ -38,7 +38,7 @@ The media format (ex: jpg, gif, png) of the [gateway](Media.md#gateway) and #### Defined in -[src/types/types.ts:572](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L572) +[src/types/types.ts:572](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L572) ___ @@ -50,7 +50,7 @@ Public gateway URI for the raw URI. Generally offers better performance. #### Defined in -[src/types/types.ts:563](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L563) +[src/types/types.ts:563](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L563) ___ @@ -63,7 +63,7 @@ original IPFS link). #### Defined in -[src/types/types.ts:560](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L560) +[src/types/types.ts:560](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L560) ___ @@ -78,7 +78,7 @@ DEPRECATED - The size of the media asset in bytes #### Defined in -[src/types/types.ts:580](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L580) +[src/types/types.ts:580](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L580) ___ @@ -90,4 +90,4 @@ URL for a resized thumbnail of the NFT media asset. #### Defined in -[src/types/types.ts:566](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L566) +[src/types/types.ts:566](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L566) diff --git a/docs-md/interfaces/MinedTransactionWebhook.md b/docs-md/interfaces/MinedTransactionWebhook.md index 215824ea..6b61d6c0 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:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2141) +[src/types/types.ts:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2141) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2122) +[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2122) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2130) +[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2130) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2124) +[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2124) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2134) +[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2134) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2132) +[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2132) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:2166](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2166) +[src/types/types.ts:2166](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2166) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2128) +[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2128) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2136) +[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2136) diff --git a/docs-md/interfaces/Nft.md b/docs-md/interfaces/Nft.md index 19253212..6ffc49d0 100644 --- a/docs-md/interfaces/Nft.md +++ b/docs-md/interfaces/Nft.md @@ -48,7 +48,7 @@ The NFT's underlying contract and relevant contract metadata. #### Defined in -[src/api/nft.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L81) +[src/api/nft.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L81) ___ @@ -60,7 +60,7 @@ The NFT description. #### Defined in -[src/api/nft.ts:87](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L87) +[src/api/nft.ts:87](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L87) ___ @@ -72,7 +72,7 @@ URIs for accessing the NFT's media assets. #### Defined in -[src/api/nft.ts:105](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L105) +[src/api/nft.ts:105](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L105) ___ @@ -84,7 +84,7 @@ Holds an error message if there was an issue fetching metadata. #### Defined in -[src/api/nft.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L93) +[src/api/nft.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L93) ___ @@ -97,7 +97,7 @@ field is undefined if Alchemy was unable to fetch metadata. #### Defined in -[src/api/nft.ts:99](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L99) +[src/api/nft.ts:99](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L99) ___ @@ -109,7 +109,7 @@ Detailed information on why an NFT was classified as spam. #### Defined in -[src/api/nft.ts:108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L108) +[src/api/nft.ts:108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L108) ___ @@ -121,7 +121,7 @@ When the NFT was last updated in the blockchain. Represented in ISO-8601 format. #### Defined in -[src/api/nft.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L90) +[src/api/nft.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L90) ___ @@ -133,7 +133,7 @@ The NFT title. #### Defined in -[src/api/nft.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L84) +[src/api/nft.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L84) ___ @@ -149,7 +149,7 @@ The NFT token ID as an integer string. #### Defined in -[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L65) +[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L65) ___ @@ -165,7 +165,7 @@ The type of ERC token, if known. #### Defined in -[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L67) +[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L67) ___ @@ -177,4 +177,4 @@ URIs for accessing the NFT's metadata blob. #### Defined in -[src/api/nft.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L102) +[src/api/nft.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L102) diff --git a/docs-md/interfaces/NftActivityWebhook.md b/docs-md/interfaces/NftActivityWebhook.md index ec24869a..ab583688 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:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2141) +[src/types/types.ts:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2141) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2122) +[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2122) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2130) +[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2130) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2124) +[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2124) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2134) +[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2134) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2132) +[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2132) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:2193](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2193) +[src/types/types.ts:2193](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2193) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2128) +[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2128) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2136) +[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2136) diff --git a/docs-md/interfaces/NftAttributeRarity.md b/docs-md/interfaces/NftAttributeRarity.md index cb265ffd..586ac7e4 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/types.ts:1363](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1363) +[src/types/types.ts:1363](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1363) ___ @@ -35,7 +35,7 @@ The type of NFT attribute. #### Defined in -[src/types/types.ts:1357](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1357) +[src/types/types.ts:1357](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1357) ___ @@ -47,4 +47,4 @@ Name of the NFT's attribute. #### Defined in -[src/types/types.ts:1354](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1354) +[src/types/types.ts:1354](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1354) diff --git a/docs-md/interfaces/NftAttributesResponse.md b/docs-md/interfaces/NftAttributesResponse.md index 8f4d65b6..f1abf357 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/types.ts:1373](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1373) +[src/types/types.ts:1373](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1373) ___ @@ -35,7 +35,7 @@ provided NFT. #### Defined in -[src/types/types.ts:1382](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1382) +[src/types/types.ts:1382](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1382) ___ @@ -47,4 +47,4 @@ The specified NFT contract's total supply. #### Defined in -[src/types/types.ts:1376](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1376) +[src/types/types.ts:1376](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1376) diff --git a/docs-md/interfaces/NftContract.md b/docs-md/interfaces/NftContract.md index a44d7869..aa1b5ca8 100644 --- a/docs-md/interfaces/NftContract.md +++ b/docs-md/interfaces/NftContract.md @@ -43,7 +43,7 @@ The address of the contract. #### Defined in -[src/api/nft.ts:21](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L21) +[src/api/nft.ts:21](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L21) ___ @@ -55,7 +55,7 @@ The address that deployed the NFT contract. #### Defined in -[src/api/nft.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L48) +[src/api/nft.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L48) ___ @@ -67,7 +67,7 @@ The block number the NFT contract deployed in. #### Defined in -[src/api/nft.ts:50](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L50) +[src/api/nft.ts:50](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L50) ___ @@ -79,7 +79,7 @@ The name of the contract. #### Defined in -[src/api/nft.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L37) +[src/api/nft.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L37) ___ @@ -91,7 +91,7 @@ OpenSea's metadata for the contract. #### Defined in -[src/api/nft.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L46) +[src/api/nft.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L46) ___ @@ -103,7 +103,7 @@ The symbol of the contract. #### Defined in -[src/api/nft.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L39) +[src/api/nft.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L39) ___ @@ -115,7 +115,7 @@ The type of the token in the contract. #### Defined in -[src/api/nft.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L35) +[src/api/nft.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L35) ___ @@ -128,4 +128,4 @@ available on ERC-721 contracts. #### Defined in -[src/api/nft.ts:44](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L44) +[src/api/nft.ts:44](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L44) diff --git a/docs-md/interfaces/NftContractBaseNftsResponse.md b/docs-md/interfaces/NftContractBaseNftsResponse.md index 177f93e0..0028effb 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/types.ts:1632](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1632) +[src/types/types.ts:1632](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1632) ___ @@ -35,4 +35,4 @@ NFTs. If there is no page key, then there are no more NFTs to fetch. #### Defined in -[src/types/types.ts:1638](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1638) +[src/types/types.ts:1638](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1638) diff --git a/docs-md/interfaces/NftContractNftsResponse.md b/docs-md/interfaces/NftContractNftsResponse.md index 44834d61..25b34d8c 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/types.ts:1649](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1649) +[src/types/types.ts:1649](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1649) ___ @@ -35,4 +35,4 @@ NFTs. If there is no page key, then there are no more NFTs to fetch. #### Defined in -[src/types/types.ts:1655](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1655) +[src/types/types.ts:1655](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1655) diff --git a/docs-md/interfaces/NftContractOwner.md b/docs-md/interfaces/NftContractOwner.md index a0a7ddb3..e5294781 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/types.ts:866](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L866) +[src/types/types.ts:866](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L866) ___ @@ -34,4 +34,4 @@ A list of objects containing token balances for the provided NFT contract. #### Defined in -[src/types/types.ts:869](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L869) +[src/types/types.ts:869](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L869) diff --git a/docs-md/interfaces/NftContractTokenBalance.md b/docs-md/interfaces/NftContractTokenBalance.md index b4d79873..a35dadda 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/types.ts:881](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L881) +[src/types/types.ts:881](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L881) ___ @@ -34,4 +34,4 @@ The token id owned in the NFT contract. #### Defined in -[src/types/types.ts:878](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L878) +[src/types/types.ts:878](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L878) diff --git a/docs-md/interfaces/NftFilter.md b/docs-md/interfaces/NftFilter.md index 9ad7e7db..51171ada 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:2309](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2309) +[src/types/types.ts:2309](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2309) ___ @@ -34,4 +34,4 @@ tracking all NFTs for the provided contract address. #### Defined in -[src/types/types.ts:2314](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2314) +[src/types/types.ts:2314](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2314) diff --git a/docs-md/interfaces/NftFiltersResponse.md b/docs-md/interfaces/NftFiltersResponse.md index fb9ae343..4f34aa49 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:2320](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2320) +[src/types/types.ts:2320](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2320) ___ @@ -34,7 +34,7 @@ Optional page key used to fetch the remaining filters. #### Defined in -[src/types/types.ts:2324](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2324) +[src/types/types.ts:2324](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2324) ___ @@ -46,4 +46,4 @@ The total number of NFT filters on the webhook. #### Defined in -[src/types/types.ts:2322](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2322) +[src/types/types.ts:2322](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2322) diff --git a/docs-md/interfaces/NftMetadata.md b/docs-md/interfaces/NftMetadata.md index 9d9b3ad9..f740a925 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/types.ts:531](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L531) +[src/types/types.ts:531](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L531) ___ @@ -44,7 +44,7 @@ Background color of the NFT item. Usually defined as a 6 character hex string. #### Defined in -[src/types/types.ts:528](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L528) +[src/types/types.ts:528](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L528) ___ @@ -56,7 +56,7 @@ A human-readable description of the NFT asset. #### Defined in -[src/types/types.ts:516](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L516) +[src/types/types.ts:516](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L516) ___ @@ -69,7 +69,7 @@ to be the highest resolution image. #### Defined in -[src/types/types.ts:525](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L525) +[src/types/types.ts:525](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L525) ___ @@ -81,7 +81,7 @@ URL to the NFT asset image. #### Defined in -[src/types/types.ts:519](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L519) +[src/types/types.ts:519](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L519) ___ @@ -93,4 +93,4 @@ Name of the NFT asset. #### Defined in -[src/types/types.ts:513](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L513) +[src/types/types.ts:513](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L513) diff --git a/docs-md/interfaces/NftMetadataBatchOptions.md b/docs-md/interfaces/NftMetadataBatchOptions.md index 5849cb8d..aec65827 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/types.ts:934](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L934) +[src/types/types.ts:934](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L934) ___ @@ -37,4 +37,4 @@ metadata for cache misses then set this value to 0. #### Defined in -[src/types/types.ts:928](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L928) +[src/types/types.ts:928](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L928) diff --git a/docs-md/interfaces/NftMetadataBatchToken.md b/docs-md/interfaces/NftMetadataBatchToken.md index 5dda1952..f3f9ab0d 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/types.ts:911](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L911) +[src/types/types.ts:911](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L911) ___ @@ -35,7 +35,7 @@ The id of the NFT. #### Defined in -[src/types/types.ts:914](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L914) +[src/types/types.ts:914](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L914) ___ @@ -47,4 +47,4 @@ Optional field to specify the type of token to speed up the query. #### Defined in -[src/types/types.ts:917](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L917) +[src/types/types.ts:917](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L917) diff --git a/docs-md/interfaces/NftMetadataUpdateWebhook.md b/docs-md/interfaces/NftMetadataUpdateWebhook.md index 9d05a58f..4a144b93 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:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2141) +[src/types/types.ts:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2141) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2122) +[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2122) ___ @@ -73,7 +73,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2130) +[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2130) ___ @@ -89,7 +89,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2124) +[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2124) ___ @@ -105,7 +105,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2134) +[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2134) ___ @@ -121,7 +121,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2132) +[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2132) ___ @@ -137,7 +137,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:2202](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2202) +[src/types/types.ts:2202](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2202) ___ @@ -153,7 +153,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2128) +[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2128) ___ @@ -169,4 +169,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2136) +[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2136) diff --git a/docs-md/interfaces/NftSale.md b/docs-md/interfaces/NftSale.md index c1654150..71dcee88 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/types.ts:1283](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1283) +[src/types/types.ts:1283](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1283) ___ @@ -46,7 +46,7 @@ The index of the token within the bundle of NFTs sold in the sale. #### Defined in -[src/types/types.ts:1289](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1289) +[src/types/types.ts:1289](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1289) ___ @@ -58,7 +58,7 @@ The address of the buyer in the NFT sale. #### Defined in -[src/types/types.ts:1259](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1259) +[src/types/types.ts:1259](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1259) ___ @@ -70,7 +70,7 @@ The NFT contract address. #### Defined in -[src/types/types.ts:1250](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1250) +[src/types/types.ts:1250](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1250) ___ @@ -82,7 +82,7 @@ The log number of the sale event emitted within the block. #### Defined in -[src/types/types.ts:1286](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1286) +[src/types/types.ts:1286](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1286) ___ @@ -94,7 +94,7 @@ The marketplace the sale took place on. #### Defined in -[src/types/types.ts:1247](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1247) +[src/types/types.ts:1247](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1247) ___ @@ -108,7 +108,7 @@ The payment from buyer to the marketplace. #### Defined in -[src/types/types.ts:1274](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1274) +[src/types/types.ts:1274](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1274) ___ @@ -120,7 +120,7 @@ The payment from buyer to the marketplace. #### Defined in -[src/types/types.ts:1277](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1277) +[src/types/types.ts:1277](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1277) ___ @@ -132,7 +132,7 @@ The number of tokens sold in the sale as a decimal integer string. #### Defined in -[src/types/types.ts:1256](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1256) +[src/types/types.ts:1256](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1256) ___ @@ -144,7 +144,7 @@ The payment from buyer to the royalty address of the NFT collection. #### Defined in -[src/types/types.ts:1280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1280) +[src/types/types.ts:1280](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1280) ___ @@ -156,7 +156,7 @@ The address of the seller in the NFT sale. #### Defined in -[src/types/types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1262) +[src/types/types.ts:1262](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1262) ___ @@ -168,7 +168,7 @@ The payment from buyer to the seller. #### Defined in -[src/types/types.ts:1268](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1268) +[src/types/types.ts:1268](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1268) ___ @@ -180,7 +180,7 @@ Whether the price taker in the trade was the buyer or the seller. #### Defined in -[src/types/types.ts:1265](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1265) +[src/types/types.ts:1265](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1265) ___ @@ -192,7 +192,7 @@ The decimal token ID of the NFT being sold. #### Defined in -[src/types/types.ts:1253](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1253) +[src/types/types.ts:1253](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1253) ___ @@ -204,4 +204,4 @@ The transactionHash of the NFT sale. #### Defined in -[src/types/types.ts:1292](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1292) +[src/types/types.ts:1292](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1292) diff --git a/docs-md/interfaces/NftSaleFeeData.md b/docs-md/interfaces/NftSaleFeeData.md index 982259b8..da4dc682 100644 --- a/docs-md/interfaces/NftSaleFeeData.md +++ b/docs-md/interfaces/NftSaleFeeData.md @@ -22,7 +22,7 @@ The fee payment amount as a decimal integer string. #### Defined in -[src/types/types.ts:1302](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1302) +[src/types/types.ts:1302](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1302) ___ @@ -34,7 +34,7 @@ The number of decimals of the token used for the payment. #### Defined in -[src/types/types.ts:1308](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1308) +[src/types/types.ts:1308](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1308) ___ @@ -46,4 +46,4 @@ The symbol of the token used for the payment. #### Defined in -[src/types/types.ts:1305](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1305) +[src/types/types.ts:1305](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1305) diff --git a/docs-md/interfaces/NftWebhookParams.md b/docs-md/interfaces/NftWebhookParams.md index 9f72e190..ef9b5f97 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:2270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2270) +[src/types/types.ts:2270](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2270) ___ @@ -35,4 +35,4 @@ created on network of the app provided in the api key config. #### Defined in -[src/types/types.ts:2275](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2275) +[src/types/types.ts:2275](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2275) diff --git a/docs-md/interfaces/OpenSeaCollectionMetadata.md b/docs-md/interfaces/OpenSeaCollectionMetadata.md index 77eba876..9d5cd3c2 100644 --- a/docs-md/interfaces/OpenSeaCollectionMetadata.md +++ b/docs-md/interfaces/OpenSeaCollectionMetadata.md @@ -28,7 +28,7 @@ The name of the collection on OpenSea. #### Defined in -[src/types/types.ts:1663](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1663) +[src/types/types.ts:1663](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1663) ___ @@ -40,7 +40,7 @@ The description of the collection on OpenSea. #### Defined in -[src/types/types.ts:1669](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1669) +[src/types/types.ts:1669](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1669) ___ @@ -52,7 +52,7 @@ The Discord URL of the collection. #### Defined in -[src/types/types.ts:1675](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1675) +[src/types/types.ts:1675](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1675) ___ @@ -64,7 +64,7 @@ The homepage of the collection as determined by OpenSea. #### Defined in -[src/types/types.ts:1671](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1671) +[src/types/types.ts:1671](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1671) ___ @@ -76,7 +76,7 @@ The floor price of the NFT. #### Defined in -[src/types/types.ts:1661](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1661) +[src/types/types.ts:1661](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1661) ___ @@ -88,7 +88,7 @@ The image URL determined by OpenSea. #### Defined in -[src/types/types.ts:1667](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1667) +[src/types/types.ts:1667](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1667) ___ @@ -100,7 +100,7 @@ Timestamp of when the OpenSea metadata was last ingested by Alchemy. #### Defined in -[src/types/types.ts:1677](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1677) +[src/types/types.ts:1677](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1677) ___ @@ -112,7 +112,7 @@ The approval status of the collection on OpenSea. #### Defined in -[src/types/types.ts:1665](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1665) +[src/types/types.ts:1665](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1665) ___ @@ -124,4 +124,4 @@ The Twitter handle of the collection. #### Defined in -[src/types/types.ts:1673](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1673) +[src/types/types.ts:1673](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1673) diff --git a/docs-md/interfaces/OwnedBaseNft.md b/docs-md/interfaces/OwnedBaseNft.md index 0ee9ec1a..df41529f 100644 --- a/docs-md/interfaces/OwnedBaseNft.md +++ b/docs-md/interfaces/OwnedBaseNft.md @@ -29,7 +29,7 @@ The token balance of the NFT. #### Defined in -[src/types/types.ts:821](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L821) +[src/types/types.ts:821](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L821) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[src/api/nft.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L63) +[src/api/nft.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L63) ___ @@ -59,7 +59,7 @@ The NFT token ID as an integer string. #### Defined in -[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L65) +[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L65) ___ @@ -75,4 +75,4 @@ The type of ERC token, if known. #### Defined in -[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L67) +[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L67) diff --git a/docs-md/interfaces/OwnedBaseNftsResponse.md b/docs-md/interfaces/OwnedBaseNftsResponse.md index ffc89e56..173451cb 100644 --- a/docs-md/interfaces/OwnedBaseNftsResponse.md +++ b/docs-md/interfaces/OwnedBaseNftsResponse.md @@ -26,7 +26,7 @@ The canonical head block hash of when your request was received. #### Defined in -[src/types/types.ts:801](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L801) +[src/types/types.ts:801](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L801) ___ @@ -38,7 +38,7 @@ The NFTs owned by the provided address. #### Defined in -[src/types/types.ts:789](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L789) +[src/types/types.ts:789](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L789) ___ @@ -51,7 +51,7 @@ NFTs. If there is no page key, then there are no more NFTs to fetch. #### Defined in -[src/types/types.ts:795](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L795) +[src/types/types.ts:795](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L795) ___ @@ -63,4 +63,4 @@ The total count of NFTs owned by the provided address. #### Defined in -[src/types/types.ts:798](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L798) +[src/types/types.ts:798](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L798) diff --git a/docs-md/interfaces/OwnedNft.md b/docs-md/interfaces/OwnedNft.md index 09962aa9..66e51904 100644 --- a/docs-md/interfaces/OwnedNft.md +++ b/docs-md/interfaces/OwnedNft.md @@ -37,7 +37,7 @@ The token balance of the NFT. #### Defined in -[src/types/types.ts:811](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L811) +[src/types/types.ts:811](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L811) ___ @@ -53,7 +53,7 @@ The NFT's underlying contract and relevant contract metadata. #### Defined in -[src/api/nft.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L81) +[src/api/nft.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L81) ___ @@ -69,7 +69,7 @@ The NFT description. #### Defined in -[src/api/nft.ts:87](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L87) +[src/api/nft.ts:87](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L87) ___ @@ -85,7 +85,7 @@ URIs for accessing the NFT's media assets. #### Defined in -[src/api/nft.ts:105](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L105) +[src/api/nft.ts:105](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L105) ___ @@ -101,7 +101,7 @@ Holds an error message if there was an issue fetching metadata. #### Defined in -[src/api/nft.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L93) +[src/api/nft.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L93) ___ @@ -118,7 +118,7 @@ field is undefined if Alchemy was unable to fetch metadata. #### Defined in -[src/api/nft.ts:99](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L99) +[src/api/nft.ts:99](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L99) ___ @@ -134,7 +134,7 @@ Detailed information on why an NFT was classified as spam. #### Defined in -[src/api/nft.ts:108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L108) +[src/api/nft.ts:108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L108) ___ @@ -150,7 +150,7 @@ When the NFT was last updated in the blockchain. Represented in ISO-8601 format. #### Defined in -[src/api/nft.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L90) +[src/api/nft.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L90) ___ @@ -166,7 +166,7 @@ The NFT title. #### Defined in -[src/api/nft.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L84) +[src/api/nft.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L84) ___ @@ -182,7 +182,7 @@ The NFT token ID as an integer string. #### Defined in -[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L65) +[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L65) ___ @@ -198,7 +198,7 @@ The type of ERC token, if known. #### Defined in -[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L67) +[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L67) ___ @@ -214,4 +214,4 @@ URIs for accessing the NFT's metadata blob. #### Defined in -[src/api/nft.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L102) +[src/api/nft.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L102) diff --git a/docs-md/interfaces/OwnedNftsResponse.md b/docs-md/interfaces/OwnedNftsResponse.md index 239cbfd5..2426ad2d 100644 --- a/docs-md/interfaces/OwnedNftsResponse.md +++ b/docs-md/interfaces/OwnedNftsResponse.md @@ -26,7 +26,7 @@ The canonical head block hash of when your request was received. #### Defined in -[src/types/types.ts:776](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L776) +[src/types/types.ts:776](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L776) ___ @@ -38,7 +38,7 @@ The NFTs owned by the provided address. #### Defined in -[src/types/types.ts:764](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L764) +[src/types/types.ts:764](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L764) ___ @@ -51,7 +51,7 @@ NFTs. If there is no page key, then there are no more NFTs to fetch. #### Defined in -[src/types/types.ts:770](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L770) +[src/types/types.ts:770](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L770) ___ @@ -63,4 +63,4 @@ The total count of NFTs owned by the provided address. #### Defined in -[src/types/types.ts:773](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L773) +[src/types/types.ts:773](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L773) diff --git a/docs-md/interfaces/OwnedToken.md b/docs-md/interfaces/OwnedToken.md index c878a1d1..07c8dd28 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:215](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L215) +[src/types/types.ts:215](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L215) ___ @@ -41,7 +41,7 @@ The contract address of the token. #### Defined in -[src/types/types.ts:204](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L204) +[src/types/types.ts:204](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L204) ___ @@ -54,7 +54,7 @@ contract and not available from other sources. #### Defined in -[src/types/types.ts:231](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L231) +[src/types/types.ts:231](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L231) ___ @@ -67,7 +67,7 @@ the other fields will be defined. #### Defined in -[src/types/types.ts:238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L238) +[src/types/types.ts:238](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L238) ___ @@ -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:233](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L233) +[src/types/types.ts:233](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L233) ___ @@ -92,7 +92,7 @@ not available from other sources. #### Defined in -[src/types/types.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L221) +[src/types/types.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L221) ___ @@ -105,7 +105,7 @@ if the [error](OwnedToken.md#error) field is present. #### Defined in -[src/types/types.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L209) +[src/types/types.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L209) ___ @@ -118,4 +118,4 @@ and not available from other sources. #### Defined in -[src/types/types.ts:226](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L226) +[src/types/types.ts:226](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L226) diff --git a/docs-md/interfaces/RawContract.md b/docs-md/interfaces/RawContract.md index 4bc62915..f2e6e7a7 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/types.ts:1485](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1485) +[src/types/types.ts:1485](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1485) ___ @@ -36,7 +36,7 @@ is not in the contract and not available from other sources. #### Defined in -[src/types/types.ts:1491](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1491) +[src/types/types.ts:1491](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1491) ___ @@ -49,4 +49,4 @@ ERC721 or ERC1155 token. #### Defined in -[src/types/types.ts:1482](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1482) +[src/types/types.ts:1482](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1482) diff --git a/docs-md/interfaces/RefreshContractResult.md b/docs-md/interfaces/RefreshContractResult.md index 5f7790fe..08ca3130 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:1388](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1388) +[src/types/types.ts:1388](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1388) ___ @@ -35,7 +35,7 @@ Field can be null if the refresh has not occurred. #### Defined in -[src/types/types.ts:1397](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1397) +[src/types/types.ts:1397](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1397) ___ @@ -47,4 +47,4 @@ The current state of the refresh request. #### Defined in -[src/types/types.ts:1391](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1391) +[src/types/types.ts:1391](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1391) diff --git a/docs-md/interfaces/SendPrivateTransactionOptions.md b/docs-md/interfaces/SendPrivateTransactionOptions.md index c1be403a..dc9725f5 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:1836](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1836) +[src/types/types.ts:1836](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1836) diff --git a/docs-md/interfaces/SimulateAssetChangesChange.md b/docs-md/interfaces/SimulateAssetChangesChange.md index 053e5ca0..717b7ecb 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:1922](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1922) +[src/types/types.ts:1922](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1922) ___ @@ -47,7 +47,7 @@ The type of asset from the transaction. #### Defined in -[src/types/types.ts:1898](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1898) +[src/types/types.ts:1898](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1898) ___ @@ -59,7 +59,7 @@ The type of change from the transaction. #### Defined in -[src/types/types.ts:1901](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1901) +[src/types/types.ts:1901](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1901) ___ @@ -72,7 +72,7 @@ ERC1155, NFT and SPECIAL_NFT transactions. #### Defined in -[src/types/types.ts:1941](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1941) +[src/types/types.ts:1941](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1941) ___ @@ -86,7 +86,7 @@ available from other sources. #### Defined in -[src/types/types.ts:1935](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1935) +[src/types/types.ts:1935](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1935) ___ @@ -98,7 +98,7 @@ The from address. #### Defined in -[src/types/types.ts:1904](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1904) +[src/types/types.ts:1904](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1904) ___ @@ -110,7 +110,7 @@ URL for the logo of the asset, if available. Only applicable to ERC20 transactio #### Defined in -[src/types/types.ts:1946](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1946) +[src/types/types.ts:1946](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1946) ___ @@ -122,7 +122,7 @@ The name of the asset transferred, if available. #### Defined in -[src/types/types.ts:1925](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1925) +[src/types/types.ts:1925](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1925) ___ @@ -136,7 +136,7 @@ NATIVE and ERC20 assets, or ERC721/ERC1155 disapprove changes (field set to #### Defined in -[src/types/types.ts:1914](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1914) +[src/types/types.ts:1914](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1914) ___ @@ -148,7 +148,7 @@ The symbol of the asset transferred if available. #### Defined in -[src/types/types.ts:1928](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1928) +[src/types/types.ts:1928](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1928) ___ @@ -160,7 +160,7 @@ The to address. #### Defined in -[src/types/types.ts:1907](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1907) +[src/types/types.ts:1907](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1907) ___ @@ -173,4 +173,4 @@ ERC1155 and SPECIAL_NFT NFTs. #### Defined in -[src/types/types.ts:1952](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1952) +[src/types/types.ts:1952](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1952) diff --git a/docs-md/interfaces/SimulateAssetChangesError.md b/docs-md/interfaces/SimulateAssetChangesError.md index 95df2d00..fbe9cbeb 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:1889](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1889) +[src/types/types.ts:1889](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1889) diff --git a/docs-md/interfaces/SimulateAssetChangesResponse.md b/docs-md/interfaces/SimulateAssetChangesResponse.md index 73a6df5f..e97dceb8 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:1960](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1960) +[src/types/types.ts:1960](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1960) ___ @@ -34,7 +34,7 @@ Optional error field that is present if an error occurred. #### Defined in -[src/types/types.ts:1967](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1967) +[src/types/types.ts:1967](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1967) ___ @@ -47,4 +47,4 @@ field is undefined if an error occurred. #### Defined in -[src/types/types.ts:1965](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1965) +[src/types/types.ts:1965](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1965) diff --git a/docs-md/interfaces/SimulateExecutionResponse.md b/docs-md/interfaces/SimulateExecutionResponse.md index 48a07517..609a65bf 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:2062](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2062) +[src/types/types.ts:2062](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2062) ___ @@ -35,4 +35,4 @@ available. #### Defined in -[src/types/types.ts:2068](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2068) +[src/types/types.ts:2068](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2068) diff --git a/docs-md/interfaces/SimulationCallTrace.md b/docs-md/interfaces/SimulationCallTrace.md index 2a2b7399..83e9ebee 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:2025](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2025) +[src/types/types.ts:2025](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2025) ___ @@ -51,7 +51,7 @@ Omit.error #### Defined in -[src/types/types.ts:2540](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2540) +[src/types/types.ts:2540](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2540) ___ @@ -67,7 +67,7 @@ Omit.from #### Defined in -[src/types/types.ts:2526](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2526) +[src/types/types.ts:2526](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2526) ___ @@ -83,7 +83,7 @@ Omit.gas #### Defined in -[src/types/types.ts:2532](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2532) +[src/types/types.ts:2532](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2532) ___ @@ -99,7 +99,7 @@ Omit.gasUsed #### Defined in -[src/types/types.ts:2534](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2534) +[src/types/types.ts:2534](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2534) ___ @@ -115,7 +115,7 @@ Omit.input #### Defined in -[src/types/types.ts:2536](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2536) +[src/types/types.ts:2536](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2536) ___ @@ -131,7 +131,7 @@ Omit.output #### Defined in -[src/types/types.ts:2538](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2538) +[src/types/types.ts:2538](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2538) ___ @@ -147,7 +147,7 @@ Omit.to #### Defined in -[src/types/types.ts:2528](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2528) +[src/types/types.ts:2528](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2528) ___ @@ -163,7 +163,7 @@ Omit.type #### Defined in -[src/types/types.ts:2023](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2023) +[src/types/types.ts:2023](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2023) ___ @@ -179,4 +179,4 @@ Omit.value #### Defined in -[src/types/types.ts:2530](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2530) +[src/types/types.ts:2530](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2530) diff --git a/docs-md/interfaces/SimulationDebugLog.md b/docs-md/interfaces/SimulationDebugLog.md index 6ace14b3..b604071a 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:2049](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2049) +[src/types/types.ts:2049](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2049) ___ @@ -35,7 +35,7 @@ The data included the log. #### Defined in -[src/types/types.ts:2051](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2051) +[src/types/types.ts:2051](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2051) ___ @@ -47,7 +47,7 @@ A decoded version of the log. Provided on a best-effort basis. #### Defined in -[src/types/types.ts:2053](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2053) +[src/types/types.ts:2053](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2053) ___ @@ -59,4 +59,4 @@ An array of topics in the log. #### Defined in -[src/types/types.ts:2047](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2047) +[src/types/types.ts:2047](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2047) diff --git a/docs-md/interfaces/SpamInfo.md b/docs-md/interfaces/SpamInfo.md index c3790d17..12591bca 100644 --- a/docs-md/interfaces/SpamInfo.md +++ b/docs-md/interfaces/SpamInfo.md @@ -21,7 +21,7 @@ A list of reasons why an NFT contract was marked as spam. #### Defined in -[src/types/types.ts:600](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L600) +[src/types/types.ts:600](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L600) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[src/types/types.ts:597](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L597) +[src/types/types.ts:597](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L597) diff --git a/docs-md/interfaces/TokenBalanceFailure.md b/docs-md/interfaces/TokenBalanceFailure.md index fde95843..b19c8b6c 100644 --- a/docs-md/interfaces/TokenBalanceFailure.md +++ b/docs-md/interfaces/TokenBalanceFailure.md @@ -18,7 +18,7 @@ #### Defined in -[src/types/types.ts:168](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L168) +[src/types/types.ts:168](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L168) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[src/types/types.ts:170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L170) +[src/types/types.ts:170](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L170) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[src/types/types.ts:169](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L169) +[src/types/types.ts:169](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L169) diff --git a/docs-md/interfaces/TokenBalanceSuccess.md b/docs-md/interfaces/TokenBalanceSuccess.md index f70d48d2..07a9358c 100644 --- a/docs-md/interfaces/TokenBalanceSuccess.md +++ b/docs-md/interfaces/TokenBalanceSuccess.md @@ -18,7 +18,7 @@ #### Defined in -[src/types/types.ts:161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L161) +[src/types/types.ts:161](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L161) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[src/types/types.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L163) +[src/types/types.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L163) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[src/types/types.ts:162](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L162) +[src/types/types.ts:162](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L162) diff --git a/docs-md/interfaces/TokenBalancesOptionsDefaultTokens.md b/docs-md/interfaces/TokenBalancesOptionsDefaultTokens.md index f5379e43..09bd11b4 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:135](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L135) +[src/types/types.ts:135](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L135) diff --git a/docs-md/interfaces/TokenBalancesOptionsErc20.md b/docs-md/interfaces/TokenBalancesOptionsErc20.md index 1a5e3b54..769fa114 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:126](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L126) +[src/types/types.ts:126](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L126) ___ @@ -34,4 +34,4 @@ The ERC-20 token type. #### Defined in -[src/types/types.ts:123](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L123) +[src/types/types.ts:123](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L123) diff --git a/docs-md/interfaces/TokenBalancesResponse.md b/docs-md/interfaces/TokenBalancesResponse.md index 297d2eb5..b703ec81 100644 --- a/docs-md/interfaces/TokenBalancesResponse.md +++ b/docs-md/interfaces/TokenBalancesResponse.md @@ -23,7 +23,7 @@ #### Defined in -[src/types/types.ts:152](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L152) +[src/types/types.ts:152](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L152) ___ @@ -33,4 +33,4 @@ ___ #### Defined in -[src/types/types.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L153) +[src/types/types.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L153) diff --git a/docs-md/interfaces/TokenBalancesResponseErc20.md b/docs-md/interfaces/TokenBalancesResponseErc20.md index 9fc010c6..afd07558 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:152](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L152) +[src/types/types.ts:152](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L152) ___ @@ -44,7 +44,7 @@ of token balances. #### Defined in -[src/types/types.ts:147](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L147) +[src/types/types.ts:147](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L147) ___ @@ -58,4 +58,4 @@ ___ #### Defined in -[src/types/types.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L153) +[src/types/types.ts:153](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L153) diff --git a/docs-md/interfaces/TokenMetadataResponse.md b/docs-md/interfaces/TokenMetadataResponse.md index 0ec8fe38..1b3c2487 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:263](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L263) +[src/types/types.ts:263](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L263) ___ @@ -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:266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L266) +[src/types/types.ts:266](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L266) ___ @@ -49,7 +49,7 @@ not available from other sources. #### Defined in -[src/types/types.ts:251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L251) +[src/types/types.ts:251](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L251) ___ @@ -62,4 +62,4 @@ and not available from other sources. #### Defined in -[src/types/types.ts:257](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L257) +[src/types/types.ts:257](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L257) diff --git a/docs-md/interfaces/TokenUri.md b/docs-md/interfaces/TokenUri.md index 89ddc892..0715cbfa 100644 --- a/docs-md/interfaces/TokenUri.md +++ b/docs-md/interfaces/TokenUri.md @@ -21,7 +21,7 @@ Public gateway URI for the raw URI. Generally offers better performance. #### Defined in -[src/types/types.ts:547](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L547) +[src/types/types.ts:547](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L547) ___ @@ -34,4 +34,4 @@ IPFS link). #### Defined in -[src/types/types.ts:544](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L544) +[src/types/types.ts:544](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L544) diff --git a/docs-md/interfaces/TransactionReceiptsBlockHash.md b/docs-md/interfaces/TransactionReceiptsBlockHash.md index d25c0f68..833304ae 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:1438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1438) +[src/types/types.ts:1438](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1438) diff --git a/docs-md/interfaces/TransactionReceiptsBlockNumber.md b/docs-md/interfaces/TransactionReceiptsBlockNumber.md index f1fc3991..4131e7e0 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:1428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1428) +[src/types/types.ts:1428](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1428) diff --git a/docs-md/interfaces/TransactionReceiptsResponse.md b/docs-md/interfaces/TransactionReceiptsResponse.md index 33a2424a..73a92f67 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:1457](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1457) +[src/types/types.ts:1457](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1457) diff --git a/docs-md/interfaces/TransactionWebhookParams.md b/docs-md/interfaces/TransactionWebhookParams.md index f821b663..2354ab5c 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:2261](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2261) +[src/types/types.ts:2261](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2261) diff --git a/docs-md/interfaces/TransferredNft.md b/docs-md/interfaces/TransferredNft.md index b3bdee39..1cc3d805 100644 --- a/docs-md/interfaces/TransferredNft.md +++ b/docs-md/interfaces/TransferredNft.md @@ -40,7 +40,7 @@ The block number as a hex string of when the transfer or mint occurred. #### Defined in -[src/types/types.ts:1138](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1138) +[src/types/types.ts:1138](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1138) ___ @@ -56,7 +56,7 @@ The NFT's underlying contract and relevant contract metadata. #### Defined in -[src/api/nft.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L81) +[src/api/nft.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L81) ___ @@ -72,7 +72,7 @@ The NFT description. #### Defined in -[src/api/nft.ts:87](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L87) +[src/api/nft.ts:87](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L87) ___ @@ -85,7 +85,7 @@ The address the NFT was from. For minted NFTs, this field is the set to #### Defined in -[src/types/types.ts:1132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1132) +[src/types/types.ts:1132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1132) ___ @@ -101,7 +101,7 @@ URIs for accessing the NFT's media assets. #### Defined in -[src/api/nft.ts:105](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L105) +[src/api/nft.ts:105](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L105) ___ @@ -117,7 +117,7 @@ Holds an error message if there was an issue fetching metadata. #### Defined in -[src/api/nft.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L93) +[src/api/nft.ts:93](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L93) ___ @@ -134,7 +134,7 @@ field is undefined if Alchemy was unable to fetch metadata. #### Defined in -[src/api/nft.ts:99](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L99) +[src/api/nft.ts:99](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L99) ___ @@ -150,7 +150,7 @@ Detailed information on why an NFT was classified as spam. #### Defined in -[src/api/nft.ts:108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L108) +[src/api/nft.ts:108](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L108) ___ @@ -166,7 +166,7 @@ When the NFT was last updated in the blockchain. Represented in ISO-8601 format. #### Defined in -[src/api/nft.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L90) +[src/api/nft.ts:90](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L90) ___ @@ -182,7 +182,7 @@ The NFT title. #### Defined in -[src/api/nft.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L84) +[src/api/nft.ts:84](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L84) ___ @@ -194,7 +194,7 @@ The address the NFT was sent or minted to. #### Defined in -[src/types/types.ts:1134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1134) +[src/types/types.ts:1134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1134) ___ @@ -210,7 +210,7 @@ The NFT token ID as an integer string. #### Defined in -[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L65) +[src/api/nft.ts:65](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L65) ___ @@ -226,7 +226,7 @@ The type of ERC token, if known. #### Defined in -[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L67) +[src/api/nft.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L67) ___ @@ -242,7 +242,7 @@ URIs for accessing the NFT's metadata blob. #### Defined in -[src/api/nft.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/nft.ts#L102) +[src/api/nft.ts:102](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/nft.ts#L102) ___ @@ -254,4 +254,4 @@ The transaction hash where the transfer or mint occurred. #### Defined in -[src/types/types.ts:1136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1136) +[src/types/types.ts:1136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1136) diff --git a/docs-md/interfaces/TransfersNftResponse.md b/docs-md/interfaces/TransfersNftResponse.md index 74a42c58..478fda1b 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/types.ts:1119](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1119) +[src/types/types.ts:1119](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1119) ___ @@ -35,4 +35,4 @@ Optional page key to use to fetch the next group of NFTs. #### Defined in -[src/types/types.ts:1121](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1121) +[src/types/types.ts:1121](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1121) diff --git a/docs-md/interfaces/Webhook.md b/docs-md/interfaces/Webhook.md index 0924b713..b30bf8d3 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:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2141) +[src/types/types.ts:2141](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2141) ___ @@ -57,7 +57,7 @@ The webhook's unique id. #### Defined in -[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2122) +[src/types/types.ts:2122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2122) ___ @@ -69,7 +69,7 @@ Whether the webhook is currently active #### Defined in -[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2130) +[src/types/types.ts:2130](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2130) ___ @@ -81,7 +81,7 @@ The network the webhook is on. #### Defined in -[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2124) +[src/types/types.ts:2124](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2124) ___ @@ -93,7 +93,7 @@ The signing key used to verify payloads for the webhook. #### Defined in -[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2134) +[src/types/types.ts:2134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2134) ___ @@ -105,7 +105,7 @@ The creation time of the webhook as an ISO string. #### Defined in -[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2132) +[src/types/types.ts:2132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2132) ___ @@ -117,7 +117,7 @@ The type of webhook. #### Defined in -[src/types/types.ts:2126](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2126) +[src/types/types.ts:2126](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2126) ___ @@ -129,7 +129,7 @@ The url that the webhook sends its payload to. #### Defined in -[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2128) +[src/types/types.ts:2128](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2128) ___ @@ -141,4 +141,4 @@ The webhook version. All newly created webhooks default to V2. #### Defined in -[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2136) +[src/types/types.ts:2136](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2136) diff --git a/docs-md/interfaces/WebhookAddressOverride.md b/docs-md/interfaces/WebhookAddressOverride.md index 9a93fd7e..b41fb064 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:2375](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2375) +[src/types/types.ts:2375](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2375) diff --git a/docs-md/interfaces/WebhookAddressUpdate.md b/docs-md/interfaces/WebhookAddressUpdate.md index 4c7ef111..1e4383e5 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:2364](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2364) +[src/types/types.ts:2364](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2364) ___ @@ -34,4 +34,4 @@ Existing addresses to remove. #### Defined in -[src/types/types.ts:2366](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2366) +[src/types/types.ts:2366](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2366) diff --git a/docs-md/interfaces/WebhookNftFilterUpdate.md b/docs-md/interfaces/WebhookNftFilterUpdate.md index 1f9cb8cc..cf04d74f 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:2342](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2342) +[src/types/types.ts:2342](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2342) ___ @@ -34,4 +34,4 @@ Existing filters to remove. #### Defined in -[src/types/types.ts:2344](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2344) +[src/types/types.ts:2344](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2344) diff --git a/docs-md/interfaces/WebhookNftMetadataFilterUpdate.md b/docs-md/interfaces/WebhookNftMetadataFilterUpdate.md index 06d2d8e6..4683484e 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:2353](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2353) +[src/types/types.ts:2353](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2353) ___ @@ -34,4 +34,4 @@ Existing filters to remove. #### Defined in -[src/types/types.ts:2355](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2355) +[src/types/types.ts:2355](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2355) diff --git a/docs-md/interfaces/WebhookStatusUpdate.md b/docs-md/interfaces/WebhookStatusUpdate.md index 2c09da4c..08f1bc54 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:2333](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2333) +[src/types/types.ts:2333](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2333) diff --git a/docs-md/modules.md b/docs-md/modules.md index b049d3ea..5e28c6ab 100644 --- a/docs-md/modules.md +++ b/docs-md/modules.md @@ -217,7 +217,7 @@ Params object when calling [NotifyNamespace.updateWebhook](classes/NotifyNamespa #### Defined in -[src/types/types.ts:2404](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2404) +[src/types/types.ts:2404](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2404) ___ @@ -230,7 +230,7 @@ filters compatible with other ethers events. #### Defined in -[src/types/types.ts:1822](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1822) +[src/types/types.ts:1822](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1822) ___ @@ -243,7 +243,7 @@ also include Alchemy's Subscription API. #### Defined in -[src/types/types.ts:1816](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1816) +[src/types/types.ts:1816](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1816) ___ @@ -256,7 +256,7 @@ least one of the fields to be set. #### Defined in -[src/types/types.ts:1805](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1805) +[src/types/types.ts:1805](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1805) ___ @@ -279,7 +279,7 @@ methods in the [DebugNamespace](classes/DebugNamespace.md). #### Defined in -[src/types/types.ts:2465](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2465) +[src/types/types.ts:2465](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2465) ___ @@ -302,7 +302,7 @@ Params object when calling [NotifyNamespace.updateWebhook](classes/NotifyNamespa #### Defined in -[src/types/types.ts:2398](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2398) +[src/types/types.ts:2398](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2398) ___ @@ -316,7 +316,7 @@ The keys are the addresses of the accounts, mapped to its corresponding state. #### Defined in -[src/types/types.ts:2582](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2582) +[src/types/types.ts:2582](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2582) ___ @@ -338,7 +338,7 @@ The level of verbosity for the logger. #### Defined in -[src/util/logger.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/util/logger.ts#L22) +[src/util/logger.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/util/logger.ts#L22) ___ @@ -351,7 +351,7 @@ Params object when calling [NotifyNamespace.updateWebhook](classes/NotifyNamespa #### Defined in -[src/types/types.ts:2390](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2390) +[src/types/types.ts:2390](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2390) ___ @@ -364,7 +364,7 @@ Params object when calling [NotifyNamespace.updateWebhook](classes/NotifyNamespa #### Defined in -[src/types/types.ts:2382](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2382) +[src/types/types.ts:2382](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2382) ___ @@ -382,7 +382,7 @@ Requires an array with at least one value. #### Defined in -[src/types/types.ts:2608](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2608) +[src/types/types.ts:2608](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2608) ___ @@ -403,7 +403,7 @@ Implementation copied over from #### Defined in -[src/types/types.ts:2602](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L2602) +[src/types/types.ts:2602](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L2602) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -[src/types/types.ts:157](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L157) +[src/types/types.ts:157](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L157) ___ @@ -425,7 +425,7 @@ The parameters to use with the [CoreNamespace.getTransactionReceipts](classes/Co #### Defined in -[src/types/types.ts:1446](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/types/types.ts#L1446) +[src/types/types.ts:1446](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/types/types.ts#L1446) ___ @@ -476,7 +476,7 @@ Converts a hex string to a decimal number. #### Defined in -[src/api/util.ts:9](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/util.ts#L9) +[src/api/util.ts:9](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/util.ts#L9) ___ @@ -498,7 +498,7 @@ Checks if a value is a hex string. #### Defined in -[src/api/util.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/util.ts#L29) +[src/api/util.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/util.ts#L29) ___ @@ -520,7 +520,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/85196e8/src/util/logger.ts#L56) +[src/util/logger.ts:56](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/util/logger.ts#L56) ___ @@ -542,4 +542,4 @@ Converts a number to a hex string. #### Defined in -[src/api/util.ts:19](https://github.com/alchemyplatform/alchemy-sdk-js/blob/85196e8/src/api/util.ts#L19) +[src/api/util.ts:19](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4a7f568/src/api/util.ts#L19) diff --git a/docs/classes/Alchemy.html b/docs/classes/Alchemy.html index d0df5fd2..c55224ef 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

  • Alchemy

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.

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/classes/AlchemyConfig.html b/docs/classes/AlchemyConfig.html index 077cfb8c..3b0e6a46 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 18cf873c..a58fdfd8 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>

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>

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>

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 9ffd19d4..56b11b55 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 b5c3cfa7..b673603e 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,46 +157,46 @@

      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

    lookupAddress

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

    Returns Promise<TransactionReceiptsResponse>

    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 e4d0d8cc..3671176b 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 60f51875..39d7bd74 100644 --- a/docs/classes/NftNamespace.html +++ b/docs/classes/NftNamespace.html @@ -3,7 +3,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.nft.

    -

    • Hierarchy

    • NftNamespace

    Index

    Methods

    Methods

    checkNftOwnership

    • checkNftOwnership(owner: string, contractAddresses: string[]): Promise<boolean>

    Hierarchy

    • NftNamespace

    Index

    Methods

    Methods

    checkNftOwnership

    • checkNftOwnership(owner: string, contractAddresses: string[]): Promise<boolean>

    • DEPRECATED - Checks that the provided owner address owns one of more of the provided NFTs.

      deprecated
        @@ -14,37 +14,37 @@

        The owner address to check.

  • contractAddresses: string[]

    An array of NFT contract addresses to check ownership for.

    -

    • Returns Promise<boolean>

    computeRarity

    Returns Promise<boolean>

    computeRarity

    getContractMetadata

    Returns Promise<NftAttributeRarity[]>

    getContractMetadata

    getContractMetadataBatch

    Returns Promise<NftContract>

    getContractMetadataBatch

    getContractsForOwner

    Returns Promise<NftContract[]>

    getContractsForOwner

    getFloorPrice

    Returns Promise<GetContractsForOwnerResponse>

    getFloorPrice

    getMintedNfts

    Returns Promise<GetFloorPriceResponse>

    getMintedNfts

    getNftMetadata

    Returns Promise<TransfersNftResponse>

    getNftMetadata

    Returns Promise<Nft>

  • +

    • Returns Promise<Nft>

  • Get the NFT metadata associated with the provided parameters.

    Parameters

    • contractAddress: string

      The contract address of the NFT.

      @@ -67,17 +67,17 @@

      Token id of the NFT.

    • Optional options: GetNftMetadataOptions

      Options for the request.

      -

    Returns Promise<Nft>

    • getNftMetadataBatch

    Returns Promise<Nft>

    getNftMetadataBatch

    getNftSales

    Returns Promise<Nft[]>

    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.

    @@ -94,7 +94,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

    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 @@ -113,7 +113,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<OwnedNftsResponse>

  • +

    • Returns Promise<OwnedNftsResponse>

  • Get all base NFTs for an owner.

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

    @@ -129,7 +129,7 @@

    The address of the owner.

  • Optional options: GetBaseNftsForOwnerOptions

    The optional parameters to use for the request.

    -

    • Returns Promise<OwnedBaseNftsResponse>

    getNftsForOwnerIterator

    Returns Promise<OwnedBaseNftsResponse>

    getNftsForOwnerIterator

    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.

    @@ -145,13 +145,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, @@ -160,7 +160,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

    isSpamContract

    Returns Promise<TransfersNftResponse>

    isSpamContract

    refreshContract

    Returns Promise<boolean>

    refreshContract

    refreshNftMetadata

    Returns Promise<RefreshContractResult>

    refreshNftMetadata

    Returns Promise<boolean>

    searchContractMetadata

    Returns Promise<boolean>

    searchContractMetadata

    summarizeNftAttributes

    Returns Promise<NftContract[]>

    summarizeNftAttributes

    verifyNftOwnership

    Returns Promise<NftAttributesResponse>

    verifyNftOwnership

    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 18af9405..9ff8ebfa 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

    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

        Legend

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

        Settings

        Theme

        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 33f4b912..ba27ee32 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

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

        Hierarchy

        • TransactNamespace

        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 5aa0e51c..46b0c182 100644 --- a/docs/classes/Wallet.html +++ b/docs/classes/Wallet.html @@ -5,47 +5,47 @@

          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

        • Parameters

          Returns Promise<TransactionRequest>

        resolveName

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

        Returns Promise<number>

        Private getWallet

        • getWallet(): Promise<Wallet>

        populateTransaction

        • Parameters

          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

        signMessage

        • signMessage(message: string | Bytes): Promise<string>

        • Parameters

          • message: string | Bytes

          Returns Promise<string>

        signTransaction

        • Parameters

          Returns Promise<string>

        Static createRandom

        • createRandom(options?: any): Wallet

        • Static methods to create Wallet instances.

          diff --git a/docs/classes/WebSocketNamespace.html b/docs/classes/WebSocketNamespace.html index bd026b79..56d3df8f 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 4ff10602..dc5f2cf9 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 3a9d3a7a..68d9d2b3 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/AssetTransfersOrder.html b/docs/enums/AssetTransfersOrder.html index c5c9809c..b4f42556 100644 --- a/docs/enums/AssetTransfersOrder.html +++ b/docs/enums/AssetTransfersOrder.html @@ -3,4 +3,4 @@ using CoreNamespace.getAssetTransfers.

        deprecated

        Use SortingOrder instead. This enum will be removed in a future version.

        -

        Index

        Enumeration members

        Enumeration members

        ASCENDING

        ASCENDING = "asc"

        DESCENDING

        DESCENDING = "desc"

        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

        ASCENDING

        ASCENDING = "asc"

        DESCENDING

        DESCENDING = "desc"

        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 74a15654..bcc9a742 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 7153b4aa..e8a040c5 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 10f71eab..6e136fb1 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 7d52663d..0c56e1b4 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 bc3c3de5..8893e63e 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"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/Network.html b/docs/enums/Network.html index 5a225626..c9d163e7 100644 --- a/docs/enums/Network.html +++ b/docs/enums/Network.html @@ -3,19 +3,19 @@ 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_RINKEBY

        ARB_RINKEBY = "arb-rinkeby"
        deprecated
          +

        Index

        Enumeration members

        Enumeration members

        ARB_GOERLI

        ARB_GOERLI = "arb-goerli"

        ARB_MAINNET

        ARB_MAINNET = "arb-mainnet"

        ARB_RINKEBY

        ARB_RINKEBY = "arb-rinkeby"
        deprecated
        • Will be removed in subsequent versions
        -

        ASTAR_MAINNET

        ASTAR_MAINNET = "astar-mainnet"

        ETH_GOERLI

        ETH_GOERLI = "eth-goerli"

        ETH_KOVAN

        ETH_KOVAN = "eth-kovan"
        deprecated
          +

        ASTAR_MAINNET

        ASTAR_MAINNET = "astar-mainnet"

        ETH_GOERLI

        ETH_GOERLI = "eth-goerli"

        ETH_KOVAN

        ETH_KOVAN = "eth-kovan"
        deprecated
        • Will be removed in subsequent versions
        -

        ETH_MAINNET

        ETH_MAINNET = "eth-mainnet"

        ETH_RINKEBY

        ETH_RINKEBY = "eth-rinkeby"
        deprecated
          +

        ETH_MAINNET

        ETH_MAINNET = "eth-mainnet"

        ETH_RINKEBY

        ETH_RINKEBY = "eth-rinkeby"
        deprecated
        • Will be removed in subsequent versions
        -

        ETH_ROPSTEN

        ETH_ROPSTEN = "eth-ropsten"
        deprecated
          +

        ETH_ROPSTEN

        ETH_ROPSTEN = "eth-ropsten"
        deprecated
        • Will be removed in subsequent versions
        -

        ETH_SEPOLIA

        ETH_SEPOLIA = "eth-sepolia"

        MATIC_MAINNET

        MATIC_MAINNET = "polygon-mainnet"

        MATIC_MUMBAI

        MATIC_MUMBAI = "polygon-mumbai"

        OPT_GOERLI

        OPT_GOERLI = "opt-goerli"

        OPT_KOVAN

        OPT_KOVAN = "opt-kovan"
        deprecated
          +

        ETH_SEPOLIA

        ETH_SEPOLIA = "eth-sepolia"

        MATIC_MAINNET

        MATIC_MAINNET = "polygon-mainnet"

        MATIC_MUMBAI

        MATIC_MUMBAI = "polygon-mumbai"

        OPT_GOERLI

        OPT_GOERLI = "opt-goerli"

        OPT_KOVAN

        OPT_KOVAN = "opt-kovan"
        deprecated
        • Will be removed in subsequent versions
        -

        OPT_MAINNET

        OPT_MAINNET = "opt-mainnet"

        POLYGONZKEVM_MAINNET

        POLYGONZKEVM_MAINNET = "polygonzkevm-mainnet"

        POLYGONZKEVM_TESTNET

        POLYGONZKEVM_TESTNET = "polygonzkevm-testnet"

        Legend

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

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        OPT_MAINNET

        OPT_MAINNET = "opt-mainnet"

        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/NftExcludeFilters.html b/docs/enums/NftExcludeFilters.html index 66be5417..20396485 100644 --- a/docs/enums/NftExcludeFilters.html +++ b/docs/enums/NftExcludeFilters.html @@ -3,8 +3,8 @@ NFTs that match one or more of these filters are excluded from the response.

        deprecated

        Use NftFilters instead. This enum will be removed in a future version.

        -
        beta

        Index

        Enumeration members

        Enumeration members

        AIRDROPS

        AIRDROPS = "AIRDROPS"
        +
        beta

        Index

        Enumeration members

        Enumeration members

        AIRDROPS

        AIRDROPS = "AIRDROPS"

        Exclude NFTs that have been airdropped to a user.

        -

        SPAM

        SPAM = "SPAM"
        +

        SPAM

        SPAM = "SPAM"

        Exclude NFTs that have been classified as spam.

        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/NftFilters.html b/docs/enums/NftFilters.html index c5c5d5e2..8bd4a54b 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.

        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/NftOrdering.html b/docs/enums/NftOrdering.html index 9921e487..669c35be 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"

        Legend

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

        Settings

        Theme

        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/NftSaleMarketplace.html b/docs/enums/NftSaleMarketplace.html index e5bbe5fa..7c2fbad6 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

        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

        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 09d84a89..706eea17 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 ceb41602..6e755935 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"

        MostlyHoneyPotOwners

        MostlyHoneyPotOwners = "MostlyHoneyPotOwners"

        OwnedByMostHoneyPots

        OwnedByMostHoneyPots = "OwnedByMostHoneyPots"

        Generated using TypeDoc

        \ No newline at end of file +

        Index

        Enumeration members

        Enumeration members

        Erc721DishonestTotalSupply

        Erc721DishonestTotalSupply = "Erc721DishonestTotalSupply"

        Erc721TooManyOwners

        Erc721TooManyOwners = "Erc721TooManyOwners"

        Erc721TooManyTokens

        Erc721TooManyTokens = "Erc721TooManyTokens"

        MostlyHoneyPotOwners

        MostlyHoneyPotOwners = "MostlyHoneyPotOwners"

        OwnedByMostHoneyPots

        OwnedByMostHoneyPots = "OwnedByMostHoneyPots"

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/enums/NftTokenType.html b/docs/enums/NftTokenType.html index 6f38869f..e6c866d4 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 f19347d4..289123d0 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/RefreshState.html b/docs/enums/RefreshState.html index 178f5221..3c0e354a 100644 --- a/docs/enums/RefreshState.html +++ b/docs/enums/RefreshState.html @@ -1,15 +1,15 @@ RefreshState | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Enumeration RefreshState

        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/SimulateAssetType.html b/docs/enums/SimulateAssetType.html index 03fd7397..2c8c5c8e 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.

        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/SimulateChangeType.html b/docs/enums/SimulateChangeType.html index 77eed97b..de302ead 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.

        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/SortingOrder.html b/docs/enums/SortingOrder.html index ef66ed82..bf1e4a8d 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"

        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

        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 546a61c0..fe0564a6 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 3f919623..2402a6c4 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 aa4e22ff..138ac330 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/AddressActivityResponse.html b/docs/interfaces/AddressActivityResponse.html index 9f5bf357..ff0b18b6 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 b4d5930e..c1110854 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.

        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/AddressWebhookParams.html b/docs/interfaces/AddressWebhookParams.html index 37a2de09..cfc21703 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.

        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/AlchemyMinedTransactionsEventFilter.html b/docs/interfaces/AlchemyMinedTransactionsEventFilter.html index 42acc203..ef22d884 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

        • AlchemyMinedTransactionsEventFilter

        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

        Legend

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

        Settings

        Theme

        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 be21cd69..4f706f64 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

        • AlchemyPendingTransactionsEventFilter

        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 1257e1da..0fee3e96 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 d6950f5c..b367f549 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 ae7a813e..c8eebe9e 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 441e2e5a..f6fec7fc 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 c9ff5ab8..3187f4b7 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 b78f4a97..9a1df665 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 c50fb4c3..e76eeab9 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 fefe2d0e..420975da 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 458666a4..ddfb8712 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

        contract

        contract: BaseNftContract

        tokenId

        tokenId: string
        +

        Hierarchy

        Index

        Properties

        Properties

        contract

        contract: BaseNftContract

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of ERC token, if known.

        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/BaseNftContract.html b/docs/interfaces/BaseNftContract.html index 438a3dba..984ad4b6 100644 --- a/docs/interfaces/BaseNftContract.html +++ b/docs/interfaces/BaseNftContract.html @@ -3,6 +3,6 @@

        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 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/ContractForOwner.html b/docs/interfaces/ContractForOwner.html index 6d421d65..64c0e5df 100644 --- a/docs/interfaces/ContractForOwner.html +++ b/docs/interfaces/ContractForOwner.html @@ -1,34 +1,34 @@ ContractForOwner | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ContractForOwner

        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 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.

        -

        isSpam

        isSpam: boolean

        media

        media: Media[]
        +

        isSpam

        isSpam: boolean

        media

        media: Media[]

        Alternative NFT metadata for this contract to be parsed manually.

        -

        Optional name

        name?: string
        +

        Optional name

        name?: string

        The name of the contract.

        -

        numDistinctTokensOwned

        numDistinctTokensOwned: number
        +

        numDistinctTokensOwned

        numDistinctTokensOwned: number

        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.

        -

        Optional openSea

        openSea?: OpenSeaCollectionMetadata
        +

        Optional openSea

        openSea?: OpenSeaCollectionMetadata

        OpenSea's metadata for the contract.

        -

        Optional symbol

        symbol?: string
        +

        Optional symbol

        symbol?: string

        The symbol of the contract.

        -

        title

        title: string
        +

        title

        title: string

        The title of the token held by the owner.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        One of the tokens from this contract held by the owner.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of the token in the contract.

        -

        totalBalance

        totalBalance: number
        +

        totalBalance

        totalBalance: number

        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/CustomGraphqlWebhook.html b/docs/interfaces/CustomGraphqlWebhook.html index 1e6b4617..61b379d6 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.

        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/CustomGraphqlWebhookConfig.html b/docs/interfaces/CustomGraphqlWebhookConfig.html index 10492a77..bf958274 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.

        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/CustomGraphqlWebhookParams.html b/docs/interfaces/CustomGraphqlWebhookParams.html index 9282c487..17cc287d 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.

        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/DebugCallTrace.html b/docs/interfaces/DebugCallTrace.html index 6c3f6915..8cee896a 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.

        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/DebugCallTracer.html b/docs/interfaces/DebugCallTracer.html index 692cdfdf..d925dd93 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

        • DebugCallTracer

        Index

        Properties

        Properties

        Optional onlyTopCall

        onlyTopCall?: boolean
        +

        Hierarchy

        • DebugCallTracer

        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.

        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/DebugPrestate.html b/docs/interfaces/DebugPrestate.html index e5919bd0..ba802935 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.

        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/DebugPrestateTracer.html b/docs/interfaces/DebugPrestateTracer.html index 0ca86e19..86e378e5 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

        • DebugPrestateTracer

        Index

        Properties

        Properties

        Optional onlyTopCall

        onlyTopCall?: boolean
        +

        Hierarchy

        • DebugPrestateTracer

        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.

        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/DebugTransaction.html b/docs/interfaces/DebugTransaction.html index a7b85e02..aa920e54 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.

        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/DecodedCallParam.html b/docs/interfaces/DecodedCallParam.html index fb0dae44..e1e93b27 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.

        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/DecodedDebugCallTrace.html b/docs/interfaces/DecodedDebugCallTrace.html index f5451159..a3569888 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.

        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/DecodedLog.html b/docs/interfaces/DecodedLog.html index 69bec63e..722145cf 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.

        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/DecodedLogInput.html b/docs/interfaces/DecodedLogInput.html index df5872a8..6238a670 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.

        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/DeployResult.html b/docs/interfaces/DeployResult.html index 955cd95a..28787872 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

        Readonly blockNumber

        blockNumber: number
        +

        Hierarchy

        • DeployResult

        Index

        Properties

        Properties

        Readonly blockNumber

        blockNumber: number

        The block number the contract was deployed in.

        -

        Optional Readonly deployerAddress

        deployerAddress?: string
        +

        Optional Readonly deployerAddress

        deployerAddress?: string

        The address of the contract deployer, if it is 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/DroppedTransactionWebhook.html b/docs/interfaces/DroppedTransactionWebhook.html index dbdf722e..b8efcfa2 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.

        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/ERC1155Metadata.html b/docs/interfaces/ERC1155Metadata.html index aa6c57eb..37fa0847 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

        Legend

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

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        Hierarchy

        • ERC1155Metadata

        Index

        Properties

        Properties

        tokenId

        tokenId: string

        value

        value: 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/EventFilter.html b/docs/interfaces/EventFilter.html index 6de51203..40ec1970 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.

        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/Filter.html b/docs/interfaces/Filter.html index 6edd9835..ffd57e5c 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.

        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/FilterByBlockHash.html b/docs/interfaces/FilterByBlockHash.html index 4362e3c3..1895e7c7 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.

        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/FloorPriceError.html b/docs/interfaces/FloorPriceError.html index 23c83cc9..92328c95 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

        Readonly error

        error: string
        +

        Hierarchy

        • FloorPriceError

        Index

        Properties

        Properties

        Readonly error

        error: string

        Error fetching floor prices from the given marketplace

        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/FloorPriceMarketplace.html b/docs/interfaces/FloorPriceMarketplace.html index 262f49b2..a426f78c 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

        Readonly collectionUrl

        collectionUrl: string
        +

        Hierarchy

        • FloorPriceMarketplace

        Index

        Properties

        Properties

        Readonly collectionUrl

        collectionUrl: string

        The link to the collection on the given marketplace

        -

        Readonly floorPrice

        floorPrice: number
        +

        Readonly floorPrice

        floorPrice: number

        The floor price of the collection on the given marketplace

        -

        Readonly priceCurrency

        priceCurrency: string
        +

        Readonly priceCurrency

        priceCurrency: string

        The currency in which the floor price is denominated

        -

        Readonly retrievedAt

        retrievedAt: string
        +

        Readonly retrievedAt

        retrievedAt: string

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

        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/GetAddressesOptions.html b/docs/interfaces/GetAddressesOptions.html index b6231d01..497f4618 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

        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/GetAllWebhooksResponse.html b/docs/interfaces/GetAllWebhooksResponse.html index 6b68c2cb..38bbdab8 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.

        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/GetBaseNftsForContractOptions.html b/docs/interfaces/GetBaseNftsForContractOptions.html index e64a46a1..e0298b46 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

        • GetBaseNftsForContractOptions

        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 75b6dd71..0c8c278b 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/GetContractsForOwnerOptions.html b/docs/interfaces/GetContractsForOwnerOptions.html index 28faccff..6af04c70 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 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 b501d325..7a009f73 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: ContractForOwner[]
        +

        Hierarchy

        • GetContractsForOwnerResponse

        Index

        Properties

        Properties

        contracts

        contracts: ContractForOwner[]

        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 bdb73be7..56a5c3e4 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

        Readonly looksRare

        looksRare: FloorPriceMarketplace | FloorPriceError

        Readonly openSea

        openSea: FloorPriceMarketplace | FloorPriceError
        +

        Hierarchy

        • GetFloorPriceResponse

        Index

        Properties

        Properties

        Readonly looksRare

        looksRare: FloorPriceMarketplace | FloorPriceError

        Readonly 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 72c94067..8918bc49 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/GetMintedNftsResponse.html b/docs/interfaces/GetMintedNftsResponse.html index 609a1ddb..f5e1f272 100644 --- a/docs/interfaces/GetMintedNftsResponse.html +++ b/docs/interfaces/GetMintedNftsResponse.html @@ -1,6 +1,6 @@ GetMintedNftsResponse | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface GetMintedNftsResponse

        deprecated

        Use TransfersNftResponse instead.

        -

        Hierarchy

        • GetMintedNftsResponse

        Index

        Properties

        Properties

        nfts

        nfts: Nft[]
        +

        Hierarchy

        • GetMintedNftsResponse

        Index

        Properties

        Properties

        nfts

        nfts: Nft[]

        An array of the minted NFTs for the provided owner address.

        -

        Optional pageKey

        pageKey?: string
        +

        Optional pageKey

        pageKey?: string

        Key for pagination to use to fetch results from the next page 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/GetNftMetadataOptions.html b/docs/interfaces/GetNftMetadataOptions.html index b6b28078..af6bafe9 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 de82ac9a..d2567dd3 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 ad1e640f..7be1bcd2 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 21f2a8ad..0c0aa008 100644 --- a/docs/interfaces/GetNftSalesResponse.html +++ b/docs/interfaces/GetNftSalesResponse.html @@ -1,7 +1,7 @@ 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.

        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 63e17a66..ac2e4d00 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 82b99659..5c4877de 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 d1b21bfe..78612348 100644 --- a/docs/interfaces/GetOwnersForContractOptions.html +++ b/docs/interfaces/GetOwnersForContractOptions.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

        • 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 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 d69f58eb..c14d558c 100644 --- a/docs/interfaces/GetOwnersForContractResponse.html +++ b/docs/interfaces/GetOwnersForContractResponse.html @@ -1,5 +1,5 @@ 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

        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 2979c1f6..9078d149 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 9a04a57f..4a5c5d2f 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 f823dc21..c2201070 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 e5ef6a6d..2de4efef 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

        Readonly owners

        owners: string[]
        +

        Hierarchy

        • GetOwnersForNftResponse

        Index

        Properties

        Properties

        Readonly owners

        owners: string[]

        An array of owner addresses for the provided token.

        -

        Optional Readonly pageKey

        pageKey?: string
        +

        Optional Readonly 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/GetTokensForOwnerOptions.html b/docs/interfaces/GetTokensForOwnerOptions.html index befa9ae6..de358d39 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 4b01e467..16db94d0 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 c11714b8..ca323be5 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 3d7a7bd8..6ce4b0b0 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/Media.html b/docs/interfaces/Media.html index fc8046b2..4a849600 100644 --- a/docs/interfaces/Media.html +++ b/docs/interfaces/Media.html @@ -1,21 +1,21 @@ Media | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Media

        Represents the URI information for the NFT's media assets.

        -

        Hierarchy

        • Media

        Index

        Properties

        Properties

        Optional bytes

        bytes?: number
        +

        Hierarchy

        • Media

        Index

        Properties

        Properties

        Optional bytes

        bytes?: number

        The size of the media asset in bytes.

        -

        Optional format

        format?: string
        +

        Optional format

        format?: string

        The media format (ex: jpg, gif, png) of the gateway and thumbnail assets.

        -

        gateway

        gateway: string
        +

        gateway

        gateway: string

        Public gateway URI for the raw URI. Generally offers better performance.

        -

        raw

        raw: string
        +

        raw

        raw: string

        URI for the location of the NFT's original metadata blob for media (ex: the original IPFS link).

        -

        Optional size

        size?: number
        +

        Optional size

        size?: number

        DEPRECATED - The size of the media asset in bytes

        deprecated
        • Please use bytes instead. This field will be removed in a subsequent release.
        -

        Optional thumbnail

        thumbnail?: string
        +

        Optional thumbnail

        thumbnail?: string

        URL for a resized thumbnail of the NFT media 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/MinedTransactionWebhook.html b/docs/interfaces/MinedTransactionWebhook.html index c77c78bb..a1c1e023 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 976cbb5d..5c9dd6f3 100644 --- a/docs/interfaces/Nft.html +++ b/docs/interfaces/Nft.html @@ -3,27 +3,27 @@

        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

        contract

        contract: NftContract
        +

        Hierarchy

        Index

        Properties

        Properties

        contract

        contract: NftContract

        The NFT's underlying contract and relevant contract metadata.

        -

        description

        description: string
        +

        description

        description: string

        The NFT description.

        -

        media

        media: Media[]
        +

        media

        media: Media[]

        URIs for accessing the NFT's media assets.

        -

        metadataError

        metadataError: undefined | string
        +

        metadataError

        metadataError: undefined | string

        Holds an error message if there was an issue fetching metadata.

        -

        rawMetadata

        rawMetadata: undefined | NftMetadata
        +

        rawMetadata

        rawMetadata: undefined | NftMetadata

        The raw metadata fetched from the metadata URL specified by the NFT. The field is undefined if Alchemy was unable to fetch metadata.

        -

        Optional spamInfo

        spamInfo?: SpamInfo
        +

        Optional spamInfo

        spamInfo?: SpamInfo

        Detailed information on why an NFT was classified as spam.

        -

        timeLastUpdated

        timeLastUpdated: string
        +

        timeLastUpdated

        timeLastUpdated: string

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

        -

        title

        title: string
        +

        title

        title: string

        The NFT title.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of ERC token, if known.

        -

        tokenUri

        tokenUri: undefined | TokenUri
        +

        tokenUri

        tokenUri: undefined | TokenUri

        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 3dabbb01..4f120534 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 9498ae48..d25851f0 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 7500bcdf..6d702992 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: number
        +

        totalSupply

        totalSupply: number

        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/NftContract.html b/docs/interfaces/NftContract.html index 35c776ed..c7174edf 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 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.

        -

        Optional openSea

        openSea?: OpenSeaCollectionMetadata
        +

        Optional openSea

        openSea?: 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 51cb80fb..b2302999 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/NftContractNftsResponse.html b/docs/interfaces/NftContractNftsResponse.html index 88570629..a9047b04 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 a2fc7046..d9e5ca21 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 ab2543ca..5014f81c 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: number
        +

        Hierarchy

        • NftContractTokenBalance

        Index

        Properties

        Properties

        balance

        balance: number

        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 eb338251..678e3dda 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 506838e4..06a6353d 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/NftMetadata.html b/docs/interfaces/NftMetadata.html index ca3c1006..1be7ceef 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 7e6806f1..befcc5d8 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 f83c0b03..e5b167ae 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 9da580a3..b73a32d5 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/NftSale.html b/docs/interfaces/NftSale.html index 0f9edd4b..cd680208 100644 --- a/docs/interfaces/NftSale.html +++ b/docs/interfaces/NftSale.html @@ -1,34 +1,34 @@ 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.

        -

        Optional marketplaceFee

        marketplaceFee?: NftSaleFeeData
        +

        Optional marketplaceFee

        marketplaceFee?: NftSaleFeeData

        The payment from buyer to the marketplace.

        deprecated

        Please use protocolFee instead.

        -

        Optional protocolFee

        protocolFee?: NftSaleFeeData
        +

        Optional 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.

        -

        Optional royaltyFee

        royaltyFee?: NftSaleFeeData
        +

        Optional 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 d23f121b..58d5ca31 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

        amount

        amount: string
        +

        Hierarchy

        • NftSaleFeeData

        Index

        Properties

        Properties

        amount

        amount: string

        The fee payment amount as a decimal integer string.

        -

        decimal

        decimal: number
        +

        decimal

        decimal: number

        The number of decimals of the token used for the payment.

        -

        symbol

        symbol: string
        +

        symbol

        symbol: string

        The symbol of the token used for the payment.

        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 3f785168..976d0d8a 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 15db3d27..636b5109 100644 --- a/docs/interfaces/OpenSeaCollectionMetadata.html +++ b/docs/interfaces/OpenSeaCollectionMetadata.html @@ -1,21 +1,21 @@ 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 collectionName

        collectionName?: string
        +

        Hierarchy

        • OpenSeaCollectionMetadata

        Index

        Properties

        Properties

        Optional collectionName

        collectionName?: string

        The name 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 NFT.

        -

        Optional imageUrl

        imageUrl?: string
        +

        Optional imageUrl

        imageUrl?: string

        The image URL determined by OpenSea.

        -

        Optional lastIngestedAt

        lastIngestedAt?: string
        +

        Optional 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 e82610b5..c28c07b6 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

        Readonly balance

        balance: number
        +

        Hierarchy

        Index

        Properties

        Properties

        Readonly balance

        balance: number

        The token balance of the NFT.

        -

        contract

        contract: BaseNftContract

        tokenId

        tokenId: string
        +

        contract

        contract: BaseNftContract

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of ERC token, if known.

        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 9849bf1c..50a1cd9d 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

        blockHash

        blockHash: string
        +

        Hierarchy

        • OwnedBaseNftsResponse

        Index

        Properties

        Properties

        blockHash

        blockHash: string

        The canonical head block hash of when your request was received.

        -

        Readonly ownedNfts

        ownedNfts: OwnedBaseNft[]
        +

        Readonly ownedNfts

        ownedNfts: OwnedBaseNft[]

        The NFTs owned by the provided address.

        -

        Optional Readonly pageKey

        pageKey?: string
        +

        Optional Readonly 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.

        -

        Readonly totalCount

        totalCount: number
        +

        Readonly totalCount

        totalCount: number

        The total count of NFTs owned by the provided 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/OwnedNft.html b/docs/interfaces/OwnedNft.html index a2c92295..1a7a72c7 100644 --- a/docs/interfaces/OwnedNft.html +++ b/docs/interfaces/OwnedNft.html @@ -1,28 +1,28 @@ 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

        Readonly balance

        balance: number
        +

        Hierarchy

        Index

        Properties

        Properties

        Readonly balance

        balance: number

        The token balance of the NFT.

        -

        contract

        contract: NftContract
        +

        contract

        contract: NftContract

        The NFT's underlying contract and relevant contract metadata.

        -

        description

        description: string
        +

        description

        description: string

        The NFT description.

        -

        media

        media: Media[]
        +

        media

        media: Media[]

        URIs for accessing the NFT's media assets.

        -

        metadataError

        metadataError: undefined | string
        +

        metadataError

        metadataError: undefined | string

        Holds an error message if there was an issue fetching metadata.

        -

        rawMetadata

        rawMetadata: undefined | NftMetadata
        +

        rawMetadata

        rawMetadata: undefined | NftMetadata

        The raw metadata fetched from the metadata URL specified by the NFT. The field is undefined if Alchemy was unable to fetch metadata.

        -

        Optional spamInfo

        spamInfo?: SpamInfo
        +

        Optional spamInfo

        spamInfo?: SpamInfo

        Detailed information on why an NFT was classified as spam.

        -

        timeLastUpdated

        timeLastUpdated: string
        +

        timeLastUpdated

        timeLastUpdated: string

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

        -

        title

        title: string
        +

        title

        title: string

        The NFT title.

        -

        tokenId

        tokenId: string
        +

        tokenId

        tokenId: string

        The NFT token ID as an integer string.

        -

        tokenType

        tokenType: NftTokenType
        +

        tokenType

        tokenType: NftTokenType

        The type of ERC token, if known.

        -

        tokenUri

        tokenUri: undefined | TokenUri
        +

        tokenUri

        tokenUri: undefined | TokenUri

        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 bac5356e..a570763a 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

        blockHash

        blockHash: string
        +

        Hierarchy

        • OwnedNftsResponse

        Index

        Properties

        Properties

        blockHash

        blockHash: string

        The canonical head block hash of when your request was received.

        -

        Readonly ownedNfts

        ownedNfts: OwnedNft[]
        +

        Readonly ownedNfts

        ownedNfts: OwnedNft[]

        The NFTs owned by the provided address.

        -

        Optional Readonly pageKey

        pageKey?: string
        +

        Optional Readonly 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.

        -

        Readonly totalCount

        totalCount: number
        +

        Readonly totalCount

        totalCount: number

        The total count of NFTs owned by the provided 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/OwnedToken.html b/docs/interfaces/OwnedToken.html index fcc4ca80..ec96ac3b 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 1b4bd715..a575336a 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 7dc1f9ea..267d0d3e 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: RefreshState
        +

        refreshState

        refreshState: RefreshState

        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/SendPrivateTransactionOptions.html b/docs/interfaces/SendPrivateTransactionOptions.html index dd20b3a5..20117bd9 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 6bd76896..504063b7 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 8a6d2d1b..f99fe805 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 9acc3720..d6c7941d 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 41eb047e..574afdc9 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 b791086d..93473430 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 ed7ee3b9..32d779c7 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/SpamInfo.html b/docs/interfaces/SpamInfo.html index 5ee50a4b..791ec502 100644 --- a/docs/interfaces/SpamInfo.html +++ b/docs/interfaces/SpamInfo.html @@ -1,5 +1,5 @@ SpamInfo | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SpamInfo

        Detailed information on whether and why an NFT contract was classified as spam.

        -

        Hierarchy

        • SpamInfo

        Index

        Properties

        Properties

        classifications

        classifications: NftSpamClassification[]
        +

        Hierarchy

        • SpamInfo

        Index

        Properties

        Properties

        classifications

        classifications: NftSpamClassification[]

        A list of reasons why an NFT contract was marked as spam.

        -

        isSpam

        isSpam: boolean

        Legend

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

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file +

        isSpam

        isSpam: 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/TokenBalanceFailure.html b/docs/interfaces/TokenBalanceFailure.html index 21eeec58..aad45629 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 ed76c78d..aafe4e09 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 008528a7..27a06b04 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 df71fb50..d0c17576 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 9f6a2766..d31494e7 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 4ffd1f41..fcdb677f 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 c56ceee3..be03df5d 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/TokenUri.html b/docs/interfaces/TokenUri.html index fa45b3f3..c321cb1f 100644 --- a/docs/interfaces/TokenUri.html +++ b/docs/interfaces/TokenUri.html @@ -1,8 +1,8 @@ TokenUri | alchemy-sdk
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TokenUri

        Represents the URI information the NFT's metadata.

        -

        Hierarchy

        • TokenUri

        Index

        Properties

        Properties

        gateway

        gateway: string
        +

        Hierarchy

        • TokenUri

        Index

        Properties

        Properties

        gateway

        gateway: string

        Public gateway URI for the raw URI. Generally offers better performance.

        -

        raw

        raw: string
        +

        raw

        raw: string

        URI for the location of the NFT's original metadata blob (ex: the original IPFS link).

        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 bcdcffa6..097ff9cf 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 6a776c08..f7e1206c 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 626f6024..87f3df64 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 c9ef0999..2c01208e 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 73edcb07..2def7c0f 100644 --- a/docs/interfaces/TransferredNft.html +++ b/docs/interfaces/TransferredNft.html @@ -1,35 +1,35 @@ 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

        blockNumber

        blockNumber: string
        +

        Hierarchy

        • Nft
          • TransferredNft

        Index

        Properties

        Properties

        blockNumber

        blockNumber: string

        The block number as a hex string of when the transfer or mint occurred.

        -

        contract

        contract: NftContract
        +

        contract

        contract: NftContract

        The NFT's underlying contract and relevant contract metadata.

        -

        description

        description: string
        +

        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.

        -

        media

        media: Media[]
        +

        media

        media: Media[]

        URIs for accessing the NFT's media assets.

        -

        metadataError

        metadataError: undefined | string
        +

        metadataError

        metadataError: undefined | string

        Holds an error message if there was an issue fetching metadata.

        -

        rawMetadata

        rawMetadata: undefined | NftMetadata
        +

        rawMetadata

        rawMetadata: undefined | NftMetadata

        The raw metadata fetched from the metadata URL specified by the NFT. The field is undefined if Alchemy was unable to fetch metadata.

        -

        Optional spamInfo

        spamInfo?: SpamInfo
        +

        Optional spamInfo

        spamInfo?: SpamInfo

        Detailed information on why an NFT was classified as spam.

        -

        timeLastUpdated

        timeLastUpdated: string
        +

        timeLastUpdated

        timeLastUpdated: string

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

        -

        title

        title: string
        +

        title

        title: string

        The NFT title.

        -

        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 ERC token, if known.

        -

        tokenUri

        tokenUri: undefined | TokenUri
        +

        tokenUri

        tokenUri: undefined | TokenUri

        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 085cc454..eef3cd96 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 873ac69c..f3956ce8 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 44acbbde..bd095751 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 9002fec3..5d463250 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 f0917fc0..b23cd3c3 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 33d4d509..72605892 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 d8f52f5d..338d99bb 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 82962069..cd51deed 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 bc984790..24ed7ea3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "alchemy-sdk", - "version": "2.8.0", + "version": "2.8.1", "description": "Extended Ethers.js SDK for Alchemy APIs", "author": "Alchemy", "license": "MIT", diff --git a/src/version.ts b/src/version.ts index d20cf912..46360a9b 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 = '2.8.0'; +export const VERSION = '2.8.1';