Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 39eb3e7

Browse files
thebrianchenthebrianchen
authored
1 parent 145ea50 commit 39eb3e7

114 files changed

Lines changed: 995 additions & 644 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Unreleased
44

5+
## 2.0.3
6+
57
### Minor Changes
68

79
- Added support for the `pageSize` parameter in `GetNftsForOwnerOptions` to specify the number of NFTs fetched when using `alchemy.nft.getNftsForOwner()`.

‎docs-md/README.md‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,6 @@ It supports the exact same syntax and functionality of the Ethers.js `AlchemyPro
88

99
The SDK leverages Alchemy's hardened node infrastructure, guaranteeing best-in-class node reliability, scalability, and data correctness, and is undergoing active development by Alchemy's engineers.
1010

11-
> :warning: **WARNING:** The `@alch/alchemy-sdk` package is now deprecated as of the v2.0.0 release. Please use the `alchemy-sdk` package instead. Note that upgrading from v1 to v2 will be a breaking change. To upgrade to v2.0.0 from v1.X.X, simply run the following in your project root:
12-
13-
```
14-
npm uninstall @alch/alchemy-sdk
15-
npm install alchemy-sdk@latest
16-
```
17-
1811
> 🙋‍♀️ **FEATURE REQUESTS:** We'd love your thoughts on what would improve your web3 dev process the most! If you have 5 minutes, tell us what you want at our [Feature Request feedback form](https://alchemyapi.typeform.com/sdk-feedback), and we'd love to build it for you:
1912
2013
## Getting started
@@ -78,7 +71,7 @@ alchemy.ws.on(
7871

7972
## Alchemy Core
8073

81-
The core package 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` and it should just work.
74+
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.
8275

8376
It also includes the majority of Alchemy Enhanced APIs, including:
8477

‎docs-md/classes/Alchemy.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ different network or API key, create a new instance of [Alchemy](Alchemy.md).
3636

3737
#### Defined in
3838

