@atomicfinance/types 4.0.0 → 4.0.2

package/lib/models/Amount.ts

@@ -61,7 +61,9 @@ export default class Amount {
   }
 
   static fromJSON(json: AmountJSON): Amount {
-    if (!json) return;
+    if (!json) {
+      return Amount.FromSatoshis(0);
+    }
     const amount = Object.create(Amount.prototype);
     return Object.assign(amount, json, {
       _satoshis: json._satoshis,
@@ -69,6 +71,7 @@ export default class Amount {
     });
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   static reviver(key: string, value: any): any {
     return key === '' ? Amount.fromJSON(value) : value;
   }

package/lib/models/Input.ts

@@ -2,6 +2,24 @@ import * as bT from '../bitcoin';
 import Amount from './Amount';
 import Utxo from './Utxo';
 
+/**
+ * Input supplementation modes for DLC operations
+ */
+export enum InputSupplementationMode {
+  None = 'none', // Use exactly these inputs, no supplementation
+  Optional = 'optional', // Try to supplement, fallback if fails
+  Required = 'required', // Must supplement or throw error
+}
+
+/**
+ * DLC-specific input information for splice transactions
+ */
+export interface DlcInputInfo {
+  localFundPubkey: string;
+  remoteFundPubkey: string;
+  contractId: string;
+}
+
 /**
  * Class for interfacing with inputs/utxos in Liquality Chainify
  * https://github.com/liquality/chainify
@@ -15,6 +33,8 @@ import Utxo from './Utxo';
  * https://github.com/liquality/chainify/tree/typescript
  * satoshis and amount will not be necessary, only value
  * https://github.com/liquality/chainify/blob/typescript/packages/types/lib/bitcoin.ts#L46
+ *
+ * Extended to support DLC inputs for splice transactions.
  */
 export default class Input {
   constructor(
@@ -33,6 +53,7 @@ export default class Input {
     readonly spendable?: boolean,
     readonly solvable?: boolean,
     readonly safe?: boolean,
+    readonly dlcInput?: DlcInputInfo, // DLC-specific information for splice transactions
   ) {}
 
   toUtxo(): Utxo {
@@ -41,6 +62,8 @@ export default class Input {
       amount = Amount.FromSatoshis(this.value);
     } else if (this.amount) {
       amount = Amount.FromBitcoin(this.amount);
+    } else {
+      amount = Amount.FromSatoshis(0);
     }
 
     return {
@@ -56,16 +79,60 @@ export default class Input {
     };
   }
 
+  /**
+   * Check if this input contains DLC information (for splice transactions)
+   */
+  isDlcInput(): boolean {
+    return !!this.dlcInput;
+  }
+
   static fromUTXO(utxo: bT.UTXO): Input {
     const amount: Amount = Amount.FromSatoshis(utxo.value);
 
-    return {
-      txid: utxo.txid,
-      vout: utxo.vout,
-      address: utxo.address,
-      value: utxo.value,
-      amount: amount.GetBitcoinAmount(),
-      toUtxo: Input.prototype.toUtxo,
-    };
+    return new Input(
+      utxo.txid,
+      utxo.vout,
+      utxo.address,
+      amount.GetBitcoinAmount(),
+      utxo.value,
+    );
+  }
+
+  /**
+   * Create a DLC input for splice transactions
+   */
+  static createDlcInput(
+    txid: string,
+    vout: number,
+    multisigAddress: string,
+    amount: number, // in BTC
+    value: number, // in sats
+    localFundPubkey: string,
+    remoteFundPubkey: string,
+    contractId: string,
+    inputSerialId?: bigint,
+  ): Input {
+    return new Input(
+      txid,
+      vout,
+      multisigAddress,
+      amount,
+      value,
+      undefined, // DLC inputs don't have derivation paths
+      220, // DLC witness length for 2-of-2 multisig P2WSH
+      undefined, // redeemScript
+      inputSerialId,
+      undefined, // scriptPubKey
+      undefined, // label
+      undefined, // confirmations
+      undefined, // spendable
+      undefined, // solvable
+      undefined, // safe
+      {
+        localFundPubkey,
+        remoteFundPubkey,
+        contractId,
+      },
+    );
   }
 }

package/lib/models/Outcome.ts

@@ -24,6 +24,7 @@ export default class Outcome {
     });
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   static reviver(key: string, value: any): any {
     return key === '' ? Outcome.fromJSON(value) : value;
   }

package/lib/models/Utxo.ts

@@ -11,23 +11,30 @@ export default class Utxo {
     readonly vout: number,
     readonly amount: Amount,
     readonly address: string,
-    readonly derivationPath: string,
     readonly maxWitnessLength: number,
+    readonly derivationPath?: string,
     readonly inputSerialId?: bigint | number,
   ) {}
 
   public toInput(): Input {
-    return {
-      txid: this.txid,
-      vout: this.vout,
-      address: this.address,
-      amount: this.amount.GetBitcoinAmount(),
-      value: this.amount.GetSatoshiAmount(),
-      derivationPath: this.derivationPath,
-      maxWitnessLength: this.maxWitnessLength,
-      inputSerialId: BigInt(this.inputSerialId),
-      toUtxo: Input.prototype.toUtxo,
-    };
+    return new Input(
+      this.txid,
+      this.vout,
+      this.address,
+      this.amount.GetBitcoinAmount(),
+      this.amount.GetSatoshiAmount(),
+      this.derivationPath,
+      this.maxWitnessLength,
+      undefined, // redeemScript
+      this.inputSerialId ? BigInt(this.inputSerialId) : undefined,
+      undefined, // scriptPubKey
+      undefined, // label
+      undefined, // confirmations
+      undefined, // spendable
+      undefined, // solvable
+      undefined, // safe
+      undefined, // dlcInput - regular UTXOs don't have DLC info
+    );
   }
 
   public toJSON(): UtxoJSON {
@@ -54,6 +61,7 @@ export default class Utxo {
     });
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   static reviver(key: string, value: any): any {
     return key === '' ? Utxo.fromJSON(value) : value;
   }
@@ -64,7 +72,7 @@ export interface UtxoJSON {
   vout: number;
   amount: AmountJSON;
   address: string;
-  derivationPath: string;
+  derivationPath?: string;
   maxWitnessLength: number;
   inputSerialId?: bigint | number;
 }

package/lib/transaction.ts

@@ -1,3 +1,4 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface Transaction<T = any> {
   // Transaction hash
   hash: string;

package/lib/wallet.ts

@@ -71,6 +71,7 @@ export interface WalletProvider {
    * Retrieve the network connected to by the wallet
    * @return {Promise<any>} Resolves with the network object
    */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   getConnectedNetwork(): Promise<any>;
 
   /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atomicfinance/types",
   "umdName": "Types",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Bitcoin Abstraction Layer Types",
   "author": "Atomic Finance <info@atomic.finance>",
   "homepage": "",
@@ -15,9 +15,9 @@
     "lint:fix": "../../node_modules/.bin/eslint --fix --ignore-path ../../.eslintignore  -c ../../.eslintrc.js ."
   },
   "dependencies": {
-    "@node-dlc/bitcoin": "^1.0.0",
-    "@node-dlc/messaging": "^1.0.0",
-    "@node-dlc/noise": "^1.0.0",
+    "@node-dlc/bitcoin": "1.1.0",
+    "@node-dlc/messaging": "1.1.0",
+    "@node-dlc/noise": "1.1.0",
     "lodash": "^4.17.20"
   },
   "devDependencies": {

package/yalc.lock

@@ -2,9 +2,19 @@
   "version": "v1",
   "packages": {
     "@node-dlc/messaging": {
-      "signature": "a52ce082cf37e0ad8b512ef2a2a94d16",
+      "signature": "096986a299c0e254d195d2828e2b038a",
       "file": true,
-      "replaced": "0.24.0"
+      "replaced": "1.0.1"
+    },
+    "@node-dlc/bitcoin": {
+      "signature": "66e5ab6938272fbda17f5a659e259926",
+      "file": true,
+      "replaced": "1.0.1"
+    },
+    "@node-dlc/noise": {
+      "signature": "c7b8a3d4f548fa3387f48afc06c9fb04",
+      "file": true,
+      "replaced": "1.0.1"
     }
   }
 }