@atomicfinance/bitcoin-dlc-provider 4.2.8 → 4.3.1

package/.yalc/@node-dlc/core/dist/lightning/CommitmentNumber.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitmentNumber = void 0;
+const bitcoin_1 = require("@node-dlc/bitcoin");
+const bufio_1 = require("@node-dlc/bufio");
+const crypto_1 = require("@node-dlc/crypto");
+class CommitmentNumber {
+    /**
+     * Using the obscured commitment number, creates a Sequence with
+     * the upper byte set to 0x80 and the lower three bytes set to the
+     * upper 3 bytes of the 48-bit commitment number.
+     *
+     * The upper most byte is set to 0x80 so that the relative lock time
+     * is disabled.
+     *
+     * @param commitment commitment number to obscure
+     */
+    static getSequence(obscurred) {
+        return new bitcoin_1.Sequence(Number((BigInt(0x80) << BigInt(24)) | (obscurred >> BigInt(24))));
+    }
+    /**
+     * Using the obscured commitment number, creates a LockTime with
+     * the upper byte set to 0x20 and the lower three bytes set to the
+     * lower 3 bytes of the 48-bit commitment number.
+     *
+     * The uppermost byte is set to 0x20 so the LockTime uses a time
+     * based absolute locktime that has already expired.
+     *
+     * @param obscurred obscurred commitment number
+     */
+    static getLockTime(obscurred) {
+        return new bitcoin_1.LockTime(Number((BigInt(0x20) << BigInt(24)) | (obscurred & BigInt(0xffffff))));
+    }
+    /**
+     * Reveals the commitment number provided by the nSequence and
+     * nLockTime values. This function reverses the obscurring using the
+     * known payment base points.
+     *
+     * @param locktime
+     * @param sequence
+     */
+    static reveal(locktime, sequence, openBasePoint, acceptBasePoint) {
+        const hash = CommitmentNumber.getHash(openBasePoint, acceptBasePoint);
+        const upper = BigInt(sequence.value & 0xffffff) << BigInt(24);
+        const lower = BigInt(locktime.value & 0xffffff);
+        return Number(hash ^ (upper | lower));
+    }
+    /**
+     * Defined in BOLT3, the obscurred commitment number is attached to the
+     * commitment transaction. The 48-bit commitment number is broken into
+     * two pieces, the lower 3-bytes are obscured in nLocketime and the
+     * upper 3-bytes are obscured in the funding input's nSequence.
+     *
+     * The obscurred commitment number is calculated as the:
+     * sha256(open_channel payment_basepoint || accept_channel payment_basepoint) ^ commitment_number
+     * @param commitment
+     * @param openBasePoint
+     * @param acceptBasePoint
+     */
+    static obscure(commitment, openBasePoint, acceptBasePoint) {
+        return (CommitmentNumber.getHash(openBasePoint, acceptBasePoint) ^
+            BigInt(commitment));
+    }
+    /**
+     * Obtains the lower 6-bytes from the sha256 of the open_channel
+     * basepoint and the accept_channel basepoint.
+     * @param openBasePoint
+     * @param acceptBasePoint
+     */
+    static getHash(openBasePoint, acceptBasePoint) {
+        const hash = (0, crypto_1.sha256)(Buffer.concat([openBasePoint, acceptBasePoint]));
+        return (0, bufio_1.bigFromBufBE)(hash.slice(hash.length - 6));
+    }
+}
+exports.CommitmentNumber = CommitmentNumber;
+//# sourceMappingURL=CommitmentNumber.js.map

package/.yalc/@node-dlc/core/dist/lightning/CommitmentNumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommitmentNumber.js","sourceRoot":"","sources":["../../lib/lightning/CommitmentNumber.ts"],"names":[],"mappings":";;;AAAA,+CAAuD;AACvD,2CAA+C;AAC/C,6CAA0C;AAE1C,MAAa,gBAAgB;IAC3B;;;;;;;;;OASG;IACI,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,IAAI,kBAAQ,CACjB,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CACjE,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,IAAI,kBAAQ,CACjB,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAClB,QAAkB,EAClB,QAAkB,EAClB,aAAqB,EACrB,eAAuB;QAEvB,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QACtE,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC;QAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAC;QAChD,OAAO,MAAM,CAAC,IAAI,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,OAAO,CACnB,UAAkB,EAClB,aAAqB,EACrB,eAAuB;QAEvB,OAAO,CACL,gBAAgB,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC;YACxD,MAAM,CAAC,UAAU,CAAC,CACnB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,OAAO,CACpB,aAAqB,EACrB,eAAuB;QAEvB,MAAM,IAAI,GAAG,IAAA,eAAM,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,IAAA,oBAAY,EAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;CACF;AAzFD,4CAyFC"}

