@atomicfinance/types 4.2.8 → 4.3.0

package/.yalc/@node-dlc/messaging/__tests__/messages/AddressCache.spec.ts

@@ -0,0 +1,79 @@
+import { BitcoinNetworks } from 'bitcoin-networks';
+import { expect } from 'chai';
+
+import { AddressCache, IAddressCache } from '../../lib/messages/AddressCache';
+
+describe('AddressCache', () => {
+  const network = BitcoinNetworks.bitcoin_regtest;
+
+  const addressCache: IAddressCache[] = [];
+  addressCache['bcrt1qe8y4pn4ed4ps89x0etf2vjcr85ch3vvfe74s2k'] = true;
+  addressCache['bcrt1qtc6s584j37797hss9e384e2q8rn0mhzufer4lg'] = true;
+
+  const cacheSPKs: Buffer[] = [
+    Buffer.from('0014c9c950ceb96d430394cfcad2a64b033d3178b189', 'hex'),
+    Buffer.from('00145e350a1eb28fbc5f5e102e627ae54038e6fddc5c', 'hex'),
+  ];
+
+  describe('serialize', () => {
+    it('serializes', () => {
+      const instance = new AddressCache();
+
+      instance.cacheSPKs = cacheSPKs;
+
+      expect(instance.serialize().toString('hex')).to.equal(
+        "fe6c" + // type address_cache
+        "02" + // num_cache_spks
+        "16" + // cache_spk_1_len
+        "0014c9c950ceb96d430394cfcad2a64b033d3178b189" + // cache_spk_1
+        "16" + // cache_spk_2_len
+        "00145e350a1eb28fbc5f5e102e627ae54038e6fddc5c" // cache_spk_2
+      ); // prettier-ignore
+    });
+  });
+
+  describe('toAddressCache', () => {
+    it('toAddressCache', () => {
+      const instance = new AddressCache();
+
+      instance.cacheSPKs = cacheSPKs;
+
+      const addressCache: IAddressCache[] = instance.toAddressCache(network);
+
+      expect(
+        addressCache['bcrt1qe8y4pn4ed4ps89x0etf2vjcr85ch3vvfe74s2k'],
+      ).to.equal(true);
+      expect(
+        addressCache['bcrt1qtc6s584j37797hss9e384e2q8rn0mhzufer4lg'],
+      ).to.equal(true);
+    });
+  });
+
+  describe('deserializes', () => {
+    it('deserializes', () => {
+      const instance = AddressCache.deserialize(
+        Buffer.from(
+          'fe6c' + // type address_cache
+            '02' + // num_cache_spks
+            '16' + // cache_spk_1_len
+            '0014c9c950ceb96d430394cfcad2a64b033d3178b189' + // cache_spk_1
+            '16' + // cache_spk_2_len
+            '00145e350a1eb28fbc5f5e102e627ae54038e6fddc5c', // cache_spk_2
+          'hex',
+        ),
+      );
+
+      expect(instance.cacheSPKs[0]).to.deep.equal(cacheSPKs[0]);
+      expect(instance.cacheSPKs[1]).to.deep.equal(cacheSPKs[1]);
+    });
+  });
+
+  describe('fromAddressCache', () => {
+    it('fromAddressCache', () => {
+      const instance = AddressCache.fromAddressCache(addressCache, network);
+
+      expect(instance.cacheSPKs[0]).to.deep.equal(cacheSPKs[0]);
+      expect(instance.cacheSPKs[1]).to.deep.equal(cacheSPKs[1]);
+    });
+  });
+});

package/.yalc/@node-dlc/messaging/__tests__/messages/BatchFundingGroup.spec.ts

