Release v9.0.0

Author: ryanio

.github/workflows/npm-publish.yml

@@ -16,10 +16,16 @@ jobs:
         with:
           node-version-file: .nvmrc
           registry-url: https://registry.npmjs.org/
+      # Publish @opensea/sdk
       - run: npm install
       - run: npm run build
       - run: npm test
         env:
           OPENSEA_API_KEY: ${{ secrets.OPENSEA_API_KEY }}
           ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
       - run: npm publish --provenance --access public
+
+      # Publish opensea-js stub (skip if version already exists)
+      - run: npm publish --provenance --access public
+        working-directory: packages/opensea-js-stub
+        continue-on-error: true

CHANGELOG.md

@@ -1,4 +1,12 @@
-# opensea-js
+# @opensea/sdk
+
+## 9.0.0
+
+### Major Changes
+
+- Rename package from `opensea-js` to `@opensea/sdk`
+
+  The API is unchanged — only the package name. The old `opensea-js` package will be deprecated with a stub that directs users to install `@opensea/sdk` instead.
 
 ## 8.1.0
 

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to opensea-js
+# Contributing to @opensea/sdk
 
 Thanks for your interest in contributing! We're glad you're here.
 

README.md

@@ -10,15 +10,17 @@
 [![Docs][docs-badge]][docs-link]
 [![Discussions][discussions-badge]][discussions-link]
 
-# OpenSea.js <!-- omit in toc -->
+# @opensea/sdk <!-- omit in toc -->
+
+> **Note:** This package was previously published as `opensea-js`. The API is unchanged.
 
 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 onchain, and listen to events in the process.
 
-Happy seafaring! ⛵️
+Happy seafaring!
 
 ## Documentation
 
@@ -32,7 +34,7 @@ Happy seafaring! ⛵️
 
 ### Security Warning
 
-**⚠️ Do not use this SDK directly in client-side/frontend applications.**
+**Do not use this SDK directly in client-side/frontend applications.**
 
 The OpenSea SDK requires an API key for initialization. If you embed your API key in frontend code (e.g., browser applications, mobile apps), it will be publicly exposed and could be extracted by anyone, leading to potential abuse and rate limit issues.
 
@@ -41,28 +43,28 @@ The OpenSea SDK requires an API key for initialization. If you embed your API ke
 For frontend applications that need to interact with OpenSea functionality:
 
 1. **Create a backend API wrapper**: Set up your own backend server that securely stores your OpenSea API key
-2. **Call OpenSea SDK server-side**: Use opensea-js on your backend to interact with OpenSea's APIs
+2. **Call OpenSea SDK server-side**: Use `@opensea/sdk` on your backend to interact with OpenSea's APIs
 3. **Return data to your frontend**: Send the necessary data (like transaction parameters) back to your frontend
 4. **Execute transactions in the browser**: Have users sign transactions with their own wallets (e.g., MetaMask) in the browser
 
 ## Changelog
 
 The changelog for recent versions can be found at:
 
-- opensea-js: https://github.com/ProjectOpenSea/opensea-js/releases
+- @opensea/sdk: https://github.com/ProjectOpenSea/opensea-js/releases
 - OpenSea API: https://docs.opensea.io/changelog
 
 [version-badge]: https://img.shields.io/github/package-json/v/ProjectOpenSea/opensea-js
 [version-link]: https://github.com/ProjectOpenSea/opensea-js/releases
-[npm-badge]: https://img.shields.io/npm/v/opensea-js?color=red
-[npm-link]: https://www.npmjs.com/package/opensea-js
+[npm-badge]: https://img.shields.io/npm/v/@opensea/sdk?color=red
+[npm-link]: https://www.npmjs.com/package/@opensea/sdk
 [ci-badge]: https://github.com/ProjectOpenSea/opensea-js/actions/workflows/code-quality.yml/badge.svg
 [ci-link]: https://github.com/ProjectOpenSea/opensea-js/actions/workflows/code-quality.yml
 [coverage-badge]: https://coveralls.io/repos/github/ProjectOpenSea/opensea-js/badge.svg?branch=main
 [coverage-link]: https://coveralls.io/github/ProjectOpenSea/opensea-js?branch=main
 [license-badge]: https://img.shields.io/github/license/ProjectOpenSea/opensea-js
 [license-link]: https://github.com/ProjectOpenSea/opensea-js/blob/main/LICENSE