package/.yalc/@node-dlc/core/dist/lightning/CommitmentSecret.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+export declare class CommitmentSecret {
+    /**
+     * Generic version of commitment secret generator as defined in
+     * BOLT3.
+     *
+     * This function works by decrementing from bits to 0. If the index
+     * number has the corresponding bit set, it flips the bit in the
+     * secret and hashes it.
+     *
+     * The natural conclusion is the first secret flips every bit and
+     * the last secret flips zero (and is thus the seed).
+     *
+     * This function can be used for generate the local per-commitment
+     * secret based on the per-commitment seed and a commitment index
+     * (in this case it) generates all 48 bits.
+     *
+     * This function can also be used to generate prior commitment
+     * secrets from a newer secret, which acts as a prefix.
+     *
+     * @param base base secret that will be used to derive from
+     * @param i secret at index I to generate
+     * @param bits bits to evaluate, default is 48
+     */
+    static derive(base: Buffer, i: bigint, bits?: number): Buffer;
+}

package/.yalc/@node-dlc/core/dist/lightning/CommitmentSecret.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitmentSecret = void 0;
+const crypto_1 = require("@node-dlc/crypto");
+class CommitmentSecret {
+    /**
+     * Generic version of commitment secret generator as defined in
+     * BOLT3.
+     *
+     * This function works by decrementing from bits to 0. If the index
+     * number has the corresponding bit set, it flips the bit in the
+     * secret and hashes it.
+     *
+     * The natural conclusion is the first secret flips every bit and
+     * the last secret flips zero (and is thus the seed).
+     *
+     * This function can be used for generate the local per-commitment
+     * secret based on the per-commitment seed and a commitment index
+     * (in this case it) generates all 48 bits.
+     *
+     * This function can also be used to generate prior commitment
+     * secrets from a newer secret, which acts as a prefix.
+     *
+     * @param base base secret that will be used to derive from
+     * @param i secret at index I to generate
+     * @param bits bits to evaluate, default is 48
+     */
+    static derive(base, i, bits = 48) {
+        // intii
+        let p = Buffer.from(base);
+        for (let b = bits - 1; b >= 0; b--) {
+            if (i & (BigInt(1) << BigInt(b))) {
+                // flip the specified bit in the specific byte
+                const byteIndex = Math.floor(b / 8);
+                const bitIndex = b % 8;
+                p[byteIndex] = p[byteIndex] ^ (1 << bitIndex);
+                p = (0, crypto_1.sha256)(p);
+            }
+        }
+        return p;
+    }
+}
+exports.CommitmentSecret = CommitmentSecret;
+//# sourceMappingURL=CommitmentSecret.js.map

package/.yalc/@node-dlc/core/dist/lightning/CommitmentSecret.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommitmentSecret.js","sourceRoot":"","sources":["../../lib/lightning/CommitmentSecret.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAE1C,MAAa,gBAAgB;IAC3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,CAAS,EAAE,IAAI,GAAG,EAAE;QACrD,QAAQ;QACR,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1B,KAAK,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAClC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;gBAChC,8CAA8C;gBAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpC,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,CAAC;gBACvB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC;gBAC9C,CAAC,GAAG,IAAA,eAAM,EAAC,CAAC,CAAC,CAAC;aACf;SACF;QACD,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AAtCD,4CAsCC"}

package/.yalc/@node-dlc/core/dist/lightning/CommitmentSecretStore.d.ts

@@ -0,0 +1,41 @@
+/// <reference types="node" />
+export type CommitmentSecretStoreItem = {
+    index: bigint;
+    secret: Buffer;
+};
+/**
+ * Defined in BOLT3, this class compactly stored received commitment
+ * secrets from our counterparty. Without this mechanism we are required
+ * to store every commitment secret that we receive (2^48) which can be
+ * a huge amount of data at 32-bytes per secret.
+ *
+ * Instead we can use the fact that later commitment secrets act as
+ * prefixes for prior commitment secrets. We can then compactly store
+ * only the secrets we need to derive older commitment secrets.
+ */
+export declare class CommitmentSecretStore {
+    /**
+     * Returns the index of the least-significant bit. This is used to
+     * determine what the value at I is a prefix for.
+     * @param I commitment
+     */
+    static calcIndex(I: bigint): number;
+    private secrets;
+    constructor();
+    /**
+     * Insert the commitment secret into the store and verify that the
+     * secret is able to derive all prior commitment secrets that we
+     * already know about.
+     *
+     * @param secret 32-byte secp256k1 secret
+     * @param i commitment number
+     */
+    insert(secret: Buffer, i: bigint): void;
+    /**
+     * Derives old commitment secrets from the from the compact store.
+     * Throws if we do not have the commitment secret for the specified
+     * commitment nmber.
+     * @param i derivation number starting at 2^48-1 down to zero.
+     */
+    derive(i: bigint): Buffer;
+}

