✨ feat: rename cso info and add position info

packages/core/lib/dlc/finance/Builder.ts

@@ -6,8 +6,8 @@ import {
   MessageType,
   OracleAnnouncementV0,
   OracleInfoV0,
-  OrderCsoInfoV0,
   OrderOfferV0,
+  OrderPositionInfoV0,
   PayoutFunctionV0,
   RoundingIntervalsV0,
 } from '@node-dlc/messaging';
@@ -481,10 +481,10 @@ export const buildLinearOrderOffer = (
   );
 
   if (shiftForFees !== 'neither') {
-    const csoInfo = new OrderCsoInfoV0();
-    csoInfo.shiftForFees = shiftForFees;
-    csoInfo.fees = fees.sats;
-    orderOffer.csoInfo = csoInfo;
+    const positionInfo = new OrderPositionInfoV0();
+    positionInfo.shiftForFees = shiftForFees;
+    positionInfo.fees = fees.sats;
+    orderOffer.positionInfo = positionInfo;
   }
 
   return orderOffer;

packages/core/lib/dlc/finance/CsoInfo.ts

@@ -5,8 +5,8 @@ import {
   ContractInfoV0,
   DigitDecompositionEventDescriptorV0,
   MessageType,
-  OrderCsoInfo,
-  OrderCsoInfoV0,
+  OrderPositionInfo,
+  OrderPositionInfoV0,
   PayoutFunctionV0,
   PolynomialPayoutCurvePiece,
 } from '@node-dlc/messaging';
