@getcofund/protocol 0.0.0-stage → 0.1.0

package/dist/keys/keys.js

@@ -0,0 +1,80 @@
+import { schnorr, secp256k1 } from "@noble/curves/secp256k1.js";
+import { bytesToHex } from "@noble/hashes/utils";
+import { HDKey } from "@scure/bip32";
+import { generateMnemonic, mnemonicToSeedSync } from "@scure/bip39";
+import { wordlist } from "@scure/bip39/wordlists/english";
+import { generatePrivateKey, privateKeyToAccount, } from "viem/accounts";
+import { BIP32_VERSIONS, COFUND_LEAF_INDEX } from "../btc/vault/xpub.js";
+import { bitcoinSignedMessageHash } from "../btc-policies/activation.js";
+import { btcXpubOwnershipChallenge } from "./xpub-ownership.js";
+/** m/86'/coin'/0': the BIP-86 account a Cofund BTC vault derives from. */
+function btcAccount(mnemonic, network) {
+    const root = HDKey.fromMasterSeed(mnemonicToSeedSync(mnemonic), BIP32_VERSIONS[network]);
+    return root.derive(`m/86'/${network === "mainnet" ? 0 : 1}'/0'`);
+}
+export function generateKeystore(network) {
+    const privateKey = generatePrivateKey();
+    const mnemonic = generateMnemonic(wordlist, 256);
+    return {
+        version: 1,
+        evm: { privateKey, address: privateKeyToAccount(privateKey).address },
+        btc: {
+            network,
+            mnemonic,
+            accountXpub: btcAccount(mnemonic, network).publicExtendedKey,
+        },
+        cofunds: {},
+    };
+}
+/** The EVM key as a viem account: an EIP-712 signer (`TypedDataSigner`) and a wallet client's account. */
+export function evmWallet(keystore) {
+    return privateKeyToAccount(keystore.evm.privateKey);
+}
+/**
+ * The xpub and its ownership proof: a BIP-340 signature by the account's /0/0
+ * key — the leaf vaults use — over the challenge bound to `userId` and the xpub.
+ */
+export function btcOwnershipProof(keystore, userId) {
+    const { mnemonic, network, accountXpub } = keystore.btc;
+    const leaf = btcAccount(mnemonic, network).deriveChild(0).deriveChild(0);
+    if (!leaf.privateKey) {
+        throw new Error("Could not derive the Bitcoin /0/0 key");
+    }
+    const signature = schnorr.sign(btcXpubOwnershipChallenge(userId, accountXpub), leaf.privateKey);
+    return { xpub: accountXpub, proof: bytesToHex(signature) };
+}
+/**
+ * The Cofund leaf's private key at `branch`, `m/86'/coin'/0'/<branch>/<leaf
+ * index>`: a vault derives every member's key in one tapleaf at that leaf's
+ * branch (0 for a single-leaf vault).
+ */
+function btcCofundLeafPrivateKey(account, branch) {
+    const leaf = account.deriveChild(branch).deriveChild(COFUND_LEAF_INDEX);
+    if (!leaf.privateKey) {
+        throw new Error("Could not derive the Bitcoin Cofund leaf key");
+    }
+    return leaf.privateKey;
+}
+/** The BTC key's Cofund leaf as a message signer: what a BTC policy approval is. */
+export function btcMessageSigner(keystore) {
+    return {
+        signMessage(message) {
+            const { mnemonic, network } = keystore.btc;
+            // The BIP-137 hash is final: no second hash.
+            const signature = secp256k1.sign(bitcoinSignedMessageHash(message), btcCofundLeafPrivateKey(btcAccount(mnemonic, network), 0), { prehash: false });
+            return Promise.resolve(bytesToHex(signature));
+        },
+    };
+}
+/** Zero aux randomness: BIP-340 permits it, and the app's signer uses it too. */
+const ZERO_AUX = new Uint8Array(32);
+/** The keystore's BTC key as a tapleaf signer; the seed is derived once, here. */
+export function btcLeafSigner(keystore) {
+    const { mnemonic, network } = keystore.btc;
+    const account = btcAccount(mnemonic, network);
+    return {
+        network,
+        leafKey: (branch) => schnorr.getPublicKey(btcCofundLeafPrivateKey(account, branch)),
+        signDigest: (branch, digest) => schnorr.sign(digest, btcCofundLeafPrivateKey(account, branch), ZERO_AUX),
+    };
+}

package/dist/keys/xpub-ownership.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The message a registering BTC key must sign: bound to the user AND the
+ * xpub so a proof can't be replayed for another account or another key.
+ * The signing key is the /0/0 child of the submitted account xpub — the
+ * same leaf every vault ceremony derives — so a valid signature
+ * demonstrates control of the seed behind the xpub, not just knowledge of
+ * the (public) xpub string. Client signs it, server verifies it; both
+ * sides import this one definition.
+ */
+export declare function btcXpubOwnershipChallenge(userId: string, xpub: string): Uint8Array;

package/dist/keys/xpub-ownership.js

@@ -0,0 +1,13 @@
+import { sha256 } from "@noble/hashes/sha2";
+/**
+ * The message a registering BTC key must sign: bound to the user AND the
+ * xpub so a proof can't be replayed for another account or another key.
+ * The signing key is the /0/0 child of the submitted account xpub — the
+ * same leaf every vault ceremony derives — so a valid signature
+ * demonstrates control of the seed behind the xpub, not just knowledge of
+ * the (public) xpub string. Client signs it, server verifies it; both
+ * sides import this one definition.
+ */
+export function btcXpubOwnershipChallenge(userId, xpub) {
+    return sha256(new TextEncoder().encode(`cofund-btc-xpub-ownership|v1|${userId}|${xpub}`));
+}

package/package.json

@@ -1,6 +1,63 @@
 {
   "name": "@getcofund/protocol",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "The Cofund protocol on chain: Bitcoin vaults, EIP-712 messages, call simulation and key derivation. Chain only: the consumer brings the deployment, readers, signers and submitters.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Strata-Labs/cofund-webapp.git",
+    "directory": "packages/protocol"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    "./evm": {
+      "types": "./dist/evm/index.d.ts",
+      "default": "./dist/evm/index.js"
+    },
+    "./btc": {
+      "types": "./dist/btc/index.d.ts",
+      "default": "./dist/btc/index.js"
+    },
+    "./btc-policies": {
+      "types": "./dist/btc-policies/index.d.ts",
+      "default": "./dist/btc-policies/index.js"
+    },
+    "./keys": {
+      "types": "./dist/keys/index.d.ts",
+      "default": "./dist/keys/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@noble/curves": "^2.0.0",
+    "@noble/hashes": "^1.8.0",
+    "@scure/base": "^1.2.5",
+    "@scure/bip32": "^1.7.0",
+    "@scure/bip39": "^1.6.0",
+    "@scure/btc-signer": "^2.0.0",
+    "viem": "^2.56.0",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/node": "24.10.13",
+    "esbuild": "0.28.2",
+    "typescript": "5.9.3",
+    "vitest": "^4.1.5"
+  },
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit && tsc --noEmit -p test",
+    "test": "vitest run",
+    "smoke": "bash scripts/smoke-pack.sh"
+  }
 }