package/.yalc/@node-dlc/core/dist/lightning/CommitmentSecretStore.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitmentSecretStore = void 0;
+const CommitmentSecret_1 = require("./CommitmentSecret");
+/**
+ * Defined in BOLT3, this class compactly stored received commitment
+ * secrets from our counterparty. Without this mechanism we are required
+ * to store every commitment secret that we receive (2^48) which can be
+ * a huge amount of data at 32-bytes per secret.
+ *
+ * Instead we can use the fact that later commitment secrets act as
+ * prefixes for prior commitment secrets. We can then compactly store
+ * only the secrets we need to derive older commitment secrets.
+ */
+class CommitmentSecretStore {
+    /**
+     * Returns the index of the least-significant bit. This is used to
+     * determine what the value at I is a prefix for.
+     * @param I commitment
+     */
+    static calcIndex(I) {
+        for (let i = BigInt(0); i < BigInt(48); i++) {
+            if (I & (BigInt(1) << i))
+                return Number(i);
+        }
+        return 48; // seed
+    }
+    constructor() {
+        this.secrets = new Array(49);
+        for (let i = 0; i < this.secrets.length; i++) {
+            this.secrets[i] = { index: BigInt(0), secret: undefined };
+        }
+    }
+    /**
+     * Insert the commitment secret into the store and verify that the
+     * secret is able to derive all prior commitment secrets that we
+     * already know about.
+     *
+     * @param secret 32-byte secp256k1 secret
+     * @param i commitment number
+     */
+    insert(secret, i) {
+        const B = CommitmentSecretStore.calcIndex(i);
+        // validate that the new secret allows derivation of known keys
+        // up to the new key
+        for (let b = 0; b < B; b++) {
+            const existing = this.secrets[b].secret;
+            const derived = CommitmentSecret_1.CommitmentSecret.derive(secret, this.secrets[b].index, B);
+            if (!derived.equals(existing)) {
+                throw new Error('The secret for I is incorrect');
+            }
+        }
+        // update the position
+        this.secrets[Number(B)].index = i;
+        this.secrets[Number(B)].secret = secret;
+    }
+    /**
+     * Derives old commitment secrets from the from the compact store.
+     * Throws if we do not have the commitment secret for the specified
+     * commitment nmber.
+     * @param i derivation number starting at 2^48-1 down to zero.
+     */
+    derive(i) {
+        for (let b = 0; b < this.secrets.length; b++) {
+            // construct a mask of the upper bits. Basically we lop off
+            // the lower b bits and then right-shift back into place
+            const mask = (BigInt(0xffffffffffff) >> BigInt(b)) << BigInt(b);
+            // Check if the prefix found using I & mask is one that we
+            // can use to derive our value. If not, we need to try
+            // another bit.
+            if ((i & mask) === this.secrets[b].index && this.secrets[b].secret) {
+                return CommitmentSecret_1.CommitmentSecret.derive(this.secrets[b].secret, i, b);
+            }
+        }
+        throw new Error("Index I hasn't been received yet");
+    }
+}
+exports.CommitmentSecretStore = CommitmentSecretStore;
+//# sourceMappingURL=CommitmentSecretStore.js.map

package/.yalc/@node-dlc/core/dist/lightning/CommitmentSecretStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommitmentSecretStore.js","sourceRoot":"","sources":["../../lib/lightning/CommitmentSecretStore.ts"],"names":[],"mappings":";;;AAAA,yDAAsD;AAItD;;;;;;;;;GASG;AACH,MAAa,qBAAqB;IAChC;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,CAAS;QAC/B,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;YAC3C,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAAE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;SAC5C;QACD,OAAO,EAAE,CAAC,CAAC,OAAO;IACpB,CAAC;IAID;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,KAAK,CAAC,EAAE,CAAgC,CAAC;QAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5C,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SAC3D;IACH,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAc,EAAE,CAAS;QACrC,MAAM,CAAC,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAE7C,+DAA+D;QAC/D,oBAAoB;QACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YACxC,MAAM,OAAO,GAAG,mCAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC1E,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;gBAC7B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;aAClD;SACF;QAED,sBAAsB;QACtB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,CAAS;QACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5C,2DAA2D;YAC3D,wDAAwD;YACxD,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YAEhE,0DAA0D;YAC1D,sDAAsD;YACtD,eAAe;YACf,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;gBAClE,OAAO,mCAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;aAC9D;SACF;QACD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,CAAC;CACF;AArED,sDAqEC"}

