ecash-agora 0.1.1-rc

package/dist/oneshot.js

@@ -0,0 +1,204 @@
+// Copyright (c) 2024 The Bitcoin developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+import { ALL_ANYONECANPAY_BIP143, ALL_BIP143, Bytes, OP_0, OP_1, OP_2, OP_3DUP, OP_CAT, OP_CHECKDATASIGVERIFY, OP_CHECKSIG, OP_CHECKSIGVERIFY, OP_CODESEPARATOR, OP_DROP, OP_ELSE, OP_ENDIF, OP_EQUAL, OP_EQUALVERIFY, OP_HASH256, OP_IF, OP_NIP, OP_NUM2BIN, OP_OVER, OP_ROT, OP_SHA256, OP_SPLIT, OP_SWAP, Script, WriterBytes, WriterLength, flagSignature, isPushOp, pushBytesOp, readTxOutput, sha256d, strToBytes, writeTxOutput, } from 'ecash-lib';
+import { AGORA_LOKAD_ID } from './consts.js';
+/**
+ * Agora offer that has to be accepted in "one shot", i.e. all or nothing.
+ * This is useful for offers that offer exactly 1 token, especially NFTs.
+ *
+ * The covenant is reasonably simple, see
+ * https://read.cash/@pein/bch-covenants-with-spedn-4a980ed3 for an explanation of the
+ * covenant mechanism, but uses two optimizations:
+ * 1. It uses ANYONECANPAY as sighash for the "accept" path, which makes the sighash
+ *    preimage start with `1000....00000`, which can be created with
+ *    `OP_1 68 OP_NUM2BIN`, saving around 64 bytes.
+ * 2. It uses OP_CODESEPARATOR before the OP_CHECKSIG, which cuts out the entire script
+ *    code, leaving only the OP_CHECKSIG behind. The scriptCode part in the BIP143
+ *    sighash now just becomes `01ac`, which is both easier to deal with in the OP_SPLIT
+ *    and also saves 100 bytes or so (depending on the enforced outputs).
+ **/
+export class AgoraOneshot {
+    constructor({ enforcedOutputs, cancelPk, }) {
+        this.enforcedOutputs = enforcedOutputs;
+        this.cancelPk = cancelPk;
+    }
+    /** Build the Script enforcing the Agora offer covenant. */
+    script() {
+        const serEnforcedOutputs = (writer) => {
+            for (const output of this.enforcedOutputs) {
+                writeTxOutput(output, writer);
+            }
+        };
+        const writerLength = new WriterLength();
+        serEnforcedOutputs(writerLength);
+        const writer = new WriterBytes(writerLength.length);
+        serEnforcedOutputs(writer);
+        const enforcedOutputsSer = writer.data;
+        return Script.fromOps([
+            OP_IF, // if is_accept
+            pushBytesOp(enforcedOutputsSer), // push enforced_outputs
+            OP_SWAP, // swap buyer_outputs, enforced_outputs
+            OP_CAT, // outputs = OP_CAT(enforced_outputs, buyer_outputs)
+            OP_HASH256, // expected_hash_outputs = OP_HASH256(outputs)
+            OP_OVER, // duplicate preimage_4_10,
+            // push hash_outputs_idx:
+            pushBytesOp(new Uint8Array([
+                36 + // 4. outpoint
+                    2 + // 5. scriptCode, truncated to 01ac via OP_CODESEPARATOR
+                    8 + // 6. value
+                    4, // 7. sequence
+            ])),
+            OP_SPLIT, // split into preimage_4_7 and preimage_8_10
+            OP_NIP, // remove preimage_4_7
+            pushBytesOp(new Uint8Array([32])), // push 32 onto the stack
+            OP_SPLIT, // split into actual_hash_outputs and preimage_9_10
+            OP_DROP, // drop preimage_9_10
+            OP_EQUALVERIFY, // expected_hash_outputs == actual_hash_outputs
+            OP_2, // push tx version
+            // length of BIP143 preimage parts 1 to 3
+            pushBytesOp(new Uint8Array([4 + 32 + 32])),
+            // build BIP143 preimage parts 1 to 3 for ANYONECANPAY using OP_NUM2BIN
+            OP_NUM2BIN,
+            OP_SWAP, // swap preimage_4_10 and preimage_1_3
+            OP_CAT, // preimage = OP_CAT(preimage_1_3, preimage_4_10)
+            OP_SHA256, // preimage_sha256 = OP_SHA256(preimage)
+            OP_3DUP, // OP_3DUP(covenant_pk, covenant_sig, preimage_sha256)
+            OP_ROT, // -> covenant_sig | preimage_sha256 | covenant_pk
+            OP_CHECKDATASIGVERIFY, // verify preimage matches covenant_sig
+            OP_DROP, // drop preimage_sha256
+            // push ALL|ANYONECANPAY|BIP143 onto the stack
+            pushBytesOp(new Uint8Array([ALL_ANYONECANPAY_BIP143.toInt()])),
+            OP_CAT, // append sighash flags onto covenant_sig
+            OP_SWAP, // swap covenant_pk, covenant_sig_flagged
+            OP_ELSE, // cancel path
+            pushBytesOp(this.cancelPk), // pubkey that can cancel the covenant
+            OP_ENDIF,
+            // cut out everything except the OP_CHECKSIG from the BIP143 scriptCode
+            OP_CODESEPARATOR,
+            OP_CHECKSIG,
+        ]);
+    }
+    static fromRedeemScript(redeemScript, opreturnScript) {
+        const ops = redeemScript.ops();
+        const outputsSerOp = ops.next();
+        if (!isPushOp(outputsSerOp)) {
+            throw new Error('Op 0 expected to be pushop for outputsSer');
+        }
+        if (ops.next() !== OP_DROP) {
+            throw new Error('Op 1 expected to be OP_DROP');
+        }
+        const cancelPkOp = ops.next();
+        if (!isPushOp(cancelPkOp)) {
+            throw new Error('Op 2 expected to be pushop for cancelPk');
+        }
+        if (cancelPkOp.data.length != 33) {
+            throw new Error(`Expected cancelPk to be 33 bytes`);
+        }
+        if (ops.next() !== OP_CHECKSIGVERIFY) {
+            throw new Error('Op 3 expected to be OP_CHECKSIGVERIFY');
+        }
+        const covenantVariantOp = ops.next();
+        if (!isPushOp(covenantVariantOp)) {
+            throw new Error('Op 4 expected to be pushop for covenantVariant');
+        }
+        if (ops.next() !== OP_EQUALVERIFY) {
+            throw new Error('Op 5 expected to be OP_EQUALVERIFY');
+        }
+        const lokadIdOp = ops.next();
+        if (!isPushOp(lokadIdOp)) {
+            throw new Error('Op 6 expected to be pushop for LOKAD ID');
+        }
+        const outputsSerBytes = new Bytes(outputsSerOp.data);
+        const enforcedOutputs = [
+            {
+                value: BigInt(0),
+                script: opreturnScript,
+            },
+        ];
+        while (outputsSerBytes.data.length > outputsSerBytes.idx) {
+            enforcedOutputs.push(readTxOutput(outputsSerBytes));
+        }
+        return new AgoraOneshot({
+            enforcedOutputs,
+            cancelPk: cancelPkOp.data,
+        });
+    }
+    adScript() {
+        const serOutputs = (writer) => {
+            for (const output of this.enforcedOutputs.slice(1)) {
+                writeTxOutput(output, writer);
+            }
+        };
+        const writerLength = new WriterLength();
+        serOutputs(writerLength);
+        const writer = new WriterBytes(writerLength.length);
+        serOutputs(writer);
+        const outputsSer = writer.data;
+        return Script.fromOps([
+            pushBytesOp(outputsSer),
+            OP_DROP,
+            pushBytesOp(this.cancelPk),
+            OP_CHECKSIGVERIFY,
+            pushBytesOp(strToBytes(AgoraOneshot.COVENANT_VARIANT)),
+            OP_EQUALVERIFY,
+            pushBytesOp(AGORA_LOKAD_ID),
+            OP_EQUAL,
+        ]);
+    }
+    askedSats() {
+        return this.enforcedOutputs.reduce((prev, output) => prev + BigInt(output.value), 0n);
+    }
+}
+AgoraOneshot.COVENANT_VARIANT = 'ONESHOT';
+export const AgoraOneshotSignatory = (covenantSk, covenantPk, numEnforcedOutputs) => {
+    return (ecc, input) => {
+        const preimage = input.sigHashPreimage(ALL_ANYONECANPAY_BIP143, 0);
+        const sighash = sha256d(preimage.bytes);
+        const covenantSig = ecc.schnorrSign(covenantSk, sighash);
+        const serBuyerOutputs = (writer) => {
+            for (const output of input.unsignedTx.tx.outputs.slice(numEnforcedOutputs)) {
+                writeTxOutput(output, writer);
+            }
+        };
+        const writerLength = new WriterLength();
+        serBuyerOutputs(writerLength);
+        const writer = new WriterBytes(writerLength.length);
+        serBuyerOutputs(writer);
+        const buyerOutputsSer = writer.data;
+        return Script.fromOps([
+            pushBytesOp(covenantPk),
+            pushBytesOp(covenantSig),
+            pushBytesOp(preimage.bytes.slice(4 + 32 + 32)), // preimage_4_10
+            pushBytesOp(buyerOutputsSer),
+            OP_1, // is_accept = true
+            pushBytesOp(preimage.redeemScript.bytecode),
+        ]);
+    };
+};
+export const AgoraOneshotCancelSignatory = (cancelSk) => {
+    return (ecc, input) => {
+        const preimage = input.sigHashPreimage(ALL_BIP143, 0);
+        const sighash = sha256d(preimage.bytes);
+        const cancelSig = flagSignature(ecc.schnorrSign(cancelSk, sighash), ALL_BIP143);
+        return Script.fromOps([
+            pushBytesOp(cancelSig),
+            OP_0, // is_accept = false
+            pushBytesOp(preimage.redeemScript.bytecode),
+        ]);
+    };
+};
+export const AgoraOneshotAdSignatory = (cancelSk) => {
+    return (ecc, input) => {
+        const preimage = input.sigHashPreimage(ALL_BIP143);
+        const sighash = sha256d(preimage.bytes);
+        const cancelSig = flagSignature(ecc.schnorrSign(cancelSk, sighash), ALL_BIP143);
+        return Script.fromOps([
+            pushBytesOp(AGORA_LOKAD_ID),
+            pushBytesOp(strToBytes(AgoraOneshot.COVENANT_VARIANT)),
+            pushBytesOp(cancelSig),
+            pushBytesOp(preimage.redeemScript.bytecode),
+        ]);
+    };
+};
+//# sourceMappingURL=oneshot.js.map