@@ -31,8 +31,8 @@ export interface CsoInfo {
 
 const ONE_BTC_CONTRACT = Value.fromBitcoin(1);
 
-export type MaybeHasCsoInfo = {
-  csoInfo?: OrderCsoInfo;
+export type MaybeHasPositionInfo = {
+  positionInfo?: OrderPositionInfo;
 };
 
 /**
@@ -147,7 +147,7 @@ export const getCsoInfoFromOffer = (
   offer: HasContractInfo &
     HasType &
     HasOfferCollateralSatoshis &
-    MaybeHasCsoInfo,
+    MaybeHasPositionInfo,
 ): CsoInfo => {
   if (
     offer.type !== MessageType.DlcOfferV0 &&
@@ -158,21 +158,21 @@ export const getCsoInfoFromOffer = (
   let shiftForFees: DlcParty = 'neither';
   const fees = Value.zero();
 
-  if (offer.csoInfo) {
-    shiftForFees = (offer.csoInfo as OrderCsoInfoV0).shiftForFees;
-    fees.add(Value.fromSats((offer.csoInfo as OrderCsoInfoV0).fees));
+  if (offer.positionInfo) {
+    shiftForFees = (offer.positionInfo as OrderPositionInfoV0).shiftForFees;
+    fees.add(Value.fromSats((offer.positionInfo as OrderPositionInfoV0).fees));
   }
 
-  const csoInfo = getCsoInfoFromContractInfo(
+  const positionInfo = getCsoInfoFromContractInfo(
     offer.contractInfo,
     shiftForFees,
     fees,
   );
 
-  if (csoInfo.offerCollateral.sats !== offer.offerCollateralSatoshis)
+  if (positionInfo.offerCollateral.sats !== offer.offerCollateralSatoshis)
     throw Error('Offer was not generated with CSO ContractInfo');
 
-  return csoInfo;
+  return positionInfo;
 };
 
 /**

packages/messaging/__tests__/messages/DlcOfferV0.spec.ts

@@ -1,7 +1,7 @@
 import { BitcoinNetworks } from 'bitcoin-networks';
 import { expect } from 'chai';
 
-import { OrderCsoInfoV0 } from '../../lib';
+import { OrderPositionInfoV0 } from '../../lib';
 import { ContractInfo } from '../../lib/messages/ContractInfo';
 import {
   DlcOffer,
@@ -160,14 +160,16 @@ describe('DlcOffer', () => {
         );
       });
 
-      it('serializes with csoinfo', () => {
-        const csoInfo = new OrderCsoInfoV0();
-        csoInfo.shiftForFees = 'acceptor';
-        csoInfo.fees = BigInt(1000);
+      it('serializes with positioninfo', () => {
+        const positionInfo = new OrderPositionInfoV0();
+        positionInfo.shiftForFees = 'acceptor';
+        positionInfo.fees = BigInt(1000);
 
-        instance.csoInfo = csoInfo;
+        instance.positionInfo = positionInfo;
         expect(instance.serialize().toString('hex')).to.equal(
-          Buffer.concat([dlcOfferHex, csoInfo.serialize()]).toString('hex'),
+          Buffer.concat([dlcOfferHex, positionInfo.serialize()]).toString(
+            'hex',
+          ),
         );
       });
     });
@@ -202,15 +204,15 @@ describe('DlcOffer', () => {
         );
       });
 
-      it('deserializes with csoinfo', () => {
-        const csoInfo = new OrderCsoInfoV0();
-        csoInfo.shiftForFees = 'acceptor';
-        csoInfo.fees = BigInt(1000);
+      it('deserializes with positioninfo', () => {
+        const positionInfo = new OrderPositionInfoV0();
+        positionInfo.shiftForFees = 'acceptor';
+        positionInfo.fees = BigInt(1000);
 
-        instance.csoInfo = csoInfo;
+        instance.positionInfo = positionInfo;
         expect(
-          DlcOfferV0.deserialize(instance.serialize()).csoInfo.serialize(),
-        ).to.deep.equal(csoInfo.serialize());
+          DlcOfferV0.deserialize(instance.serialize()).positionInfo.serialize(),
+        ).to.deep.equal(positionInfo.serialize());
       });
     });
 

packages/messaging/__tests__/messages/OrderOffer.spec.ts

@@ -1,6 +1,10 @@
 import { expect } from 'chai';
 
-import { LOCKTIME_THRESHOLD, MessageType, OrderCsoInfoV0 } from '../../lib';
+import {
+  LOCKTIME_THRESHOLD,
+  MessageType,
+  OrderPositionInfoV0,
+} from '../../lib';
 import { ContractInfo } from '../../lib/messages/ContractInfo';
 import {
   IOrderIrcInfoJSON,
@@ -261,11 +265,11 @@ describe('OrderOffer', () => {
     });
 
     it('serializes with cso info', () => {
-      const csoInfo = new OrderCsoInfoV0();
-      csoInfo.shiftForFees = 'offeror';
-      csoInfo.fees = BigInt(10000);
+      const positionInfo = new OrderPositionInfoV0();
+      positionInfo.shiftForFees = 'offeror';
+      positionInfo.fees = BigInt(10000);
 
-      instance.csoInfo = csoInfo;
+      instance.positionInfo = positionInfo;
 
       expect(instance.serialize().toString('hex')).to.equal(
         'f532' + // type
@@ -373,18 +377,20 @@ describe('OrderOffer', () => {
       );
     });
 
-    it('deserializes with csoinfo', () => {
-      const bufWithCsoInfo = Buffer.concat([
+    it('deserializes with positioninfo', () => {
+      const bufWithPositionInfo = Buffer.concat([
         buf,
         Buffer.from('fdf53a09010000000000002710', 'hex'),
       ]);
 
-      const instance = OrderOfferV0.deserialize(bufWithCsoInfo);
+      const instance = OrderOfferV0.deserialize(bufWithPositionInfo);
 
-      expect((instance.csoInfo as OrderCsoInfoV0).shiftForFees).to.equal(
-        'offeror',
+      expect(
+        (instance.positionInfo as OrderPositionInfoV0).shiftForFees,
+      ).to.equal('offeror');
+      expect((instance.positionInfo as OrderPositionInfoV0).fees).to.equal(
+        BigInt(10000),
       );
-      expect((instance.csoInfo as OrderCsoInfoV0).fees).to.equal(BigInt(10000));
     });
   });
 

packages/messaging/__tests__/messages/OrderPositionInfo.spec.ts

@@ -0,0 +1,75 @@
+import { expect } from 'chai';
+
+import { OrderPositionInfoV0 } from '../../lib/messages/OrderPositionInfo';
+
+describe('OrderPositionInfo', () => {
+  let instance: OrderPositionInfoV0;
+
+  beforeEach(() => {
+    instance = new OrderPositionInfoV0();
+    instance.shiftForFees = 'offeror';
+    instance.fees = BigInt(10000);
+    instance.instrumentName = 'BTC-24SEP23-23500-P';
+    instance.contractSize = BigInt(1e8);
+    instance.direction = 'buy';
+    instance.price = BigInt(100000);
+  });
+
+  describe('deserialize', () => {
+    it('should correctly deserialize data', () => {
+      const buf = Buffer.from(
+        'fdf53a2e010000000000002710134254432d323453455032332d32333530302d500000000005f5e1000100000000000186a00000',
+        'hex',
+      );
+      const result = OrderPositionInfoV0.deserialize(buf);
+
+      expect(result.shiftForFees).to.equal('offeror');
+      expect(result.fees).to.equal(BigInt(10000));
+    });
+
+    it('should throw an error for invalid shiftForFees value', () => {
+      const buf = Buffer.from('fdf53a09030000000000002710', 'hex');
+      expect(() => OrderPositionInfoV0.deserialize(buf)).to.throw(
+        'Invalid shift for fees value: 3',
+      );
+    });
+
+    it('should deserialize with no instrument name or other parameters', () => {
+      const buf = Buffer.from('fdf53a2e010000000000002710', 'hex');
+      const result = OrderPositionInfoV0.deserialize(buf);
+
+      expect(result.shiftForFees).to.equal('offeror');
+      expect(result.fees).to.equal(BigInt(10000));
+    });
+  });
+
+  describe('serialize', () => {
+    it('should correctly serialize data', () => {
+      instance.shiftForFees = 'offeror';
+      instance.fees = BigInt(10000);
+
+      const result = instance.serialize();
+      expect(result.toString('hex')).to.equal(
+        'fdf53a30010000000000002710134254432d323453455032332d32333530302d500000000005f5e1000100000000000186a00000',
+      );
+    });
+  });
+
+  describe('toJSON', () => {
+    it('should correctly convert to JSON', () => {
+      instance.shiftForFees = 'offeror';
+      instance.fees = BigInt(10000);
+
+      const result = instance.toJSON();
+      expect(result).to.deep.equal({
+        type: instance.type,
+        shiftForFees: instance.shiftForFees,
+        fees: Number(instance.fees),
+        instrumentName: instance.instrumentName,
+        direction: instance.direction,
+        price: Number(instance.price),
+        extraPrecision: instance.extraPrecision,
+      });
+    });
+  });
+});

packages/messaging/lib/MessageType.ts

@@ -68,7 +68,7 @@ export enum MessageType {
   OrderAcceptV0 = 62772,
   OrderMetadataV0 = 62774,
   OrderIrcInfoV0 = 62776,
-  OrderCsoInfoV0 = 62778,
+  OrderPositionInfoV0 = 62778,
 
   OrderNegotiationFieldsV0 = 65334,
   OrderNegotiationFieldsV1 = 65336,

packages/messaging/lib/index.ts

@@ -31,7 +31,7 @@ export * from './messages/OracleInfoV0';
 export * from './messages/OrderAccept';
 export * from './messages/OrderNegotiationFields';
 export * from './messages/OrderOffer';
-export * from './messages/OrderCsoInfo';
+export * from './messages/OrderPositionInfo';
 export * from './messages/OrderIrcInfo';
 export * from './messages/OrderMetadata';
 export * from './messages/PayoutCurvePiece';

packages/messaging/lib/messages/DlcOffer.ts

@@ -19,7 +19,6 @@ import {
   FundingInputV0,
   IFundingInputV0JSON,
 } from './FundingInput';
-import { IOrderCsoInfoJSON, OrderCsoInfo } from './OrderCsoInfo';
 import {
   IOrderIrcInfoJSON,
   OrderIrcInfo,
@@ -30,6 +29,7 @@ import {
   OrderMetadata,
   OrderMetadataV0,
 } from './OrderMetadata';
+import { IOrderPositionInfoJSON, OrderPositionInfo } from './OrderPositionInfo';
 
 export const LOCKTIME_THRESHOLD = 500000000;
 export abstract class DlcOffer {
@@ -108,8 +108,8 @@ export class DlcOfferV0 extends DlcOffer implements IDlcMessage {
         case MessageType.OrderIrcInfoV0:
           instance.ircInfo = OrderIrcInfoV0.deserialize(buf);
           break;
-        case MessageType.OrderCsoInfoV0:
-          instance.csoInfo = OrderCsoInfo.deserialize(buf);
+        case MessageType.OrderPositionInfoV0:
+          instance.positionInfo = OrderPositionInfo.deserialize(buf);
           break;
         default:
           break;
@@ -156,7 +156,7 @@ export class DlcOfferV0 extends DlcOffer implements IDlcMessage {
 
   public ircInfo?: OrderIrcInfo;
 
-  public csoInfo?: OrderCsoInfo;
+  public positionInfo?: OrderPositionInfo;
 
   /**
    * Get funding, change and payout address from DlcOffer
@@ -293,7 +293,7 @@ export class DlcOfferV0 extends DlcOffer implements IDlcMessage {
 
     if (this.metadata) tlvs.push(this.metadata.toJSON());
     if (this.ircInfo) tlvs.push(this.ircInfo.toJSON());
-    if (this.csoInfo) tlvs.push(this.csoInfo.toJSON());
+    if (this.positionInfo) tlvs.push(this.positionInfo.toJSON());
 
     return {
       type: this.type,
@@ -345,7 +345,7 @@ export class DlcOfferV0 extends DlcOffer implements IDlcMessage {
 
     if (this.metadata) writer.writeBytes(this.metadata.serialize());
     if (this.ircInfo) writer.writeBytes(this.ircInfo.serialize());
-    if (this.csoInfo) writer.writeBytes(this.csoInfo.serialize());
+    if (this.positionInfo) writer.writeBytes(this.positionInfo.serialize());
 
     return writer.toBuffer();
   }
@@ -367,7 +367,7 @@ export interface IDlcOfferV0JSON {
   feeRatePerVb: number;
   cetLocktime: number;
   refundLocktime: number;
-  tlvs: (IOrderMetadataJSON | IOrderIrcInfoJSON | IOrderCsoInfoJSON)[];
+  tlvs: (IOrderMetadataJSON | IOrderIrcInfoJSON | IOrderPositionInfoJSON)[];
 }
 
 export interface IDlcOfferV0Addresses {