package/.yalc/@node-dlc/core/dist/lightning/Htlc.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="node" />
+import { Value } from '@node-dlc/bitcoin';
+import { HtlcDirection } from './HtlcDirection';
+/**
+ * An HTLC (hashed time-locked contract) is part of the transfer
+ * layer of the Lightning network. HTLCs are used to trustlessly offer
+ * a payment to a counterparty if they are able to provide a preimage
+ * of the hash. The offeror can claw back funds after an expiration
+ * period (absolute lock time) if the recipient is unable to provide
+ * the preimage for the contract. HTLCs are used in Lightning for both
+ * initiating payments to a peer directly and as part of forwarding
+ * payments.
+ */
+export declare class Htlc {
+    readonly htlcId: bigint;
+    readonly direction: HtlcDirection;
+    readonly value: Value;
+    readonly cltvExpiry: number;
+    readonly paymentHash: Buffer;
+    /**
+     * The preimage of the payment hash using SHA256.
+     */
+    paymentPreimage: Buffer;
+    /**
+     * Constructs an HTLC with associated information
+     * @param htlcId Identifier for the HTLC is a counter maintained
+     * per-channel, per-peer. It starts at zero and is incremented when
+     * an HTLC is offered. This value is used when sending channel
+     * related messages to disambiguate HTLCs that may share the same
+     * preimage.
+     *
+     * @param direction Direction, from your node's perspective, that
+     * indicates if the HTLC was offered or received.
+     *
+     * @param value The value of the HTLC in millisatoshi.
+     *
+     * @param cltvExpiry The absolutely blocktime expiry of the HTLC.
+     * The value must be under 500,000,000 to ensure it is a block-based
+     * locktime. After this timeout has expired, the offeror can perform
+     * a forced resolution on-chain.
+     *
+     * @param paymentHash The 32-byte hash of the preimage. Knowledge of
+     * the preimage is irrevocable and considers payment complete.
+     */
+    constructor(htlcId: bigint, direction: HtlcDirection, value: Value, cltvExpiry: number, paymentHash: Buffer, paymentPreimage?: Buffer);
+}

package/.yalc/@node-dlc/core/dist/lightning/Htlc.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Htlc = void 0;
+/**
+ * An HTLC (hashed time-locked contract) is part of the transfer
+ * layer of the Lightning network. HTLCs are used to trustlessly offer
+ * a payment to a counterparty if they are able to provide a preimage
+ * of the hash. The offeror can claw back funds after an expiration
+ * period (absolute lock time) if the recipient is unable to provide
+ * the preimage for the contract. HTLCs are used in Lightning for both
+ * initiating payments to a peer directly and as part of forwarding
+ * payments.
+ */
+class Htlc {
+    /**
+     * Constructs an HTLC with associated information
+     * @param htlcId Identifier for the HTLC is a counter maintained
+     * per-channel, per-peer. It starts at zero and is incremented when
+     * an HTLC is offered. This value is used when sending channel
+     * related messages to disambiguate HTLCs that may share the same
+     * preimage.
+     *
+     * @param direction Direction, from your node's perspective, that
+     * indicates if the HTLC was offered or received.
+     *
+     * @param value The value of the HTLC in millisatoshi.
+     *
+     * @param cltvExpiry The absolutely blocktime expiry of the HTLC.
+     * The value must be under 500,000,000 to ensure it is a block-based
+     * locktime. After this timeout has expired, the offeror can perform
+     * a forced resolution on-chain.
+     *
+     * @param paymentHash The 32-byte hash of the preimage. Knowledge of
+     * the preimage is irrevocable and considers payment complete.
+     */
+    constructor(htlcId, direction, value, cltvExpiry, paymentHash, paymentPreimage) {
+        this.htlcId = htlcId;
+        this.direction = direction;
+        this.value = value;
+        this.cltvExpiry = cltvExpiry;
+        this.paymentHash = paymentHash;
+        this.paymentPreimage = paymentPreimage;
+    }
+}
+exports.Htlc = Htlc;
+//# sourceMappingURL=Htlc.js.map