package/dist/oneshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oneshot.js","sourceRoot":"","sources":["../src/oneshot.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,mEAAmE;AACnE,sEAAsE;AAEtE,OAAO,EACH,uBAAuB,EACvB,UAAU,EACV,KAAK,EAEL,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,OAAO,EACP,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,cAAc,EACd,UAAU,EACV,KAAK,EACL,MAAM,EACN,UAAU,EACV,OAAO,EACP,MAAM,EACN,SAAS,EACT,QAAQ,EACR,OAAO,EACP,MAAM,EAIN,WAAW,EACX,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,WAAW,EACX,YAAY,EACZ,OAAO,EACP,UAAU,EACV,aAAa,GAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;;;IAcI;AACJ,MAAM,OAAO,YAAY;IAMrB,YAAY,EACR,eAAe,EACf,QAAQ,GAIX;QACG,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,2DAA2D;IACpD,MAAM;QACT,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAE,EAAE;YAC1C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;gBACxC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAClC,CAAC;QACL,CAAC,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACxC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACpD,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC;QAEvC,OAAO,MAAM,CAAC,OAAO,CAAC;YAClB,KAAK,EAAE,eAAe;YAEtB,WAAW,CAAC,kBAAkB,CAAC,EAAE,wBAAwB;YACzD,OAAO,EAAE,uCAAuC;YAChD,MAAM,EAAE,oDAAoD;YAC5D,UAAU,EAAE,8CAA8C;YAE1D,OAAO,EAAE,2BAA2B;YACpC,yBAAyB;YACzB,WAAW,CACP,IAAI,UAAU,CAAC;gBACX,EAAE,GAAG,cAAc;oBACf,CAAC,GAAG,wDAAwD;oBAC5D,CAAC,GAAG,WAAW;oBACf,CAAC,EAAE,cAAc;aACxB,CAAC,CACL;YACD,QAAQ,EAAE,4CAA4C;YACtD,MAAM,EAAE,sBAAsB;YAC9B,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,yBAAyB;YAC5D,QAAQ,EAAE,mDAAmD;YAC7D,OAAO,EAAE,qBAAqB;YAE9B,cAAc,EAAE,+CAA+C;YAC/D,IAAI,EAAE,kBAAkB;YACxB,yCAAyC;YACzC,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;YAC1C,uEAAuE;YACvE,UAAU;YACV,OAAO,EAAE,sCAAsC;YAC/C,MAAM,EAAE,iDAAiD;YACzD,SAAS,EAAE,wCAAwC;YACnD,OAAO,EAAE,sDAAsD;YAC/D,MAAM,EAAE,kDAAkD;YAC1D,qBAAqB,EAAE,uCAAuC;YAC9D,OAAO,EAAE,uBAAuB;YAChC,8CAA8C;YAC9C,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC9D,MAAM,EAAE,yCAAyC;YACjD,OAAO,EAAE,yCAAyC;YAElD,OAAO,EAAE,cAAc;YAEvB,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,sCAAsC;YAElE,QAAQ;YAER,uEAAuE;YACvE,gBAAgB;YAChB,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAC1B,YAAoB,EACpB,cAAsB;QAEtB,MAAM,GAAG,GAAG,YAAY,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,iBAAiB,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QACD,MAAM,iBAAiB,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACtE,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,cAAc,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,eAAe,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,eAAe,GAAe;YAChC;gBACI,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;gBAChB,MAAM,EAAE,cAAc;aACzB;SACJ,CAAC;QACF,OAAO,eAAe,CAAC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;YACvD,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,IAAI,YAAY,CAAC;YACpB,eAAe;YACf,QAAQ,EAAE,UAAU,CAAC,IAAI;SAC5B,CAAC,CAAC;IACP,CAAC;IAEM,QAAQ;QACX,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE;YAClC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjD,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAClC,CAAC;QACL,CAAC,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACxC,UAAU,CAAC,YAAY,CAAC,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACpD,UAAU,CAAC,MAAM,CAAC,CAAC;QACnB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;QAE/B,OAAO,MAAM,CAAC,OAAO,CAAC;YAClB,WAAW,CAAC,UAAU,CAAC;YACvB,OAAO;YACP,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC1B,iBAAiB;YACjB,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;YACtD,cAAc;YACd,WAAW,CAAC,cAAc,CAAC;YAC3B,QAAQ;SACX,CAAC,CAAC;IACP,CAAC;IAEM,SAAS;QACZ,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAC9B,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAC7C,EAAE,CACL,CAAC;IACN,CAAC;;AAjKa,6BAAgB,GAAG,SAAS,CAAC;AAoK/C,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACjC,UAAsB,EACtB,UAAsB,EACtB,kBAA0B,EAC5B,EAAE;IACA,OAAO,CAAC,GAAQ,EAAE,KAAsB,EAAU,EAAE;QAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,eAAe,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,EAAE;YACvC,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAClD,kBAAkB,CACrB,EAAE,CAAC;gBACA,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAClC,CAAC;QACL,CAAC,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACxC,eAAe,CAAC,YAAY,CAAC,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACpD,eAAe,CAAC,MAAM,CAAC,CAAC;QACxB,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;QAEpC,OAAO,MAAM,CAAC,OAAO,CAAC;YAClB,WAAW,CAAC,UAAU,CAAC;YACvB,WAAW,CAAC,WAAW,CAAC;YACxB,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,gBAAgB;YAChE,WAAW,CAAC,eAAe,CAAC;YAC5B,IAAI,EAAE,mBAAmB;YACzB,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC;SAC9C,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,QAAoB,EAAE,EAAE;IAChE,OAAO,CAAC,GAAQ,EAAE,KAAsB,EAAU,EAAE;QAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,aAAa,CAC3B,GAAG,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,EAClC,UAAU,CACb,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CAAC;YAClB,WAAW,CAAC,SAAS,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC;SAC9C,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,QAAoB,EAAE,EAAE;IAC5D,OAAO,CAAC,GAAQ,EAAE,KAAsB,EAAU,EAAE;QAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,aAAa,CAC3B,GAAG,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,EAClC,UAAU,CACb,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CAAC;YAClB,WAAW,CAAC,cAAc,CAAC;YAC3B,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;YACtD,WAAW,CAAC,SAAS,CAAC;YACtB,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC;SAC9C,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC,CAAC"}

