@atomicfinance/types 4.0.2 → 4.1.0

package/lib/ddk.ts

@@ -0,0 +1,430 @@
+/* auto-generated by NAPI-RS */
+
+export interface AdaptorSignature {
+  signature: Buffer;
+  proof: Buffer;
+}
+
+export interface ChangeOutputAndFees {
+  changeOutput: TxOutput;
+  fundFee: bigint;
+  cetFee: bigint;
+}
+
+export interface DdkDlcInputInfo {
+  fundTx: DdkTransaction;
+  fundVout: number;
+  localFundPubkey: Buffer;
+  remoteFundPubkey: Buffer;
+  fundAmount: bigint;
+  maxWitnessLen: number;
+  inputSerialId: bigint;
+  contractId: Buffer;
+}
+
+export interface DlcOutcome {
+  localPayout: bigint;
+  remotePayout: bigint;
+}
+
+export interface DdkDlcTransactions {
+  fund: DdkTransaction;
+  cets: Array<DdkTransaction>;
+  refund: DdkTransaction;
+  fundingScriptPubkey: Buffer;
+}
+
+export interface DdkOracleInfo {
+  publicKey: Buffer;
+  nonces: Array<Buffer>;
+}
+
+export interface PartyParams {
+  fundPubkey: Buffer;
+  changeScriptPubkey: Buffer;
+  changeSerialId: bigint;
+  payoutScriptPubkey: Buffer;
+  payoutSerialId: bigint;
+  inputs: Array<TxInputInfo>;
+  inputAmount: bigint;
+  collateral: bigint;
+  dlcInputs: Array<DdkDlcInputInfo>;
+}
+
+export interface Payout {
+  offer: bigint;
+  accept: bigint;
+}
+
+export interface DdkTransaction {
+  version: number;
+  lockTime: number;
+  inputs: Array<TxInput>;
+  outputs: Array<TxOutput>;
+  rawBytes: Buffer;
+}
+
+export interface TxInput {
+  txid: string;
+  vout: number;
+  scriptSig: Buffer;
+  sequence: number;
+  witness: Array<Buffer>;
+}
+
+export interface TxInputInfo {
+  txid: string;
+  vout: number;
+  scriptSig: Buffer;
+  maxWitnessLength: number;
+  serialId: bigint;
+}
+
+export interface TxOutput {
+  value: bigint;
+  scriptPubkey: Buffer;
+}
+
+// Main DDK interface that any implementation must provide
+export interface DdkInterface {
+  createCet(
+    localOutput: TxOutput,
+    localPayoutSerialId: bigint,
+    remoteOutput: TxOutput,
+    remotePayoutSerialId: bigint,
+    fundTxId: string,
+    fundVout: number,
+    lockTime: number,
+  ): DdkTransaction;
+
+  createCetAdaptorSignatureFromOracleInfo(
+    cet: DdkTransaction,
+    oracleInfo: DdkOracleInfo,
+    fundingSk: Buffer,
+    fundingScriptPubkey: Buffer,
+    totalCollateral: bigint,
+    msgs: Array<Buffer>,
+  ): AdaptorSignature;
+
+  createCetAdaptorSigsFromOracleInfo(
+    cets: Array<DdkTransaction>,
+    oracleInfo: Array<DdkOracleInfo>,
+    fundingSecretKey: Buffer,
+    fundingScriptPubkey: Buffer,
+    fundOutputValue: bigint,
+    msgs: Array<Array<Array<Buffer>>>,
+  ): Array<AdaptorSignature>;
+
+  verifyCetAdaptorSigFromOracleInfo(
+    adaptorSig: AdaptorSignature,
+    cet: DdkTransaction,
+    oracleInfo: Array<DdkOracleInfo>,
+    pubkey: Buffer,
+    fundingScriptPubkey: Buffer,
+    totalCollateral: bigint,
+    msgs: Array<Array<Buffer>>,
+  ): boolean;
+
+  verifyCetAdaptorSigsFromOracleInfo(
+    adaptorSigs: Array<AdaptorSignature>,
+    cets: Array<DdkTransaction>,
+    oracleInfo: Array<DdkOracleInfo>,
+    pubkey: Buffer,
+    fundingScriptPubkey: Buffer,
+    totalCollateral: bigint,
+    msgs: Array<Array<Array<Buffer>>>,
+  ): boolean;
+
+  createCets(
+    fundTxId: string,
+    fundVout: number,
+    localFinalScriptPubkey: Buffer,
+    remoteFinalScriptPubkey: Buffer,
+    outcomes: Array<Payout>,
+    lockTime: number,
+    localSerialId: bigint,
+    remoteSerialId: bigint,
+  ): Array<DdkTransaction>;
+
+  createDlcTransactions(
+    outcomes: Array<Payout>,
+    localParams: PartyParams,
+    remoteParams: PartyParams,
+    refundLocktime: number,
+    feeRate: bigint,
+    fundLockTime: number,
+    cetLockTime: number,
+    fundOutputSerialId: bigint,
+  ): DdkDlcTransactions;
+
+  createFundTxLockingScript(
+    localFundPubkey: Buffer,
+    remoteFundPubkey: Buffer,
+  ): Buffer;
+
+  createRefundTransaction(
+    localFinalScriptPubkey: Buffer,
+    remoteFinalScriptPubkey: Buffer,
+    localAmount: bigint,
+    remoteAmount: bigint,
+    lockTime: number,
+    fundTxId: string,
+    fundVout: number,
+  ): DdkTransaction;
+
+  createSplicedDlcTransactions(
+    outcomes: Array<Payout>,
+    localParams: PartyParams,
+    remoteParams: PartyParams,
+    refundLocktime: number,
+    feeRate: bigint,
+    fundLockTime: number,
+    cetLockTime: number,
+    fundOutputSerialId: bigint,
+  ): DdkDlcTransactions;
+
+  getChangeOutputAndFees(
+    params: PartyParams,
+    feeRate: bigint,
+  ): ChangeOutputAndFees;
+
+  getRawFundingTransactionInputSignature(
+    fundingTransaction: DdkTransaction,
+    privkey: Buffer,
+    prevTxId: string,
+    prevTxVout: number,
+    value: bigint,
+  ): Buffer;
+
+  getTotalInputVsize(inputs: Array<TxInputInfo>): number;
+
+  isDustOutput(output: TxOutput): boolean;
+
+  signFundTransactionInput(
+    fundTransaction: DdkTransaction,
+    privkey: Buffer,
+    prevTxId: string,
+    prevTxVout: number,
+    value: bigint,
+  ): DdkTransaction;
+
+  verifyFundTxSignature(
+    fundTx: DdkTransaction,
+    signature: Buffer,
+    pubkey: Buffer,
+    txid: string,
+    vout: number,
+    inputAmount: bigint,
+  ): boolean;
+
+  signCet(
+    cet: DdkTransaction,
+    adaptorSignature: Buffer,
+    oracleSignatures: Array<Buffer>,
+    fundingSecretKey: Buffer,
+    otherPubkey: Buffer,
+    fundingScriptPubkey: Buffer,
+    fundOutputValue: bigint,
+  ): DdkTransaction;
+
+  convertMnemonicToSeed(mnemonic: string, passphrase?: string | null): Buffer;
+
+  createXprivFromParentPath(
+    xpriv: Buffer,
+    baseDerivationPath: string,
+    network: string,
+    path: string,
+  ): Buffer;
+
+  getXpubFromXpriv(xpriv: Buffer, network: string): Buffer;
+
+  version(): string;
+
+  addSignatureToTransaction(
+    tx: DdkTransaction,
+    signature: Buffer,
+    pubkey: Buffer,
+    inputIndex: number,
+  ): DdkTransaction;
+
+  signMultiSigInput(
+    tx: DdkTransaction,
+    dlcInput: DdkDlcInputInfo,
+    localPrivkey: Buffer,
+    remoteSignature: Buffer,
+  ): DdkTransaction;
+}
+
+// Legacy function declarations for backward compatibility
+export declare function createCet(
+  localOutput: TxOutput,
+  localPayoutSerialId: bigint,
+  remoteOutput: TxOutput,
+  remotePayoutSerialId: bigint,
+  fundTxId: string,
+  fundVout: number,
+  lockTime: number,
+): DdkTransaction;
+
+export declare function createCetAdaptorSignatureFromOracleInfo(
+  cet: DdkTransaction,
+  oracleInfo: DdkOracleInfo,
+  fundingSk: Buffer,
+  fundingScriptPubkey: Buffer,
+  totalCollateral: bigint,
+  msgs: Array<Buffer>,
+): AdaptorSignature;
+
+export declare function createCetAdaptorSigsFromOracleInfo(
+  cets: Array<DdkTransaction>,
+  oracleInfo: Array<DdkOracleInfo>,
+  fundingSecretKey: Buffer,
+  fundingScriptPubkey: Buffer,
+  fundOutputValue: bigint,
+  msgs: Array<Array<Array<Buffer>>>,
+): Array<AdaptorSignature>;
+
+export declare function verifyCetAdaptorSigFromOracleInfo(
+  adaptorSig: AdaptorSignature,
+  cet: DdkTransaction,
+  oracleInfo: Array<DdkOracleInfo>,
+  pubkey: Buffer,
+  fundingScriptPubkey: Buffer,
+  totalCollateral: bigint,
+  msgs: Array<Array<Buffer>>,
+): boolean;
+
+export declare function verifyCetAdaptorSigsFromOracleInfo(
+  adaptorSigs: Array<AdaptorSignature>,
+  cets: Array<DdkTransaction>,
+  oracleInfo: Array<DdkOracleInfo>,
+  pubkey: Buffer,
+  fundingScriptPubkey: Buffer,
+  totalCollateral: bigint,
+  msgs: Array<Array<Array<Buffer>>>,
+): boolean;
+
+export declare function createCets(
+  fundTxId: string,
+  fundVout: number,
+  localFinalScriptPubkey: Buffer,
+  remoteFinalScriptPubkey: Buffer,
+  outcomes: Array<Payout>,
+  lockTime: number,
+  localSerialId: bigint,
+  remoteSerialId: bigint,
+): Array<DdkTransaction>;
+
+export declare function createDlcTransactions(
+  outcomes: Array<Payout>,
+  localParams: PartyParams,
+  remoteParams: PartyParams,
+  refundLocktime: number,
+  feeRate: bigint,
+  fundLockTime: number,
+  cetLockTime: number,
+  fundOutputSerialId: bigint,
+): DdkDlcTransactions;
+
+export declare function createFundTxLockingScript(
+  localFundPubkey: Buffer,
+  remoteFundPubkey: Buffer,
+): Buffer;
+
+export declare function createRefundTransaction(
+  localFinalScriptPubkey: Buffer,
+  remoteFinalScriptPubkey: Buffer,
+  localAmount: bigint,
+  remoteAmount: bigint,
+  lockTime: number,
+  fundTxId: string,
+  fundVout: number,
+): DdkTransaction;
+
+export declare function createSplicedDlcTransactions(
+  outcomes: Array<Payout>,
+  localParams: PartyParams,
+  remoteParams: PartyParams,
+  refundLocktime: number,
+  feeRate: bigint,
+  fundLockTime: number,
+  cetLockTime: number,
+  fundOutputSerialId: bigint,
+): DdkDlcTransactions;
+
+export declare function getChangeOutputAndFees(
+  params: PartyParams,
+  feeRate: bigint,
+): ChangeOutputAndFees;
+
+export declare function getRawFundingTransactionInputSignature(
+  fundingTransaction: DdkTransaction,
+  privkey: Buffer,
+  prevTxId: string,
+  prevTxVout: number,
+  value: bigint,
+): Buffer;
+
+export declare function getTotalInputVsize(inputs: Array<TxInputInfo>): number;
+
+export declare function isDustOutput(output: TxOutput): boolean;
+
+export declare function signFundTransactionInput(
+  fundTransaction: DdkTransaction,
+  privkey: Buffer,
+  prevTxId: string,
+  prevTxVout: number,
+  value: bigint,
+): DdkTransaction;
+
+export declare function verifyFundTxSignature(
+  fundTx: DdkTransaction,
+  signature: Buffer,
+  pubkey: Buffer,
+  txid: string,
+  vout: number,
+  inputAmount: bigint,
+): boolean;
+
+export declare function version(): string;
+
+export declare function signCet(
+  cet: DdkTransaction,
+  adaptorSignature: Buffer,
+  oracleSignatures: Array<Buffer>,
+  fundingSecretKey: Buffer,
+  otherPubkey: Buffer,
+  fundingScriptPubkey: Buffer,
+  fundOutputValue: bigint,
+): DdkTransaction;
+
+export declare function convertMnemonicToSeed(
+  mnemonic: string,
+  passphrase?: string | null,
+): Buffer;
+
+export declare function createXprivFromParentPath(
+  xpriv: Buffer,
+  baseDerivationPath: string,
+  network: string,
+  path: string,
+): Buffer;
+
+export declare function getXpubFromXpriv(
+  xpriv: Buffer,
+  network: string,
+): Buffer;
+
+export declare function addSignatureToTransaction(
+  tx: DdkTransaction,
+  signature: Buffer,
+  pubkey: Buffer,
+  inputIndex: number,
+): DdkTransaction;
+
+export declare function signMultiSigInput(
+  tx: DdkTransaction,
+  dlcInput: DdkDlcInputInfo,
+  localPrivkey: Buffer,
+  remoteSignature: Buffer,
+): DdkTransaction;