@@ -0,0 +1,72 @@
+import { Value } from '@node-dlc/bitcoin';
+import { expect } from 'chai';
+
+import { BatchFundingGroup } from '../../lib';
+
+describe('BatchFundingGroup TLV', () => {
+  it('should serialize and deserialize without contract ids', () => {
+    const batchFundingGroup = new BatchFundingGroup();
+
+    const eventIds = ['event1', 'event2', 'event3'];
+
+    batchFundingGroup.eventIds = eventIds;
+    batchFundingGroup.allocatedCollateral = Value.fromBitcoin(0.5);
+
+    const deserialized = BatchFundingGroup.deserialize(
+      batchFundingGroup.serialize(),
+    );
+
+    expect(deserialized.eventIds).to.deep.equal(eventIds);
+    expect(batchFundingGroup.serialize()).to.deep.equal(
+      deserialized.serialize(),
+    );
+  });
+
+  it('should serialize and deserialize with contract ids', () => {
+    const batchFundingGroup = new BatchFundingGroup();
+
+    const eventIds = ['event1', 'event2', 'event3'];
+
+    batchFundingGroup.eventIds = eventIds;
+    batchFundingGroup.allocatedCollateral = Value.fromBitcoin(0.5);
+    batchFundingGroup.tempContractIds = [
+      Buffer.from('tempContractId1'),
+      Buffer.from('tempContractId2'),
+      Buffer.from('tempContractId3'),
+    ];
+    batchFundingGroup.contractIds = [
+      Buffer.from('contractId1'),
+      Buffer.from('contractId2'),
+      Buffer.from('contractId3'),
+    ];
+
+    const deserialized = BatchFundingGroup.deserialize(
+      batchFundingGroup.serialize(),
+    );
+
+    expect(deserialized.eventIds).to.deep.equal(eventIds);
+    expect(batchFundingGroup.serialize()).to.deep.equal(
+      deserialized.serialize(),
+    );
+  });
+
+  it('should serialize and deserialize with empty contract ids', () => {
+    const batchFundingGroup = new BatchFundingGroup();
+
+    const eventIds = ['event1', 'event2', 'event3'];
+
+    batchFundingGroup.eventIds = eventIds;
+    batchFundingGroup.allocatedCollateral = Value.fromBitcoin(0.5);
+    batchFundingGroup.tempContractIds = [];
+    batchFundingGroup.contractIds = [];
+
+    const deserialized = BatchFundingGroup.deserialize(
+      batchFundingGroup.serialize(),
+    );
+
+    expect(deserialized.eventIds).to.deep.equal(eventIds);
+    expect(batchFundingGroup.serialize()).to.deep.equal(
+      deserialized.serialize(),
+    );
+  });
+});

package/.yalc/@node-dlc/messaging/__tests__/messages/CetAdaptorSignatures.spec.ts

@@ -0,0 +1,57 @@
+import { expect } from 'chai';
+
+import { CetAdaptorSignatures } from '../../lib/messages/CetAdaptorSignatures';
+
+describe('CetAdaptorSignatures', () => {
+  let instance: CetAdaptorSignatures;
+
+  // Use proper sizes: encrypted signatures are 65 bytes, DLEQ proofs are 97 bytes
+  const encryptedSigOne = Buffer.alloc(65, 0x01);
+  const dleqProofOne = Buffer.alloc(97, 0x02);
+  const encryptedSigTwo = Buffer.alloc(65, 0x03);
+  const dleqProofTwo = Buffer.alloc(97, 0x04);
+  const encryptedSigThree = Buffer.alloc(65, 0x05);
+  const dleqProofThree = Buffer.alloc(97, 0x06);
+
+  beforeEach(() => {
+    instance = new CetAdaptorSignatures();
+    instance.sigs = [
+      { encryptedSig: encryptedSigOne, dleqProof: dleqProofOne },
+      { encryptedSig: encryptedSigTwo, dleqProof: dleqProofTwo },
+      { encryptedSig: encryptedSigThree, dleqProof: dleqProofThree },
+    ];
+  });
+
+  describe('serialize and deserialize', () => {
+    it('should round-trip correctly', () => {
+      const serialized = instance.serialize();
+      expect(serialized).to.be.instanceof(Buffer);
+      expect(serialized.length).to.be.greaterThan(0);
+
+      const deserialized = CetAdaptorSignatures.deserialize(serialized);
+      expect(deserialized.sigs).to.have.length(3);
+      expect(deserialized.sigs[0].encryptedSig).to.deep.equal(encryptedSigOne);
+      expect(deserialized.sigs[0].dleqProof).to.deep.equal(dleqProofOne);
+      expect(deserialized.sigs[1].encryptedSig).to.deep.equal(encryptedSigTwo);
+      expect(deserialized.sigs[1].dleqProof).to.deep.equal(dleqProofTwo);
+      expect(deserialized.sigs[2].encryptedSig).to.deep.equal(
+        encryptedSigThree,
+      );
+      expect(deserialized.sigs[2].dleqProof).to.deep.equal(dleqProofThree);
+    });
+  });
+
+  describe('toJSON', () => {
+    it('should convert to canonical rust-dlc JSON format', () => {
+      const json = instance.toJSON();
+      expect(json.ecdsaAdaptorSignatures).to.be.an('array');
+      expect(json.ecdsaAdaptorSignatures).to.have.length(3);
+
+      // Verify first signature combines encryptedSig + dleqProof
+      const expectedSig1 = Buffer.concat([encryptedSigOne, dleqProofOne]);
+      expect(json.ecdsaAdaptorSignatures[0].signature).to.equal(
+        expectedSig1.toString('hex'),
+      );
+    });
+  });
+});

