v2.9.0 (#339)

alchemyplatform · Jun 5, 2023 · d9f6619 · d9f6619
1 parent 94bd4bc
commit d9f6619
Show file tree

Hide file tree

Showing 315 changed files with 1,734 additions and 1,512 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@
 
 ### Major Changes
 
+### Minor Changes
+
+## 2.9.0
+
+### Major Changes
+
 - Fixed a bug with in `NftNamespace.getNftSales()` in which there was a typo in `decimal` field of the `NftSaleFeeData` object. The field is now correctly named `decimals`, and `decimal` is marked deprecated to avoid a breaking change.
 
 ### Minor Changes

diff --git 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/905f87c/src/api/alchemy.ts#L63)
+[src/api/alchemy.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy.ts#L42)
+[src/api/alchemy.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy.ts#L24)
+[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy.ts#L54)
+[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy.ts#L27)
+[src/api/alchemy.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy.ts#L48)
+[src/api/alchemy.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy.ts#L36)
+[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy.ts#L30)
+[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/src/api/alchemy.ts#L30)
diff --git 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/905f87c/src/api/alchemy-config.ts#L64)
+[src/api/alchemy-config.ts:64](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L23)
+[src/api/alchemy-config.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L41)
+[src/api/alchemy-config.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L32)
+[src/api/alchemy-config.ts:32](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L29)
+[src/api/alchemy-config.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L26)
+[src/api/alchemy-config.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L46)
+[src/api/alchemy-config.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L38)
+[src/api/alchemy-config.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L107)
+[src/api/alchemy-config.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-config.ts#L129)
+[src/api/alchemy-config.ts:129](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/src/api/alchemy-config.ts#L129)
diff --git 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/905f87c/src/api/alchemy-provider.ts#L41)
+[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-provider.ts#L43)
+[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-provider.ts#L42)
+[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-provider.ts#L209)
+[src/api/alchemy-provider.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-provider.ts#L197)
+[src/api/alchemy-provider.ts:197](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-provider.ts#L219)
+[src/api/alchemy-provider.ts:219](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-provider.ts#L233)
+[src/api/alchemy-provider.ts:233](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/src/api/alchemy-provider.ts#L233)
 
 ___
 

diff --git 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/905f87c/src/api/alchemy-websocket-provider.ts#L81)
+[src/api/alchemy-websocket-provider.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L82)
+[src/api/alchemy-websocket-provider.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L947)
+[src/api/alchemy-websocket-provider.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L970)
+[src/api/alchemy-websocket-provider.ts:970](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L871)
+[src/api/alchemy-websocket-provider.ts:871](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L911)
+[src/api/alchemy-websocket-provider.ts:911](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L407)
+[src/api/alchemy-websocket-provider.ts:407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L703)
+[src/api/alchemy-websocket-provider.ts:703](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L419)
+[src/api/alchemy-websocket-provider.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L223)
+[src/api/alchemy-websocket-provider.ts:223](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L239)
+[src/api/alchemy-websocket-provider.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L191)
+[src/api/alchemy-websocket-provider.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L163)
+[src/api/alchemy-websocket-provider.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L178)
+[src/api/alchemy-websocket-provider.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/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/905f87c/src/api/alchemy-websocket-provider.ts#L207)
+[src/api/alchemy-websocket-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4483414/src/api/alchemy-websocket-provider.ts#L207)
 
 ___