v7: remove v1 APIs, upgrade to ethers v6 (#1310)

* bump version to v7

* remove bundles

* WIP: breaking version upgrade to v7, remove v1 apis, other small tasks and cleanup

* add `offerProtectionEnabled` to `buildOffer()`

* fix getFees: optional seller

* waiting for getPaymentTokens to be introduced in api v2, refactor method meanwhile
dedupe OrderSide

* update to signerOrProvider

* fixes

* upgrade to ethers v6 (#1311)

* upgrade to ethers v6

* lint

* update

* improve docs

* improve docs

.prettierrc

@@ -0,0 +1 @@
+{}

README.md

@@ -12,11 +12,11 @@
 
 # OpenSea.js <!-- omit in toc -->
 
-This is the JavaScript SDK for [OpenSea](https://opensea.io), the largest marketplace for NFTs.
+This is the TypeScript SDK for [OpenSea](https://opensea.io), the largest marketplace for NFTs.
 
 It allows developers to access the official orderbook, filter it, create listings and offers, and complete trades programmatically.
 
-Get started by [requesting an API key](https://docs.opensea.io/reference/api-keys) and instantiating your own OpenSea SDK instance. Then you can create orders off-chain or fulfill orders on-chain, and listen to events (like `ApproveAllAssets` or `WrapEth`) in the process.
+Get started by [requesting an API key](https://docs.opensea.io/reference/api-keys) and instantiating your own OpenSea SDK instance. Then you can create orders off-chain or fulfill orders on-chain, and listen to events in the process.
 
 Happy seafaring! ⛵️
 

developerDocs/advanced-use-cases.md

@@ -36,15 +36,15 @@ const order = await openseaSDK.createListing({
 You can buy and transfer an item to someone else in one step! Just pass the `recipientAddress` parameter:
 
 ```typescript
-const order = await openseaSDK.api.getOrder({ side: "ask", ... })
+const order = await openseaSDK.api.getOrder({ side: OrderSide.ASK, ... })
 await openseaSDK.fulfillOrder({
   order,
   accountAddress, // The address of your wallet, which will sign the transaction
   recipientAddress // The address of the recipient, i.e. the wallet you're purchasing on behalf of
 })
 ```
 
-If the order is a listing (sell order, `order.side === "ask"`), the taker is the _buyer_ and this will prompt the buyer to pay for the item(s) but send them to the `recipientAddress`. If the order is an offer (buy order, `"bid"`), the taker is the _seller_ but the bid amount be sent to the `recipientAddress`.
+If the order is a listing (sell order, `order.side === OrderSide.ASK`), the taker is the _buyer_ and this will prompt the buyer to pay for the item(s) but send them to the `recipientAddress`. If the order is an offer (buy order, `"bid"`), the taker is the _seller_ but the bid amount be sent to the `recipientAddress`.
 
 This will automatically approve the assets for trading and confirm the transaction for sending them.
 
@@ -68,14 +68,13 @@ const order = await openseaSDK.createListing({
 });
 ```
 
-You can use `getPaymentTokens` to search for tokens by symbol name. And you can even list all orders for a specific ERC-20 token by querying the API:
+You can use `getPaymentToken` to search for payment tokens by address. And you can even list all orders for a specific ERC-20 token by querying the API:
 
 ```typescript
-const token = (await openseaSDK.api.getPaymentTokens({ symbol: "MANA" }))
-  .tokens[0];
+const token = await openseaSDK.api.getPaymentToken(paymentTokenAddress);
 
 const order = await openseaSDK.api.getOrders({
-  side: "ask",
+  side: OrderSide.ASK,
   paymentTokenAddress: token.address,
 });
 ```
@@ -110,34 +109,35 @@ Events are fired whenever transactions or orders are being created, and when tra
 Our recommendation is that you "forward" OpenSea events to your own store or state management system. Here are examples of listening to the events:
 
 ```typescript
-import { openSeaSDK, EventType } from 'opensea-js'
+import { OpenSeaSDK, EventType } from 'opensea-js'
+const sdk = new OpenSeaSDK(...);
 
 handleSDKEvents() {
-    openSeaSDK.addListener(EventType.TransactionCreated, ({ transactionHash, event }) => {
+    sdk.addListener(EventType.TransactionCreated, ({ transactionHash, event }) => {
       console.info('Transaction created: ', { transactionHash, event })
     })
-    openSeaSDK.addListener(EventType.TransactionConfirmed, ({ transactionHash, event }) => {
+    sdk.addListener(EventType.TransactionConfirmed, ({ transactionHash, event }) => {
       console.info('Transaction confirmed: ',{ transactionHash, event })
     })
-    openSeaSDK.addListener(EventType.TransactionDenied, ({ transactionHash, event }) => {
+    sdk.addListener(EventType.TransactionDenied, ({ transactionHash, event }) => {
       console.info('Transaction denied: ',{ transactionHash, event })
     })
-    openSeaSDK.addListener(EventType.TransactionFailed, ({ transactionHash, event }) => {
+    sdk.addListener(EventType.TransactionFailed, ({ transactionHash, event }) => {
       console.info('Transaction failed: ',{ transactionHash, event })
     })
-    openSeaSDK.addListener(EventType.WrapEth, ({ accountAddress, amount }) => {
+    sdk.addListener(EventType.WrapEth, ({ accountAddress, amount }) => {
       console.info('Wrap ETH: ',{ accountAddress, amount })
     })
-    openSeaSDK.addListener(EventType.UnwrapWeth, ({ accountAddress, amount }) => {
+    sdk.addListener(EventType.UnwrapWeth, ({ accountAddress, amount }) => {
       console.info('Unwrap ETH: ',{ accountAddress, amount })
     })
-    openSeaSDK.addListener(EventType.MatchOrders, ({ buy, sell, accountAddress }) => {
+    sdk.addListener(EventType.MatchOrders, ({ buy, sell, accountAddress }) => {
       console.info('Match orders: ', { buy, sell, accountAddress })
     })
-    openSeaSDK.addListener(EventType.CancelOrder, ({ order, accountAddress }) => {
+    sdk.addListener(EventType.CancelOrder, ({ order, accountAddress }) => {
       console.info('Cancel order: ', { order, accountAddress })
     })
 }
 ```
 
-To remove all listeners call `openseaSDK.removeAllListeners()`.
+To remove all listeners call `sdk.removeAllListeners()`.

developerDocs/getting-started.md

@@ -20,15 +20,15 @@ hidden: false
 ### Fetching NFTs
 
 ```TypeScript
-const { nft } = await openseaSDK.api.getNFT(openseaSDK.chain, tokenAddress, tokenId)
+const { nft } = await openseaSDK.api.getNFT(tokenAddress, tokenId)
 ```
 
 Also see methods `getNFTsByCollection`, `getNFTsByContract`, and `getNFTsByAccount`.
 
 #### Checking Balances and Ownerships
 
 ```typescript
-import { TokenStandard } from "opensea-js/lib/types";
+import { TokenStandard } from "opensea-js";
 
 const asset = {
   // CryptoKitties
@@ -42,7 +42,7 @@ const balance = await openseaSDK.getBalance({
   asset,
 });
 
-const ownsKitty = balance.gt(0);
+const ownsKitty = balance > 0n;
 ```
 
 ### Making Offers
@@ -128,18 +128,18 @@ Note that auctions aren't supported with Ether directly due to limitations in Et
 To retrieve a list of offers and auctions on an asset, you can use `getOrders`. Parameters passed into API filter objects are camel-cased and serialized before being sent as [API parameters](https://docs.opensea.io/v2.0/reference):
 
 ```typescript
-// Get offers (bids), a.k.a. orders where `side == "bid"`
+// Get offers (bids), a.k.a. orders where `side == OrderSide.BID`
 const { orders, count } = await openseaSDK.api.getOrders({
   assetContractAddress: tokenAddress,
   tokenId,
-  side: "bid",
+  side: OrderSide.BID,
 });
 
-// Get page 2 of all auctions, a.k.a. orders where `side == "ask"`
+// Get page 2 of all auctions, a.k.a. orders where `side == OrderSide.ASK`
 const { orders, count } = await openseaSDK.api.getOrders({
   assetContractAddress: tokenAddress,
   tokenId,
-  side: "ask",
+  side: OrderSide.ASK,
 });
 ```
 
@@ -166,23 +166,23 @@ const offer = await openseaSDK.api.getBestOffer(collectionSlug, tokenId);
 To buy an item, you need to **fulfill a listing**. To do that, it's just one call:
 
 ```typescript
-const order = await openseaSDK.api.getOrder({ side: "ask", ... })
+const order = await openseaSDK.api.getOrder({ side: OrderSide.ASK, ... })
 const accountAddress = "0x..." // The buyer's wallet address, also the taker
 const transactionHash = await openseaSDK.fulfillOrder({ order, accountAddress })
 ```
 
 Note that the `fulfillOrder` promise resolves when the transaction has been confirmed and mined to the blockchain. To get the transaction hash before this happens, add an event listener (see [Listening to Events](#listening-to-events)) for the `TransactionCreated` event.
 
-If the order is a listing (sell order, `order.side === "ask"`), the taker is the _buyer_ and this will prompt the buyer to pay for the item(s).
+If the order is a listing (sell order, `order.side === OrderSide.ASK`), the taker is the _buyer_ and this will prompt the buyer to pay for the item(s).
 
 ### Accepting Offers
 
 Similar to fulfilling listings above, you need to fulfill an offer (buy order) on an item you own to receive the tokens in the offer.
 
 ```typescript
-const order = await openseaSDK.api.getOrder({ side: "bid", ... })
+const order = await openseaSDK.api.getOrder({ side: OrderSide.BID, ... })
 const accountAddress = "0x..." // The owner's wallet address, also the taker
 await openseaSDK.fulfillOrder({ order, accountAddress })
 ```
 
-If the order is an offer (buy order, `order.side === "bid"`), then the taker is the _owner_ and this will prompt the owner to exchange their item(s) for whatever is being offered in return. See [Listening to Events](#listening-to-events) below to respond to the setup transactions that occur the first time a user accepts a bid.
+If the order is an offer (buy order, `order.side === OrderSide.BID`), then the taker is the _owner_ and this will prompt the owner to exchange their item(s) for whatever is being offered in return. See [Listening to Events](#listening-to-events) below to respond to the setup transactions that occur the first time a user accepts a bid.

developerDocs/quick-start.md

@@ -30,11 +30,9 @@ import { ethers } from "ethers";
 import { OpenSeaSDK, Chain } from "opensea-js";
 
 // This example provider won't let you make transactions, only read-only calls:
-const provider = new ethers.providers.JsonRpcProvider(
-  "https://mainnet.infura.io",
-);
+const provider = new ethers.JsonRpcProvider("https://mainnet.infura.io");
 
-const openseaSDK = new OpenSeaSDK(walletWithProvider, {
+const openseaSDK = new OpenSeaSDK(provider, {
   chain: Chain.Mainnet,
   apiKey: YOUR_API_KEY,
 });