@gobob/bob-sdk 1.2.0 → 2.0.0

package/dist/wallet/address.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidBtcAddress = void 0;
+const BTC_MAINNET_REGEX = /\b([13][a-km-zA-HJ-NP-Z1-9]{25,34}|bc1[ac-hj-np-zAC-HJ-NP-Z02-9]{11,71})\b/;
+const BTC_TESTNET_REGEX = /\b([2mn][a-km-zA-HJ-NP-Z1-9]{25,34}|tb1[ac-hj-np-zAC-HJ-NP-Z02-9]{11,71})\b/;
+const mainnetRegex = new RegExp(BTC_MAINNET_REGEX);
+const testnetRegex = new RegExp(BTC_TESTNET_REGEX);
+const isValidBtcAddress = (network, address) => {
+    switch (network) {
+        case 'mainnet':
+            return mainnetRegex.test(address);
+        case 'testnet':
+            return testnetRegex.test(address);
+        default:
+            throw new Error(`Invalid bitcoin network configured: ${network}. Valid values are: mainnet | testnet.`);
+    }
+};
+exports.isValidBtcAddress = isValidBtcAddress;
+//# sourceMappingURL=address.js.map

package/dist/wallet/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../src/wallet/address.ts"],"names":[],"mappings":";;;AAEA,MAAM,iBAAiB,GAAG,4EAA4E,CAAC;AACvG,MAAM,iBAAiB,GAAG,6EAA6E,CAAC;AAExG,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAC;AACnD,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAE5C,MAAM,iBAAiB,GAAG,CAAC,OAA2B,EAAE,OAAe,EAAW,EAAE;IACzF,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,SAAS;YACZ,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,SAAS;YACZ,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpC;YACE,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,wCAAwC,CAAC,CAAC;IAC5G,CAAC;AACH,CAAC,CAAC;AATW,QAAA,iBAAiB,qBAS5B"}

package/dist/wallet/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./address";
+export * from "./utxo";

package/dist/wallet/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./address"), exports);
+__exportStar(require("./utxo"), exports);
+//# sourceMappingURL=index.js.map

package/dist/wallet/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/wallet/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,yCAAuB"}

package/dist/wallet/inscriptions.d.ts

@@ -0,0 +1,4 @@
+import { EsploraClient, UTXO } from "../esplora";
+import { OrdinalsClient } from "../ordinal-api";
+export declare function findUtxoForInscriptionId(esploraClient: EsploraClient, ordinalsClient: OrdinalsClient, utxos: UTXO[], inscriptionId: string): Promise<UTXO | undefined>;
+export declare function findUtxosWithoutInscriptions(network: string, utxos: UTXO[]): Promise<UTXO[]>;

package/dist/wallet/inscriptions.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findUtxoForInscriptionId = findUtxoForInscriptionId;
+exports.findUtxosWithoutInscriptions = findUtxosWithoutInscriptions;
+const inscription_1 = require("../inscription");
+const ordinal_api_1 = require("../ordinal-api");
+async function findUtxoForInscriptionId(esploraClient, ordinalsClient, utxos, inscriptionId) {
+    const { txid, index } = ordinal_api_1.InscriptionId.fromString(inscriptionId);
+    for (const utxo of utxos) {
+        if (utxo.confirmed) {
+            const inscriptionUtxo = await ordinalsClient.getInscriptionsFromOutPoint(utxo);
+            if (inscriptionUtxo.inscriptions && inscriptionUtxo.inscriptions.includes(inscriptionId)) {
+                return utxo;
+            }
+        }
+        else if (txid == utxo.txid) {
+            const inscriptions = await (0, inscription_1.getTxInscriptions)(esploraClient, utxo.txid);
+            if (typeof inscriptions[index] !== 'undefined') {
+                return utxo;
+            }
+        }
+    }
+    return undefined;
+}
+async function findUtxosWithoutInscriptions(network, utxos) {
+    const ordinalsClient = new ordinal_api_1.DefaultOrdinalsClient(network);
+    const safeUtxos = [];
+    await Promise.all([
+        utxos.map(async (utxo) => {
+            if (utxo.confirmed) {
+                const inscription = await ordinalsClient.getInscriptionsFromOutPoint({
+                    txid: utxo.txid,
+                    vout: utxo.vout
+                });
+                if (inscription.inscriptions.length === 0) {
+                    safeUtxos.push(utxo);
+                }
+            }
+        })
+    ]);
+    return safeUtxos;
+}
+//# sourceMappingURL=inscriptions.js.map

