Skip to content

Commit

Permalink
v2.10.1 (#368)
Browse files Browse the repository at this point in the history
  • Loading branch information
thebrianchen authored Sep 12, 2023
1 parent b4279cc commit 20328ff
Show file tree
Hide file tree
Showing 314 changed files with 1,575 additions and 1,537 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

### Minor Changes

## 2.10.1

### Major Changes

### Minor Changes

- Fixed a bug in the `Log` object where the `removed` field was not included in the response.

## 2.10.0
Expand Down
16 changes: 8 additions & 8 deletions docs-md/classes/Alchemy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/8dc500a/src/api/alchemy.ts#L63)
[src/api/alchemy.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy.ts#L63)

## Properties

Expand All @@ -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/8dc500a/src/api/alchemy.ts#L42)
[src/api/alchemy.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy.ts#L42)

___

Expand All @@ -64,7 +64,7 @@ Enhanced APIs.

#### Defined in

[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy.ts#L24)
[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy.ts#L24)

___

Expand All @@ -77,7 +77,7 @@ transactions.

#### Defined in

[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy.ts#L54)
[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy.ts#L54)

___

Expand All @@ -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/8dc500a/src/api/alchemy.ts#L27)
[src/api/alchemy.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy.ts#L27)

___

Expand All @@ -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/8dc500a/src/api/alchemy.ts#L48)
[src/api/alchemy.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy.ts#L48)

___

Expand All @@ -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/8dc500a/src/api/alchemy.ts#L36)
[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy.ts#L36)

___

Expand All @@ -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/8dc500a/src/api/alchemy.ts#L30)
[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy.ts#L30)
20 changes: 10 additions & 10 deletions docs-md/classes/AlchemyConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/8dc500a/src/api/alchemy-config.ts#L64)
[src/api/alchemy-config.ts:64](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L64)

## Properties

Expand All @@ -52,7 +52,7 @@ The Alchemy API key.

#### Defined in

[src/api/alchemy-config.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-config.ts#L23)
[src/api/alchemy-config.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L23)

___

Expand All @@ -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/8dc500a/src/api/alchemy-config.ts#L41)
[src/api/alchemy-config.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L41)

___

Expand All @@ -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/8dc500a/src/api/alchemy-config.ts#L32)
[src/api/alchemy-config.ts:32](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L32)

___

Expand All @@ -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/8dc500a/src/api/alchemy-config.ts#L29)
[src/api/alchemy-config.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L29)

___

Expand All @@ -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/8dc500a/src/api/alchemy-config.ts#L26)
[src/api/alchemy-config.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L26)

___

Expand All @@ -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/8dc500a/src/api/alchemy-config.ts#L46)
[src/api/alchemy-config.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L46)

___

Expand All @@ -125,7 +125,7 @@ and apiKey.

#### Defined in

[src/api/alchemy-config.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-config.ts#L38)
[src/api/alchemy-config.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L38)

## Methods

Expand All @@ -149,7 +149,7 @@ other less-common methods.

#### Defined in

[src/api/alchemy-config.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-config.ts#L107)
[src/api/alchemy-config.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L107)

___

Expand All @@ -174,4 +174,4 @@ other less-common methods.

#### Defined in

[src/api/alchemy-config.ts:129](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-config.ts#L129)
[src/api/alchemy-config.ts:129](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-config.ts#L129)
38 changes: 31 additions & 7 deletions docs-md/classes/AlchemyProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ Do not call this constructor directly. Instead, instantiate an instance of
- [listenerCount](AlchemyProvider.md#listenercount)
- [listeners](AlchemyProvider.md#listeners)
- [lookupAddress](AlchemyProvider.md#lookupaddress)
- [modifyFormatter](AlchemyProvider.md#modifyformatter)
- [off](AlchemyProvider.md#off)
- [on](AlchemyProvider.md#on)
- [once](AlchemyProvider.md#once)
Expand Down Expand Up @@ -401,7 +402,7 @@ ___

#### Defined in

[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-provider.ts#L41)
[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-provider.ts#L41)

___

Expand All @@ -411,7 +412,7 @@ ___

#### Defined in

[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-provider.ts#L43)
[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-provider.ts#L43)

___

Expand Down Expand Up @@ -463,7 +464,7 @@ ___

#### Defined in

[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-provider.ts#L42)
[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-provider.ts#L42)

## Accessors

Expand Down Expand Up @@ -935,7 +936,7 @@ JsonRpcProvider.\_startPending

#### Defined in

[src/api/alchemy-provider.ts:209](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-provider.ts#L209)
[src/api/alchemy-provider.ts:211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-provider.ts#L211)

___

Expand Down Expand Up @@ -1135,7 +1136,7 @@ JsonRpcProvider.detectNetwork

#### Defined in

[src/api/alchemy-provider.ts:197](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-provider.ts#L197)
[src/api/alchemy-provider.ts:199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-provider.ts#L199)

___

Expand Down Expand Up @@ -1614,7 +1615,7 @@ CommunityResourcable.isCommunityResource

#### Defined in

[src/api/alchemy-provider.ts:219](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-provider.ts#L219)
[src/api/alchemy-provider.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-provider.ts#L221)

___

Expand Down Expand Up @@ -1708,6 +1709,29 @@ node_modules/@ethersproject/providers/lib/base-provider.d.ts:142

___

### modifyFormatter

`Private` **modifyFormatter**(): `void`

Overrides the base `Formatter` class inherited from ethers to support
returning custom fields in Ethers response types.

For context, ethers has a `Formatter` class that is used to format the
response from a JSON-RPC request. Any fields that are not defined in the
`Formatter` class are removed from the returned response. By modifying the
`Formatter` class in this method, we can add support for fields that are
not defined in ethers.

#### Returns

`void`

#### Defined in

[src/api/alchemy-provider.ts:332](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-provider.ts#L332)

___

### off

**off**(`eventName`, `listener?`): [`AlchemyProvider`](AlchemyProvider.md)
Expand Down Expand Up @@ -1974,7 +1998,7 @@ JsonRpcProvider.send

#### Defined in

[src/api/alchemy-provider.ts:233](https://github.com/alchemyplatform/alchemy-sdk-js/blob/8dc500a/src/api/alchemy-provider.ts#L233)
[src/api/alchemy-provider.ts:235](https://github.com/alchemyplatform/alchemy-sdk-js/blob/e05babb/src/api/alchemy-provider.ts#L235)

___

Expand Down
Loading

0 comments on commit 20328ff

Please sign in to comment.