v2.3.0 (#239)

CHANGELOG.md

@@ -4,7 +4,13 @@
 
 ### Major Changes
 
-- Added the `DebugNamesapce` to the top-level `Alchemy` object. The `DebugNamespace` is used to replay and inspect transactions and mined blocks in greater detail.
+### Minor Changes
+
+## 2.3.0
+
+### Major Changes
+
+- Added the `DebugNamespace` to the top-level `Alchemy` object. The `DebugNamespace` is used to replay and inspect transactions and mined blocks in greater detail.
 
 ### Minor Changes
 

docs-md/README.md

@@ -99,7 +99,9 @@ The Alchemy SDK also supports a number of Ethers.js objects that streamline the
 - [`Wallet`](https://docs.ethers.io/v5/api/signer/#Wallet): An implementation of `Signer` that can sign transactions and messages using a private key as a standard Externally Owned Account.
 
 ## Alchemy Settings
-An `AlchemySettings` object can be passed on instantiation to the Alchemy object, with the following optional parameters: 
+
+An `AlchemySettings` object can be passed on instantiation to the Alchemy object, with the following optional parameters:
+
 - `apiKey`: API key that can be found in the Alchemy dashboard. Defaults to `demo`: a rate-limited public key.
 - `network`: Name of the network. Defaults to `Network.ETH_MAINNET`
 - `maxRetries`: The maximum number of retries to attempt if a request fails. Defaults to 5.
@@ -201,10 +203,11 @@ under the `alchemy.nft` namespace:
 - `getNftMetadata()`: Get the NFT metadata for an NFT contract address and tokenId.
 - `getNftMetadataBatch()`: Get the NFT metadata for multiple NFT contract addresses/token id pairs.
 - `getContractMetadata()`: Get the metadata associated with an NFT contract
+- `getContractsForOwner()`: Get all NFT contracts that the provided owner address owns.
 - `getNftsForOwner()`: Get NFTs for an owner address.
 - `getNftsForOwnerIterator()`: Get NFTs for an owner address as an async iterator (handles paging automatically).
 - `getNftsForContract()`: Get all NFTs for a contract address.
-- `getNftForContractIterator()`: Get all NFTs for a contract address as an async iterator (handles paging
+- `getNftsForContractIterator()`: Get all NFTs for a contract address as an async iterator (handles paging
   automatically).
 - `getOwnersForNft()`: Get all the owners for a given NFT contract address and a particular token ID.
 - `getOwnersForContract()`: Get all the owners for a given NFT contract address.
@@ -274,6 +277,16 @@ Methods include:
 - `updateWebhook()`: Update an existing webhook's active status or tracked addresses and NFT filters.
 - `deleteWebhook()`: Delete the provided webhook.
 
+## Alchemy Debug
+
+Methods on the `DebugNamespace` can be accessed via `alchemy.debug`. These methods are used for inspecting and debugging transactions.
+
+Methods include:
+
+- `traceCall()`: Run an `eth_call` with the context of the provided block execution using the final state of the parent block as the base.
+- `traceTransaction()`: 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 that corresponds to the given hash.
+- `traceBlock()`: Replay a block that has already been mined.
+
 ## Documentation
 
 The SDK is documented via `tsdoc` comments in the source code. The generated types and documentation are included when

docs-md/classes/Alchemy.md

@@ -18,6 +18,7 @@ different network or API key, create a new instance of [Alchemy](Alchemy.md).
 
 - [config](Alchemy.md#config)
 - [core](Alchemy.md#core)
+- [debug](Alchemy.md#debug)
 - [nft](Alchemy.md#nft)
 - [notify](Alchemy.md#notify)
 - [transact](Alchemy.md#transact)
@@ -37,7 +38,7 @@ different network or API key, create a new instance of [Alchemy](Alchemy.md).
 
 #### Defined in
 
-[src/api/alchemy.ts:55](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L55)
+[src/api/alchemy.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy.ts#L63)
 
 ## Properties
 
@@ -50,7 +51,7 @@ and allows access to the underlying providers.
 
 #### Defined in
 
-[src/api/alchemy.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L41)
+[src/api/alchemy.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy.ts#L42)
 
 ___
 
@@ -63,7 +64,20 @@ Enhanced APIs.
 
 #### Defined in
 
-[src/api/alchemy.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L23)
+[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy.ts#L24)
+
+___
+
+### debug
+
+• `Readonly` **debug**: [`DebugNamespace`](DebugNamespace.md)
+
+The `debug` namespace contains methods for inspecting and debugging
+transactions.
+
+#### Defined in
+
+[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy.ts#L54)
 
 ___
 
@@ -75,7 +89,7 @@ The `nft` namespace contains methods for Alchemy's NFT API.
 
 #### Defined in
 
-[src/api/alchemy.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L26)
+[src/api/alchemy.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy.ts#L27)
 
 ___
 
@@ -88,7 +102,7 @@ as part of the Notify API.
 
 #### Defined in
 
-[src/api/alchemy.ts:47](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L47)
+[src/api/alchemy.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy.ts#L48)
 
 ___
 
@@ -101,7 +115,7 @@ checking on the state of submitted transasctions.
 
 #### Defined in
 
-[src/api/alchemy.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L35)
+[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy.ts#L36)
 
 ___
 
@@ -113,4 +127,4 @@ The `ws` namespace contains methods for using WebSockets and creating subscripti
 
 #### Defined in
 
-[src/api/alchemy.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L29)
+[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy.ts#L30)

docs-md/classes/AlchemyConfig.md

@@ -18,6 +18,7 @@ exposes the underlying providers for more advanced use cases.
 - [batchRequests](AlchemyConfig.md#batchrequests)
 - [maxRetries](AlchemyConfig.md#maxretries)
 - [network](AlchemyConfig.md#network)
+- [requestTimeout](AlchemyConfig.md#requesttimeout)
 - [url](AlchemyConfig.md#url)
 
 ### Methods
@@ -39,7 +40,7 @@ exposes the underlying providers for more advanced use cases.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:58](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L58)
+[src/api/alchemy-config.ts:64](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L64)
 
 ## Properties
 
@@ -51,7 +52,7 @@ The Alchemy API key.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L22)
+[src/api/alchemy-config.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L23)
 
 ___
 
@@ -63,7 +64,7 @@ The optional Alchemy auth token to use when sending requests with the Notify API
 
 #### Defined in
 
-[src/api/alchemy-config.ts:40](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L40)
+[src/api/alchemy-config.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L41)
 
 ___
 
@@ -75,7 +76,7 @@ Setting to enable automatic batching on json-rpc requests. Defaults to false.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:31](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L31)
+[src/api/alchemy-config.ts:32](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L32)
 
 ___
 
@@ -87,7 +88,7 @@ The maximum number of retries to perform.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:28](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L28)
+[src/api/alchemy-config.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L29)
 
 ___
 
@@ -99,7 +100,19 @@ The Network that this SDK is associated with.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L25)
+[src/api/alchemy-config.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L26)
+
+___
+
+### requestTimeout
+
+• `Optional` `Readonly` **requestTimeout**: `number`
+
+The optional Request timeout provided in `ms` for NFT and NOTIFY API. Defaults to 0.
+
+#### Defined in
+
+[src/api/alchemy-config.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L46)
 
 ___
 
@@ -112,7 +125,7 @@ and apiKey.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L37)
+[src/api/alchemy-config.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L38)
 
 ## Methods
 
@@ -136,7 +149,7 @@ other less-common methods.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:100](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L100)
+[src/api/alchemy-config.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L107)
 
 ___
 
@@ -161,4 +174,4 @@ other less-common methods.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L122)
+[src/api/alchemy-config.ts:129](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-config.ts#L129)

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/d97ef0d/src/api/alchemy-provider.ts#L41)
+[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/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/d97ef0d/src/api/alchemy-provider.ts#L43)
+[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/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/d97ef0d/src/api/alchemy-provider.ts#L42)
+[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-provider.ts#L42)
 
 ## Accessors
 
@@ -935,7 +935,7 @@ JsonRpcProvider.\_startPending
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:204](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-provider.ts#L204)
+[src/api/alchemy-provider.ts:204](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-provider.ts#L204)
 
 ___
 
@@ -1135,7 +1135,7 @@ JsonRpcProvider.detectNetwork
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:192](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-provider.ts#L192)
+[src/api/alchemy-provider.ts:192](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-provider.ts#L192)
 
 ___
 
@@ -1614,7 +1614,7 @@ CommunityResourcable.isCommunityResource
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:214](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-provider.ts#L214)
+[src/api/alchemy-provider.ts:214](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-provider.ts#L214)
 
 ___
 
@@ -1974,7 +1974,7 @@ JsonRpcProvider.send
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-provider.ts#L228)
+[src/api/alchemy-provider.ts:228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/0c05b32/src/api/alchemy-provider.ts#L228)
 
 ___