package/dist/wallet/inscriptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inscriptions.js","sourceRoot":"","sources":["../../src/wallet/inscriptions.ts"],"names":[],"mappings":";;AAIA,4DA0BC;AAED,oEAsBC;AArDD,gDAAmD;AACnD,gDAAsF;AAE/E,KAAK,UAAU,wBAAwB,CAC1C,aAA4B,EAC5B,cAA8B,EAC9B,KAAa,EACb,aAAqB;IAIrB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,2BAAa,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;IAE/D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAA;YAC9E,IAAI,eAAe,CAAC,YAAY,IAAI,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;gBACvF,OAAO,IAAI,CAAC;YAChB,CAAC;QACL,CAAC;aAAM,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC3B,MAAM,YAAY,GAAG,MAAM,IAAA,+BAAiB,EAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAEvE,IAAI,OAAO,YAAY,CAAC,KAAK,CAAC,KAAK,WAAW,EAAE,CAAC;gBAC7C,OAAO,IAAI,CAAC;YAChB,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAEM,KAAK,UAAU,4BAA4B,CAAC,OAAe,EAAE,KAAa;IAC7E,MAAM,cAAc,GAAG,IAAI,mCAAqB,CAAC,OAAO,CAAC,CAAC;IAE1D,MAAM,SAAS,GAAW,EAAE,CAAC;IAG7B,MAAM,OAAO,CAAC,GAAG,CAAC;QACd,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACrB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjB,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,2BAA2B,CAAC;oBACjE,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,IAAI,EAAE,IAAI,CAAC,IAAI;iBAClB,CAAC,CAAC;gBAEH,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACxC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACzB,CAAC;YACL,CAAC;QACL,CAAC,CAAC;KACL,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC;AACrB,CAAC"}

package/dist/wallet/utxo.d.ts

@@ -0,0 +1,23 @@
+import { Transaction } from '@scure/btc-signer';
+import { AddressType } from 'bitcoin-address-validation';
+import { UTXO } from '../esplora';
+export type BitcoinNetworkName = 'mainnet' | 'testnet';
+export declare const getBtcNetwork: (name: BitcoinNetworkName) => {
+    bech32: string;
+    pubKeyHash: number;
+    scriptHash: number;
+    wif: number;
+};
+export interface Input {
+    txid: string;
+    index: number;
+    witness_script?: Uint8Array;
+    redeemScript?: Uint8Array;
+    witnessUtxo?: {
+        script: Uint8Array;
+        amount: bigint;
+    };
+    nonWitnessUtxo?: Uint8Array;
+}
+export declare function createTransfer(network: BitcoinNetworkName, addressType: AddressType, fromAddress: string, toAddress: string, amount: number, publicKey?: string, opReturnData?: string, confirmationTarget?: number): Promise<Transaction>;
+export declare function getInputFromUtxoAndTx(network: BitcoinNetworkName, utxo: UTXO, transaction: Transaction, addressType: AddressType, pubKey?: string): Input;

