Add checksum to constants in isValidProtocol (#864) (#865)

* Add checksum to constants in isValidProtocol (#864) * Increase package version * Add unit tests --------- Co-authored-by: Reagan <[email protected]>
ProjectOpenSea · Mar 7, 2023 · a24cc4f · a24cc4f
1 parent df72323
commit a24cc4f
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 4 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "opensea-js",
-  "version": "4.0.18",
+  "version": "4.0.19",
   "description": "JavaScript SDK for the OpenSea marketplace. Let users buy or sell crypto collectibles and other cryptogoods, all on your own site!",
   "license": "MIT",
   "author": "OpenSea Developers",

diff --git a/src/__tests__/utils/utils.ts b/src/__tests__/utils/utils.ts
@@ -0,0 +1,30 @@
+import {
+  CROSS_CHAIN_SEAPORT_ADDRESS,
+  CROSS_CHAIN_SEAPORT_V1_4_ADDRESS,
+} from "@opensea/seaport-js/lib/constants";
+import { assert } from "chai";
+import { suite, test } from "mocha";
+import Web3 from "web3";
+import { isValidProtocol } from "../../utils/utils";
+
+suite("Utils: utils", () => {
+  test("isValidProtocol works with all forms of address", async () => {
+    const seaport_v1_1 = CROSS_CHAIN_SEAPORT_ADDRESS;
+    const seaport_v_1_4 = CROSS_CHAIN_SEAPORT_V1_4_ADDRESS;
+    const randomAddress = "0x1F7Cf51573Bf5270323a395F0bb5Fd3c3a4DB867";
+
+    assert.isTrue(isValidProtocol(seaport_v1_1));
+    assert.isTrue(isValidProtocol(seaport_v_1_4));
+    assert.isFalse(isValidProtocol(randomAddress));
+
+    assert.isTrue(isValidProtocol(seaport_v1_1.toLowerCase()));
+    assert.isTrue(isValidProtocol(seaport_v_1_4.toLowerCase()));
+    assert.isFalse(isValidProtocol(randomAddress.toLowerCase()));
+
+    assert.isTrue(isValidProtocol(Web3.utils.toChecksumAddress(seaport_v1_1)));
+    assert.isTrue(isValidProtocol(Web3.utils.toChecksumAddress(seaport_v_1_4)));
+    assert.isFalse(
+      isValidProtocol(Web3.utils.toChecksumAddress(randomAddress))
+    );
+  });
+});
diff --git a/src/utils/utils.ts b/src/utils/utils.ts
@@ -1145,6 +1145,6 @@ export const isValidProtocol = (protocolAddress: string): boolean => {
   const validProtocolAddresses = [
     CROSS_CHAIN_SEAPORT_ADDRESS,
     CROSS_CHAIN_SEAPORT_V1_4_ADDRESS,
-  ];
+  ].map((address) => Web3.utils.toChecksumAddress(address));
   return validProtocolAddresses.includes(checkSumAddress);
 };