ecash-agora 0.3.2 → 0.4.0

package/README.md

@@ -174,3 +174,7 @@ Running from `bitcoin-abc/modules/ecash-agora` if your build dir is `bitcoin-abc
 ### 0.3.2
 
 -   Improve offer checks in `historicOffers` [D17630](https://reviews.bitcoinabc.org/D17630)
+
+### 0.4.0
+
+-   Add `getAgoraPartialAcceptFuelInputs` and `getAgoraCancelFuelInputs` [D17637](https://reviews.bitcoinabc.org/D17637)

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './ad.js';
 export * from './agora.js';
 export * from './consts.js';
+export * from './inputs.js';
 export * from './oneshot.js';
 export * from './partial.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}

package/dist/index.js

@@ -20,6 +20,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ad.js"), exports);
 __exportStar(require("./agora.js"), exports);
 __exportStar(require("./consts.js"), exports);
+__exportStar(require("./inputs.js"), exports);
 __exportStar(require("./oneshot.js"), exports);
 __exportStar(require("./partial.js"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;;;;;;;;;;;;;;;;AAEtE,0CAAwB;AACxB,6CAA2B;AAC3B,8CAA4B;AAC5B,+CAA6B;AAC7B,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;;;;;;;;;;;;;;;;AAEtE,0CAAwB;AACxB,6CAA2B;AAC3B,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,+CAA6B"}

package/dist/inputs.d.ts

@@ -0,0 +1,22 @@
+import { ScriptUtxo } from 'chronik-client';
+import { AgoraOffer } from './agora';
+export declare const DUMMY_KEYPAIR: {
+    sk: Uint8Array;
+    pk: Uint8Array;
+};
+/**
+ * Determine input utxos to cover an Agora Partial accept offer
+ */
+export declare const getAgoraPartialAcceptFuelInputs: (agoraOffer: AgoraOffer, utxos: ScriptUtxo[], acceptedTokens: bigint, feePerKb?: number) => ScriptUtxo[];
+/**
+ * Determine input utxos to cover an Agora ONESHOT accept offer
+ * Note: we could refactor getAgoraPartialAcceptFuelInputs to work with ONESHOT offers
+ * However there is some ambiguity involved with the acceptedTokens param
+ * Cleaner to keep distinct functions
+ */
+export declare const getAgoraOneshotAcceptFuelInputs: (agoraOffer: AgoraOffer, utxos: ScriptUtxo[], feePerKb?: number) => ScriptUtxo[];
+/**
+ * Determine input utxos to cancel an Agora offer (Partial or ONESHOT)
+ */
+export declare const getAgoraCancelFuelInputs: (agoraOffer: AgoraOffer, utxos: ScriptUtxo[], feePerKb?: number) => ScriptUtxo[];
+//# sourceMappingURL=inputs.d.ts.map

package/dist/inputs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inputs.d.ts","sourceRoot":"","sources":["../src/inputs.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAOrC,eAAO,MAAM,aAAa;;;CAKzB,CAAC;AAiBF;;GAEG;AACH,eAAO,MAAM,+BAA+B,eAC5B,UAAU,SACf,UAAU,EAAE,kBACH,MAAM,wBAEvB,UAAU,EA6BZ,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,eAC5B,UAAU,SACf,UAAU,EAAE,wBAEpB,UAAU,EA4BZ,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,eACrB,UAAU,SACf,UAAU,EAAE,wBAEpB,UAAU,EA2BZ,CAAC"}

package/dist/inputs.js

@@ -0,0 +1,122 @@
+"use strict";
+// Copyright (c) 2025 The Bitcoin developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAgoraCancelFuelInputs = exports.getAgoraOneshotAcceptFuelInputs = exports.getAgoraPartialAcceptFuelInputs = exports.DUMMY_KEYPAIR = void 0;
+const ecash_lib_1 = require("ecash-lib");
+const DUMMY_TXID = '1111111111111111111111111111111111111111111111111111111111111111';
+const DUMMY_WALLET_HASH = (0, ecash_lib_1.fromHex)('12'.repeat(20));
+const DUMMY_SUFFICIENT_CANCEL_VALUE = 10000;
+const DUMMY_SCRIPT = ecash_lib_1.Script.p2pkh(DUMMY_WALLET_HASH);
+exports.DUMMY_KEYPAIR = {
+    sk: (0, ecash_lib_1.fromHex)('33'.repeat(32)),
+    pk: (0, ecash_lib_1.fromHex)('023c72addb4fdf09af94f0c94d7fe92a386a7e70cf8a1d85916386bb2535c7b1b1'),
+};
+// Used for accept and cancel fee estimation of agora partial offers
+const DUMMY_INPUT = {
+    input: {
+        prevOut: {
+            txid: DUMMY_TXID,
+            outIdx: 1,
+        },
+        signData: {
+            value: DUMMY_SUFFICIENT_CANCEL_VALUE,
+            outputScript: DUMMY_SCRIPT,
+        },
+    },
+    signatory: (0, ecash_lib_1.P2PKHSignatory)(exports.DUMMY_KEYPAIR.sk, exports.DUMMY_KEYPAIR.pk, ecash_lib_1.ALL_BIP143),
+};
+/**
+ * Determine input utxos to cover an Agora Partial accept offer
+ */
+const getAgoraPartialAcceptFuelInputs = (agoraOffer, utxos, acceptedTokens, feePerKb = ecash_lib_1.DEFAULT_FEE_PER_KB) => {
+    const fuelInputs = [];
+    const dummyInputs = [];
+    let inputSatoshis = 0n;
+    for (const utxo of utxos) {
+        // Accumulative utxo selection
+        fuelInputs.push(utxo);
+        // Match our fuelInput count with dummyInputs
+        dummyInputs.push(DUMMY_INPUT);
+        inputSatoshis += BigInt(utxo.value);
+        const askedSats = agoraOffer.askedSats(BigInt(acceptedTokens));
+        // Get the tx fee for this tx
+        const acceptFeeSats = agoraOffer.acceptFeeSats({
+            recipientScript: DUMMY_SCRIPT,
+            extraInputs: dummyInputs,
+            acceptedTokens,
+            feePerKb,
+        });
+        // We need to cover the tx fee and the asking price
+        const requiredSats = acceptFeeSats + askedSats;
+        if (inputSatoshis >= requiredSats) {
+            return fuelInputs;
+        }
+    }
+    throw new Error('Insufficient utxos to accept this offer');
+};
+exports.getAgoraPartialAcceptFuelInputs = getAgoraPartialAcceptFuelInputs;
+/**
+ * Determine input utxos to cover an Agora ONESHOT accept offer
+ * Note: we could refactor getAgoraPartialAcceptFuelInputs to work with ONESHOT offers
+ * However there is some ambiguity involved with the acceptedTokens param
+ * Cleaner to keep distinct functions
+ */
+const getAgoraOneshotAcceptFuelInputs = (agoraOffer, utxos, feePerKb = ecash_lib_1.DEFAULT_FEE_PER_KB) => {
+    const fuelInputs = [];
+    const dummyInputs = [];
+    let inputSatoshis = 0n;
+    for (const utxo of utxos) {
+        // Accumulative utxo selection
+        fuelInputs.push(utxo);
+        // Match our fuelInput count with dummyInputs
+        dummyInputs.push(DUMMY_INPUT);
+        inputSatoshis += BigInt(utxo.value);
+        const askedSats = agoraOffer.askedSats();
+        // Get the tx fee for this tx
+        const acceptFeeSats = agoraOffer.acceptFeeSats({
+            recipientScript: DUMMY_SCRIPT,
+            extraInputs: dummyInputs,
+            feePerKb,
+        });
+        // We need to cover the tx fee and the asking price
+        const requiredSats = acceptFeeSats + askedSats;
+        if (inputSatoshis >= requiredSats) {
+            return fuelInputs;
+        }
+    }
+    throw new Error('Insufficient utxos to accept this offer');
+};
+exports.getAgoraOneshotAcceptFuelInputs = getAgoraOneshotAcceptFuelInputs;
+/**
+ * Determine input utxos to cancel an Agora offer (Partial or ONESHOT)
+ */
+const getAgoraCancelFuelInputs = (agoraOffer, utxos, feePerKb = ecash_lib_1.DEFAULT_FEE_PER_KB) => {
+    const fuelInputs = [];
+    const dummyInputs = [];
+    let inputSatoshis = 0n;
+    for (const utxo of utxos) {
+        // Accumulative utxo selection
+        fuelInputs.push(utxo);
+        // Match our fuelInput count with dummyInputs
+        dummyInputs.push(DUMMY_INPUT);
+        inputSatoshis += BigInt(utxo.value);
+        // Get the tx fee for this tx
+        // In practice, this is always bigger than dust
+        // So we do not check to make sure the output we cover is at least dust
+        const cancelFeeSats = agoraOffer.cancelFeeSats({
+            recipientScript: DUMMY_SCRIPT,
+            extraInputs: dummyInputs,
+            feePerKb,
+        });
+        // There is no asking price for cancellation
+        // cancelFeeSats is the size of the output we need
+        if (inputSatoshis >= cancelFeeSats) {
+            return fuelInputs;
+        }
+    }
+    throw new Error('Insufficient utxos to cancel this offer');
+};
+exports.getAgoraCancelFuelInputs = getAgoraCancelFuelInputs;
+//# sourceMappingURL=inputs.js.map

package/dist/inputs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inputs.js","sourceRoot":"","sources":["../src/inputs.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;;;AAEtE,yCAMmB;AAKnB,MAAM,UAAU,GACZ,kEAAkE,CAAC;AACvE,MAAM,iBAAiB,GAAG,IAAA,mBAAO,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AACnD,MAAM,6BAA6B,GAAG,KAAK,CAAC;AAC5C,MAAM,YAAY,GAAG,kBAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AACxC,QAAA,aAAa,GAAG;IACzB,EAAE,EAAE,IAAA,mBAAO,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC5B,EAAE,EAAE,IAAA,mBAAO,EACP,oEAAoE,CACvE;CACJ,CAAC;AAEF,oEAAoE;AACpE,MAAM,WAAW,GAAG;IAChB,KAAK,EAAE;QACH,OAAO,EAAE;YACL,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,CAAC;SACZ;QACD,QAAQ,EAAE;YACN,KAAK,EAAE,6BAA6B;YACpC,YAAY,EAAE,YAAY;SAC7B;KACJ;IACD,SAAS,EAAE,IAAA,0BAAc,EAAC,qBAAa,CAAC,EAAE,EAAE,qBAAa,CAAC,EAAE,EAAE,sBAAU,CAAC;CAC5E,CAAC;AAEF;;GAEG;AACI,MAAM,+BAA+B,GAAG,CAC3C,UAAsB,EACtB,KAAmB,EACnB,cAAsB,EACtB,QAAQ,GAAG,8BAAkB,EACjB,EAAE;IACd,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,8BAA8B;QAC9B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,6CAA6C;QAC7C,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9B,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEpC,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;QAE/D,6BAA6B;QAC7B,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;YAC3C,eAAe,EAAE,YAAY;YAC7B,WAAW,EAAE,WAAW;YACxB,cAAc;YACd,QAAQ;SACX,CAAC,CAAC;QAEH,mDAAmD;QACnD,MAAM,YAAY,GAAG,aAAa,GAAG,SAAS,CAAC;QAE/C,IAAI,aAAa,IAAI,YAAY,EAAE,CAAC;YAChC,OAAO,UAAU,CAAC;QACtB,CAAC;IACL,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;AAC/D,CAAC,CAAC;AAlCW,QAAA,+BAA+B,mCAkC1C;AAEF;;;;;GAKG;AACI,MAAM,+BAA+B,GAAG,CAC3C,UAAsB,EACtB,KAAmB,EACnB,QAAQ,GAAG,8BAAkB,EACjB,EAAE;IACd,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,8BAA8B;QAC9B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,6CAA6C;QAC7C,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9B,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEpC,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC;QAEzC,6BAA6B;QAC7B,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;YAC3C,eAAe,EAAE,YAAY;YAC7B,WAAW,EAAE,WAAW;YACxB,QAAQ;SACX,CAAC,CAAC;QAEH,mDAAmD;QACnD,MAAM,YAAY,GAAG,aAAa,GAAG,SAAS,CAAC;QAE/C,IAAI,aAAa,IAAI,YAAY,EAAE,CAAC;YAChC,OAAO,UAAU,CAAC;QACtB,CAAC;IACL,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;AAC/D,CAAC,CAAC;AAhCW,QAAA,+BAA+B,mCAgC1C;AAEF;;GAEG;AACI,MAAM,wBAAwB,GAAG,CACpC,UAAsB,EACtB,KAAmB,EACnB,QAAQ,GAAG,8BAAkB,EACjB,EAAE;IACd,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,8BAA8B;QAC9B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,6CAA6C;QAC7C,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9B,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEpC,6BAA6B;QAC7B,+CAA+C;QAC/C,uEAAuE;QACvE,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;YAC3C,eAAe,EAAE,YAAY;YAC7B,WAAW,EAAE,WAAW;YACxB,QAAQ;SACX,CAAC,CAAC;QAEH,4CAA4C;QAC5C,kDAAkD;QAClD,IAAI,aAAa,IAAI,aAAa,EAAE,CAAC;YACjC,OAAO,UAAU,CAAC;QACtB,CAAC;IACL,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;AAC/D,CAAC,CAAC;AA/BW,QAAA,wBAAwB,4BA+BnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ecash-agora",
-    "version": "0.3.2",
+    "version": "0.4.0",
     "description": "Library for interacting with the eCash Agora protocol",
     "main": "./dist/index.js",
     "scripts": {