package/.yalc/@node-dlc/messaging/__tests__/messages/ContractDescriptor.spec.ts

@@ -0,0 +1,266 @@
+import { expect } from 'chai';
+
+import {
+  ContractDescriptor,
+  EnumeratedDescriptor,
+  NumericalDescriptor,
+} from '../../lib/messages/ContractDescriptor';
+import { HyperbolaPayoutCurvePiece } from '../../lib/messages/PayoutCurvePiece';
+import { PayoutFunction } from '../../lib/messages/PayoutFunction';
+import { RoundingIntervals } from '../../lib/messages/RoundingIntervals';
+import { F64 } from '../../lib/serialize/F64';
+
+describe('ContractDescriptor', () => {
+  describe('EnumeratedDescriptor', () => {
+    describe('serialize', () => {
+      it('serializes', () => {
+        const instance = new EnumeratedDescriptor();
+
+        // Use simple string outcomes instead of hex hashes for the new format
+        const outcomeOne = 'win';
+        const payoutOne = BigInt(0);
+        const outcomeTwo = 'lose';
+        const payoutTwo = BigInt(153445027);
+        const outcomeThree = 'draw';
+        const payoutThree = BigInt(200000000);
+
+        instance.outcomes = [
+          { outcome: outcomeOne, localPayout: payoutOne },
+          { outcome: outcomeTwo, localPayout: payoutTwo },
+          { outcome: outcomeThree, localPayout: payoutThree },
+        ];
+
+        expect(instance.serialize().toString('hex')).to.equal(
+          '00' + // type: enumerated_contract_descriptor (0)
+            '03' + // num_outcomes
+            '03' +
+            '77696e' + // outcome_1: "win" (length=3, data)
+            '0000000000000000' + // payout_1
+            '04' +
+            '6c6f7365' + // outcome_2: "lose" (length=4, data)
+            '00000000092562a3' + // payout_2 (actual hex value from implementation)
+            '04' +
+            '64726177' + // outcome_3: "draw" (length=4, data)
+            '000000000bebc200', // payout_3
+        );
+      });
+    });
+
+    describe('deserialize', () => {
+      it('deserializes', () => {
+        // Create a test instance and serialize it
+        const originalInstance = new EnumeratedDescriptor();
+        originalInstance.outcomes = [
+          { outcome: 'win', localPayout: BigInt(0) },
+          { outcome: 'lose', localPayout: BigInt(153517731) },
+          { outcome: 'draw', localPayout: BigInt(200000000) },
+        ];
+
+        // Serialize and then deserialize to ensure round-trip consistency
+        const serialized = originalInstance.serialize();
+        const unknownInstance = ContractDescriptor.deserialize(serialized);
+
+        expect(unknownInstance.contractDescriptorType).to.equal(0); // enumerated_contract_descriptor type (new format)
+
+        if (unknownInstance instanceof EnumeratedDescriptor) {
+          const instance = unknownInstance as EnumeratedDescriptor;
+
+          expect(instance.outcomes.length).to.equal(3);
+          expect(instance.outcomes[0].outcome).to.equal('win');
+          expect(Number(instance.outcomes[0].localPayout)).to.equal(0);
+          expect(instance.outcomes[1].outcome).to.equal('lose');
+          expect(Number(instance.outcomes[1].localPayout)).to.equal(153517731);
+          expect(instance.outcomes[2].outcome).to.equal('draw');
+          expect(Number(instance.outcomes[2].localPayout)).to.equal(200000000);
+        }
+      });
+    });
+
+    describe('toJSON', () => {
+      it('converts to JSON', () => {
+        const instance = new EnumeratedDescriptor();
+
+        const outcomeOne = 'win';
+        const payoutOne = BigInt(0);
+        const outcomeTwo = 'lose';
+        const payoutTwo = BigInt(153517731); // Updated to match actual implementation
+        const outcomeThree = 'draw';
+        const payoutThree = BigInt(200000000);
+
+        instance.outcomes = [
+          { outcome: outcomeOne, localPayout: payoutOne },
+          { outcome: outcomeTwo, localPayout: payoutTwo },
+          { outcome: outcomeThree, localPayout: payoutThree },
+        ];
+
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const json = instance.toJSON() as any; // Cast to any to access the wrapped structure
+
+        // Check that the JSON has the proper enum format structure
+        expect(json.enumeratedContractDescriptor).to.exist;
+        expect(json.enumeratedContractDescriptor.payouts.length).to.equal(3);
+        expect(json.enumeratedContractDescriptor.payouts[0].outcome).to.equal(
+          outcomeOne,
+        );
+        expect(
+          json.enumeratedContractDescriptor.payouts[0].offerPayout,
+        ).to.equal(0);
+        expect(json.enumeratedContractDescriptor.payouts[1].outcome).to.equal(
+          outcomeTwo,
+        );
+        expect(
+          json.enumeratedContractDescriptor.payouts[1].offerPayout,
+        ).to.equal(153517731); // Updated value
+        expect(json.enumeratedContractDescriptor.payouts[2].outcome).to.equal(
+          outcomeThree,
+        );
+        expect(
+          json.enumeratedContractDescriptor.payouts[2].offerPayout,
+        ).to.equal(200000000);
+      });
+    });
+  });
+
+  describe('NumericalDescriptor', () => {
+    describe('serialize/deserialize', () => {
+      it('should serialize and deserialize correctly', () => {
+        const instance = new NumericalDescriptor();
+        instance.numDigits = 18;
+
+        // Create proper HyperbolaPayoutCurvePiece instance with new F64 structure
+        const hyperbolaPayoutCurvePiece = new HyperbolaPayoutCurvePiece();
+        hyperbolaPayoutCurvePiece.usePositivePiece = true;
+        hyperbolaPayoutCurvePiece.translateOutcome = F64.fromNumber(0);
+        hyperbolaPayoutCurvePiece.translatePayout = F64.fromNumber(30518);
+        hyperbolaPayoutCurvePiece.a = F64.fromNumber(1);
+        hyperbolaPayoutCurvePiece.b = F64.fromNumber(0);
+        hyperbolaPayoutCurvePiece.c = F64.fromNumber(0);
+        hyperbolaPayoutCurvePiece.d = F64.fromNumber(4000000000);
+
+        // Create proper PayoutFunction instance with new structure
+        const payoutFunction = new PayoutFunction();
+        payoutFunction.lastEndpoint = {
+          eventOutcome: BigInt(0),
+          outcomePayout: BigInt(969482),
+          extraPrecision: 0,
+        };
+        payoutFunction.payoutFunctionPieces = [
+          {
+            endPoint: {
+              eventOutcome: BigInt(131071),
+              outcomePayout: BigInt(0),
+              extraPrecision: 0,
+            },
+            payoutCurvePiece: hyperbolaPayoutCurvePiece,
+          },
+        ];
+
+        instance.payoutFunction = payoutFunction;
+
+        // Create proper RoundingIntervals instance
+        const roundingIntervals = new RoundingIntervals();
+        roundingIntervals.intervals = [
+          {
+            beginInterval: BigInt(0),
+            roundingMod: BigInt(500),
+          },
+        ];
+
+        instance.roundingIntervals = roundingIntervals;
+
+        const serialized = instance.serialize();
+        const deserialized = ContractDescriptor.deserialize(serialized);
+
+        expect(deserialized.contractDescriptorType).to.equal(1); // numeric_outcome_contract_descriptor type (new format)
+        expect(deserialized).to.be.instanceOf(NumericalDescriptor);
+
+        if (deserialized instanceof NumericalDescriptor) {
+          expect(deserialized.numDigits).to.equal(18);
+          expect(
+            deserialized.payoutFunction.payoutFunctionPieces.length,
+          ).to.equal(1);
+          expect(
+            deserialized.payoutFunction.lastEndpoint.eventOutcome,
+          ).to.equal(BigInt(0));
+          expect(
+            deserialized.payoutFunction.lastEndpoint.outcomePayout,
+          ).to.equal(BigInt(969482));
+          expect(deserialized.roundingIntervals.intervals.length).to.equal(1);
+          expect(
+            deserialized.roundingIntervals.intervals[0].beginInterval,
+          ).to.equal(BigInt(0));
+          expect(
+            deserialized.roundingIntervals.intervals[0].roundingMod,
+          ).to.equal(BigInt(500));
+        }
+      });
+    });
+
+    describe('toJSON', () => {
+      it('converts to JSON', () => {
+        const instance = new NumericalDescriptor();
+        instance.numDigits = 5;
+
+        // Create a simple hyperbola payout curve piece for JSON testing
+        const hyperbolaPayoutCurvePiece = new HyperbolaPayoutCurvePiece();
+        hyperbolaPayoutCurvePiece.usePositivePiece = true;
+        hyperbolaPayoutCurvePiece.translateOutcome = F64.fromNumber(100);
+        hyperbolaPayoutCurvePiece.translatePayout = F64.fromNumber(50000);
+        hyperbolaPayoutCurvePiece.a = F64.fromNumber(2);
+        hyperbolaPayoutCurvePiece.b = F64.fromNumber(3);
+        hyperbolaPayoutCurvePiece.c = F64.fromNumber(4);
+        hyperbolaPayoutCurvePiece.d = F64.fromNumber(5000000000);
+
+        const payoutFunction = new PayoutFunction();
+        payoutFunction.lastEndpoint = {
+          eventOutcome: BigInt(31),
+          outcomePayout: BigInt(100000000),
+          extraPrecision: 0,
+        };
+        payoutFunction.payoutFunctionPieces = [
+          {
+            endPoint: {
+              eventOutcome: BigInt(15),
+              outcomePayout: BigInt(50000000),
+              extraPrecision: 0,
+            },
+            payoutCurvePiece: hyperbolaPayoutCurvePiece,
+          },
+        ];
+
+        instance.payoutFunction = payoutFunction;
+
+        const roundingIntervals = new RoundingIntervals();
+        roundingIntervals.intervals = [
+          {
+            beginInterval: BigInt(0),
+            roundingMod: BigInt(1),
+          },
+        ];
+        instance.roundingIntervals = roundingIntervals;
+
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const json = instance.toJSON() as any; // Cast to any to access the wrapped structure
+
+        // Check that the JSON has the proper structure
+        expect(json.numericOutcomeContractDescriptor).to.exist;
+        expect(json.numericOutcomeContractDescriptor.numDigits).to.equal(5);
+        expect(json.numericOutcomeContractDescriptor.payoutFunction).to.exist;
+        expect(
+          json.numericOutcomeContractDescriptor.payoutFunction
+            .payoutFunctionPieces.length,
+        ).to.equal(1);
+        expect(
+          json.numericOutcomeContractDescriptor.payoutFunction.lastEndpoint
+            .eventOutcome,
+        ).to.equal(31);
+        expect(json.numericOutcomeContractDescriptor.roundingIntervals).to
+          .exist;
+        expect(
+          json.numericOutcomeContractDescriptor.roundingIntervals.intervals
+            .length,
+        ).to.equal(1);
+      });
+    });
+  });
+});