bip-321 0.0.1 → 0.0.2

package/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run lint
+        run: bun run lint
+
+      - name: Run type check
+        run: bun run check
+
+      - name: Run tests
+        run: bun test

package/README.md

@@ -13,11 +13,6 @@ A TypeScript/JavaScript library for parsing BIP-321 Bitcoin URI scheme. This lib
 - ✅ **TypeScript support** - Fully typed with TypeScript definitions
 - ✅ **Proof of payment** - Supports pop/req-pop parameters for payment callbacks
 - ✅ **Comprehensive error handling** - Clear error messages for invalid URIs
-- ✅ **Full type safety** - Passes strict TypeScript type checking with no errors
-
-## TypeScript Type Safety
-
-This library is built with full TypeScript support and passes strict type checking (`tsc --noEmit`) with zero errors. All functions return fully-typed objects, providing excellent IDE autocomplete and compile-time safety.
 
 ```typescript
 import { parseBIP321, type BIP321ParseResult, type PaymentMethod } from "bip-321";
@@ -40,8 +35,6 @@ result.paymentMethods.forEach((method: PaymentMethod) => {
 ```
 
 ## Installation
-</text>
-
 
 ```bash
 bun add bip-321
@@ -53,6 +46,16 @@ Or with npm:
 npm install bip-321
 ```
 