package/.yalc/@node-dlc/core/dist/lightning/Htlc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Htlc.js","sourceRoot":"","sources":["../../lib/lightning/Htlc.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;;GASG;AACH,MAAa,IAAI;IAMf;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YACW,MAAc,EACd,SAAwB,EACxB,KAAY,EACZ,UAAkB,EAClB,WAAmB,EAC5B,eAAwB;QALf,WAAM,GAAN,MAAM,CAAQ;QACd,cAAS,GAAT,SAAS,CAAe;QACxB,UAAK,GAAL,KAAK,CAAO;QACZ,eAAU,GAAV,UAAU,CAAQ;QAClB,gBAAW,GAAX,WAAW,CAAQ;QAG5B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;CACF;AArCD,oBAqCC"}

package/.yalc/@node-dlc/core/dist/lightning/HtlcDirection.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Direction, from our node's perspective, of an HTLC.
+ */
+export declare enum HtlcDirection {
+    /**
+     * We have offered this HTLC to pay a node directly or on behalf
+     * of a forward request.
+     */
+    Offered = 0,
+    /**
+     * We have accepted this HTLC from the counterparty. We may be the
+     * final hop in a chain (and would posssess) the preimage or we may
+     * be a processing hop in a sequence of payments.
+     */
+    Accepted = 1
+}

package/.yalc/@node-dlc/core/dist/lightning/HtlcDirection.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtlcDirection = void 0;
+/**
+ * Direction, from our node's perspective, of an HTLC.
+ */
+var HtlcDirection;
+(function (HtlcDirection) {
+    /**
+     * We have offered this HTLC to pay a node directly or on behalf
+     * of a forward request.
+     */
+    HtlcDirection[HtlcDirection["Offered"] = 0] = "Offered";
+    /**
+     * We have accepted this HTLC from the counterparty. We may be the
+     * final hop in a chain (and would posssess) the preimage or we may
+     * be a processing hop in a sequence of payments.
+     */
+    HtlcDirection[HtlcDirection["Accepted"] = 1] = "Accepted";
+})(HtlcDirection = exports.HtlcDirection || (exports.HtlcDirection = {}));
+//# sourceMappingURL=HtlcDirection.js.map

package/.yalc/@node-dlc/core/dist/lightning/HtlcDirection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HtlcDirection.js","sourceRoot":"","sources":["../../lib/lightning/HtlcDirection.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB;;;OAGG;IACH,uDAAW,CAAA;IAEX;;;;OAIG;IACH,yDAAY,CAAA;AACd,CAAC,EAbW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAaxB"}

package/.yalc/@node-dlc/core/dist/lightning/ScriptFactory.d.ts

@@ -0,0 +1,76 @@
+/// <reference types="node" />
+import { Script } from '@node-dlc/bitcoin';
+export declare class ScriptFactory {
+    /**
+     * Constructs the P2MS commit script used in in the funding transaction
+     * as defined in BOLT3. The pubkeys must be sorted in lexicographical
+     * order.
+     *
+     * @param openPubKey funding_pubkey sent in open_channel
+     * @param acceptPubKey funding_pubkey sent in accept_channel
+     */
+    static fundingScript(openPubKey: Buffer, acceptPubKey: Buffer): Script;
+    /**
+     * Constructs an revocable sequence maturing contract using the
+     * provided keys and delay. This script is used in the `to_local`
+     * output of the commmitment transaction as well as the secondary
+     * HTLC-Success and HTLC-Timeout transactions.
+     *
+     * @param revocationPubKey the revocation pubkey that has the ability
+     * to perform a penalty transaction should a revoked version of this
+     * output be spend.
+     * @param delayedPubKey the delayed pubkey spendable after the
+     * sequence delay
+     * @param toSelfDelay the sequence delay in blocks
+     */
+    static toLocalScript(revocationPubKey: Buffer, delayedPubKey: Buffer, toSelfDelay: number): Script;
+    /**
+     * Constructs the script for an offered HTLC output of a  commitment
+     * transaction as defined in BOLT3. This enables on-chain resolution
+     * of an HTLC to the local node via the secondary HTLC-Timeout
+     * transaction. This secondary transaction is both sequence delayed
+     * and timelocked and requires signatures by both parties to prevent
+     * premature spending. The remote node can immediately resolve the
+     * transaction wit knowledge of the preimage.
+     *
+     * Revocable with witness:
+     * [revocationSig, revocationPubKey]
+     *
+     * Pay to local via the HTLC-Timeout transaction by using witness
+     * [0, remoteHtlcSig, localHtlcSig, <>]
+     *
+     * Pay to remote counterparty without delay using witness
+     * [remoteHtlcSig, preimage]
+     *
+     * @param paymentHash
+     * @param revocationPubKey
+     * @param localHtlcPubKey
+     * @param remoteHtlcPubKey
+     */
+    static offeredHtlcScript(paymentHash: Buffer, revocationPubKey: Buffer, localHtlcPubKey: Buffer, remoteHtlcPubKey: Buffer): Script;
+    /**
+     * Constructs the script for a received HTLC output of a commitment
+     * transaction as defined in BOLT3. This enables on-chain resolution
+     * of an HTLC to the local node via the secondary HTLC-Success
+     * transaction. This secondary transaction is sequence delayed and
+     * thus local spends require both parties signatures. The remote
+     * node can perform a timeout of this output after the timelock
+     * expires.
+     *
+     * Revocable with witness:
+     * [revocationSig, revocationPubKey]
+     *
+     * Pay to local via the HTLC-Success transaction by using witness
+     * [0, remoteHtlcSig, localHtlcSig, preimage]
+     *
+     * Pay to remote counterparty after the CLTV expiry using witness
+     * [remoteHtlcSig, <>]
+     *
+     * @param paymentHash
+     * @param cltvExpiry
+     * @param revocationPubKey
+     * @param localHtlcPubKey
+     * @param remoteHtlcPubKey
+     */
+    static receivedHtlcScript(paymentHash: Buffer, cltvExpiry: number, revocationPubKey: Buffer, localHtlcPubKey: Buffer, remoteHtlcPubKey: Buffer): Script;
+}

