@0xsquid/react-hooks 1.0.0

package/src/tests/jest-svg-transform.ts

@@ -0,0 +1,19 @@
+/**
+ * See https://stackoverflow.com/questions/58603201/jest-cannot-load-svg-file
+ * And also https://jestjs.io/docs/tutorial-react#custom-transformers
+ *
+ * This file is used to transform svg files into empty modules
+ * this way Jest can handle .svg imports without any issues
+ */
+// export {};
+module.exports = {
+  process() {
+    return {
+      code: `module.exports = {};`,
+    };
+  },
+  getCacheKey() {
+    // The output is always the same.
+    return "svgTransform";
+  },
+};

package/src/tests/walletService.test.ts

@@ -0,0 +1,178 @@
+import {
+  isWalletAddressValid,
+  formatWalletAddress,
+} from "@/services/internal/walletService";
+import { OnlineSquidData, fetchSquidData } from "./fetchSquidData";
+
+let squid: OnlineSquidData | undefined = undefined;
+let CHAINS: OnlineSquidData["chains"] = {};
+
+describe("walletService", () => {
+  beforeAll(async () => {
+    squid = await fetchSquidData();
+    CHAINS = squid?.chains;
+  });
+  describe("isWalletAddressValid", () => {
+    test("returns true when address is a valid EVM address for an EVM chain", () => {
+      expect(
+        isWalletAddressValid(
+          CHAINS.BASE,
+          "0xA7D7079b0FEaD91F3e65f86E8915Cb59c1a4C664"
+        )
+      ).toBe(true);
+
+      expect(
+        isWalletAddressValid(
+          CHAINS.BINANCE,
+          "0x6f1c3f578ef3f0d2cf9b1ec712d9654f143ea4d1"
+        )
+      ).toBe(true);
+
+      expect(
+        isWalletAddressValid(
+          CHAINS.POLYGON,
+          "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
+        )
+      ).toBe(true);
+    });
+
+    test("returns false when address is not a valid EVM address for an EVM chain", () => {
+      expect(
+        isWalletAddressValid(
+          CHAINS.BASE,
+          "0xA7D7079b0FEaD91F3e65f86E8915Cb59c1a4C66" // missing last character
+        )
+      ).toBe(false);
+
+      expect(
+        isWalletAddressValid(
+          CHAINS.BINANCE,
+          "e43f1c3f578ef3f0d2cf9b1ec712d9654f143ea4d1" // missing 0x prefix
+        )
+      ).toBe(false);
+
+      expect(
+        isWalletAddressValid(
+          CHAINS.POLYGON,
+          "cosmos1w3jhx7w3jhx7w3jhx7w3jhx7w3jhx7w3jhx7w3j" // cosmos address
+        )
+      ).toBe(false);
+    });
+
+    test("returns true when address is a valid Cosmos address for a Cosmos chain", () => {
+      expect(
+        isWalletAddressValid(
+          CHAINS.NOBLE,
+          "noble1awrua7e2kj69d7vn5qt5tccrhavmj9xa6up0eq"
+        )
+      ).toBe(true);
+
+      expect(
+        isWalletAddressValid(
+          CHAINS.NOBLE,
+          "noble1qe8uuf5x69c526h4nzxwv4ltftr73v7qgk33qz"
+        )
+      ).toBe(true);
+
+      expect(
+        isWalletAddressValid(
+          CHAINS.NOBLE,
+          "noble1zttnm2cl60m5ffsrfeqtzkmtvepl4hwnsqg9fd"
+        )
+      ).toBe(true);
+    });
+
+    test("returns false when address is not a valid Cosmos address for a Cosmos chain", () => {
+      expect(
+        isWalletAddressValid(
+          CHAINS.NOBLE,
+          "noble1qe8uuf5x69c526h4nzxwv4ltftr73v7qgk33" // missing last character
+        )
+      ).toBe(false);
+
+      expect(
+        isWalletAddressValid(
+          CHAINS.NOBLE,
+          "1qe8uuf5x69c526h4nzxwv4ltftr73v7qgk33q" // missing chain prefix
+        )
+      ).toBe(false);
+
+      expect(
+        isWalletAddressValid(
+          CHAINS.NOBLE,
+          "0xA7D7079b0FEaD91F3e65f86E8915Cb59c1a4C664" // EVM address
+        )
+      ).toBe(false);
+    });
+  });
+
+  describe("formatWalletAddress", () => {
+    test("formats EVM addresses correctly", () => {
+      expect(
+        formatWalletAddress("0x6f1c3f578ef3f0d2cf9b1ec712d9654f143ea4d1", 5)
+      ).toBe("0x6f1...4d1");
+
+      expect(
+        formatWalletAddress("0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d", 8)
+      ).toBe("0xbc4ca0...36f13d");
+
+      expect(
+        formatWalletAddress("0xA7D7079b0FEaD91F3e65f86E8915Cb59c1a4C664", 3)
+      ).toBe("0xa...4");
+    });
+
+    test("formats Cosmos addresses correctly", () => {
+      expect(
+        formatWalletAddress("noble1awrua7e2kj69d7vn5qt5tccrhavmj9xa6up0eq", 5)
+      ).toBe("noble...0eq");
+
+      expect(
+        formatWalletAddress("noble1qe8uuf5x69c526h4nzxwv4ltftr73v7qgk33qz", 8)
+      ).toBe("noble1qe...gk33qz");
+
+      expect(
+        formatWalletAddress("noble1zttnm2cl60m5ffsrfeqtzkmtvepl4hwnsqg9fd", 3)
+      ).toBe("nob...d");
+    });
+
+    test("returns empty string when address is undefined or empty string", () => {
+      expect(formatWalletAddress(undefined)).toBe("");
+
+      expect(formatWalletAddress("")).toBe("");
+
+      expect(formatWalletAddress("", 0)).toBe("");
+
+      expect(formatWalletAddress(undefined, 0)).toBe("");
+    });
+
+    test("handles trim length smaller than or equal to 2", () => {
+      expect(formatWalletAddress("0x123", 1)).toBe("0...");
+
+      expect(formatWalletAddress("0x123", 2)).toBe("0x...");
+    });
+
+    test("for negative trim length, removes its absolute value and adds three dots at the end", () => {
+      expect(formatWalletAddress("0x123", -1)).toBe("0x12..."); // trims 1 characters and adds three dots
+
+      expect(
+        formatWalletAddress("0x6f1c3f578ef3f0d2cf9b1ec712d9654f143ea4d1", -5)
+      ).toBe(
+        "0x6f1c3f578ef3f0d2cf9b1ec712d9654f143..." // trims 5 characters and adds three dots
+      );
+
+      expect(
+        formatWalletAddress("noble1awrua7e2kj69d7vn5qt5tccrhavmj9xa6up0eq", -9)
+      ).toBe(
+        "noble1awrua7e2kj69d7vn5qt5tccrhavmj..." // trims 9 characters and adds three dots
+      );
+    });
+
+    test("returns full address when its length is smaller than trim length", () => {
+      const evmAddress = "0x6f1c3f578ef3f0d2cf9b1ec712d9654f143ea4d1";
+      expect(formatWalletAddress(evmAddress, 100)).toBe(evmAddress);
+
+      const cosmosAddress = "noble1awrua7e2kj69d7vn5qt5tccrhavmj9xa6up0eq";
+      expect(formatWalletAddress(cosmosAddress, 100)).toBe(cosmosAddress);
+    });
+  });
+});

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "module": "ESNext",
+    "target": "ES6",
+    "moduleResolution": "node",
+    "declaration": true,
+    "esModuleInterop": true,
+    "jsx": "react",
+    "sourceMap": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    },
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "noFallthroughCasesInSwitch": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "types": ["jest", "node", "react", "react-dom"]
+  },
+  "include": ["src/**/*", "src/**/*.json", "src/**/*.svg"],
+  "exclude": ["**/.*/", "**/dist", "node_modules"]
+}