package/lib/dlc.ts

@@ -1,6 +1,3 @@
-/* eslint-disable max-len */
-/* eslint-disable indent */
-
 import { Tx } from '@node-dlc/bitcoin';
 import {
   CetAdaptorSignatures,
@@ -335,9 +332,6 @@ interface PayoutGroup {
   groups: number[][];
 }
 
-/* eslint-disable max-len */
-/* eslint-disable indent */
-
 export interface AdaptorPair {
   signature: string;
   proof: string;

package/lib/index.ts

@@ -34,6 +34,7 @@ interface IClient {
 export * from './cfd';
 export * from './common';
 export * from './dlc';
+export * from './ddk';
 export { default as Amount } from './models/Amount';
 export {
   default as Input,

package/lib/jsonrpc.ts

@@ -48,16 +48,6 @@ export interface AddressInfo {
 
 export type AddressGrouping = string[][];
 
-export interface ReceivedByAddress {
-  involvesWatchonly: boolean;
-  address: string;
-  account: string;
-  amount: number;
-  confirmations: number;
-  label: string;
-  txids: string[];
-}
-
 export interface Block {
   hash: string;
   confirmations: number;

package/lib/models/Input.ts

@@ -76,6 +76,7 @@ export default class Input {
       inputSerialId: this.inputSerialId,
       toJSON: Utxo.prototype.toJSON,
       toInput: Utxo.prototype.toInput,
+      toTxInputInfo: Utxo.prototype.toTxInputInfo,
     };
   }
 

package/lib/models/Utxo.ts

@@ -1,3 +1,4 @@
+import { TxInputInfo } from '../ddk';
 import Amount, { AmountJSON } from './Amount';
 import Input from './Input';
 
@@ -37,6 +38,16 @@ export default class Utxo {
     );
   }
 
+  public toTxInputInfo(): TxInputInfo {
+    return {
+      txid: this.txid,
+      vout: this.vout,
+      scriptSig: Buffer.alloc(0),
+      maxWitnessLength: this.maxWitnessLength,
+      serialId: this.inputSerialId ? BigInt(this.inputSerialId) : undefined,
+    };
+  }
+
   public toJSON(): UtxoJSON {
     return Object.assign({}, this, {
       txid: this.txid,

package/package.json

@@ -1,19 +1,12 @@
 {
   "name": "@atomicfinance/types",
   "umdName": "Types",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Bitcoin Abstraction Layer Types",
   "author": "Atomic Finance <info@atomic.finance>",
   "homepage": "",
   "license": "ISC",
   "main": "dist/index.js",
-  "scripts": {
-    "build": "../../node_modules/.bin/tsc --project tsconfig.json",
-    "prepublishOnly": "yarn run build",
-    "test": "yarn run build",
-    "lint": "../../node_modules/.bin/eslint --ignore-path ../../.eslintignore  -c ../../.eslintrc.js .",
-    "lint:fix": "../../node_modules/.bin/eslint --fix --ignore-path ../../.eslintignore  -c ../../.eslintrc.js ."
-  },
   "dependencies": {
     "@node-dlc/bitcoin": "1.1.0",
     "@node-dlc/messaging": "1.1.0",
@@ -22,9 +15,15 @@
   },
   "devDependencies": {
     "@types/lodash": "^4.14.160",
-    "@types/node": "16.10.3"
+    "@types/node": "20.19.10"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "../../node_modules/.bin/tsc --project tsconfig.json",
+    "test": "pnpm run build",
+    "lint": "../../node_modules/.bin/eslint  .",
+    "lint:fix": "../../node_modules/.bin/eslint --fix  ."
   }
-}
+}