@atomicfinance/client 2.2.3

package/lib/Dlc.ts

@@ -0,0 +1,421 @@
+import {
+  AddSignaturesToRefundTxRequest,
+  AddSignaturesToRefundTxResponse,
+  AddSignatureToFundTransactionRequest,
+  AddSignatureToFundTransactionResponse,
+  CreateCetAdaptorSignatureRequest,
+  CreateCetAdaptorSignatureResponse,
+  CreateCetAdaptorSignaturesRequest,
+  CreateCetAdaptorSignaturesResponse,
+  CreateCetRequest,
+  CreateCetResponse,
+  CreateDlcTransactionsRequest,
+  CreateDlcTransactionsResponse,
+  CreateFundTransactionRequest,
+  CreateFundTransactionResponse,
+  CreateRefundTransactionRequest,
+  CreateRefundTransactionResponse,
+  GetRawFundTxSignatureRequest,
+  GetRawFundTxSignatureResponse,
+  GetRawRefundTxSignatureRequest,
+  GetRawRefundTxSignatureResponse,
+  Input,
+  SignCetRequest,
+  SignCetResponse,
+  SignFundTransactionRequest,
+  SignFundTransactionResponse,
+  VerifyCetAdaptorSignatureRequest,
+  VerifyCetAdaptorSignatureResponse,
+  VerifyCetAdaptorSignaturesRequest,
+  VerifyCetAdaptorSignaturesResponse,
+  VerifyFundTxSignatureRequest,
+  VerifyFundTxSignatureResponse,
+  VerifyRefundTxSignatureRequest,
+  VerifyRefundTxSignatureResponse,
+} from '@atomicfinance/types';
+import {
+  ContractInfo,
+  DlcAccept,
+  DlcClose,
+  DlcOffer,
+  DlcSign,
+  DlcTransactions,
+  FundingInput,
+  OracleAttestationV0,
+} from '@node-dlc/messaging';
+import { Tx } from '@node-lightning/bitcoin';
+
+export default class Dlc {
+  client: any;
+
+  constructor(client: any) {
+    this.client = client;
+  }
+
+  /**
+   * Check whether wallet is offerer of DlcOffer or DlcAccept
+   * @param dlcOffer Dlc Offer Message
+   * @param dlcAccept Dlc Accept Message
+   * @returns {Promise<boolean>}
+   */
+  async isOfferer(dlcOffer: DlcOffer, dlcAccept: DlcAccept): Promise<boolean> {
+    return this.client.getMethod('isOfferer')(dlcOffer, dlcAccept);
+  }
+
+  /**
+   * Create DLC Offer Message
+   * @param contractInfo ContractInfo TLV (V0 or V1)
+   * @param offerCollateralSatoshis Amount DLC Initiator is putting into the contract
+   * @param feeRatePerVb Fee rate in satoshi per virtual byte that both sides use to compute fees in funding tx
+   * @param cetLocktime The nLockTime to be put on CETs
+   * @param refundLocktime The nLockTime to be put on the refund transaction
+   * @returns {Promise<DlcOffer>}
+   */
+  async createDlcOffer(
+    contractInfo: ContractInfo,
+    offerCollateralSatoshis: bigint,
+    feeRatePerVb: bigint,
+    cetLocktime: number,
+    refundLocktime: number,
+    fixedInputs?: IInput[],
+  ): Promise<DlcOffer> {
+    return this.client.getMethod('createDlcOffer')(
+      contractInfo,
+      offerCollateralSatoshis,
+      feeRatePerVb,
+      cetLocktime,
+      refundLocktime,
+      fixedInputs,
+    );
+  }
+
+  /**
+   * Accept DLC Offer
+   * @param dlcOffer Dlc Offer Message
+   * @param fixedInputs Optional inputs to use for Funding Inputs
+   * @returns {Promise<AcceptDlcOfferResponse}
+   */
+  async acceptDlcOffer(
+    dlcOffer: DlcOffer,
+    fixedInputs?: IInput[],
+  ): Promise<AcceptDlcOfferResponse> {
+    return this.client.getMethod('acceptDlcOffer')(dlcOffer, fixedInputs);
+  }
+
+  /**
+   * Sign Dlc Accept Message
+   * @param dlcOffer Dlc Offer Message
+   * @param dlcAccept Dlc Accept Message
+   * @returns {Promise<SignDlcAcceptResponse}
+   */
+  async signDlcAccept(
+    dlcOffer: DlcOffer,
+    dlcAccept: DlcAccept,
+  ): Promise<SignDlcAcceptResponse> {
+    return this.client.getMethod('signDlcAccept')(dlcOffer, dlcAccept);
+  }
+
+  /**
+   * Finalize Dlc Sign
+   * @param dlcOffer Dlc Offer Message
+   * @param dlcAccept Dlc Accept Message
+   * @param dlcSign Dlc Sign Message
+   * @param dlcTxs Dlc Transactions Message
+   * @returns {Promise<Tx>}
+   */
+  async finalizeDlcSign(
+    dlcOffer: DlcOffer,
+    dlcAccept: DlcAccept,
+    dlcSign: DlcSign,
+    dlcTxs: DlcTransactions,
+  ): Promise<Tx> {
+    return this.client.getMethod('finalizeDlcSign')(
+      dlcOffer,
+      dlcAccept,
+      dlcSign,
+      dlcTxs,
+    );
+  }
+
+  /**
+   * Execute DLC
+   * @param dlcOffer Dlc Offer Message
+   * @param dlcAccept Dlc Accept Message
+   * @param dlcSign Dlc Sign Message
+   * @param dlcTxs Dlc Transactions Message
+   * @param oracleAttestation Oracle Attestations TLV (V0)
+   * @param isOfferer Whether party is Dlc Offerer
+   * @returns {Promise<Tx>}
+   */
+  async execute(
+    dlcOffer: DlcOffer,
+    dlcAccept: DlcAccept,
+    dlcSign: DlcSign,
+    dlcTxs: DlcTransactions,
+    oracleAttestation: OracleAttestationV0,
+    isOfferer?: boolean,
+  ): Promise<Tx> {
+    return this.client.getMethod('execute')(
+      dlcOffer,
+      dlcAccept,
+      dlcSign,
+      dlcTxs,
+      oracleAttestation,
+      isOfferer,
+    );
+  }
+
+  /**
+   * Refund DLC
+   * @param dlcOffer Dlc Offer Message
+   * @param dlcAccept Dlc Accept Message
+   * @param dlcSign Dlc Sign Message
+   * @param dlcTxs Dlc Transactions message
+   * @returns {Promise<Tx>}
+   */
+  async refund(
+    dlcOffer: DlcOffer,
+    dlcAccept: DlcAccept,
+    dlcSign: DlcSign,
+    dlcTxs: DlcTransactions,
+  ): Promise<Tx> {
+    return this.client.getMethod('refund')(
+      dlcOffer,
+      dlcAccept,
+      dlcSign,
+      dlcTxs,
+    );
+  }
+
+  /**
+   * Generate DlcClose messagetype for closing DLC with Mutual Consent
+   * @param dlcOffer DlcOffer TLV (V0)
+   * @param dlcAccept DlcAccept TLV (V0)
+   * @param dlcTxs DlcTransactions TLV (V0)
+   * @param initiatorPayoutSatoshis Amount initiator expects as a payout
+   * @param isOfferer Whether offerer or not
+   * @param inputs Optionally specified closing inputs
+   * @returns {Promise<DlcClose>}
+   */
+  async createDlcClose(
+    dlcOffer: DlcOffer,
+    dlcAccept: DlcAccept,
+    dlcTxs: DlcTransactions,
+    initiatorPayoutSatoshis: bigint,
+    isOfferer?: boolean,
+    inputs?: Input[],
+  ): Promise<DlcClose> {
+    return this.client.getMethod('createDlcClose')(
+      dlcOffer,
+      dlcAccept,
+      dlcTxs,
+      initiatorPayoutSatoshis,
+      isOfferer,
+      inputs,
+    );
+  }
+
+  /**
+   * Generate multiple DlcClose messagetypes for closing DLC with Mutual Consent
+   * @param dlcOffer DlcOffer TLV (V0)
+   * @param dlcAccept DlcAccept TLV (V0)
+   * @param dlcTxs DlcTransactions TLV (V0)
+   * @param initiatorPayouts Array of amounts initiator expects as payouts
+   * @param isOfferer Whether offerer or not
+   * @param inputs Optionally specified closing inputs
+   * @returns {Promise<DlcClose[]>}
+   */
+  async createBatchDlcClose(
+    dlcOffer: DlcOffer,
+    dlcAccept: DlcAccept,
+    dlcTxs: DlcTransactions,
+    initiatorPayouts: bigint[],
+    isOfferer?: boolean,
+    inputs?: Input[],
+  ): Promise<DlcClose[]> {
+    return this.client.getMethod('createBatchDlcClose')(
+      dlcOffer,
+      dlcAccept,
+      dlcTxs,
+      initiatorPayouts,
+      isOfferer,
+      inputs,
+    );
+  }
+
+  /**
+   * Verify multiple DlcClose messagetypes for closing DLC with Mutual Consent
+   * @param dlcOffer DlcOffer TLV (V0)
+   * @param dlcAccept DlcAccept TLV (V0)
+   * @param dlcTxs DlcTransactions TLV (V0)
+   * @param dlcCloses DlcClose[] TLV (V0)
+   * @param isOfferer Whether offerer or not
+   * @returns {Promise<void>}
+   */
+  async verifyBatchDlcClose(
+    dlcOffer: DlcOffer,
+    dlcAccept: DlcAccept,
+    dlcTxs: DlcTransactions,
+    dlcCloses: DlcClose[],
+    isOfferer?: boolean,
+  ): Promise<void> {
+    return this.client.getMethod('verifyBatchDlcClose')(
+      dlcOffer,
+      dlcAccept,
+      dlcTxs,
+      dlcCloses,
+      isOfferer,
+    );
+  }
+
+  /**
+   * Finalize Dlc Close
+   * @param dlcOffer Dlc Offer Message
+   * @param dlcAccept Dlc Accept Message
+   * @param dlcClose Dlc Close Message
+   * @param dlcTxs Dlc Transactions Message
+   * @returns {Promise<string>}
+   */
+  finalizeDlcClose(
+    dlcOffer: DlcOffer,
+    dlcAccept: DlcAccept,
+    dlcClose: DlcClose,
+    dlcTxs: DlcTransactions,
+  ): Promise<string> {
+    return this.client.getMethod('finalizeDlcClose')(
+      dlcOffer,
+      dlcAccept,
+      dlcClose,
+      dlcTxs,
+    );
+  }
+
+  async AddSignatureToFundTransaction(
+    jsonObject: AddSignatureToFundTransactionRequest,
+  ): Promise<AddSignatureToFundTransactionResponse> {
+    return this.client.getMethod('AddSignatureToFundTransaction')(jsonObject);
+  }
+
+  async CreateCetAdaptorSignature(
+    jsonObject: CreateCetAdaptorSignatureRequest,
+  ): Promise<CreateCetAdaptorSignatureResponse> {
+    return this.client.getMethod('CreateCetAdaptorSignature')(jsonObject);
+  }
+
+  async CreateCetAdaptorSignatures(
+    jsonObject: CreateCetAdaptorSignaturesRequest,
+  ): Promise<CreateCetAdaptorSignaturesResponse> {
+    return this.client.getMethod('CreateCetAdaptorSignatures')(jsonObject);
+  }
+
+  async AddSignaturesToRefundTx(
+    jsonObject: AddSignaturesToRefundTxRequest,
+  ): Promise<AddSignaturesToRefundTxResponse> {
+    return this.client.getMethod('AddSignaturesToRefundTx')(jsonObject);
+  }
+
+  async CreateCet(jsonObject: CreateCetRequest): Promise<CreateCetResponse> {
+    return this.client.getMethod('CreateCet')(jsonObject);
+  }
+
+  async CreateDlcTransactions(
+    jsonObject: CreateDlcTransactionsRequest,
+  ): Promise<CreateDlcTransactionsResponse> {
+    return this.client.getMethod('CreateDlcTransactions')(jsonObject);
+  }
+
+  async CreateFundTransaction(
+    jsonObject: CreateFundTransactionRequest,
+  ): Promise<CreateFundTransactionResponse> {
+    return this.client.getMethod('CreateFundTransaction')(jsonObject);
+  }
+
+  async CreateRefundTransaction(
+    jsonObject: CreateRefundTransactionRequest,
+  ): Promise<CreateRefundTransactionResponse> {
+    return this.client.getMethod('CreateRefundTransaction')(jsonObject);
+  }
+
+  async GetRawFundTxSignature(
+    jsonObject: GetRawFundTxSignatureRequest,
+  ): Promise<GetRawFundTxSignatureResponse> {
+    return this.client.getMethod('GetRawFundTxSignature')(jsonObject);
+  }
+
+  async GetRawRefundTxSignature(
+    jsonObject: GetRawRefundTxSignatureRequest,
+  ): Promise<GetRawRefundTxSignatureResponse> {
+    return this.client.getMethod('GetRawRefundTxSignature')(jsonObject);
+  }
+
+  async SignCetRequest(jsonObject: SignCetRequest): Promise<SignCetResponse> {
+    return this.client.getMethod('SignCetRequest')(jsonObject);
+  }
+
+  async SignFundTransaction(
+    jsonObject: SignFundTransactionRequest,
+  ): Promise<SignFundTransactionResponse> {
+    return this.client.getMethod('SignFundTransaction')(jsonObject);
+  }
+
+  async VerifyCetAdaptorSignature(
+    jsonObject: VerifyCetAdaptorSignatureRequest,
+  ): Promise<VerifyCetAdaptorSignatureResponse> {
+    return this.client.getMethod('VerifyCetAdaptorSignature')(jsonObject);
+  }
+
+  async VerifyCetAdaptorSignaturesRequest(
+    jsonObject: VerifyCetAdaptorSignaturesRequest,
+  ): Promise<VerifyCetAdaptorSignaturesResponse> {
+    return this.client.getMethod('VerifyCetAdaptorSignatures')(jsonObject);
+  }
+
+  async VerifyFundTxSignature(
+    jsonObject: VerifyFundTxSignatureRequest,
+  ): Promise<VerifyFundTxSignatureResponse> {
+    return this.client.getMethod('VerifyFundTxSignature')(jsonObject);
+  }
+
+  async VerifyRefundTxSignature(
+    jsonObject: VerifyRefundTxSignatureRequest,
+  ): Promise<VerifyRefundTxSignatureResponse> {
+    return this.client.getMethod('VerifyRefundTxSignature')(jsonObject);
+  }
+
+  async fundingInputToInput(_input: FundingInput): Promise<IInput> {
+    return this.client.getMethod('fundingInputToInput')(_input);
+  }
+
+  async inputToFundingInput(input: IInput): Promise<FundingInput> {
+    return this.client.getMethod('inputToFundingInput')(input);
+  }
+}
+
+export interface AcceptDlcOfferResponse {
+  dlcAccept: DlcAccept;
+  dlcTransactions: DlcTransactions;
+}
+
+export interface SignDlcAcceptResponse {
+  dlcSign: DlcSign;
+  dlcTransactions: DlcTransactions;
+}
+
+export interface IInput {
+  txid: string;
+  vout: number;
+  address: string;
+  amount: number; // in BTC
+  value: number; // in sats
+  derivationPath?: string;
+  maxWitnessLength?: number;
+  redeemScript?: string;
+  inputSerialId?: bigint;
+  scriptPubKey?: string;
+  label?: string;
+  confirmations?: number;
+  spendable?: boolean;
+  solvable?: boolean;
+  safe?: boolean;
+  toUtxo: any;
+}

