@chainvue/verus-sdk 0.4.0

package/dist/utxo/index.js

@@ -0,0 +1,139 @@
+"use strict";
+/**
+ * Client-side UTXO selection for Verus transactions
+ *
+ * Selects UTXOs to cover required native + currency amounts,
+ * calculates fees, and determines change outputs.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeUtxo = decodeUtxo;
+exports.estimateFee = estimateFee;
+exports.selectUtxos = selectUtxos;
+const utxo_lib_1 = require("@bitgo/utxo-lib");
+const index_js_1 = require("../constants/index.js");
+const errors_js_1 = require("../errors.js");
+const { unpackOutput } = utxo_lib_1.smarttxs;
+// Transaction size estimation constants
+const INPUT_SIZE = 180;
+const P2PKH_OUTPUT_SIZE = 34;
+const SMART_OUTPUT_SIZE = 200;
+const TX_OVERHEAD = 60;
+/**
+ * Decode a UTXO's script to extract currency values
+ */
+function decodeUtxo(utxo, systemId) {
+    const currencyValues = new Map();
+    try {
+        const output = {
+            value: utxo.satoshis,
+            script: Buffer.from(utxo.script, 'hex'),
+        };
+        const unpacked = unpackOutput(output, systemId, true);
+        for (const [currency, value] of Object.entries(unpacked.values)) {
+            const amount = typeof value === 'number' ? value : value.toNumber();
+            if (amount > 0) {
+                currencyValues.set(currency, amount);
+            }
+        }
+    }
+    catch {
+        // If unpacking fails, treat as native-only
+        if (utxo.satoshis > 0) {
+            currencyValues.set(systemId, utxo.satoshis);
+        }
+    }
+    return { ...utxo, currencyValues };
+}
+/**
+ * Estimate transaction fee based on input/output counts
+ */
+function estimateFee(numInputs, numOutputs, feePerKb = index_js_1.DEFAULT_FEE_PER_KB, hasSmartOutputs = false) {
+    const outputSize = hasSmartOutputs ? SMART_OUTPUT_SIZE : P2PKH_OUTPUT_SIZE;
+    const txSize = TX_OVERHEAD + numInputs * INPUT_SIZE + numOutputs * outputSize;
+    const fee = Math.ceil((txSize / 1000) * feePerKb);
+    return Math.max(fee, 10000);
+}
+/**
+ * Select UTXOs to cover required amounts
+ */
+function selectUtxos(utxos, requiredNative, requiredCurrencies = new Map(), numOutputs = 2, systemId = index_js_1.NETWORK_CONFIG.mainnet.chainId, feePerKb = index_js_1.DEFAULT_FEE_PER_KB, hasSmartOutputs = false) {
+    const decoded = utxos.map((u) => decodeUtxo(u, systemId));
+    const remaining = new Map(requiredCurrencies);
+    let remainingNative = requiredNative;
+    const selected = [];
+    // Phase 1: Select UTXOs that have required non-native currencies
+    if (remaining.size > 0) {
+        for (const utxo of decoded) {
+            if (selected.includes(utxo))
+                continue;
+            let hasNeededCurrency = false;
+            for (const [currency, needed] of remaining) {
+                if (currency === systemId)
+                    continue;
+                const utxoAmount = utxo.currencyValues.get(currency) || 0;
+                if (utxoAmount > 0 && needed > 0) {
+                    hasNeededCurrency = true;
+                    break;
+                }
+            }
+            if (hasNeededCurrency) {
+                selected.push(utxo);
+                for (const [currency, amount] of utxo.currencyValues) {
+                    if (currency === systemId) {
+                        remainingNative -= amount;
+                    }
+                    else {
+                        const needed = remaining.get(currency) || 0;
+                        remaining.set(currency, needed - amount);
+                    }
+                }
+                remainingNative -= utxo.satoshis;
+            }
+        }
+        for (const [currency, needed] of remaining) {
+            if (currency !== systemId && needed > 0) {
+                const totalAvailable = decoded.reduce((sum, u) => sum + (u.currencyValues.get(currency) || 0), 0);
+                throw new errors_js_1.InsufficientFundsError(needed + totalAvailable, totalAvailable, currency);
+            }
+        }
+    }
+    // Phase 2: Select UTXOs for native amount + fee
+    const nativeOnly = decoded
+        .filter((u) => !selected.includes(u))
+        .sort((a, b) => b.satoshis - a.satoshis);
+    let changeOutputCount = 0;
+    for (const [currency, needed] of remaining) {
+        if (currency !== systemId && needed < 0) {
+            changeOutputCount++;
+        }
+    }
+    let fee = estimateFee(selected.length + 1, numOutputs + 1 + changeOutputCount, feePerKb, hasSmartOutputs);
+    while (remainingNative + fee > 0) {
+        const next = nativeOnly.shift();
+        if (!next) {
+            const totalAvailable = decoded.reduce((sum, u) => sum + u.satoshis, 0);
+            throw new errors_js_1.InsufficientFundsError(requiredNative + fee, totalAvailable, 'VRSC');
+        }
+        selected.push(next);
+        remainingNative -= next.satoshis;
+        fee = estimateFee(selected.length, numOutputs + 1 + changeOutputCount, feePerKb, hasSmartOutputs);
+    }
+    // Calculate change
+    const totalNativeIn = selected.reduce((sum, u) => sum + u.satoshis, 0);
+    const actualNativeChange = totalNativeIn - requiredNative - fee;
+    const currencyChanges = new Map();
+    for (const [currency, needed] of remaining) {
+        if (currency !== systemId && needed < 0) {
+            currencyChanges.set(currency, -needed);
+        }
+    }
+    const finalNativeChange = actualNativeChange > index_js_1.DUST_THRESHOLD ? actualNativeChange : 0;
+    const finalFee = actualNativeChange > index_js_1.DUST_THRESHOLD ? fee : fee + actualNativeChange;
+    return {
+        selected: selected.map(({ currencyValues, ...utxo }) => utxo),
+        nativeChange: finalNativeChange,
+        currencyChanges,
+        fee: finalFee,
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/utxo/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utxo/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAqBH,gCAwBC;AAKD,kCAUC;AAKD,kCAoHC;AAnLD,8CAA2C;AAC3C,oDAA2F;AAC3F,4CAAsD;AAGtD,MAAM,EAAE,YAAY,EAAE,GAAG,mBAAQ,CAAC;AAKlC,wCAAwC;AACxC,MAAM,UAAU,GAAG,GAAG,CAAC;AACvB,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB;;GAEG;AACH,SAAgB,UAAU,CAAC,IAAU,EAAE,QAAgB;IACrD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEjD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,QAAQ;YACpB,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC;SACxC,CAAC;QACF,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEtD,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAChE,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,KAAa,CAAC,QAAQ,EAAE,CAAC;YAC7E,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBACf,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,2CAA2C;QAC3C,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;YACtB,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,OAAO,EAAE,GAAG,IAAI,EAAE,cAAc,EAAE,CAAC;AACrC,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CACzB,SAAiB,EACjB,UAAkB,EAClB,WAAmB,6BAAkB,EACrC,kBAA2B,KAAK;IAEhC,MAAM,UAAU,GAAG,eAAe,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC;IAC3E,MAAM,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IAC9E,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CACzB,KAAa,EACb,cAAsB,EACtB,qBAA0C,IAAI,GAAG,EAAE,EACnD,aAAqB,CAAC,EACtB,WAAmB,yBAAc,CAAC,OAAO,CAAC,OAAO,EACjD,WAAmB,6BAAkB,EACrC,kBAA2B,KAAK;IAEhC,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE1D,MAAM,SAAS,GAAG,IAAI,GAAG,CAAiB,kBAAkB,CAAC,CAAC;IAC9D,IAAI,eAAe,GAAG,cAAc,CAAC;IAErC,MAAM,QAAQ,GAAkB,EAAE,CAAC;IAEnC,iEAAiE;IACjE,IAAI,SAAS,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACvB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAAE,SAAS;YAEtC,IAAI,iBAAiB,GAAG,KAAK,CAAC;YAC9B,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;gBAC3C,IAAI,QAAQ,KAAK,QAAQ;oBAAE,SAAS;gBACpC,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC1D,IAAI,UAAU,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;oBACjC,iBAAiB,GAAG,IAAI,CAAC;oBACzB,MAAM;gBACR,CAAC;YACH,CAAC;YAED,IAAI,iBAAiB,EAAE,CAAC;gBACtB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpB,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;oBACrD,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;wBAC1B,eAAe,IAAI,MAAM,CAAC;oBAC5B,CAAC;yBAAM,CAAC;wBACN,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;wBAC5C,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;oBAC3C,CAAC;gBACH,CAAC;gBACD,eAAe,IAAI,IAAI,CAAC,QAAQ,CAAC;YACnC,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;YAC3C,IAAI,QAAQ,KAAK,QAAQ,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClG,MAAM,IAAI,kCAAsB,CAC9B,MAAM,GAAG,cAAc,EAAE,cAAc,EAAE,QAAQ,CAClD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,gDAAgD;IAChD,MAAM,UAAU,GAAG,OAAO;SACvB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SACpC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;IAE3C,IAAI,iBAAiB,GAAG,CAAC,CAAC;IAC1B,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC3C,IAAI,QAAQ,KAAK,QAAQ,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,iBAAiB,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;IAED,IAAI,GAAG,GAAG,WAAW,CACnB,QAAQ,CAAC,MAAM,GAAG,CAAC,EACnB,UAAU,GAAG,CAAC,GAAG,iBAAiB,EAClC,QAAQ,EACR,eAAe,CAChB,CAAC;IAEF,OAAO,eAAe,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC;QAChC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YACvE,MAAM,IAAI,kCAAsB,CAC9B,cAAc,GAAG,GAAG,EAAE,cAAc,EAAE,MAAM,CAC7C,CAAC;QACJ,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpB,eAAe,IAAI,IAAI,CAAC,QAAQ,CAAC;QAEjC,GAAG,GAAG,WAAW,CACf,QAAQ,CAAC,MAAM,EACf,UAAU,GAAG,CAAC,GAAG,iBAAiB,EAClC,QAAQ,EACR,eAAe,CAChB,CAAC;IACJ,CAAC;IAED,mBAAmB;IACnB,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACvE,MAAM,kBAAkB,GAAG,aAAa,GAAG,cAAc,GAAG,GAAG,CAAC;IAEhE,MAAM,eAAe,GAAG,IAAI,GAAG,EAAkB,CAAC;IAClD,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC3C,IAAI,QAAQ,KAAK,QAAQ,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,MAAM,iBAAiB,GACrB,kBAAkB,GAAG,yBAAc,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,MAAM,QAAQ,GACZ,kBAAkB,GAAG,yBAAc,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,kBAAkB,CAAC;IAEvE,OAAO;QACL,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC;QAC7D,YAAY,EAAE,iBAAiB;QAC/B,eAAe;QACf,GAAG,EAAE,QAAQ;KACd,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@chainvue/verus-sdk",
+  "version": "0.4.0",
+  "description": "100% offline, fully typed TypeScript SDK for Verus transaction signing",
+  "main": "dist/bundle.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "pnpm run clean && pnpm run build && pnpm run bundle && pnpm run test",
+    "bundle": "tsup"
+  },
+  "keywords": [
+    "verus",
+    "cryptocurrency",
+    "offline-signing",
+    "typescript"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/chainvue/verus-sdk.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@bitgo/utxo-lib": "github:VerusCoin/BitGoJS#utxo-lib-verus",
+    "bitcoin-ops": "github:VerusCoin/bitcoin-ops",
+    "bn.js": "^5.2.2",
+    "bs58check": "^2.1.2",
+    "create-hash": "^1.2.0",
+    "ecpair": "^2.1.0",
+    "tiny-secp256k1": "^2.2.4",
+    "verus-typescript-primitives": "github:VerusCoin/verus-typescript-primitives#4243cd075b4f68df1ce72fd2fd9c9b18ac36767e",
+    "wif": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/bn.js": "^5.2.0",
+    "@types/bs58check": "^2.1.2",
+    "@types/create-hash": "^1.2.6",
+    "@types/node": "^20.19.33",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^1.6.1"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "packageManager": "pnpm@9.15.0",
+  "pnpm": {
+    "overrides": {
+      "bitcoin-ops": "github:VerusCoin/bitcoin-ops",
+      "verus-typescript-primitives": "github:VerusCoin/verus-typescript-primitives#4243cd075b4f68df1ce72fd2fd9c9b18ac36767e"
+    },
+    "patchedDependencies": {
+      "bitcoin-ops": "patches/bitcoin-ops.patch"
+    }
+  }
+}