@utxopia/sdk 0.1.0-alpha.2 → 0.1.0-alpha.4

package/{packages/sdk/dist → dist}/taproot.d.ts

@@ -22,18 +22,55 @@ export declare function deriveTaprootAddress(commitment: Uint8Array, network?: "
     address: string;
     outputKey: Uint8Array;
     tweak: Uint8Array;
+    /** y-parity of the output key — the low bit of a script-path control block. */
+    parity: number;
 };
 /**
- * Commitment a `verify_deposit` (disc 25) deposit address is derived from.
+ * Per-deposit commitment carried in a `verify_deposit` (disc 25) address's tapleaf.
  *
  * Both keys are hashed in. Binding the note key alone would leave the ephemeral
  * pubkey caller-chosen on the Solana side: the credited amount and owner would
  * still be right, but a substituted ephemeral key makes the stealth announcement
  * undecryptable and the recipient never finds their note.
  *
- * Feed the result to `deriveTaprootAddress` as the commitment.
+ * Feed the result to `deriveDepositAddress`.
  */
 export declare function depositTweakCommitment(notePublicKey: Uint8Array, ephemeralPubkey: Uint8Array): Uint8Array;
+/**
+ * BIP-341's suggested NUMS point, used as the deposit address's internal key.
+ *
+ * Nobody knows its discrete log, so the key path is unspendable and custody
+ * rests entirely on the script path. That is deliberate: Ika's MPC cannot sign
+ * for a tweaked key, so an address whose internal key were the dWallet key plus
+ * a per-deposit tweak would be unspendable by the custodian meant to sweep it.
+ */
+export declare const DEPOSIT_NUMS_INTERNAL_KEY: Uint8Array<ArrayBufferLike>;
+/**
+ * The single tapleaf a deposit address commits to:
+ *
+ * ```text
+ * <commitment> OP_DROP <ika_xonly> OP_CHECKSIG
+ * ```
+ *
+ * The commitment rides in the script purely to make the leaf — and so the
+ * address — unique per deposit; `OP_DROP` discards it at spend time. Only the
+ * dWallet key can satisfy the `OP_CHECKSIG`, and it signs untweaked.
+ */
+export declare function depositLeafScript(commitment: Uint8Array, ikaXOnlyPubkey: Uint8Array): Uint8Array;
+/**
+ * Derive a deposit address bound to `commitment`, spendable only by the pool's
+ * Ika dWallet via the script path.
+ *
+ * Returns everything the sweeper needs to spend it: a script-path witness is
+ * `[signature, leafScript, controlBlock]`.
+ */
+export declare function deriveDepositAddress(commitment: Uint8Array, ikaXOnlyPubkey: Uint8Array, network?: "mainnet" | "testnet" | "regtest"): {
+    address: string;
+    outputKey: Uint8Array;
+    leafScript: Uint8Array;
+    leafHash: Uint8Array;
+    controlBlock: Uint8Array;
+};
 /**
  * Verify that a Taproot address is correctly derived from a commitment
  *

package/{packages/sdk/dist → dist}/taproot.js

@@ -68,17 +68,18 @@ export function deriveTaprootAddress(commitment, network = "testnet", internalKe
         address,
         outputKey,
         tweak,
+        parity: outputKeyHex.startsWith("03") ? 1 : 0,
     };
 }
 /**
- * Commitment a `verify_deposit` (disc 25) deposit address is derived from.
+ * Per-deposit commitment carried in a `verify_deposit` (disc 25) address's tapleaf.
  *
  * Both keys are hashed in. Binding the note key alone would leave the ephemeral
  * pubkey caller-chosen on the Solana side: the credited amount and owner would
  * still be right, but a substituted ephemeral key makes the stealth announcement
  * undecryptable and the recipient never finds their note.
  *
- * Feed the result to `deriveTaprootAddress` as the commitment.
+ * Feed the result to `deriveDepositAddress`.
  */
 export function depositTweakCommitment(notePublicKey, ephemeralPubkey) {
     if (notePublicKey.length !== 32 || ephemeralPubkey.length !== 32) {
@@ -89,6 +90,57 @@ export function depositTweakCommitment(notePublicKey, ephemeralPubkey) {
     material.set(ephemeralPubkey, 32);
     return sha256(material);
 }
+/**
+ * BIP-341's suggested NUMS point, used as the deposit address's internal key.
+ *
+ * Nobody knows its discrete log, so the key path is unspendable and custody
+ * rests entirely on the script path. That is deliberate: Ika's MPC cannot sign
+ * for a tweaked key, so an address whose internal key were the dWallet key plus
+ * a per-deposit tweak would be unspendable by the custodian meant to sweep it.
+ */
+export const DEPOSIT_NUMS_INTERNAL_KEY = hexToBytes("50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0");
+/**
+ * The single tapleaf a deposit address commits to:
+ *
+ * ```text
+ * <commitment> OP_DROP <ika_xonly> OP_CHECKSIG
+ * ```
+ *
+ * The commitment rides in the script purely to make the leaf — and so the
+ * address — unique per deposit; `OP_DROP` discards it at spend time. Only the
+ * dWallet key can satisfy the `OP_CHECKSIG`, and it signs untweaked.
+ */
+export function depositLeafScript(commitment, ikaXOnlyPubkey) {
+    if (commitment.length !== 32 || ikaXOnlyPubkey.length !== 32) {
+        throw new Error("commitment and ikaXOnlyPubkey must be 32 bytes");
+    }
+    const script = new Uint8Array(68);
+    script[0] = 0x20; // push 32 bytes
+    script.set(commitment, 1);
+    script[33] = 0x75; // OP_DROP
+    script[34] = 0x20; // push 32 bytes
+    script.set(ikaXOnlyPubkey, 35);
+    script[67] = 0xac; // OP_CHECKSIG
+    return script;
+}
+/**
+ * Derive a deposit address bound to `commitment`, spendable only by the pool's
+ * Ika dWallet via the script path.
+ *
+ * Returns everything the sweeper needs to spend it: a script-path witness is
+ * `[signature, leafScript, controlBlock]`.
+ */
+export function deriveDepositAddress(commitment, ikaXOnlyPubkey, network = "testnet") {
+    const leafScript = depositLeafScript(commitment, ikaXOnlyPubkey);
+    // One leaf, so the leaf hash IS the merkle root.
+    const leafHash = computeTapLeafHash(leafScript);
+    const { address, outputKey, parity } = deriveTaprootAddress(leafHash, network, DEPOSIT_NUMS_INTERNAL_KEY);
+    // <leaf_version | parity> || internal_key. No merkle path: single leaf.
+    const controlBlock = new Uint8Array(33);
+    controlBlock[0] = 0xc0 | parity;
+    controlBlock.set(DEPOSIT_NUMS_INTERNAL_KEY, 1);
+    return { address, outputKey, leafScript, leafHash, controlBlock };
+}
 /**
  * Verify that a Taproot address is correctly derived from a commitment
  *

package/package.json

@@ -1,73 +1,88 @@
 {
   "name": "@utxopia/sdk",
-  "version": "0.1.0-alpha.2",
-  "description": "UTXOpia public SDK workspace",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/UTXOpia/utxopia-sdk.git"
-  },
-  "homepage": "https://github.com/UTXOpia/utxopia-sdk#readme",
-  "bugs": {
-    "url": "https://github.com/UTXOpia/utxopia-sdk/issues"
-  },
+  "version": "0.1.0-alpha.4",
+  "description": "UTXOpia SDK - Private Bitcoin across Solana and Sui",
   "type": "module",
-  "private": false,
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "packages/sdk/dist",
-    "packages/btc-client/src",
-    "README.md",
-    "LICENSE"
-  ],
-  "sideEffects": false,
-  "main": "./packages/sdk/dist/index.js",
-  "module": "./packages/sdk/dist/index.js",
-  "types": "./packages/sdk/dist/index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./packages/sdk/dist/index.d.ts",
-      "import": "./packages/sdk/dist/index.js",
-      "default": "./packages/sdk/dist/index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     },
     "./prover": {
-      "types": "./packages/sdk/dist/prover/index.d.ts",
-      "import": "./packages/sdk/dist/prover/index.js",
-      "default": "./packages/sdk/dist/prover/index.js"
+      "types": "./dist/prover/index.d.ts",
+      "import": "./dist/prover/index.js",
+      "default": "./dist/prover/index.js"
     },
     "./prover/web": {
-      "types": "./packages/sdk/dist/prover/web.d.ts",
-      "import": "./packages/sdk/dist/prover/web.js",
-      "default": "./packages/sdk/dist/prover/web.js"
+      "types": "./dist/prover/web.d.ts",
+      "import": "./dist/prover/web.js",
+      "default": "./dist/prover/web.js"
     },
     "./prover/mobile": {
-      "types": "./packages/sdk/dist/prover/mobile.d.ts",
-      "import": "./packages/sdk/dist/prover/mobile.js",
-      "default": "./packages/sdk/dist/prover/mobile.js"
+      "types": "./dist/prover/mobile.d.ts",
+      "import": "./dist/prover/mobile.js",
+      "default": "./dist/prover/mobile.js"
+    },
+    "./stealth": {
+      "types": "./dist/stealth/index.d.ts",
+      "import": "./dist/stealth/index.js",
+      "default": "./dist/stealth/index.js"
     },
     "./bitcoin": {
-      "types": "./packages/sdk/dist/bitcoin/index.d.ts",
-      "import": "./packages/sdk/dist/bitcoin/index.js",
-      "default": "./packages/sdk/dist/bitcoin/index.js"
+      "types": "./dist/bitcoin/index.d.ts",
+      "import": "./dist/bitcoin/index.js",
+      "default": "./dist/bitcoin/index.js"
     },
-    "./stealth": {
-      "types": "./packages/sdk/dist/stealth.d.ts",
-      "import": "./packages/sdk/dist/stealth.js",
-      "default": "./packages/sdk/dist/stealth.js"
+    "./solana": {
+      "types": "./dist/solana/index.d.ts",
+      "import": "./dist/solana/index.js",
+      "default": "./dist/solana/index.js"
+    },
+    "./watcher": {
+      "types": "./dist/watcher/index.d.ts",
+      "import": "./dist/watcher/index.js",
+      "default": "./dist/watcher/index.js"
+    },
+    "./watcher/web": {
+      "types": "./dist/watcher/web.d.ts",
+      "import": "./dist/watcher/web.js",
+      "default": "./dist/watcher/web.js"
     },
-    "./btc-client": {
-      "types": "./packages/btc-client/src/index.ts",
-      "import": "./packages/btc-client/src/index.ts",
-      "default": "./packages/btc-client/src/index.ts"
+    "./watcher/native": {
+      "types": "./dist/watcher/native.d.ts",
+      "import": "./dist/watcher/native.js",
+      "default": "./dist/watcher/native.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js",
+      "default": "./dist/react/index.js"
     }
   },
+  "files": [
+    "dist",
+    "src",
+    "circuits"
+  ],
   "scripts": {
-    "build": "cd packages/sdk && bunx tsc",
-    "test": "cd packages/sdk && bun install --ignore-scripts && bun test",
-    "prepare": "cd packages/sdk && bunx tsc",
-    "copy-circuits": "cd packages/sdk && bun run copy-circuits"
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "bun run build",
+    "test": "bun test",
+    "test:unit": "bun test src/ test/commitment.test.ts test/commitment-onchain.test.ts",
+    "test:e2e": "bun test test/e2e/",
+    "test:e2e:devnet": "NETWORK=devnet bun test test/e2e/",
+    "test:e2e:claim": "bun test test/e2e/claim.test.ts",
+    "test:e2e:split": "bun test test/e2e/split.test.ts",
+    "test:e2e:partial": "bun test test/e2e/partial-public.test.ts",
+    "test:e2e:nullifier": "bun test test/e2e/nullifier.test.ts",
+    "test:e2e:tree": "bun test test/e2e/tree-consistency.test.ts",
+    "copy-circuits": "CIRCUITS_DIR=${UTXOPIA_CIRCUITS_DIR:-../../utxopia-circuits/circuits}; mkdir -p circuits && cp -r \"$CIRCUITS_DIR\"/build/* circuits/",
+    "e2e": "bun run scripts/e2e-mock-spv.ts"
   },
   "dependencies": {
     "@magicblock-labs/ephemeral-rollups-kit": "0.16.2",
@@ -82,6 +97,12 @@
     "circomlibjs": "^0.1.7",
     "poseidon-lite": "0.3.0"
   },
+  "devDependencies": {
+    "@solana/web3.js": "^1.98.4",
+    "@types/node": "^20.10.0",
+    "@types/react": "^19",
+    "typescript": "^5.3.0"
+  },
   "peerDependencies": {
     "react": ">=17.0.0",
     "snarkjs": "^0.7.5"
@@ -94,15 +115,17 @@
       "optional": true
     }
   },
-  "devDependencies": {
-    "@solana/web3.js": "^1.98.4",
-    "@types/node": "^20.10.0",
-    "@types/react": "^19",
-    "typescript": "^5.3.0"
-  },
-  "overrides": {
-    "uuid": "11.1.1",
-    "valibot": "1.4.2",
-    "ws": "8.21.1"
-  }
+  "keywords": [
+    "solana",
+    "bitcoin",
+    "bridge",
+    "privacy",
+    "zkp",
+    "circom",
+    "groth16",
+    "snarkjs",
+    "taproot"
+  ],
+  "author": "UTXOpia Team",
+  "license": "MIT"
 }