-[docs-badge]: https://img.shields.io/badge/OpenSea.js-documentation-informational
+[docs-badge]: https://img.shields.io/badge/@opensea/sdk-documentation-informational
 [docs-link]: https://github.com/ProjectOpenSea/opensea-js#documentation
-[discussions-badge]: https://img.shields.io/badge/OpenSea.js-discussions-blueviolet
+[discussions-badge]: https://img.shields.io/badge/@opensea/sdk-discussions-blueviolet
 [discussions-link]: https://github.com/ProjectOpenSea/opensea-js/discussions

developerDocs/advanced-use-cases.md

@@ -156,7 +156,7 @@ The SDK provides efficient methods for creating multiple listings or offers with
 Use `createBulkListings()` to create multiple listings with a single signature:
 
 ```typescript
-import { getUnixTimestampInSeconds, TimeInSeconds } from "opensea-js";
+import { getUnixTimestampInSeconds, TimeInSeconds } from "@opensea/sdk";
 
 const listings = await openseaSDK.createBulkListings({
   listings: [
@@ -192,7 +192,7 @@ const listings = await openseaSDK.createBulkListings({
 Use `createBulkOffers()` to create multiple offers with a single signature:
 
 ```typescript
-import { getUnixTimestampInSeconds, TimeInSeconds } from "opensea-js";
+import { getUnixTimestampInSeconds, TimeInSeconds } from "@opensea/sdk";
 
 const offers = await openseaSDK.createBulkOffers({
   offers: [
@@ -283,7 +283,7 @@ This applies to all API operations, not just bulk orders. If a request fails aft
 **Example with All Options:**
 
 ```typescript
-import { getUnixTimestampInSeconds, TimeInSeconds } from "opensea-js";
+import { getUnixTimestampInSeconds, TimeInSeconds } from "@opensea/sdk";
 
 const listings = await openseaSDK.createBulkListings({
   listings: [
@@ -396,7 +396,7 @@ 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/sdk'
 const sdk = new OpenSeaSDK(...);
 
 function handleSDKEvents() {

developerDocs/api-reference.md

@@ -9,7 +9,7 @@ hidden: false
 
 # OpenSea API Reference
 
-This comprehensive reference documents all OpenSea API endpoints available through the opensea-js SDK. The SDK provides convenient TypeScript methods to interact with the OpenSea API v2.
+This comprehensive reference documents all OpenSea API endpoints available through the @opensea/sdk. The SDK provides convenient TypeScript methods to interact with the OpenSea API v2.
 
 > **Note:** Your API key should only be used on a secure backend server. Never expose it in client-side code, public repositories, or browser environments. See the [Security Warning](../README.md#security-warning) in the README for more details.
 

developerDocs/contributing.md

@@ -79,16 +79,16 @@ WALLET_PRIV_KEY=your_test_wallet_private_key  # For integration tests only
 To test your changes in another project:
 
 ```bash
-# In opensea-js repo
+# In @opensea/sdk repo
 npm link
 
 # In the project where you want to test
-npm link opensea-js
+npm link @opensea/sdk
 ```
 
 **Generate Documentation**
 
-Generate HTML docs (also available for browsing at [https://projectopensea.github.io/opensea-js/](https://projectopensea.github.io/opensea-js/)):
+Generate HTML docs (also available for browsing at [https://projectopensea.github.io/@opensea/sdk](https://projectopensea.github.io/@opensea/sdk)):
 
 ```bash
 npm run docs-build
@@ -125,7 +125,7 @@ The pre-commit hooks will automatically format your code and run linting checks.
 ## Project Structure
 
 ```
-opensea-js/
+@opensea/sdk
 ├── src/                   # Source code
 │   ├── api/               # API client implementation
 │   ├── orders/            # Order creation and utilities
@@ -153,6 +153,6 @@ When adding new features:
 
 ## Getting Help
 
-- **Issues**: Use [GitHub Issues](https://github.com/ProjectOpenSea/opensea-js/issues) for bug reports and feature requests
-- **Discussions**: Use [GitHub Discussions](https://github.com/ProjectOpenSea/opensea-js/discussions) for questions and general discussion
+- **Issues**: Use [GitHub Issues](https://github.com/ProjectOpenSea/@opensea/sdkissues) for bug reports and feature requests
+- **Discussions**: Use [GitHub Discussions](https://github.com/ProjectOpenSea/@opensea/sdkdiscussions) for questions and general discussion
 - **Documentation**: Check the [docs](https://docs.opensea.io/reference/sdk-overview) for API and SDK guidance

developerDocs/getting-started.md

@@ -45,7 +45,7 @@ const { nft } = await openseaSDK.api.getNFT(tokenAddress, tokenId);
 ### Checking Balances and Ownerships
 
 ```typescript
-import { TokenStandard } from "opensea-js";
+import { TokenStandard } from "@opensea/sdk";
 
 const asset = {
   // CryptoKitties contract
@@ -95,7 +95,7 @@ Note: The total value of offers must not exceed 1000x wallet balance.
 To sell an asset, call `createListing`:
 
 ```typescript
-import { getUnixTimestampInSeconds, TimeInSeconds } from "opensea-js";
+import { getUnixTimestampInSeconds, TimeInSeconds } from "@opensea/sdk";
 
 // Expire this listing one day from now
 const expirationTime = getUnixTimestampInSeconds(TimeInSeconds.DAY);
@@ -247,7 +247,7 @@ The SDK provides methods to retrieve historical events for NFTs, collections, an
 Fetch all events with optional filters:
 
 ```typescript
-import { AssetEventType } from "opensea-js";
+import { AssetEventType } from "@opensea/sdk";
 
 const { asset_events, next } = await openseaSDK.api.getEvents({
   event_type: AssetEventType.SALE, // Optional: filter by event type
@@ -301,7 +301,7 @@ const { asset_events } = await openseaSDK.api.getEventsByCollection(
 Fetch events for a specific NFT:
 
 ```typescript
-import { Chain } from "opensea-js";
+import { Chain } from "@opensea/sdk";
 
 const { asset_events } = await openseaSDK.api.getEventsByNFT(
   Chain.Mainnet, // Chain
@@ -368,7 +368,7 @@ do {
 To buy an item, you need to **fulfill a listing**. To do that, it's just one call:
 
 ```typescript
-import { OrderSide } from "opensea-js";
+import { OrderSide } from "@opensea/sdk";
 
 const order = await openseaSDK.api.getOrderByHash(
   "0x...",
@@ -391,7 +391,7 @@ If the order is a listing, the taker is the _buyer_ and this will prompt the buy
 Similar to fulfilling listings above, you need to fulfill an offer on an item you own to receive the tokens in the offer.
 
 ```typescript
-import { OrderSide } from "opensea-js";
+import { OrderSide } from "@opensea/sdk";
 
 const order = await openseaSDK.api.getOrderByHash(
   "0x...",

developerDocs/overview.md

@@ -49,7 +49,7 @@ Happy seafaring! ⛵️
 
 ```typescript
 import { ethers } from "ethers";
-import { OpenSeaSDK, Chain, OrderSide } from "opensea-js";
+import { OpenSeaSDK, Chain, OrderSide } from "@opensea/sdk";
 
 // Initialize the SDK
 const provider = new ethers.JsonRpcProvider(

developerDocs/quick-start.md

@@ -16,9 +16,9 @@ Node.js version 20 or higher is required for the SDK. If you have Node Version M
 Then in your project, run:
 
 ```bash
-npm install --save opensea-js
+npm install --save @opensea/sdk
 # or
-yarn add opensea-js
+yarn add @opensea/sdk
 ```
 
 # Initialization
@@ -29,7 +29,7 @@ Then, create a new OpenSeaSDK client using your web3 provider:
 
 ```typescript
 import { ethers } from "ethers";
-import { OpenSeaSDK, Chain } from "opensea-js";
+import { OpenSeaSDK, Chain } from "@opensea/sdk";
 
 // This example provider won't let you make transactions, only read-only calls:
 const provider = new ethers.JsonRpcProvider(