@atomicfinance/bitcoin-dlc-provider 2.4.2 → 3.0.0

package/lib/BitcoinDlcProvider.ts

@@ -1,11 +1,12 @@
-import { chainHashFromNetwork } from '@atomicfinance/bitcoin-networks';
 import Provider from '@atomicfinance/provider';
 import {
   AdaptorPair,
+  Address,
   AddSignaturesToRefundTxRequest,
   AddSignaturesToRefundTxResponse,
   AddSignatureToFundTransactionRequest,
   AddSignatureToFundTransactionResponse,
+  bitcoin,
   CalculateEcSignatureRequest,
   CreateCetAdaptorSignatureRequest,
   CreateCetAdaptorSignatureResponse,
@@ -44,14 +45,13 @@ import {
   VerifyRefundTxSignatureResponse,
   VerifySignatureRequest,
 } from '@atomicfinance/types';
-import { BitcoinNetwork } from '@liquality/bitcoin-networks';
-import { Address, bitcoin } from '@liquality/types';
-import { sleep } from '@liquality/utils';
+import { sleep } from '@atomicfinance/utils';
 import {
   DualClosingTxFinalizer,
   DualFundingTxFinalizer,
   groupByIgnoringDigits,
   HyperbolaPayoutCurve,
+  PolynomialPayoutCurve,
   roundPayout,
 } from '@node-dlc/core';
 import {
@@ -83,6 +83,7 @@ import {
   OracleEventV0,
   OracleInfoV0,
   PayoutFunctionV0,
+  PolynomialPayoutCurvePiece,
   ScriptWitnessV0,
 } from '@node-dlc/messaging';
 import { Script, Sequence, Tx } from '@node-lightning/bitcoin';
@@ -90,6 +91,7 @@ import { StreamReader } from '@node-lightning/bufio';
 import { hash160, sha256, xor } from '@node-lightning/crypto';
 import assert from 'assert';
 import BigNumber from 'bignumber.js';
+import { BitcoinNetwork, chainHashFromNetwork } from 'bitcoin-networks';
 import {
   address,
   ECPairInterface,
@@ -316,6 +318,66 @@ export default class BitcoinDlcProvider
     return { payouts, payoutGroups, messagesList };
   }
 
+  private GetPayoutsFromPolynomialPayoutFunction(
+    _dlcOffer: DlcOffer,
+    contractDescriptor: ContractDescriptorV1,
+    oracleInfo: OracleInfoV0,
+    totalCollateral: bigint,
+  ): GetPayoutsResponse {
+    if (_dlcOffer.type !== MessageType.DlcOfferV0)
+      throw Error('DlcOffer must be V0');
+    const dlcOffer = _dlcOffer as DlcOfferV0;
+    if (contractDescriptor.payoutFunction.type !== MessageType.PayoutFunctionV0)
+      throw Error('PayoutFunction must be V0');
+    const payoutFunction = contractDescriptor.payoutFunction as PayoutFunctionV0;
+    if (payoutFunction.pieces.length === 0)
+      throw Error('PayoutFunction must have at least once PayoutCurvePiece');
+    for (const piece of payoutFunction.pieces) {
+      if (
+        piece.payoutCurvePiece.type !== MessageType.PolynomialPayoutCurvePiece
+      )
+        throw Error('Must be PolynomialPayoutCurvePiece');
+    }
+    const eventDescriptor = oracleInfo.announcement.oracleEvent
+      .eventDescriptor as DigitDecompositionEventDescriptorV0;
+    if (
+      eventDescriptor.type !== MessageType.DigitDecompositionEventDescriptorV0
+    )
+      throw Error('Only DigitDecomposition Oracle Events supported');
+
+    const roundingIntervals = contractDescriptor.roundingIntervals;
+    const cetPayouts = PolynomialPayoutCurve.computePayouts(
+      payoutFunction,
+      totalCollateral,
+      roundingIntervals,
+    );
+
+    const payoutGroups: PayoutGroup[] = [];
+    cetPayouts.forEach((p) => {
+      payoutGroups.push({
+        payout: p.payout,
+        groups: groupByIgnoringDigits(
+          p.indexFrom,
+          p.indexTo,
+          eventDescriptor.base,
+          contractDescriptor.numDigits,
+        ),
+      });
+    });
+
+    const rValuesMessagesList = this.GenerateMessages(oracleInfo);
+
+    const { payouts, messagesList } = outputsToPayouts(
+      payoutGroups,
+      rValuesMessagesList,
+      dlcOffer.offerCollateralSatoshis,
+      dlcOffer.contractInfo.totalCollateral - dlcOffer.offerCollateralSatoshis,
+      true,
+    );
+
+    return { payouts, payoutGroups, messagesList };
+  }
+
   private GetPayouts(_dlcOffer: DlcOffer): GetPayoutsResponse[] {
     const { dlcOffer } = checkTypes({ _dlcOffer });
 
@@ -371,18 +433,45 @@ export default class BitcoinDlcProvider
     totalCollateral: bigint,
   ) {
     switch (contractDescriptor.type) {
-      case MessageType.ContractDescriptorV0:
+      case MessageType.ContractDescriptorV0: {
         throw Error('ContractDescriptorV0 not yet supported');
+      }
       case MessageType.ContractDescriptorV1:
-        // eslint-disable-next-line no-case-declarations
-        return this.GetPayoutsFromPayoutFunction(
-          dlcOffer,
-          contractDescriptor as ContractDescriptorV1,
-          oracleInfo,
-          totalCollateral,
-        );
-      default:
+        {
+          const contractDescriptorV1 = contractDescriptor as ContractDescriptorV1;
+          const payoutFunction = contractDescriptorV1.payoutFunction as PayoutFunctionV0;
+
+          // TODO: add a better check for this
+          const payoutCurvePiece = payoutFunction.pieces[0].payoutCurvePiece;
+
+          switch (payoutCurvePiece.type) {
+            case MessageType.HyperbolaPayoutCurvePiece:
+              return this.GetPayoutsFromPayoutFunction(
+                dlcOffer,
+                contractDescriptor as ContractDescriptorV1,
+                oracleInfo,
+                totalCollateral,
+              );
+            case MessageType.OldHyperbolaPayoutCurvePiece:
+              return this.GetPayoutsFromPayoutFunction(
+                dlcOffer,
+                contractDescriptor as ContractDescriptorV1,
+                oracleInfo,
+                totalCollateral,
+              );
+            case MessageType.PolynomialPayoutCurvePiece:
+              return this.GetPayoutsFromPolynomialPayoutFunction(
+                dlcOffer,
+                contractDescriptor as ContractDescriptorV1,
+                oracleInfo,
+                totalCollateral,
+              );
+          }
+        }
+        break;
+      default: {
         throw Error('ContractDescriptor must be V0 or V1');
+      }
     }
   }
 
@@ -558,7 +647,7 @@ export default class BitcoinDlcProvider
       network,
     );
 
-    const { derivationPath } = await this.getMethod('findAddress')([
+    const { derivationPath } = await this.client.wallet.findAddress([
       fundingAddress,
     ]);
 
@@ -922,6 +1011,84 @@ export default class BitcoinDlcProvider
     return fundTx;
   }
 
+  async FindOutcomeIndexFromPolynomialPayoutCurvePiece(
+    _dlcOffer: DlcOffer,
+    contractDescriptor: ContractDescriptorV1,
+    contractOraclePairIndex: number,
+    polynomialPayoutCurvePiece: PolynomialPayoutCurvePiece,
+    oracleAttestation: OracleAttestationV0,
+    outcome: bigint,
+  ): Promise<FindOutcomeResponse> {
+    const { dlcOffer } = checkTypes({ _dlcOffer });
+
+    const polynomialCurve = PolynomialPayoutCurve.fromPayoutCurvePiece(
+      polynomialPayoutCurvePiece,
+    );
+
+    const clampBN = (val: BigNumber) =>
+      BigNumber.max(
+        0,
+        BigNumber.min(val, dlcOffer.contractInfo.totalCollateral.toString()),
+      );
+
+    const payout = clampBN(polynomialCurve.getPayout(outcome));
+
+    const payoutResponses = this.GetPayouts(dlcOffer);
+    const payoutIndexOffset = this.GetIndicesFromPayouts(payoutResponses)[
+      contractOraclePairIndex
+    ].startingMessagesIndex;
+
+    const { payoutGroups } = payoutResponses[contractOraclePairIndex];
+
+    const intervalsSorted = [
+      ...contractDescriptor.roundingIntervals.intervals,
+    ].sort((a, b) => Number(b.beginInterval) - Number(a.beginInterval));
+
+    const interval = intervalsSorted.find(
+      (interval) => Number(outcome) >= Number(interval.beginInterval),
+    );
+
+    const roundedPayout = BigInt(
+      clampBN(
+        new BigNumber(roundPayout(payout, interval.roundingMod).toString()),
+      ).toString(),
+    );
+
+    const outcomesFormatted = oracleAttestation.outcomes.map((outcome) =>
+      parseInt(outcome),
+    );
+
+    let index = 0;
+    let groupIndex = -1;
+    let groupLength = 0;
+
+    for (const payoutGroup of payoutGroups) {
+      if (payoutGroup.payout === roundedPayout) {
+        groupIndex = payoutGroup.groups.findIndex((group) => {
+          return group.every((msg, i) => msg === outcomesFormatted[i]);
+        });
+        if (groupIndex === -1)
+          throw Error(
+            'Failed to Find OutcomeIndex From PolynomialPayoutCurvePiece. \
+Payout Group found but incorrect group index',
+          );
+        index += groupIndex;
+        groupLength = payoutGroup.groups[groupIndex].length;
+        break;
+      } else {
+        index += payoutGroup.groups.length;
+      }
+    }
+
+    if (groupIndex === -1)
+      throw Error(
+        'Failed to Find OutcomeIndex From PolynomialPayoutCurvePiece. \
+Payout Group not found',
+      );
+
+    return { index: payoutIndexOffset + index, groupLength };
+  }
+
   async FindOutcomeIndexFromHyperbolaPayoutCurvePiece(
     _dlcOffer: DlcOffer,
     contractDescriptor: ContractDescriptorV1,
@@ -1052,14 +1219,21 @@ Payout Group not found',
       .reduce((acc, val, i) => acc + Number(val) * base ** i, 0);
 
     const piecesSorted = payoutFunction.pieces.sort(
-      (a, b) => Number(b.endpoint) - Number(a.endpoint),
+      (a, b) => Number(a.endpoint) - Number(b.endpoint),
     );
 
     const piece = piecesSorted.find((piece) => outcome < piece.endpoint);
 
     switch (piece.payoutCurvePiece.type) {
       case MessageType.PolynomialPayoutCurvePiece:
-        throw Error('Polynomial Curve Piece not yet supported');
+        return this.FindOutcomeIndexFromPolynomialPayoutCurvePiece(
+          dlcOffer,
+          contractDescriptor,
+          contractOraclePairIndex,
+          piece.payoutCurvePiece as PolynomialPayoutCurvePiece,
+          oracleAttestation,
+          BigInt(outcome),
+        );
       case MessageType.HyperbolaPayoutCurvePiece:
         return this.FindOutcomeIndexFromHyperbolaPayoutCurvePiece(
           dlcOffer,
@@ -1563,11 +1737,13 @@ Payout Group not found',
       network,
     );
 
-    let walletAddress: Address = await this.getMethod('findAddress')([
+    let walletAddress: Address = await this.client.wallet.findAddress([
       offerFundingAddress,
     ]);
     if (walletAddress) return true;
-    walletAddress = await this.getMethod('findAddress')([acceptFundingAddress]);
+    walletAddress = await this.client.wallet.findAddress([
+      acceptFundingAddress,
+    ]);
     if (walletAddress) return false;
 
     throw Error('Wallet Address not found for DlcOffer or DlcAccept');
@@ -2774,9 +2950,9 @@ Payout Group not found',
     let derivationPath: string;
 
     if (findDerivationPath) {
-      const inputAddress: Address = await this.client.financewallet.quickFindAddress(
-        [_address],
-      );
+      const inputAddress: Address = await this.client.wallet.findAddress([
+        _address,
+      ]);
       if (inputAddress) {
         derivationPath = inputAddress.derivationPath;
       }
@@ -2816,6 +2992,7 @@ Payout Group not found',
         );
       }
     }
+
     const tx = Tx.decode(StreamReader.fromHex(txRaw));
 
     fundingInput.prevTx = tx;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@atomicfinance/bitcoin-dlc-provider",
   "umdName": "BitcoinDlcProvider",
-  "version": "2.4.2",
-  "description": "CAL Finance Bitcoin Dlc Provider",
+  "version": "3.0.0",
+  "description": "Bitcoin Abstraction Layer Dlc Provider",
   "author": "Atomic Finance <info@atomic.finance>",
   "homepage": "",
   "license": "ISC",
@@ -15,20 +15,18 @@
     "lint:fix": "../../node_modules/.bin/eslint --fix --ignore-path ../../.eslintignore  -c ../../.eslintrc.js ."
   },
   "dependencies": {
-    "@atomicfinance/bitcoin-networks": "^2.4.2",
-    "@atomicfinance/provider": "^2.4.2",
-    "@atomicfinance/types": "^2.4.2",
-    "@liquality/bitcoin-utils": "1.1.5",
-    "@liquality/provider": "1.1.5",
-    "@liquality/types": "1.1.5",
-    "@liquality/utils": "1.1.5",
-    "@node-dlc/core": "0.12.1",
-    "@node-dlc/messaging": "0.12.1",
+    "@atomicfinance/bitcoin-utils": "3.0.0",
+    "@atomicfinance/provider": "^3.0.0",
+    "@atomicfinance/types": "^3.0.0",
+    "@atomicfinance/utils": "^3.0.0",
+    "@node-dlc/core": "0.19.1",
+    "@node-dlc/messaging": "0.19.1",
     "@node-lightning/bitcoin": "0.26.1",
     "@node-lightning/bufio": "0.26.1",
     "@node-lightning/crypto": "0.26.1",
-    "bignumber.js": "9.0.1",
+    "bignumber.js": "^9.0.1",
     "bip-schnorr": "0.6.2",
+    "bitcoin-networks": "^1.0.0",
     "bitcoinjs-lib": "5.2.0",
     "lodash": "^4.17.20",
     "randombytes": "2.1.0",
@@ -36,10 +34,9 @@
   },
   "devDependencies": {
     "@types/lodash": "^4.14.160",
-    "@types/node": "^16.10.2"
+    "@types/node": "16.10.3"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "ae5d1bf9db5c664032f0be604116a83dbf6b5db3"
+  }
 }