v2.2.4 (#212)

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - Added `TransactNamespace.sendGasOptimizedTransaction()`. Instead of sending a single transaction that might not get mined, this method allows you to send the same transaction multiple times, with different gas prices and gas limits. This should result in lower fees paid.
 
+## 2.2.4
+
+## Major Changes
+
 ### Minor Changes
 
 - Fixed a bug where `newHeads` subscriptions would error and crash when reconnecting to the websocket.

docs-md/README.md

@@ -98,6 +98,15 @@ The Alchemy SDK also supports a number of Ethers.js objects that streamline the
 - [`ContractFactory`](https://docs.ethers.io/v5/api/contract/contract-factory/): Allows developers to build a `Contract` object.
 - [`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: 
+- `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.
+- `url`: Optional URL endpoint to use for all requests. Setting this field will override the URL generated by the `network` and`apiKey` fields.
+- `authToken`: Alchemy auth token required to use the Notify API. This token can be found in the Alchemy Dashboard on the Notify tab.
+- `batchRequests`: Optional setting that automatically batches and sends json-rpc requests for higher throughput and reduced network IO. Defaults to false.
+
 ## Alchemy Core
 
 The core namespace contains all commonly-used [Ethers.js Provider](https://docs.ethers.io/v5/api/providers/api-providers/#AlchemyProvider) methods. If you are already using Ethers.js, you should be simply able to replace the Ethers.js Provider object with `alchemy.core` when accessing provider methods and it should just work.
@@ -210,17 +219,6 @@ under the `alchemy.nft` namespace:
 - `summarizeNftAttributes()`: Get the summary of attribute prevalence for all NFTs in a contract.
 - `searchContractMetadata()`: Search for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts.
 
-### Using `BaseNft` and `Nft`
-
-The SDK currently uses the `BaseNft` and `Nft` classes to represent NFTs returned by the Alchemy. 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.
-
-By default, the SDK will return the `Nft` object. You can optionally choose to fetch the `BaseNft` object instead by
-setting the `omitMetadata` parameter to `true`. The SDK documentation describes the different parameter and response
-interfaces in more detail.
-
 ### Pagination
 
 The Alchemy NFT endpoints return 100 results per page. To get the next page, you can pass in the `pageKey` returned by

docs-md/classes/Alchemy.md

@@ -37,7 +37,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/8b1ae5c/src/api/alchemy.ts#L55)
+[src/api/alchemy.ts:55](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L55)
 
 ## Properties
 
@@ -50,7 +50,7 @@ and allows access to the underlying providers.
 
 #### Defined in
 
-[src/api/alchemy.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy.ts#L41)
+[src/api/alchemy.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L41)
 
 ___
 
@@ -63,7 +63,7 @@ Enhanced APIs.
 
 #### Defined in
 
-[src/api/alchemy.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy.ts#L23)
+[src/api/alchemy.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L23)
 
 ___
 
@@ -75,7 +75,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/8b1ae5c/src/api/alchemy.ts#L26)
+[src/api/alchemy.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L26)
 
 ___
 
@@ -88,7 +88,7 @@ as part of the Notify API.
 
 #### Defined in
 
-[src/api/alchemy.ts:47](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy.ts#L47)
+[src/api/alchemy.ts:47](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L47)
 
 ___
 
@@ -101,7 +101,7 @@ checking on the state of submitted transasctions.
 
 #### Defined in
 
-[src/api/alchemy.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy.ts#L35)
+[src/api/alchemy.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L35)
 
 ___
 
@@ -113,4 +113,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/8b1ae5c/src/api/alchemy.ts#L29)
+[src/api/alchemy.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy.ts#L29)

docs-md/classes/AlchemyConfig.md

@@ -39,7 +39,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/8b1ae5c/src/api/alchemy-config.ts#L58)
+[src/api/alchemy-config.ts:58](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L58)
 
 ## Properties
 
@@ -51,7 +51,7 @@ The Alchemy API key.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy-config.ts#L22)
+[src/api/alchemy-config.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L22)
 
 ___
 
@@ -63,7 +63,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/8b1ae5c/src/api/alchemy-config.ts#L40)
+[src/api/alchemy-config.ts:40](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L40)
 
 ___
 
@@ -75,7 +75,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/8b1ae5c/src/api/alchemy-config.ts#L31)
+[src/api/alchemy-config.ts:31](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L31)
 
 ___
 
@@ -87,7 +87,7 @@ The maximum number of retries to perform.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:28](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy-config.ts#L28)
+[src/api/alchemy-config.ts:28](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L28)
 
 ___
 
@@ -99,7 +99,7 @@ The Network that this SDK is associated with.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy-config.ts#L25)
+[src/api/alchemy-config.ts:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L25)
 
 ___
 
@@ -112,7 +112,7 @@ and apiKey.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy-config.ts#L37)
+[src/api/alchemy-config.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L37)
 
 ## Methods
 
@@ -136,7 +136,7 @@ other less-common methods.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:100](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy-config.ts#L100)
+[src/api/alchemy-config.ts:100](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L100)
 
 ___
 
@@ -161,4 +161,4 @@ other less-common methods.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8b1ae5c/src/api/alchemy-config.ts#L122)
+[src/api/alchemy-config.ts:122](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-config.ts#L122)

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/8b1ae5c/src/api/alchemy-provider.ts#L41)
+[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/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/8b1ae5c/src/api/alchemy-provider.ts#L43)
+[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/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/8b1ae5c/src/api/alchemy-provider.ts#L42)
+[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/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/8b1ae5c/src/api/alchemy-provider.ts#L204)
+[src/api/alchemy-provider.ts:204](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/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/8b1ae5c/src/api/alchemy-provider.ts#L192)
+[src/api/alchemy-provider.ts:192](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/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/8b1ae5c/src/api/alchemy-provider.ts#L214)
+[src/api/alchemy-provider.ts:214](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/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/8b1ae5c/src/api/alchemy-provider.ts#L228)
+[src/api/alchemy-provider.ts:228](https://github.com/alchemyplatform/alchemy-sdk-js/blob/d97ef0d/src/api/alchemy-provider.ts#L228)
 
 ___