package/dist/partial.d.ts

@@ -0,0 +1,256 @@
+import { Ecc, Script, Signatory, UnsignedTxInput } from 'ecash-lib';
+/**
+ * "Human viable" parameters for partial Agora offers, can serve as a basis to
+ * approximate the actual Script parameters via AgoraPartial.approximateParams.
+ **/
+export interface AgoraPartialParams {
+    /**
+     * Offered tokens in base tokens. After param approximation, this may differ
+     * from `AgoraPartial`.offeredTokens(), so make sure to use that when
+     * preparing the offer!
+     *
+     * For SLP, the maximum allowed value here is 0xffffffffffffffff, for ALP it
+     * is 0xffffffffffff.
+     **/
+    offeredTokens: bigint;
+    /**
+     * Price in nano sats per (base) token.
+     * Using nsats allows users to specify a very large range of prices, from
+     * tokens where billions of them cost a single sat, to offers where single
+     * tokens can cost millions of XEC.
+     **/
+    priceNanoSatsPerToken: bigint;
+    /**
+     * Public key of the offering party.
+     * This is the public key of the wallet, and it serves both as the pubkey to
+     * cancel the offer, as well as the pubkey of the P2PKH script to send the
+     * sats to.
+     **/
+    makerPk: Uint8Array;
+    /**
+     * Minimum number of tokens that can be accepted.
+     * Can be used to avoid spam and prevent exploits with really small
+     * accept amounts.
+     * Also, small amounts can have very bad precision, and raising the minimum
+     * amount can mitigate this.
+     * It can also just be used to increase the minimum for which tokens are
+     * available.
+     * It is recommended to set this to 0.1% of the offered amount.
+     **/
+    minAcceptedTokens: bigint;
+    /** Token ID of the offered token, in big-endian hex. */
+    tokenId: string;
+    /** Token type of the offered token. */
+    tokenType: number;
+    /** Token protocol of the offered token. */
+    tokenProtocol: 'SLP' | 'ALP';
+    /** Dust amount to be used by the script. */
+    dustAmount?: number;
+    /**
+     * Minimum tokenScaleFactor when approximating numTokenTruncBytes.
+     * It is recommended to leave this at the default (1000), but it is exposed
+     * to either increase price precision and granularity of token amounts (by
+     * raising the limit), or to lower price precision but allow more fine-
+     * grained token amounts (by lowering the limit).
+     **/
+    minTokenScaleFactor?: bigint;
+    /**
+     * Minimum integer when representing the price
+     * (scaledTruncTokensPerTruncSat), the approximation will truncate
+     * additional sats bytes in order to make scaledTruncTokensPerTruncSat
+     * bigger.
+     * It is recommended to leave this at the default (1000), but it is exposed
+     * for cases where a small number of tokens are offered for a big price,
+     * this can be used to improve precision.
+     **/
+    minPriceInteger?: bigint;
+    /**
+     * Minimum ratio tokenScaleFactor / scaledTruncTokensPerTruncSat, this can
+     * be used to limit the additional truncation introduced by minPriceInteger.
+     * It is recommended to leave this at the default (1000), but it is exposed
+     * for cases where the askedSats for small accept amounts are very
+     * inaccurate.
+     **/
+    minScaleRatio?: bigint;
+}
+/**
+ * An Agora offer that can partially be accepted.
+ * In contrast to oneshot offers, these can be partially accepted, with the
+ * remainder sent back to a new UTXO with the same terms but reduced token
+ * amount.
+ * This is useful for fungible tokens, where the maker doesn't know upfront how
+ * many tokens the takers would like to acquire.
+ *
+ * The Script enforces that the taker re-creates an offer with the same terms
+ * with tokens he didn't buy.
+ * It calculates the required sats to accept the offer based on the price per
+ * token, and the number of tokens requested by the taker, and enforces the
+ * correct amount of satoshis are sent to the P2PKH of the maker of this offer.
+ *
+ * Offers can also be cancelled by the maker of the offer.
+ *
+ * One complication is the price calculation, due to eCash's limited precision
+ * and range (31-bits plus 1 sign bit) of its Script integers.
+ * We employ two strategies to increase precision and range:
+ * - "Scaling": We scale up values to the maximum representable, such that we
+ *   make full use of the 31 bits available. Values that have been scaled up
+ *   have the prefix "scaled", and the scale factor is "tokenScaleFactor". We
+ *   only scale token amounts.
+ * - "Truncation": We cut off bytes at the "end" of numbers, essentially
+ *   dividing them by 256 for each truncation, until they fit in 31 bits, so we
+ *   can use arithmetic opcodes. Later we "un-truncate" values again by adding
+ *   the bytes back. We use OP_CAT to un-truncate values, which doesn't care
+ *   about the 31-bit limit. Values that have been truncated have the "trunc"
+ *   prefix. We truncate both token amounts (by numTokenTruncBytes bytes) and
+ *   sats amounts (by numSatsTruncBytes).
+ *
+ * Scaling and truncation can be combined, such that the token price is in
+ * "scaledTruncTokensPerTruncSat".
+ * Together, they give us a very large range of representable values, while
+ * keeping a decent precision.
+ *
+ * Ideally, eCash can eventually raise the maximum integer size to e.g. 64-bits,
+ * which would greatly increase the precision. The strategies employed are
+ * useful there too, we simply get a much more accurate price calculation.
+ **/
+export declare class AgoraPartial {
+    static COVENANT_VARIANT: string;
+    /**
+     * Truncated amount that's offered.
+     * The last numTokenTruncBytes bytes are truncated to allow representing it
+     * in Script or to increase precision.
+     * This means that tokens can only be accepted at a granularity of
+     * 2^(8*numTokenTruncBytes).
+     * offeredTokens = truncTokens * 2^(8*numTokenTruncBytes).
+     **/
+    truncTokens: bigint;
+    /**
+     * How many bytes are truncated from the real token amount, so it fits into
+     * 31-bit ints, or to increase precision.
+     **/
+    numTokenTruncBytes: number;
+    /**
+     * Factor token amounts will be multiplied with in the Script to improve
+     * precision.
+     **/
+    tokenScaleFactor: bigint;
+    /**
+     * Price in scaled trunc tokens per truncated sat.
+     * This unit may seem a bit bizzare, but it is exactly what is needed in the
+     * Script calculation: The "acceptedTokens" coming from the taker is both
+     * scaled by tokenScaleFactor and also truncated by numTokenTruncBytes
+     * bytes, so we only have to divide the acceptedTokens by this number to get
+     * the required (truncated) sats. So we only have to un-truncate that and we
+     * have the asked sats.
+     **/
+    scaledTruncTokensPerTruncSat: bigint;
+    /**
+     * How many bytes are truncated from the real sats amount, so it fits into
+     * 31-bit ints or to improve precision.
+     **/
+    numSatsTruncBytes: number;
+    /**
+     * Where the sats for the tokens should go, and who can cancel the trade.
+     **/
+    makerPk: Uint8Array;
+    /**
+     * How many tokens (scaled and truncated) at minimum have to be accepted.
+     **/
+    minAcceptedScaledTruncTokens: bigint;
+    /** Token of the contract, in big-endian hex. */
+    tokenId: string;
+    /** Token type offered */
+    tokenType: number;
+    /** Token protocol of the offered token */
+    tokenProtocol: 'SLP' | 'ALP';
+    /** Byte length of the Script, after OP_CODESEPARATOR. */
+    scriptLen: number;
+    /**
+     * Dust amount of the network, the Script will enforce token outputs to have
+     * this amount.
+     **/
+    dustAmount: number;
+    constructor(params: {
+        truncTokens: bigint;
+        numTokenTruncBytes: number;
+        tokenScaleFactor: bigint;
+        scaledTruncTokensPerTruncSat: bigint;
+        numSatsTruncBytes: number;
+        makerPk: Uint8Array;
+        minAcceptedScaledTruncTokens: bigint;
+        tokenId: string;
+        tokenType: number;
+        tokenProtocol: 'SLP' | 'ALP';
+        scriptLen: number;
+        dustAmount: number;
+    });
+    /**
+     * Approximate good script parameters for the given offer params.
+     * Note: This is not guaranteed to be optimal and is done on a best-effort
+     * basis.
+     * @param params Offer params to approximate, see AgoraPartialParams for
+     *        details.
+     * @param scriptIntegerBits How many bits Script integers have on the
+     *        network. On XEC, this must be 32, but if it is raised in the
+     *        future to e.g. 64-bit integers, this can be set to 64 to greatly
+     *        increase accuracy.
+     **/
+    static approximateParams(params: AgoraPartialParams, scriptIntegerBits?: bigint): AgoraPartial;
+    updateScriptLen(): void;
+    /**
+     * How many tokens are accually offered by the Script.
+     * This may differ from the offeredTokens in the AgoraPartialParams used to
+     * approximate this AgoraPartial.
+     **/
+    offeredTokens(): bigint;
+    /**
+     * Actual minimum acceptable tokens of this Script.
+     * This may differ from the minAcceptedTokens in the AgoraPartialParams used
+     * to approximate this AgoraPartial.
+     **/
+    minAcceptedTokens(): bigint;
+    /**
+     * Calculate the actually asked satoshi amount for the given accepted number of tokens.
+     * This is the exact amount that has to be sent to makerPk's P2PKH address
+     * to accept the offer.
+     * `acceptedTokens` must have the lowest numTokenTruncBytes bytes set to 0,
+     * use prepareAcceptedTokens to do so.
+     **/
+    askedSats(acceptedTokens: bigint): bigint;
+    /**
+     * Prepare the given acceptedTokens amount for the Script; `acceptedTokens`
+     * must have the lowest numTokenTruncBytes bytes set to 0 and this function
+     * does this for us.
+     **/
+    prepareAcceptedTokens(acceptedTokens: bigint): bigint;
+    /**
+     * Calculate the actual priceNanoSatsPerToken of this offer, factoring in
+     * all approximation inacurracies.
+     * Due to the rounding, the price can change based on the accepted token
+     * amount. By default it calculates the price per token for accepting the
+     * entire offer.
+     **/
+    priceNanoSatsPerToken(acceptedTokens?: bigint): bigint;
+    adPushdata(): Uint8Array;
+    covenantConsts(): [Uint8Array, number];
+    script(): Script;
+    private _scriptBuildOpReturn;
+    private _scriptBuildSlpOpReturn;
+    private _scriptBuildAlpOpReturn;
+    private _scriptSerTruncTokens;
+    private _scriptOutro;
+    /**
+     * redeemScript of the Script advertizing this offer.
+     * It requires a setup tx followed by the actual offer, which reveals
+     * the covenantConsts.
+     * The reason we have an OP_CHECKSIGVERIFY (as opposed to just leaving it
+     * as "anyone can spend with this pushdata") is so that others on the
+     * network can't spend this UTXO (and potentially take the tokens in it),
+     * and only the maker can spend it.
+     **/
+    adScript(): Script;
+}
+export declare const AgoraPartialSignatory: (params: AgoraPartial, acceptedTruncTokens: bigint, covenantSk: Uint8Array, covenantPk: Uint8Array) => Signatory;
+export declare const AgoraPartialCancelSignatory: (makerSk: Uint8Array, tokenProtocol: 'SLP' | 'ALP') => Signatory;
+export declare const AgoraPartialAdSignatory: (makerSk: Uint8Array) => (ecc: Ecc, input: UnsignedTxInput) => Script;
+//# sourceMappingURL=partial.d.ts.map