package/.yalc/@node-dlc/core/dist/lightning/ScriptFactory.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScriptFactory = void 0;
+const bitcoin_1 = require("@node-dlc/bitcoin");
+const crypto_1 = require("@node-dlc/crypto");
+class ScriptFactory {
+    /**
+     * Constructs the P2MS commit script used in in the funding transaction
+     * as defined in BOLT3. The pubkeys must be sorted in lexicographical
+     * order.
+     *
+     * @param openPubKey funding_pubkey sent in open_channel
+     * @param acceptPubKey funding_pubkey sent in accept_channel
+     */
+    static fundingScript(openPubKey, acceptPubKey) {
+        const pubkeys = [openPubKey, acceptPubKey].sort((a, b) => a.compare(b));
+        return bitcoin_1.Script.p2msLock(2, ...pubkeys);
+    }
+    /**
+     * Constructs an revocable sequence maturing contract using the
+     * provided keys and delay. This script is used in the `to_local`
+     * output of the commmitment transaction as well as the secondary
+     * HTLC-Success and HTLC-Timeout transactions.
+     *
+     * @param revocationPubKey the revocation pubkey that has the ability
+     * to perform a penalty transaction should a revoked version of this
+     * output be spend.
+     * @param delayedPubKey the delayed pubkey spendable after the
+     * sequence delay
+     * @param toSelfDelay the sequence delay in blocks
+     */
+    static toLocalScript(revocationPubKey, delayedPubKey, toSelfDelay) {
+        return new bitcoin_1.Script(bitcoin_1.OpCode.OP_IF, revocationPubKey, bitcoin_1.OpCode.OP_ELSE, bitcoin_1.Script.number(toSelfDelay), bitcoin_1.OpCode.OP_CHECKSEQUENCEVERIFY, bitcoin_1.OpCode.OP_DROP, delayedPubKey, bitcoin_1.OpCode.OP_ENDIF, bitcoin_1.OpCode.OP_CHECKSIG); // prettier-ignore
+    }
+    /**
+     * Constructs the script for an offered HTLC output of a  commitment
+     * transaction as defined in BOLT3. This enables on-chain resolution
+     * of an HTLC to the local node via the secondary HTLC-Timeout
+     * transaction. This secondary transaction is both sequence delayed
+     * and timelocked and requires signatures by both parties to prevent
+     * premature spending. The remote node can immediately resolve the
+     * transaction wit knowledge of the preimage.
+     *
+     * Revocable with witness:
+     * [revocationSig, revocationPubKey]
+     *
+     * Pay to local via the HTLC-Timeout transaction by using witness
+     * [0, remoteHtlcSig, localHtlcSig, <>]
+     *
+     * Pay to remote counterparty without delay using witness
+     * [remoteHtlcSig, preimage]
+     *
+     * @param paymentHash
+     * @param revocationPubKey
+     * @param localHtlcPubKey
+     * @param remoteHtlcPubKey
+     */
+    static offeredHtlcScript(paymentHash, revocationPubKey, localHtlcPubKey, remoteHtlcPubKey) {
+        return new bitcoin_1.Script(
+        // to remote with revocation key
+        bitcoin_1.OpCode.OP_DUP, bitcoin_1.OpCode.OP_HASH160, (0, crypto_1.hash160)(revocationPubKey), bitcoin_1.OpCode.OP_EQUAL, bitcoin_1.OpCode.OP_IF, bitcoin_1.OpCode.OP_CHECKSIG, bitcoin_1.OpCode.OP_ELSE, remoteHtlcPubKey, bitcoin_1.OpCode.OP_SWAP, bitcoin_1.OpCode.OP_SIZE, bitcoin_1.Script.number(32), bitcoin_1.OpCode.OP_EQUAL, bitcoin_1.OpCode.OP_NOTIF, 
+        // to local via HTLC-Timeout transaction (timelocked)
+        bitcoin_1.OpCode.OP_DROP, bitcoin_1.OpCode.OP_2, bitcoin_1.OpCode.OP_SWAP, localHtlcPubKey, bitcoin_1.OpCode.OP_2, bitcoin_1.OpCode.OP_CHECKMULTISIG, bitcoin_1.OpCode.OP_ELSE, 
+        // to remote with preimage and signature
+        bitcoin_1.OpCode.OP_HASH160, (0, crypto_1.ripemd160)(paymentHash), bitcoin_1.OpCode.OP_EQUALVERIFY, bitcoin_1.OpCode.OP_CHECKSIG, bitcoin_1.OpCode.OP_ENDIF, bitcoin_1.OpCode.OP_ENDIF); // prettier-ignore
+    }
+    /**
+     * Constructs the script for a received HTLC output of a commitment
+     * transaction as defined in BOLT3. This enables on-chain resolution
+     * of an HTLC to the local node via the secondary HTLC-Success
+     * transaction. This secondary transaction is sequence delayed and
+     * thus local spends require both parties signatures. The remote
+     * node can perform a timeout of this output after the timelock
+     * expires.
+     *
+     * Revocable with witness:
+     * [revocationSig, revocationPubKey]
+     *
+     * Pay to local via the HTLC-Success transaction by using witness
+     * [0, remoteHtlcSig, localHtlcSig, preimage]
+     *
+     * Pay to remote counterparty after the CLTV expiry using witness
+     * [remoteHtlcSig, <>]
+     *
+     * @param paymentHash
+     * @param cltvExpiry
+     * @param revocationPubKey
+     * @param localHtlcPubKey
+     * @param remoteHtlcPubKey
+     */
+    static receivedHtlcScript(paymentHash, cltvExpiry, revocationPubKey, localHtlcPubKey, remoteHtlcPubKey) {
+        return new bitcoin_1.Script(
+        // to remote with revocation key
+        bitcoin_1.OpCode.OP_DUP, bitcoin_1.OpCode.OP_HASH160, (0, crypto_1.hash160)(revocationPubKey), bitcoin_1.OpCode.OP_EQUAL, bitcoin_1.OpCode.OP_IF, bitcoin_1.OpCode.OP_CHECKSIG, bitcoin_1.OpCode.OP_ELSE, remoteHtlcPubKey, bitcoin_1.OpCode.OP_SWAP, bitcoin_1.OpCode.OP_SIZE, bitcoin_1.Script.number(32), bitcoin_1.OpCode.OP_EQUAL, bitcoin_1.OpCode.OP_IF, 
+        // to local via HTLC-Success transaction
+        bitcoin_1.OpCode.OP_HASH160, (0, crypto_1.ripemd160)(paymentHash), bitcoin_1.OpCode.OP_EQUALVERIFY, bitcoin_1.OpCode.OP_2, bitcoin_1.OpCode.OP_SWAP, localHtlcPubKey, bitcoin_1.OpCode.OP_2, bitcoin_1.OpCode.OP_CHECKMULTISIG, bitcoin_1.OpCode.OP_ELSE, 
+        // to remote after cltv expiry with signature
+        bitcoin_1.OpCode.OP_DROP, bitcoin_1.Script.number(cltvExpiry), bitcoin_1.OpCode.OP_CHECKLOCKTIMEVERIFY, bitcoin_1.OpCode.OP_DROP, bitcoin_1.OpCode.OP_CHECKSIG, bitcoin_1.OpCode.OP_ENDIF, bitcoin_1.OpCode.OP_ENDIF); // prettier-ignore
+    }
+}
+exports.ScriptFactory = ScriptFactory;
+//# sourceMappingURL=ScriptFactory.js.map