package/dist/wallet/utxo.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBtcNetwork = void 0;
+exports.createTransfer = createTransfer;
+exports.getInputFromUtxoAndTx = getInputFromUtxoAndTx;
+const btc_signer_1 = require("@scure/btc-signer");
+const base_1 = require("@scure/base");
+const bitcoin_address_validation_1 = require("bitcoin-address-validation");
+const esplora_1 = require("../esplora");
+const bitcoinNetworks = {
+    mainnet: btc_signer_1.NETWORK,
+    testnet: btc_signer_1.TEST_NETWORK
+};
+const getBtcNetwork = (name) => {
+    return bitcoinNetworks[name];
+};
+exports.getBtcNetwork = getBtcNetwork;
+async function createTransfer(network, addressType, fromAddress, toAddress, amount, publicKey, opReturnData, confirmationTarget = 3) {
+    const esploraClient = new esplora_1.DefaultEsploraClient(network);
+    const [confirmedUtxos, feeRate] = await Promise.all([
+        esploraClient.getAddressUtxos(fromAddress),
+        esploraClient.getFeeEstimate(confirmationTarget)
+    ]);
+    if (confirmedUtxos.length === 0) {
+        throw new Error('No confirmed UTXOs');
+    }
+    let possibleInputs = [];
+    await Promise.all(confirmedUtxos.map(async (utxo) => {
+        const hex = await esploraClient.getTransactionHex(utxo.txid);
+        const transaction = btc_signer_1.Transaction.fromRaw(Buffer.from(hex, 'hex'), { allowUnknownOutputs: true });
+        const input = getInputFromUtxoAndTx(network, utxo, transaction, addressType, publicKey);
+        possibleInputs.push(input);
+    }));
+    const outputs = [
+        {
+            address: toAddress,
+            amount: BigInt(amount)
+        }
+    ];
+    if (opReturnData) {
+        if (opReturnData.startsWith('0x')) {
+            opReturnData = opReturnData.slice(2);
+        }
+        outputs.push({
+            script: btc_signer_1.Script.encode(['RETURN', base_1.hex.decode(opReturnData)]),
+            amount: BigInt(0)
+        });
+    }
+    const transaction = (0, btc_signer_1.selectUTXO)(possibleInputs, outputs, 'default', {
+        changeAddress: fromAddress,
+        feePerByte: BigInt(Math.ceil(feeRate)),
+        bip69: true,
+        createTx: true,
+        network: (0, exports.getBtcNetwork)(network),
+        allowUnknownOutputs: true,
+        allowLegacyWitnessUtxo: true
+    });
+    if (!transaction || !transaction.tx) {
+        throw new Error('Failed to create transaction. Do you have enough funds?');
+    }
+    return transaction.tx;
+}
+function getInputFromUtxoAndTx(network, utxo, transaction, addressType, pubKey) {
+    const output = transaction.getOutput(utxo.vout);
+    let redeemScript = {};
+    if (addressType === bitcoin_address_validation_1.AddressType.p2sh) {
+        const inner = (0, btc_signer_1.p2wpkh)(Buffer.from(pubKey, 'hex'), (0, exports.getBtcNetwork)(network));
+        redeemScript = (0, btc_signer_1.p2sh)(inner);
+    }
+    const scriptMixin = {
+        ...redeemScript
+    };
+    const nonWitnessUtxo = {
+        nonWitnessUtxo: Buffer.from(transaction.hex, 'hex')
+    };
+    const witnessUtxo = {
+        witnessUtxo: {
+            script: output.script,
+            amount: output.amount
+        }
+    };
+    const witnessMixin = transaction.hasWitnesses ? witnessUtxo : nonWitnessUtxo;
+    const input = {
+        txid: utxo.txid,
+        index: utxo.vout,
+        ...scriptMixin,
+        ...witnessMixin
+    };
+    return input;
+}
+//# sourceMappingURL=utxo.js.map