package/lib/Wallet.ts

@@ -0,0 +1,72 @@
+import { CreateMultisigResponse, Input, Output } from '@atomicfinance/types';
+import { Transaction } from 'bitcoinjs-lib';
+
+export default class Wallet {
+  client: any;
+
+  constructor(client: any) {
+    this.client = client;
+  }
+
+  createMultisig(m: number, pubkeys: string[]): CreateMultisigResponse {
+    return this.client.getMethod('createMultisig')(m, pubkeys);
+  }
+
+  buildMultisigPSBT(
+    m: number,
+    pubkeys: string[],
+    inputs: Input[],
+    outputs: Output[],
+  ): string {
+    return this.client.getMethod('buildMultisigPSBT')(
+      m,
+      pubkeys,
+      inputs,
+      outputs,
+    );
+  }
+
+  walletProcessPSBT(psbtString: string): Promise<string> {
+    return this.client.getMethod('walletProcessPSBT')(psbtString);
+  }
+
+  finalizePSBT(psbtString: string): Transaction {
+    return this.client.getMethod('finalizePSBT')(psbtString);
+  }
+
+  async buildSweepTransactionWithSetOutputs(
+    externalChangeAddress: string,
+    feePerByte: number,
+    outputs: Output[],
+    fixedInputs: Input[],
+  ) {
+    return this.client.getMethod('buildSweepTransactionWithSetOutputs')(
+      externalChangeAddress,
+      feePerByte,
+      outputs,
+      fixedInputs,
+    );
+  }
+
+  async sendSweepTransactionWithSetOutputs(
+    externalChangeAddress: string,
+    feePerByte: number,
+    outputs: Output[],
+    fixedInputs: Input[],
+  ) {
+    return this.client.getMethod('sendSweepTransactionWithSetOutputs')(
+      externalChangeAddress,
+      feePerByte,
+      outputs,
+      fixedInputs,
+    );
+  }
+
+  async getUnusedAddress(change = false, numAddressPerCall = 100) {
+    return this.client.getMethod('getUnusedAddress')(change, numAddressPerCall);
+  }
+
+  async quickFindAddress(addresses: string[]) {
+    return this.client.getMethod('quickFindAddress')(addresses);
+  }
+}

package/lib/index.ts

@@ -0,0 +1,2 @@
+export { default as Client } from './Client';
+export { default } from './Client';

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@atomicfinance/client",
+  "umdName": "Client",
+  "version": "2.2.3",
+  "description": "CAL Finance Client Provider",
+  "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": {
+    "@atomicfinance/provider": "^2.2.3",
+    "@atomicfinance/types": "^2.2.3",
+    "@liquality/client": "1.1.5",
+    "@liquality/errors": "1.1.5",
+    "@liquality/provider": "1.1.5",
+    "@node-dlc/messaging": "0.10.3",
+    "@node-lightning/bitcoin": "0.22.1",
+    "lodash": "^4.17.20"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.160",
+    "@types/node": "^14.0.13"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "205d2d24dde632ae2bd931dbf297f78f2919fcc4"
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+  },
+  "include": ["./lib"],
+}