package/.yalc/@node-dlc/core/dist/lightning/ScriptFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScriptFactory.js","sourceRoot":"","sources":["../../lib/lightning/ScriptFactory.ts"],"names":[],"mappings":";;;AAAA,+CAAmD;AACnD,6CAAsD;AAEtD,MAAa,aAAa;IACxB;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CACzB,UAAkB,EAClB,YAAoB;QAEpB,MAAM,OAAO,GAAG,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACxE,OAAO,gBAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,aAAa,CACzB,gBAAwB,EACxB,aAAqB,EACrB,WAAmB;QAEnB,OAAO,IAAI,gBAAM,CACT,gBAAM,CAAC,KAAK,EACR,gBAAgB,EACpB,gBAAM,CAAC,OAAO,EACV,gBAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAC1B,gBAAM,CAAC,sBAAsB,EAC7B,gBAAM,CAAC,OAAO,EACd,aAAa,EACjB,gBAAM,CAAC,QAAQ,EACf,gBAAM,CAAC,WAAW,CACrB,CAAC,CAAC,kBAAkB;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,MAAM,CAAC,iBAAiB,CAC7B,WAAmB,EACnB,gBAAwB,EACxB,eAAuB,EACvB,gBAAwB;QAExB,OAAO,IAAI,gBAAM;QACT,gCAAgC;QAChC,gBAAM,CAAC,MAAM,EAAE,gBAAM,CAAC,UAAU,EAAE,IAAA,gBAAO,EAAC,gBAAgB,CAAC,EAAE,gBAAM,CAAC,QAAQ,EAC5E,gBAAM,CAAC,KAAK,EACR,gBAAM,CAAC,WAAW,EACtB,gBAAM,CAAC,OAAO,EACV,gBAAgB,EAAE,gBAAM,CAAC,OAAO,EAAE,gBAAM,CAAC,OAAO,EAAE,gBAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,gBAAM,CAAC,QAAQ,EACpF,gBAAM,CAAC,QAAQ;QACX,qDAAqD;QACrD,gBAAM,CAAC,OAAO,EAAE,gBAAM,CAAC,IAAI,EAAE,gBAAM,CAAC,OAAO,EAAE,eAAe,EAAE,gBAAM,CAAC,IAAI,EAAE,gBAAM,CAAC,gBAAgB,EACtG,gBAAM,CAAC,OAAO;QACV,wCAAwC;QACxC,gBAAM,CAAC,UAAU,EAAE,IAAA,kBAAS,EAAC,WAAW,CAAC,EAAE,gBAAM,CAAC,cAAc,EAChE,gBAAM,CAAC,WAAW,EACtB,gBAAM,CAAC,QAAQ,EACnB,gBAAM,CAAC,QAAQ,CAClB,CAAC,CAAC,kBAAkB;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,MAAM,CAAC,kBAAkB,CAC9B,WAAmB,EACnB,UAAkB,EAClB,gBAAwB,EACxB,eAAuB,EACvB,gBAAwB;QAExB,OAAO,IAAI,gBAAM;QACT,gCAAgC;QAChC,gBAAM,CAAC,MAAM,EAAE,gBAAM,CAAC,UAAU,EAAE,IAAA,gBAAO,EAAC,gBAAgB,CAAC,EAAE,gBAAM,CAAC,QAAQ,EAC5E,gBAAM,CAAC,KAAK,EACR,gBAAM,CAAC,WAAW,EACtB,gBAAM,CAAC,OAAO,EACV,gBAAgB,EAAE,gBAAM,CAAC,OAAO,EAAE,gBAAM,CAAC,OAAO,EAAE,gBAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,gBAAM,CAAC,QAAQ,EACpF,gBAAM,CAAC,KAAK;QACR,wCAAwC;QACxC,gBAAM,CAAC,UAAU,EAAE,IAAA,kBAAS,EAAC,WAAW,CAAC,EAAE,gBAAM,CAAC,cAAc,EAChE,gBAAM,CAAC,IAAI,EAAE,gBAAM,CAAC,OAAO,EAAE,eAAe,EAAE,gBAAM,CAAC,IAAI,EAAE,gBAAM,CAAC,gBAAgB,EACtF,gBAAM,CAAC,OAAO;QACV,6CAA6C;QAC7C,gBAAM,CAAC,OAAO,EAAE,gBAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,gBAAM,CAAC,sBAAsB,EAAE,gBAAM,CAAC,OAAO,EACxF,gBAAM,CAAC,WAAW,EACtB,gBAAM,CAAC,QAAQ,EACnB,gBAAM,CAAC,QAAQ,CAClB,CAAC,CAAC,kBAAkB;IAC3B,CAAC;CACF;AAlJD,sCAkJC"}