package/dist/wallet/utxo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utxo.js","sourceRoot":"","sources":["../../src/wallet/utxo.ts"],"names":[],"mappings":";;;AA+BA,wCA4EC;AAGD,sDAgDC;AA9JD,kDAAyG;AACzG,sCAAkC;AAClC,2EAAyD;AAEzD,wCAAwD;AAIxD,MAAM,eAAe,GAA+C;IAClE,OAAO,EAAE,oBAAO;IAChB,OAAO,EAAE,yBAAY;CACtB,CAAC;AAEK,MAAM,aAAa,GAAG,CAAC,IAAwB,EAAE,EAAE;IACxD,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB;AAgBK,KAAK,UAAU,cAAc,CAClC,OAA2B,EAC3B,WAAwB,EACxB,WAAmB,EACnB,SAAiB,EACjB,MAAc,EACd,SAAkB,EAClB,YAAqB,EACrB,qBAA6B,CAAC;IAE9B,MAAM,aAAa,GAAG,IAAI,8BAAoB,CAAC,OAAO,CAAC,CAAC;IAIxD,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAClD,aAAa,CAAC,eAAe,CAAC,WAAW,CAAC;QAC1C,aAAa,CAAC,cAAc,CAAC,kBAAkB,CAAC;KACjD,CAAC,CAAC;IAEH,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IAGD,IAAI,cAAc,GAAY,EAAE,CAAC;IAEjC,MAAM,OAAO,CAAC,GAAG,CACf,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAChC,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE7D,MAAM,WAAW,GAAG,wBAAW,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC,CAAC;QAEhG,MAAM,KAAK,GAAG,qBAAqB,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;QAExF,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,CAAC,CACH,CAAC;IAEF,MAAM,OAAO,GAAa;QACxB;YACE,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;SACvB;KACF,CAAC;IAEF,IAAI,YAAY,EAAE,CAAC;QAEjB,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,CAAC,IAAI,CAAC;YAEX,MAAM,EAAE,mBAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,UAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YAC3D,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;SAClB,CAAC,CAAA;IACJ,CAAC;IAMD,MAAM,WAAW,GAAG,IAAA,uBAAU,EAAC,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE;QACjE,aAAa,EAAE,WAAW;QAC1B,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtC,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAA,qBAAa,EAAC,OAAO,CAAC;QAC/B,mBAAmB,EAAE,IAAI;QACzB,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC;IAEH,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,WAAW,CAAC,EAAE,CAAC;AACxB,CAAC;AAGD,SAAgB,qBAAqB,CACnC,OAA2B,EAC3B,IAAU,EACV,WAAwB,EACxB,WAAwB,EACxB,MAAe;IAIf,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAMhD,IAAI,YAAY,GAAG,EAAE,CAAC;IAEtB,IAAI,WAAW,KAAK,wCAAW,CAAC,IAAI,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,IAAA,mBAAM,EAAC,MAAM,CAAC,IAAI,CAAC,MAAO,EAAE,KAAK,CAAC,EAAE,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC,CAAC;QAC1E,YAAY,GAAG,IAAA,iBAAI,EAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAGD,MAAM,WAAW,GAAG;QAClB,GAAG,YAAY;KAChB,CAAC;IAGF,MAAM,cAAc,GAAG;QACrB,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC;KACpD,CAAC;IACF,MAAM,WAAW,GAAG;QAClB,WAAW,EAAE;YACX,MAAM,EAAE,MAAM,CAAC,MAAO;YACtB,MAAM,EAAE,MAAM,CAAC,MAAO;SACvB;KACF,CAAC;IACF,MAAM,YAAY,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC;IAG7E,MAAM,KAAK,GAAG;QACZ,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,KAAK,EAAE,IAAI,CAAC,IAAI;QAChB,GAAG,WAAW;QACd,GAAG,YAAY;KAChB,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@gobob/bob-sdk",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "vitest run test/*.ts",
-    "deploy-relay": "ts-node scripts/relay-genesis.ts",
-    "update-relay": "ts-node scripts/relay-retarget.ts",
+    "deploy-relay": "ts-node src/scripts/relay-genesis.ts",
+    "update-relay": "ts-node src/scripts/relay-retarget.ts",
     "build": "tsc -p tsconfig.json"
   },
   "files": [
@@ -18,17 +18,21 @@
     "README.md"
   ],
   "devDependencies": {
-    "@types/node": "^20.11.25",
-    "@types/yargs": "^17.0.32",
+    "@types/node": "^22.0.0",
+    "@types/yargs": "^17.0.33",
     "ecpair": "^2.1.0",
-    "mocha": "^10.3.0",
+    "mocha": "^10.7.3",
     "tiny-secp256k1": "^2.2.3",
     "ts-node": "^10.0.0",
-    "typescript": "^5.4.2",
-    "vitest": "^1.3.1",
+    "typescript": "^5.5.4",
+    "vitest": "^2.0.5",
     "yargs": "^17.5.1"
   },
   "dependencies": {
-    "bitcoinjs-lib": "^6.1.5"
+    "@scure/base": "^1.1.7",
+    "@scure/btc-signer": "^1.3.2",
+    "bitcoin-address-validation": "^2.2.3",
+    "bitcoinjs-lib": "^6.1.6",
+    "ethers": "^6.13.2"
   }
 }