Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v3.1.1 #404

Merged
merged 2 commits into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,16 @@

### Minor Changes

- Added endpoints for `isAirdropNft()` and `reportSpam()` on the nft namespace.
## 3.1.1

### Major Changes

### Minor Changes

- Added endpoints for `isAirdropNft()` and `reportSpam()` in `NftNamespace`.
- Added a missing `marketplaceAddress` field to the `NftSale` in `NftNamespace.getNftSales()`.
- Fixed an incorrect field name for `bannerImageUrl` in `OpenSeaCollectionMetadata`. Deprecated the old field name `imageBannerUrl`.
- Added support for Base networks in `NotifyNamespace`.

## 3.1.0

Expand Down
2 changes: 2 additions & 0 deletions docs-md/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@ under the `alchemy.nft` namespace:
- `verifyNftOwnership()`: Check whether the provided owner address owns the provided NFT contract addresses.
- `isSpamContract()`: Check whether the given NFT contract address is a spam contract as defined by Alchemy (see the [NFT API FAQ](https://docs.alchemy.com/alchemy/enhanced-apis/nft-api/nft-api-faq#nft-spam-classification))
- `getSpamContracts()`: Returns a list of all spam contracts marked by Alchemy.
- `reportSpam()`: Report feedback that a given NFT contract address is a spam contract as defined by Alchemy.
- `isAirdropNft()`: Check whether the given NFT token is marked as an airdrop or not. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address.
- `refreshNftMetadata()`: Refresh the cached NFT metadata for a contract address and a single tokenId.
- `refreshContract()`: Enqueues the specified contract address to have all token ids' metadata refreshed.
- `getFloorPrice()`: Return the floor prices of a NFT contract by marketplace.
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/5cfa150/src/api/alchemy.ts#L63)
[src/api/alchemy.ts:63](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy.ts#L42)
[src/api/alchemy.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy.ts#L24)
[src/api/alchemy.ts:24](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy.ts#L54)
[src/api/alchemy.ts:54](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy.ts#L27)
[src/api/alchemy.ts:27](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy.ts#L48)
[src/api/alchemy.ts:48](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy.ts#L36)
[src/api/alchemy.ts:36](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy.ts#L30)
[src/api/alchemy.ts:30](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L64)
[src/api/alchemy-config.ts:64](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L23)
[src/api/alchemy-config.ts:23](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L41)
[src/api/alchemy-config.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L32)
[src/api/alchemy-config.ts:32](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L29)
[src/api/alchemy-config.ts:29](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L26)
[src/api/alchemy-config.ts:26](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L46)
[src/api/alchemy-config.ts:46](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L38)
[src/api/alchemy-config.ts:38](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L107)
[src/api/alchemy-config.ts:107](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/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/5cfa150/src/api/alchemy-config.ts#L129)
[src/api/alchemy-config.ts:129](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-config.ts#L129)
16 changes: 8 additions & 8 deletions docs-md/classes/AlchemyProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ ___

#### Defined in

[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-provider.ts#L41)
[src/api/alchemy-provider.ts:41](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-provider.ts#L41)

___

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

#### Defined in

[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-provider.ts#L43)
[src/api/alchemy-provider.ts:43](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-provider.ts#L43)

___

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

#### Defined in

[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-provider.ts#L42)
[src/api/alchemy-provider.ts:42](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-provider.ts#L42)

## Accessors

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

#### Defined in

[src/api/alchemy-provider.ts:211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-provider.ts#L211)
[src/api/alchemy-provider.ts:211](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-provider.ts#L211)

___

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

#### Defined in

[src/api/alchemy-provider.ts:199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-provider.ts#L199)
[src/api/alchemy-provider.ts:199](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-provider.ts#L199)

___

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

#### Defined in

[src/api/alchemy-provider.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-provider.ts#L221)
[src/api/alchemy-provider.ts:221](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-provider.ts#L221)

___

Expand Down Expand Up @@ -1728,7 +1728,7 @@ not defined in ethers.

#### Defined in

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

___

Expand Down Expand Up @@ -1998,7 +1998,7 @@ JsonRpcProvider.send

#### Defined in

[src/api/alchemy-provider.ts:235](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-provider.ts#L235)
[src/api/alchemy-provider.ts:235](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-provider.ts#L235)

___

Expand Down
30 changes: 15 additions & 15 deletions docs-md/classes/AlchemyWebSocketProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ WebSocketProvider.\_events

#### Defined in

[src/api/alchemy-websocket-provider.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L81)
[src/api/alchemy-websocket-provider.ts:81](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L81)

___

Expand Down Expand Up @@ -504,7 +504,7 @@ ___

#### Defined in

[src/api/alchemy-websocket-provider.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L82)
[src/api/alchemy-websocket-provider.ts:82](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L82)

___

Expand Down Expand Up @@ -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/5cfa150/src/api/alchemy-websocket-provider.ts#L947)
[src/api/alchemy-websocket-provider.ts:947](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L947)

___

Expand Down Expand Up @@ -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/5cfa150/src/api/alchemy-websocket-provider.ts#L970)
[src/api/alchemy-websocket-provider.ts:970](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L970)

___

Expand Down Expand Up @@ -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/5cfa150/src/api/alchemy-websocket-provider.ts#L871)
[src/api/alchemy-websocket-provider.ts:871](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L871)

___

Expand Down Expand Up @@ -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/5cfa150/src/api/alchemy-websocket-provider.ts#L911)
[src/api/alchemy-websocket-provider.ts:911](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L911)

___

Expand Down Expand Up @@ -1262,7 +1262,7 @@ WebSocketProvider.destroy

#### Defined in

[src/api/alchemy-websocket-provider.ts:407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L407)
[src/api/alchemy-websocket-provider.ts:407](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L407)

___

Expand Down Expand Up @@ -1307,7 +1307,7 @@ ___

#### Defined in

[src/api/alchemy-websocket-provider.ts:703](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L703)
[src/api/alchemy-websocket-provider.ts:703](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L703)

___

Expand Down Expand Up @@ -1761,7 +1761,7 @@ CommunityResourcable.isCommunityResource

#### Defined in

[src/api/alchemy-websocket-provider.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L419)
[src/api/alchemy-websocket-provider.ts:419](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L419)

___

Expand Down Expand Up @@ -1808,7 +1808,7 @@ WebSocketProvider.listenerCount

#### Defined in

[src/api/alchemy-websocket-provider.ts:223](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L223)
[src/api/alchemy-websocket-provider.ts:223](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L223)

___

Expand Down Expand Up @@ -1837,7 +1837,7 @@ WebSocketProvider.listeners

#### Defined in

[src/api/alchemy-websocket-provider.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L239)
[src/api/alchemy-websocket-provider.ts:239](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L239)

___

Expand Down Expand Up @@ -1891,7 +1891,7 @@ WebSocketProvider.off

#### Defined in

[src/api/alchemy-websocket-provider.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L191)
[src/api/alchemy-websocket-provider.ts:191](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L191)

___

Expand Down Expand Up @@ -1920,7 +1920,7 @@ WebSocketProvider.on

#### Defined in

[src/api/alchemy-websocket-provider.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L163)
[src/api/alchemy-websocket-provider.ts:163](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L163)

___

Expand Down Expand Up @@ -1951,7 +1951,7 @@ WebSocketProvider.once

#### Defined in

[src/api/alchemy-websocket-provider.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L178)
[src/api/alchemy-websocket-provider.ts:178](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L178)

___

Expand Down Expand Up @@ -2048,7 +2048,7 @@ WebSocketProvider.removeAllListeners

#### Defined in

[src/api/alchemy-websocket-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/5cfa150/src/api/alchemy-websocket-provider.ts#L207)
[src/api/alchemy-websocket-provider.ts:207](https://github.com/alchemyplatform/alchemy-sdk-js/blob/6dc36f9/src/api/alchemy-websocket-provider.ts#L207)

___

Expand Down
Loading