+### Note on Dependencies
+
+This library uses modern, browser-native dependencies:
+- **`@scure/base`** - Pure JavaScript base58, bech32, and bech32m encoding (no browserify needed)
+- **`@noble/hashes`** - Pure JavaScript cryptographic hashing
+- **`bitcoinjs-lib`** - Bitcoin address validation
+- **`light-bolt11-decoder`** - Lightning invoice parsing
+
+All dependencies work natively in Node.js, browsers, and React Native without any build tools or polyfills required.
+
 ## Quick Start
 
 ```typescript
@@ -333,4 +336,4 @@ BSD-2-Clause (same as BIP-321)
 ## Related
 
 - [BIP-321 Specification](https://bips.dev/321/)
-- [BIP-21 (Original)](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki)
+- [BIP-21 (Original)](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki)

package/bun.lock

@@ -4,13 +4,14 @@
     "": {
       "name": "bip-321",
       "dependencies": {
+        "@noble/hashes": "^2.0.1",
         "@scure/base": "^2.0.0",
         "bitcoinjs-lib": "^7.0.0",
-        "bs58check": "^4.0.0",
         "light-bolt11-decoder": "^3.2.0",
       },
       "devDependencies": {
         "@types/bun": "latest",
+        "oxlint": "^1.26.0",
       },
       "peerDependencies": {
         "typescript": "^5",
@@ -18,7 +19,23 @@
     },
   },
   "packages": {
-    "@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="],
+    "@noble/hashes": ["@noble/hashes@2.0.1", "", {}, "sha512-XlOlEbQcE9fmuXxrVTXCTlG2nlRXa9Rj3rr5Ue/+tX+nmkgbX720YHh0VR3hBF9xDvwnb8D2shVGOwNx+ulArw=="],
+
+    "@oxlint/darwin-arm64": ["@oxlint/darwin-arm64@1.26.0", "", { "os": "darwin", "cpu": "arm64" }, "sha512-kTmm1opqyn7iZopWHO3Ml4D/44pA5eknZBepgxCnTaPrW8XgCEUI85Q5AvOOvoNve8NziTYb8ax+CyuGJIgn/Q=="],
+
+    "@oxlint/darwin-x64": ["@oxlint/darwin-x64@1.26.0", "", { "os": "darwin", "cpu": "x64" }, "sha512-/hMfZ9j7ZzVPRmMm02PHNc6MIMk0QYv5VowZJRIp40YLqLPvFfGNGZBj8e1fDVgZMFEGWDQK3yrt1uBKxXAK4Q=="],
+
+    "@oxlint/linux-arm64-gnu": ["@oxlint/linux-arm64-gnu@1.26.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-iv4wdrwdCa8bhJxOpKlvfxqTs0LgW5tKBUMvH9B13zREHm1xT9JRZ8cQbbKiyC6LNdggwu5S6TSvODgAu7/DlA=="],
+
+    "@oxlint/linux-arm64-musl": ["@oxlint/linux-arm64-musl@1.26.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-a3gTbnN1JzedxqYeGTkg38BAs/r3Krd2DPNs/MF7nnHthT3RzkPUk47isMePLuNc4e/Weljn7m2m/Onx22tiNg=="],
+
+    "@oxlint/linux-x64-gnu": ["@oxlint/linux-x64-gnu@1.26.0", "", { "os": "linux", "cpu": "x64" }, "sha512-cCAyqyuKpFImjlgiBuuwSF+aDBW2h19/aCmHMTMSp6KXwhoQK7/Xx7/EhZKP5wiQJzVUYq5fXr0D8WmpLGsjRg=="],
+
+    "@oxlint/linux-x64-musl": ["@oxlint/linux-x64-musl@1.26.0", "", { "os": "linux", "cpu": "x64" }, "sha512-8VOJ4vQo0G1tNdaghxrWKjKZGg73tv+FoMDrtNYuUesqBHZN68FkYCsgPwEsacLhCmtoZrkF3ePDWDuWEpDyAg=="],
+
+    "@oxlint/win32-arm64": ["@oxlint/win32-arm64@1.26.0", "", { "os": "win32", "cpu": "arm64" }, "sha512-N8KUtzP6gfEHKvaIBZCS9g8wRfqV5v55a/B8iJjIEhtMehcEM+UX+aYRsQ4dy5oBCrK3FEp4Yy/jHgb0moLm3Q=="],
+
+    "@oxlint/win32-x64": ["@oxlint/win32-x64@1.26.0", "", { "os": "win32", "cpu": "x64" }, "sha512-7tCyG0laduNQ45vzB9blVEGq/6DOvh7AFmiUAana8mTp0zIKQQmwJ21RqhazH0Rk7O6lL7JYzKcu+zaJHGpRLA=="],
 
     "@scure/base": ["@scure/base@2.0.0", "", {}, "sha512-3E1kpuZginKkek01ovG8krQ0Z44E3DHPjc5S2rjJw9lZn3KSQOs8S7wqikF/AH7iRanHypj85uGyxk0XAyC37w=="],
 
@@ -46,6 +63,8 @@
 
     "light-bolt11-decoder": ["light-bolt11-decoder@3.2.0", "", { "dependencies": { "@scure/base": "1.1.1" } }, "sha512-3QEofgiBOP4Ehs9BI+RkZdXZNtSys0nsJ6fyGeSiAGCBsMwHGUDS/JQlY/sTnWs91A2Nh0S9XXfA8Sy9g6QpuQ=="],
 
+    "oxlint": ["oxlint@1.26.0", "", { "optionalDependencies": { "@oxlint/darwin-arm64": "1.26.0", "@oxlint/darwin-x64": "1.26.0", "@oxlint/linux-arm64-gnu": "1.26.0", "@oxlint/linux-arm64-musl": "1.26.0", "@oxlint/linux-x64-gnu": "1.26.0", "@oxlint/linux-x64-musl": "1.26.0", "@oxlint/win32-arm64": "1.26.0", "@oxlint/win32-x64": "1.26.0" }, "peerDependencies": { "oxlint-tsgolint": ">=0.4.0" }, "optionalPeers": ["oxlint-tsgolint"], "bin": { "oxlint": "bin/oxlint", "oxc_language_server": "bin/oxc_language_server" } }, "sha512-KRpL+SMi07JQyggv5ldIF+wt2pnrKm8NLW0B+8bK+0HZsLmH9/qGA+qMWie5Vf7lnlMBllJmsuzHaKFEGY3rIA=="],
+
     "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
 
     "uint8array-tools": ["uint8array-tools@0.0.9", "", {}, "sha512-9vqDWmoSXOoi+K14zNaf6LBV51Q8MayF0/IiQs3GlygIKUYtog603e6virExkjjFosfJUBI4LhbQK1iq8IG11A=="],
@@ -56,6 +75,10 @@
 
     "varuint-bitcoin": ["varuint-bitcoin@2.0.0", "", { "dependencies": { "uint8array-tools": "^0.0.8" } }, "sha512-6QZbU/rHO2ZQYpWFDALCDSRsXbAs1VOEmXAxtbtjLtKuMJ/FQ8YbhfxlaiKv5nklci0M6lZtlZyxo9Q+qNnyog=="],
 
+    "bitcoinjs-lib/@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="],
+
+    "bs58check/@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="],
+
     "light-bolt11-decoder/@scure/base": ["@scure/base@1.1.1", "", {}, "sha512-ZxOhsSyxYwLJj3pLZCefNitxsj093tb2vq90mp2txoYeBqbcjDjqFhyM8eUjq/uFm6zJ+mUuqxlS2FkuSY1MTA=="],
 
     "varuint-bitcoin/uint8array-tools": ["uint8array-tools@0.0.8", "", {}, "sha512-xS6+s8e0Xbx++5/0L+yyexukU7pz//Yg6IHg3BKhXotg1JcYtgxVcUctQ0HxLByiJzpAkNFawz1Nz5Xadzo82g=="],

package/index.ts

@@ -1,7 +1,7 @@
 import * as bitcoin from "bitcoinjs-lib";
 import { decode as decodeLightning } from "light-bolt11-decoder";
-import bs58check from "bs58check";
-import { bech32, bech32m } from "@scure/base";
+import { sha256 } from "@noble/hashes/sha2.js";
+import { base58, bech32, bech32m } from "@scure/base";
 
 export interface PaymentMethod {
   type:
@@ -46,7 +46,7 @@ function detectAddressNetwork(
         // Try using bitcoinjs-lib first (works for non-taproot)
         bitcoin.address.toOutputScript(address, bitcoin.networks.bitcoin);
         return "mainnet";
-      } catch (e) {
+      } catch {
         // Fallback to manual bech32/bech32m validation for taproot
         try {
           const decoded = lowerAddress.startsWith("bc1p")
@@ -63,7 +63,7 @@ function detectAddressNetwork(
       try {
         bitcoin.address.toOutputScript(address, bitcoin.networks.testnet);
         return "testnet";
-      } catch (e) {
+      } catch {
         try {
           const decoded = lowerAddress.startsWith("tb1p")
             ? bech32m.decode(address as `${string}1${string}`, 90)
@@ -79,7 +79,7 @@ function detectAddressNetwork(
       try {
         bitcoin.address.toOutputScript(address, bitcoin.networks.regtest);
         return "regtest";
-      } catch (e) {
+      } catch {
         try {
           const decoded = lowerAddress.startsWith("bcrt1p")
             ? bech32m.decode(address as `${string}1${string}`, 90)
@@ -93,19 +93,38 @@ function detectAddressNetwork(
       }
     }
 
-    // Base58 addresses (P2PKH, P2SH)
-    const decoded = bs58check.decode(address);
-    const version = decoded[0];
+    // Base58 addresses (P2PKH, P2SH) - manual validation with checksum
+    try {
+      const decoded = base58.decode(address);
+      if (decoded.length < 25) {
+        return undefined;
+      }
 
-    // Mainnet: P2PKH (0x00), P2SH (0x05)
-    if (version === 0x00 || version === 0x05) {
-      return "mainnet";
-    }
-    // Testnet: P2PKH (0x6f), P2SH (0xc4)
-    else if (version === 0x6f || version === 0xc4) {
-      return "testnet";
+      // Verify checksum
+      const payload = decoded.slice(0, -4);
+      const checksum = decoded.slice(-4);
+      const hash = sha256(sha256(payload));
+
+      for (let i = 0; i < 4; i++) {
+        if (checksum[i] !== hash[i]) {
+          return undefined;
+        }
+      }
+
+      const version = payload[0];
+
+      // Mainnet: P2PKH (0x00), P2SH (0x05)
+      if (version === 0x00 || version === 0x05) {
+        return "mainnet";
+      }
+      // Testnet: P2PKH (0x6f), P2SH (0xc4)
+      else if (version === 0x6f || version === 0xc4) {
+        return "testnet";
+      }
+    } catch (e) {
+      return undefined;
     }
-  } catch (e) {
+  } catch {
     return undefined;
   }
   return undefined;
@@ -134,7 +153,7 @@ function validateLightningInvoice(invoice: string): {
   error?: string;
 } {
   try {
-    const decoded = decodeLightning(invoice);
+    const _decoded = decodeLightning(invoice);
     let network: "mainnet" | "testnet" | "regtest" | "signet" | undefined;
 
     const lowerInvoice = invoice.toLowerCase();
@@ -174,7 +193,7 @@ function validatePopUri(popUri: string): { valid: boolean; error?: string } {
     }
 
     return { valid: true };
-  } catch (e) {
+  } catch {
     return { valid: false, error: "Invalid pop URI encoding" };
   }
 }
@@ -284,7 +303,7 @@ export function parseBIP321(uri: string): BIP321ParseResult {
           }
         }
       } else if (lowerKey === "pop" || lowerKey === "req-pop") {
-        const popKey = lowerKey === "req-pop" ? "req-pop" : "pop";
+        const _popKey = lowerKey === "req-pop" ? "req-pop" : "pop";
         if (result.pop !== undefined || result.popRequired !== undefined) {
           result.errors.push("Multiple pop/req-pop parameters not allowed");
           result.valid = false;

package/oxlintrc.json

@@ -0,0 +1,23 @@
+{
+  "categories": {
+    "correctness": "warn",
+    "suspicious": "warn",
+    "pedantic": "warn",
+    "perf": "warn",
+    "style": "warn",
+    "restriction": "warn"
+  },
+  "rules": {
+    "typescript/no-explicit-any": "error",
+    "typescript/no-non-null-assertion": "error",
+    "no-console": "warn",
+    "no-debugger": "error",
+    "eqeqeq": "error"
+  },
+  "ignorePatterns": [
+    "**/node_modules/**",
+    "**/dist/**",
+    "**/build/**",
+    "**/*.min.js"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bip-321",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A TypeScript/JavaScript library for parsing BIP-321 Bitcoin URI scheme with support for multiple payment methods",
   "type": "module",
   "main": "./index.ts",
@@ -14,7 +14,9 @@
   },
   "scripts": {
     "test": "bun test",
-    "example": "bun example.ts"
+    "example": "bun example.ts",
+    "check": "tsc --noEmit",
+    "lint": "oxlint"
   },
   "keywords": [
     "bitcoin",
@@ -40,25 +42,26 @@
   "author": "",
   "license": "BSD-2-Clause",
   "dependencies": {
+    "@noble/hashes": "^2.0.1",
     "@scure/base": "^2.0.0",
     "bitcoinjs-lib": "^7.0.0",
-    "bs58check": "^4.0.0",
     "light-bolt11-decoder": "^3.2.0"
   },
   "devDependencies": {
-    "@types/bun": "latest"
+    "@types/bun": "latest",
+    "oxlint": "^1.26.0"
   },
   "peerDependencies": {
     "typescript": "^5"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/yourusername/bip-321.git"
+    "url": "https://github.com/niteshbalusu11/bip-321.git"
   },
   "bugs": {
-    "url": "https://github.com/yourusername/bip-321/issues"
+    "url": "https://github.com/niteshbalusu11/bip-321/issues"
   },
-  "homepage": "https://github.com/yourusername/bip-321#readme",
+  "homepage": "https://github.com/niteshbalusu11/bip-321#readme",
   "engines": {
     "node": ">=16.0.0"
   }