v6.0.0 release (#1010)

The release contains a vast number of improvements including reducing dependencies, consistently using a single BigNumbers implementation, improved naming, and removing deprecated and broken functions.  
For more info, see the Release Notes: https://github.com/ProjectOpenSea/opensea-js/releases/tag/v6.0.0

.eslintrc.js

@@ -6,10 +6,10 @@ module.exports = {
     node: true,
   },
   root: true,
-  ignorePatterns: ["docs", "lib"],
+  ignorePatterns: ["docs", "lib", "src/typechain"],
   reportUnusedDisableDirectives: true,
   parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint", "import", "jest", "prettier"],
+  plugins: ["@typescript-eslint", "import", "prettier"],
 
   extends: [
     "eslint:recommended",

.github/workflows/code-quality.yml

@@ -18,17 +18,11 @@ jobs:
           node-version-file: .nvmrc
           cache: npm
 
-      - name: Upgrade npm
-        run: npm install -g npm
-
       - name: Install dependencies
-        run: npm install --immutable --ignore-scripts
-
-      - name: Gen ABI
-        run: npm run abi-type-gen
+        run: npm install
 
       - name: Run linters
-        run: npm run lint:check
+        run: npm run lint
 
   test:
     runs-on: ubuntu-latest
@@ -39,39 +33,48 @@ jobs:
           node-version-file: .nvmrc
           cache: npm
 
-      - name: Upgrade npm
-        run: npm install -g npm
-
       - name: Install dependencies
-        run: npm install --immutable --ignore-scripts
-
-      - name: Gen ABI
-        run: npm run abi-type-gen
+        run: npm install
 
       - name: Run tests
         env:
-          API_KEY: ${{ secrets.API_KEY }}
+          OPENSEA_API_KEY: ${{ secrets.OPENSEA_API_KEY }}
         run: npm run test
 
-  test-earliest-node-engine-support:
+  test-integration:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: "16.0.0" # specified in the package.json engines.node field
+          node-version-file: .nvmrc
           cache: npm
 
-      - name: Upgrade npm
-        run: npm install -g npm
-
       - name: Install dependencies
-        run: npm install --immutable --ignore-scripts
+        run: npm install
+
+      - name: Run integration tests
+        env:
+          OPENSEA_API_KEY: ${{ secrets.OPENSEA_API_KEY }}
+          ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+          WALLET_PRIV_KEY: ${{ secrets.WALLET_PRIV_KEY }}
+          SELL_ORDER_CONTRACT_ADDRESS: ${{ secrets.SELL_ORDER_CONTRACT_ADDRESS }}
+          SELL_ORDER_TOKEN_ID: ${{ secrets.SELL_ORDER_TOKEN_ID }}
+        run: npm run test:integration
 
-      - name: Gen ABI
-        run: npm run abi-type-gen
+  test-earliest-node-engine-support:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.0.0 # specified in the package.json engines.node field
+          cache: npm
+
+      - name: Install dependencies
+        run: npm install
 
       - name: Run tests
         env:
-          API_KEY: ${{ secrets.API_KEY }}
+          OPENSEA_API_KEY: ${{ secrets.OPENSEA_API_KEY }}
         run: npm run test

.github/workflows/docs.yml

@@ -16,16 +16,10 @@ jobs:
           node-version-file: .nvmrc
           cache: npm
 
-      - name: Upgrade npm
-        run: npm install -g npm
-
       - name: Install dependencies
-        run: npm install --immutable --ignore-scripts
-
-      - name: Gen ABI
-        run: npm run abi-type-gen
+        run: npm install
 
-      - name: Build
+      - name: Build docs
         run: npm run docs-build
 
       - name: Deploy 🚀

.github/workflows/npm-publish.yml

@@ -8,20 +8,6 @@ on:
     types: [created]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: .nvmrc
-      - name: Upgrade npm
-        run: npm install -g npm
-      - run: npm ci
-      - run: npm test
-      - run: npm run build
-      - run: yarn build
-
   publish-npm:
     needs: build
     runs-on: ubuntu-latest
@@ -32,10 +18,8 @@ jobs:
         with:
           node-version-file: .nvmrc
           registry-url: https://registry.npmjs.org/
-      - name: Upgrade npm
-        run: npm install -g npm
-      - run: npm ci
-      - run: npm run build
+      - run: npm install
+      - run: npm test
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn lint-staged
+npm run lint-staged

.husky/pre-push

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn check-types
+npm run check-types

.prettierignore

@@ -1,3 +1,4 @@
 lib
 docs
 .nyc_output
+src/typechain

CHANGELOG.md

@@ -1,53 +1,6 @@
 # Changelog
 
-Full changelog coming soon. For now, here are the most important changes for doing major migrations:
+The changelog for recent versions can be found at
 
-## Migrating to version 1.2
-
-- `OpenSeaPort::computeFees()` No longer accepts an `isPrivate` parameter.
-
-## Migrating to version 1.1
-
-- `OpenSeaPort::computeFees()` No longer accepts a `fees` parameter, relying solely on `asset`.
-
-## Migrating to version 1.0
-
-Version 1.0 introduces bundling for semi-fungible and fungible assets, serialized asset collections, a smaller bundle size, and more, along with many bug fixes.
-
-**Breaking directory changes**
-
-- Many constants inside of `/utils` have been moved to `/constants`.
-- Other utils have been moved to `/utils/utils`
-
-**Breaking type changes**
-
-- `profile_img_url` in the `OpenSeaAccount` type has been renamed to `profileImgUrl`
-- `OpenSeaPort::computeFees()` now returns a new type, `ComputedFees`, which expands "BPS" to "BasisPoints" for each of its member keys
-
-**Breaking interface changes**
-
-- `OpenSeaPort::computeFees()` now takes in a single asset, and returns a new and more consistent type, `ComputedFees`
-- `schemaName` has been moved out of main method calls and into the `Asset` type
-- `OpenSeaAPI::getAsset()` now accepts named arguments, consistent with other methods
-- `OpenSeaPort::createFactorySellOrders` now accepts an `assets` parameter consistent with the other `Asset` type parameters in other methods
-- `OpenSeaPort::getTokenBalance()` no longer defaults to the WETH address if no `tokenAddress` is set. And it accepts a `schemaName` parameter instead of an ABI
-- `OpenSeaPort::approveNonFungibleToken()` has been renamed to `approveSemiOrNonFungibleToken()`, though it always worked for semi-fungible tokens like ERC-1155
-
-**Removed deprecations:**
-
-- `OpenSeaPort::transferOne()`, replaced by `OpenSeaPort::transfer()`
-- `tokenId` and `tokenAddress` parameters for most SDK methods, replaced by creating an `Asset` type and passing that in
-
-## Migrating to version 0.6
-
-Version 0.6 introduces some major new features, including trading fungible and semi-fungible assets (including ERC-20 and ERC-1155 assets). These have been architected to maximize backwards compatibility, but there were a few breaking changes:
-
-- The `Asset` type now has `version` instead of `nftVersion` as a property
-- Similarly, the `NFTVersion` type has been renamed `TokenStandardVersion`
-- `computeFees` now takes in a single, annotated OpenSeaAsset as a parameter instead of a list of assets
-- In `isAssetTransferrable`, `didOwnerApprove` was renamed to `useProxy`
-
-Non-breaking changes with deprecation notices:
-
-- `getFungibleTokens` has been deprecated. Use `api.getPaymentTokens`
-- Methods now show a deprecation warning when used with `tokenId` or `tokenAddress` as arguments, instead of using `asset` or `assets` (of type `Asset`/`Asset[]`)
+- https://docs.opensea.io/changelog
+- https://github.com/ProjectOpenSea/opensea-js/releases