package/dist/partial.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"partial.d.ts","sourceRoot":"","sources":["../src/partial.ts"],"names":[],"mappings":"AAIA,OAAO,EAKH,GAAG,EAsDH,MAAM,EAEN,SAAS,EAGT,eAAe,EAKlB,MAAM,WAAW,CAAC;AAGnB;;;IAGI;AACJ,MAAM,WAAW,kBAAkB;IAC/B;;;;;;;QAOI;IACJ,aAAa,EAAE,MAAM,CAAC;IACtB;;;;;QAKI;IACJ,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;;;QAKI;IACJ,OAAO,EAAE,UAAU,CAAC;IACpB;;;;;;;;;QASI;IACJ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,aAAa,EAAE,KAAK,GAAG,KAAK,CAAC;IAC7B,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;QAMI;IACJ,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;;;;QAQI;IACJ,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;QAMI;IACJ,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuCI;AACJ,qBAAa,YAAY;IACrB,OAAc,gBAAgB,SAAa;IAE3C;;;;;;;QAOI;IACG,WAAW,EAAE,MAAM,CAAC;IAC3B;;;QAGI;IACG,kBAAkB,EAAE,MAAM,CAAC;IAClC;;;QAGI;IACG,gBAAgB,EAAE,MAAM,CAAC;IAChC;;;;;;;;QAQI;IACG,4BAA4B,EAAE,MAAM,CAAC;IAC5C;;;QAGI;IACG,iBAAiB,EAAE,MAAM,CAAC;IACjC;;QAEI;IACG,OAAO,EAAE,UAAU,CAAC;IAC3B;;QAEI;IACG,4BAA4B,EAAE,MAAM,CAAC;IAC5C,gDAAgD;IACzC,OAAO,EAAE,MAAM,CAAC;IACvB,yBAAyB;IAClB,SAAS,EAAE,MAAM,CAAC;IACzB,0CAA0C;IACnC,aAAa,EAAE,KAAK,GAAG,KAAK,CAAC;IACpC,yDAAyD;IAClD,SAAS,EAAE,MAAM,CAAC;IACzB;;;QAGI;IACG,UAAU,EAAE,MAAM,CAAC;gBAEP,MAAM,EAAE;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,gBAAgB,EAAE,MAAM,CAAC;QACzB,4BAA4B,EAAE,MAAM,CAAC;QACrC,iBAAiB,EAAE,MAAM,CAAC;QAC1B,OAAO,EAAE,UAAU,CAAC;QACpB,4BAA4B,EAAE,MAAM,CAAC;QACrC,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,EAAE,KAAK,GAAG,KAAK,CAAC;QAC7B,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;KACtB;IAeD;;;;;;;;;;QAUI;WACU,iBAAiB,CAC3B,MAAM,EAAE,kBAAkB,EAC1B,iBAAiB,GAAE,MAAY,GAChC,YAAY;IAuJR,eAAe;IAStB;;;;QAII;IACG,aAAa,IAAI,MAAM;IAI9B;;;;QAII;IACG,iBAAiB,IAAI,MAAM;IAQlC;;;;;;QAMI;IACG,SAAS,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM;IAoBhD;;;;QAII;IACG,qBAAqB,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM;IAK5D;;;;;;QAMI;IACG,qBAAqB,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM;IAOtD,UAAU,IAAI,UAAU;IAsBxB,cAAc,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC;IAkCtC,MAAM,IAAI,MAAM;IAmWvB,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,uBAAuB;IAwF/B,OAAO,CAAC,uBAAuB;IAsH/B,OAAO,CAAC,qBAAqB;IAyB7B,OAAO,CAAC,YAAY;IAmBpB;;;;;;;;QAQI;IACG,QAAQ,IAAI,MAAM;CAc5B;AAiBD,eAAO,MAAM,qBAAqB,WACtB,YAAY,uBACC,MAAM,cACf,UAAU,cACV,UAAU,KACvB,SA+BF,CAAC;AAEF,eAAO,MAAM,2BAA2B,YAC3B,UAAU,iBACJ,KAAK,GAAG,KAAK,KAC7B,SAeF,CAAC;AAEF,eAAO,MAAM,uBAAuB,YAAa,UAAU,WAC1C,GAAG,SAAS,eAAe,KAAG,MAc9C,CAAC"}