39-
[src/api/alchemy.ts:44](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy.ts#L44)
39+
[src/api/alchemy.ts:44](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy.ts#L44)
4040

4141
## Properties
4242

@@ -49,7 +49,7 @@ and allows access to the underlying providers.
4949

5050
#### Defined in
5151

52-
[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy.ts#L36)
52+
[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy.ts#L36)
5353

5454
___
5555

@@ -62,7 +62,7 @@ Enhanced APIs.
6262

6363
#### Defined in
6464

65-
[src/api/alchemy.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy.ts#L22)
65+
[src/api/alchemy.ts:22](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy.ts#L22)
6666

6767
___
6868

@@ -74,7 +74,7 @@ The `nft` namespace contains methods for Alchemy's NFT API.
7474

7575
#### Defined in
7676

77-
[src/api/alchemy.ts:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy.ts#L25)
77+
[src/api/alchemy.ts:25](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy.ts#L25)
7878

7979
___
8080

@@ -84,7 +84,7 @@ ___
8484

8585
#### Defined in
8686

87-
[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy.ts#L30)
87+
[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy.ts#L30)
8888

8989
___
9090

@@ -96,4 +96,4 @@ The `ws` namespace contains methods for using WebSockets and creating subscripti
9696

9797
#### Defined in
9898

99-
[src/api/alchemy.ts:28](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy.ts#L28)
99+
[src/api/alchemy.ts:28](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy.ts#L28)

‎docs-md/classes/AlchemyConfig.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ exposes the underlying providers for more advanced use cases.
3636

3737
#### Defined in
3838

39-
[src/api/alchemy-config.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-config.ts#L51)
39+
[src/api/alchemy-config.ts:51](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-config.ts#L51)
4040

4141
## Properties
4242

@@ -48,7 +48,7 @@ The Alchemy API key.
4848

4949
#### Defined in
5050

51-
[src/api/alchemy-config.ts:21](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-config.ts#L21)
51+
[src/api/alchemy-config.ts:21](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-config.ts#L21)
5252

5353
___
5454

@@ -60,7 +60,7 @@ The maximum number of retries to perform.
6060

6161
#### Defined in
6262

63-
[src/api/alchemy-config.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-config.ts#L27)
63+
[src/api/alchemy-config.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-config.ts#L27)
6464

6565
___
6666

@@ -72,7 +72,7 @@ The Network that this SDK is associated with.
7272

7373
#### Defined in
7474

75-
[src/api/alchemy-config.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-config.ts#L24)
75+
[src/api/alchemy-config.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-config.ts#L24)
7676

7777
___
7878

@@ -85,7 +85,7 @@ and apiKey.
8585

8686
#### Defined in
8787

88-
[src/api/alchemy-config.ts:33](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-config.ts#L33)
88+
[src/api/alchemy-config.ts:33](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-config.ts#L33)
8989

9090
## Methods
9191

@@ -109,4 +109,4 @@ other less-common methods.
109109

110110
#### Defined in
111111

112-
[src/api/alchemy-config.ts:89](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-config.ts#L89)
112+
[src/api/alchemy-config.ts:89](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-config.ts#L89)

‎docs-md/classes/AlchemyProvider.md‎

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@ Do not call this constructor directly. Instead, instantiate an instance of
119119
- [waitForTransaction](AlchemyProvider.md#waitfortransaction)
120120
- [defaultUrl](AlchemyProvider.md#defaulturl)
121121
- [getFormatter](AlchemyProvider.md#getformatter)
122-
- [getNetwork](AlchemyProvider.md#getnetwork-1)
123122
- [hexlifyTransaction](AlchemyProvider.md#hexlifytransaction)
124123
- [isProvider](AlchemyProvider.md#isprovider)
125124

@@ -401,7 +400,7 @@ ___
401400

402401
#### Defined in
403402

404-
[src/api/alchemy-provider.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-provider.ts#L36)
403+
[src/api/alchemy-provider.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-provider.ts#L38)
405404

406405
___
407406

@@ -453,7 +452,7 @@ ___
453452

454453
#### Defined in
455454

456-
[src/api/alchemy-provider.ts:37](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-provider.ts#L37)
455+
[src/api/alchemy-provider.ts:39](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-provider.ts#L39)
457456

458457
## Accessors
459458

@@ -925,7 +924,7 @@ JsonRpcProvider.\_startPending
925924

926925
#### Defined in
927926

928-
[src/api/alchemy-provider.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-provider.ts#L163)
927+
[src/api/alchemy-provider.ts:183](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-provider.ts#L183)
929928

930929
___
931930

@@ -1125,7 +1124,7 @@ JsonRpcProvider.detectNetwork
11251124

11261125
#### Defined in
11271126

1128-
[src/api/alchemy-provider.ts:151](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-provider.ts#L151)
1127+
[src/api/alchemy-provider.ts:171](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-provider.ts#L171)
11291128

11301129
___
11311130

@@ -1604,7 +1603,7 @@ CommunityResourcable.isCommunityResource
16041603

16051604
#### Defined in
16061605

1607-
[src/api/alchemy-provider.ts:173](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-provider.ts#L173)
1606+
[src/api/alchemy-provider.ts:193](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-provider.ts#L193)
16081607

16091608
___
16101609

@@ -1964,7 +1963,7 @@ JsonRpcProvider.send
19641963

19651964
#### Defined in
19661965

1967-
[src/api/alchemy-provider.ts:187](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-provider.ts#L187)
1966+
[src/api/alchemy-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-provider.ts#L207)
19681967

19691968
___
19701969

@@ -2054,30 +2053,6 @@ node_modules/@ethersproject/providers/lib/base-provider.d.ts:92
20542053

20552054
___
20562055

2057-
### getNetwork
2058-
2059-
▸ `Static` **getNetwork**(`network`): `Network`
2060-
2061-
#### Parameters
2062-
2063-
| Name | Type |
2064-
| :------ | :------ |
2065-
| `network` | `Networkish` |
2066-
2067-
#### Returns
2068-
2069-
`Network`
2070-
2071-
#### Inherited from
2072-
2073-
JsonRpcProvider.getNetwork
2074-
2075-
#### Defined in
2076-
2077-
node_modules/@ethersproject/providers/lib/base-provider.d.ts:93
2078-
2079-
___
2080-
20812056
### hexlifyTransaction
20822057

20832058
▸ `Static` **hexlifyTransaction**(`transaction`, `allowExtra?`): `Object`

‎docs-md/classes/AlchemyWebSocketProvider.md‎

Lines changed: 14 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@ Do not call this constructor directly. Instead, instantiate an instance of
126126
- [waitForTransaction](AlchemyWebSocketProvider.md#waitfortransaction)
127127
- [defaultUrl](AlchemyWebSocketProvider.md#defaulturl)
128128
- [getFormatter](AlchemyWebSocketProvider.md#getformatter)
129-
- [getNetwork](AlchemyWebSocketProvider.md#getnetwork-1)
130129
- [hexlifyTransaction](AlchemyWebSocketProvider.md#hexlifytransaction)
131130
- [isProvider](AlchemyWebSocketProvider.md#isprovider)
132131

@@ -202,7 +201,7 @@ WebSocketProvider.\_events
202201

203202
#### Defined in
204203

205-
[src/api/alchemy-websocket-provider.ts:68](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L68)
204+
[src/api/alchemy-websocket-provider.ts:78](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L78)
206205

207206
___
208207

@@ -504,7 +503,7 @@ ___
504503

505504
#### Defined in
506505

507-
[src/api/alchemy-websocket-provider.ts:69](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L69)
506+
[src/api/alchemy-websocket-provider.ts:79](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L79)
508507

509508
___
510509

@@ -941,7 +940,7 @@ order to parse the Alchemy subscription event.
941940

942941
#### Defined in
943942

944-
[src/api/alchemy-websocket-provider.ts:897](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L897)
943+
[src/api/alchemy-websocket-provider.ts:925](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L925)
945944

946945
___
947946

@@ -970,7 +969,7 @@ order to parse the Alchemy subscription event.
970969

971970
#### Defined in
972971

973-
[src/api/alchemy-websocket-provider.ts:920](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L920)
972+
[src/api/alchemy-websocket-provider.ts:948](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L948)
974973

975974
___
976975

@@ -1000,7 +999,7 @@ order to parse the Alchemy subscription event.
1000999

10011000
#### Defined in
10021001

1003-
[src/api/alchemy-websocket-provider.ts:821](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L821)
1002+
[src/api/alchemy-websocket-provider.ts:849](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L849)
10041003

10051004
___
10061005

@@ -1047,7 +1046,7 @@ order to parse the Alchemy subscription event.
10471046

10481047
#### Defined in
10491048

1050-
[src/api/alchemy-websocket-provider.ts:861](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L861)
1049+
[src/api/alchemy-websocket-provider.ts:889](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L889)
10511050

10521051
___
10531052

@@ -1262,7 +1261,7 @@ WebSocketProvider.destroy
12621261

12631262
#### Defined in
12641263

1265-
[src/api/alchemy-websocket-provider.ts:387](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L387)
1264+
[src/api/alchemy-websocket-provider.ts:415](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L415)
12661265

12671266
___
12681267

@@ -1734,7 +1733,7 @@ CommunityResourcable.isCommunityResource
17341733

17351734
#### Defined in
17361735

1737-
[src/api/alchemy-websocket-provider.ts:399](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L399)
1736+
[src/api/alchemy-websocket-provider.ts:427](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L427)
17381737

17391738
___
17401739

@@ -1781,7 +1780,7 @@ WebSocketProvider.listenerCount
17811780

17821781
#### Defined in
17831782

1784-
[src/api/alchemy-websocket-provider.ts:192](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L192)
1783+
[src/api/alchemy-websocket-provider.ts:220](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L220)
17851784

17861785
___
17871786

@@ -1810,7 +1809,7 @@ WebSocketProvider.listeners
18101809

18111810
#### Defined in
18121811

1813-
[src/api/alchemy-websocket-provider.ts:208](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L208)
1812+
[src/api/alchemy-websocket-provider.ts:236](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L236)
18141813

18151814
___
18161815

@@ -1864,7 +1863,7 @@ WebSocketProvider.off
18641863

18651864
#### Defined in
18661865

1867-
[src/api/alchemy-websocket-provider.ts:160](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L160)
1866+
[src/api/alchemy-websocket-provider.ts:188](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L188)
18681867

18691868
___
18701869

@@ -1893,7 +1892,7 @@ WebSocketProvider.on
18931892

18941893
#### Defined in
18951894

1896-
[src/api/alchemy-websocket-provider.ts:132](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L132)
1895+
[src/api/alchemy-websocket-provider.ts:160](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L160)
18971896

18981897
___
18991898

@@ -1924,7 +1923,7 @@ WebSocketProvider.once
19241923

19251924
#### Defined in
19261925

1927-
[src/api/alchemy-websocket-provider.ts:147](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L147)
1926+
[src/api/alchemy-websocket-provider.ts:175](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L175)
19281927

19291928
___
19301929

@@ -2021,7 +2020,7 @@ WebSocketProvider.removeAllListeners
20212020

20222021
#### Defined in
20232022

2024-
[src/api/alchemy-websocket-provider.ts:176](https://github.com/alchemyplatform/alchemy-sdk-js/blob/fd39d10/src/api/alchemy-websocket-provider.ts#L176)
2023+
[src/api/alchemy-websocket-provider.ts:204](https://github.com/alchemyplatform/alchemy-sdk-js/blob/145ea50/src/api/alchemy-websocket-provider.ts#L204)
20252024

20262025
___
20272026

@@ -2209,30 +2208,6 @@ node_modules/@ethersproject/providers/lib/base-provider.d.ts:92
22092208

22102209
___
22112210

2212-
### getNetwork
2213-
2214-
▸ `Static` **getNetwork**(`network`): `Network`
2215-
2216-
#### Parameters
2217-
2218-
| Name | Type |
2219-
| :------ | :------ |
2220-
| `network` | `Networkish` |
2221-
2222-
#### Returns
2223-
2224-
`Network`
2225-
2226-
#### Inherited from
2227-
2228-
WebSocketProvider.getNetwork
2229-
2230-
#### Defined in
2231-
2232-
node_modules/@ethersproject/providers/lib/base-provider.d.ts:93
2233-
2234-
___
2235-
22362211
### hexlifyTransaction
22372212

22382213
▸ `Static` **hexlifyTransaction**(`transaction`, `allowExtra?`): `Object`

0 commit comments

Comments
 (0)