v3.5.0 (#473)

alchemyplatform · Nov 15, 2024 · 0b67961 · 0b67961
1 parent 92caf40
commit 0b67961
Show file tree

Hide file tree

Showing 362 changed files with 2,576 additions and 1,654 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,10 +4,14 @@
 
 ### Major Changes
 
-- Added a new `PricesNamespace` with three new methods: `getTokenPriceByAddress()`, `getTokenPriceBySymbol()`, `getHistoricalPriceByAddress`, and `getHistoricalPriceBySymbol()`. Access these methods via `alchemy.prices`.
-
 ### Minor Changes
 
+## 3.5.0
+
+### Major Changes
+
+- Added a new `PricesNamespace` with three new methods: `getTokenPriceByAddress()`, `getTokenPriceBySymbol()`, `getHistoricalPriceByAddress`, and `getHistoricalPriceBySymbol()`. Access these methods via `alchemy.prices`.
+
 ## 3.4.8
 
 ### Minor Changes

diff --git a/docs-md/README.md b/docs-md/README.md
@@ -36,6 +36,11 @@ The SDK currently supports the following chains (chains with '(d)' after are dep
 - **Celo**: Mainnet, Alfajores
 - **Metis**: Mainnet
 - **OpBNB**: Mainnet, Testnet
+- **Berachain**: Bartio
+- **Soneium**: Minato
+- **Worldchain**: Mainnet, Sepolia
+- **Rootstock**: Mainnet, Testnet
+- **Flow**: Mainnet, Testnet
 
 You can find per-method documentation of the Alchemy SDK endpoints at the [Alchemy Docs linked in the sidebar](https://docs.alchemy.com/reference/alchemy-sdk-quickstart).
 
@@ -401,4 +406,4 @@ alchemy.core.getTokenBalances('vitalik.eth').then(console.log);
 
 If you have any questions, issues, or feedback, please file an issue
 on [GitHub](https://github.com/alchemyplatform/alchemy-sdk-js/issues), or drop us a message on
-our [Discord](https://discord.com/channels/735965332958871634/983472322998575174) channel for the SDK.
+our [Discord](https://discord.com/invite/alchemyplatform) channel for the SDK.
diff --git a/docs-md/classes/Alchemy.md b/docs-md/classes/Alchemy.md
@@ -21,6 +21,7 @@ different network or API key, create a new instance of [Alchemy](Alchemy.md).
 - [debug](Alchemy.md#debug)
 - [nft](Alchemy.md#nft)
 - [notify](Alchemy.md#notify)
+- [prices](Alchemy.md#prices)
 - [transact](Alchemy.md#transact)
 - [ws](Alchemy.md#ws)
 
@@ -38,7 +39,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/4e3af22/src/api/alchemy.ts#L63)
+[src/api/alchemy.ts:67](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L67)
 
 ## Properties
 
@@ -51,7 +52,7 @@ and allows access to the underlying providers.
 
 #### Defined in
 
-[src/api/alchemy.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy.ts#L42)
+[src/api/alchemy.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L43)
 
 ___
 
@@ -64,7 +65,7 @@ Enhanced APIs.
 
 #### Defined in
 
-[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy.ts#L24)
+[src/api/alchemy.ts:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L25)
 
 ___
 
@@ -77,7 +78,7 @@ transactions.
 
 #### Defined in
 
-[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy.ts#L54)
+[src/api/alchemy.ts:55](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L55)
 
 ___
 
@@ -89,7 +90,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/4e3af22/src/api/alchemy.ts#L27)
+[src/api/alchemy.ts:28](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L28)
 
 ___
 
@@ -102,7 +103,19 @@ as part of the Notify API.
 
 #### Defined in
 
-[src/api/alchemy.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy.ts#L48)
+[src/api/alchemy.ts:49](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L49)
+
+___
+
+### prices
+
+• `Readonly` **prices**: [`PricesNamespace`](PricesNamespace.md)
+
+The `prices` namespace contains methods for getting token price data.
+
+#### Defined in
+
+[src/api/alchemy.ts:58](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L58)
 
 ___
 
@@ -115,7 +128,7 @@ checking on the state of submitted transasctions.
 
 #### Defined in
 
-[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy.ts#L36)
+[src/api/alchemy.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L37)
 
 ___
 
@@ -127,4 +140,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/4e3af22/src/api/alchemy.ts#L30)
+[src/api/alchemy.ts:31](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy.ts#L31)
diff --git a/docs-md/classes/AlchemyConfig.md b/docs-md/classes/AlchemyConfig.md
@@ -41,7 +41,7 @@ exposes the underlying providers for more advanced use cases.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:68](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L68)
+[src/api/alchemy-config.ts:69](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L69)
 
 ## Properties
 
@@ -53,7 +53,7 @@ The Alchemy API key.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L25)
+[src/api/alchemy-config.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L26)
 
 ___
 
@@ -65,7 +65,7 @@ The optional Alchemy auth token to use when sending requests with the Notify API
 
 #### Defined in
 
-[src/api/alchemy-config.ts:45](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L45)
+[src/api/alchemy-config.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L46)
 
 ___
 
@@ -77,7 +77,7 @@ Setting to enable automatic batching on json-rpc requests. Defaults to false.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:34](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L34)
+[src/api/alchemy-config.ts:35](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L35)
 
 ___
 
@@ -87,7 +87,7 @@ ___
 
 #### Defined in
 
-[src/api/alchemy-config.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L36)
+[src/api/alchemy-config.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L37)
 
 ___
 
@@ -99,7 +99,7 @@ The maximum number of retries to perform.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:31](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L31)
+[src/api/alchemy-config.ts:32](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L32)
 
 ___
 
@@ -111,7 +111,7 @@ The Network that this SDK is associated with.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:28](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L28)
+[src/api/alchemy-config.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L29)
 
 ___
 
@@ -123,7 +123,7 @@ The optional Request timeout provided in `ms` for NFT and NOTIFY API. Defaults t
 
 #### Defined in
 
-[src/api/alchemy-config.ts:50](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L50)
+[src/api/alchemy-config.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L51)
 
 ___
 
@@ -136,7 +136,7 @@ and apiKey.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L42)
+[src/api/alchemy-config.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L43)
 
 ## Methods
 
@@ -160,7 +160,7 @@ other less-common methods.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:112](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L112)
+[src/api/alchemy-config.ts:115](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L115)
 
 ___
 
@@ -185,4 +185,4 @@ other less-common methods.
 
 #### Defined in
 
-[src/api/alchemy-config.ts:134](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-config.ts#L134)
+[src/api/alchemy-config.ts:137](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-config.ts#L137)
diff --git a/docs-md/classes/AlchemyProvider.md b/docs-md/classes/AlchemyProvider.md
@@ -402,7 +402,7 @@ ___
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-provider.ts#L41)
+[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-provider.ts#L41)
 
 ___
 
@@ -412,7 +412,7 @@ ___
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-provider.ts#L43)
+[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-provider.ts#L43)
 
 ___
 
@@ -464,7 +464,7 @@ ___
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-provider.ts#L42)
+[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-provider.ts#L42)
 
 ## Accessors
 
@@ -936,7 +936,7 @@ JsonRpcProvider.\_startPending
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:219](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-provider.ts#L219)
+[src/api/alchemy-provider.ts:219](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-provider.ts#L219)
 
 ___
 
@@ -1136,7 +1136,7 @@ JsonRpcProvider.detectNetwork
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-provider.ts#L207)
+[src/api/alchemy-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-provider.ts#L207)
 
 ___
 
@@ -1615,7 +1615,7 @@ CommunityResourcable.isCommunityResource
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-provider.ts#L229)
+[src/api/alchemy-provider.ts:229](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-provider.ts#L229)
 
 ___
 
@@ -1728,7 +1728,7 @@ not defined in ethers.
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:340](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-provider.ts#L340)
+[src/api/alchemy-provider.ts:340](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-provider.ts#L340)
 
 ___
 
@@ -1998,7 +1998,7 @@ JsonRpcProvider.send
 
 #### Defined in
 
-[src/api/alchemy-provider.ts:243](https://github.com/alchemyplatform/alchemy-sdk-js/blob/4e3af22/src/api/alchemy-provider.ts#L243)
+[src/api/alchemy-provider.ts:243](https://github.com/alchemyplatform/alchemy-sdk-js/blob/44aa50c/src/api/alchemy-provider.ts#L243)
 
 ___