refactor: use Set for shared storefront addresses and checksum remapped address (#1864)

* refactor: use Set for shared storefront addresses and return checksummed addresses

- Convert SHARED_STOREFRONT_ADDRESSES from array to Set for O(1) lookups
- remapSharedStorefrontAddress now returns checksummed addresses via ethers.getAddress()
- Gracefully handle invalid addresses by returning them unchanged
- Remove uppercase address test since we don't need to handle 0X prefix

Co-Authored-By: Claude Opus 4.5 <[email protected]>

* fix: prettier formatting and bump version to 8.0.14

Co-Authored-By: Claude Opus 4.5 <[email protected]>

* refactor: only checksum remapped shared storefront address

Return original tokenAddress unchanged for non-shared storefront addresses.
Only return checksummed address when remapping to lazy mint adapter.

Co-Authored-By: Claude Opus 4.5 <[email protected]>

---------

Co-authored-by: Claude Opus 4.5 <[email protected]>

Author: ryanio

developerDocs/advanced-use-cases.md

@@ -60,7 +60,8 @@ const listing = await openseaSDK.createListing({
 });
 ```
 
-**Important**  
+**Important**
+
 > Private orders only restrict the taker address at the contract level. The order data remains public and discoverable via OpenSea APIs and on-chain indexers.
 
 ### Canceling Orders

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opensea-js",
-  "version": "8.0.13",
+  "version": "8.0.14",
   "description": "TypeScript SDK for the OpenSea marketplace helps developers build new experiences using NFTs and our marketplace data",
   "license": "MIT",
   "author": "OpenSea Developers",

src/constants.ts

@@ -80,9 +80,9 @@ const SHARED_STOREFRONT_ADDRESS_MAINNET =
   "0x495f947276749ce646f68ac8c248420045cb7b5e";
 const SHARED_STOREFRONT_ADDRESS_POLYGON =
   "0x2953399124f0cbb46d2cbacd8a89cf0599974963";
-export const SHARED_STOREFRONT_ADDRESSES = [
+export const SHARED_STOREFRONT_ADDRESSES = new Set([
   SHARED_STOREFRONT_ADDRESS_MAINNET,
   SHARED_STOREFRONT_ADDRESS_POLYGON,
-].map((address) => address.toLowerCase());
+]);
 export const SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS =
   "0xa604060890923ff400e8c6f5290461a83aedacec";

src/utils/protocol.ts

@@ -47,9 +47,12 @@ export const getAssetItemType = (tokenStandard: TokenStandard) => {
  *          otherwise returns the original address unchanged
  */
 export const remapSharedStorefrontAddress = (tokenAddress: string): string => {
-  return SHARED_STOREFRONT_ADDRESSES.includes(tokenAddress.toLowerCase())
-    ? SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS
-    : tokenAddress;
+  if (SHARED_STOREFRONT_ADDRESSES.has(tokenAddress.toLowerCase())) {
+    return ethers.getAddress(
+      SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS,
+    );
+  }
+  return tokenAddress;
 };
 
 /**

test/sdk/misc.spec.ts

@@ -22,25 +22,18 @@ suite("SDK: misc", () => {
     assert.equal(typeof sdk.api.getOrders, "function");
   });
 
-  test("Checks that a non-shared storefront address is not remapped", async () => {
+  test("Checks that a non-shared storefront address is returned unchanged", async () => {
     const address = BAYC_CONTRACT_ADDRESS;
     assert.equal(remapSharedStorefrontAddress(address), address);
   });
 
-  test("Checks that shared storefront addresses are remapped to lazy mint adapter address", async () => {
+  test("Checks that shared storefront addresses are remapped to checksummed lazy mint adapter address", async () => {
     for (const address of SHARED_STOREFRONT_ADDRESSES) {
       assert.equal(
         remapSharedStorefrontAddress(address),
-        SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS,
-      );
-    }
-  });
-
-  test("Checks that upper case shared storefront addresses are remapped to lazy mint adapter address", async () => {
-    for (const address of SHARED_STOREFRONT_ADDRESSES) {
-      assert.equal(
-        remapSharedStorefrontAddress(address.toUpperCase()),
-        SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS,
+        ethers.getAddress(
+          SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS,
+        ),
       );
     }
   });

test/utils/protocol.spec.ts

@@ -112,21 +112,13 @@ suite("Utils: protocol", () => {
   });
 
   suite("remapSharedStorefrontAddress", () => {
-    test("returns lazy mint adapter address for shared storefront address", () => {
+    test("returns checksummed lazy mint adapter address for shared storefront address", () => {
       for (const sharedStorefrontAddress of SHARED_STOREFRONT_ADDRESSES) {
         const result = remapSharedStorefrontAddress(sharedStorefrontAddress);
         expect(result).to.equal(
-          SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS,
-        );
-      }
-    });
-
-    test("returns lazy mint adapter address for uppercase shared storefront address", () => {
-      for (const sharedStorefrontAddress of SHARED_STOREFRONT_ADDRESSES) {
-        const upperCaseAddress = sharedStorefrontAddress.toUpperCase();
-        const result = remapSharedStorefrontAddress(upperCaseAddress);
-        expect(result).to.equal(
-          SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS,
+          ethers.getAddress(
+            SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS,
+          ),
         );
       }
     });