@atomicfinance/types 3.6.0 → 4.0.0

package/.yalc/@node-dlc/messaging/lib/messages/OrderIrcInfo.ts

@@ -0,0 +1,100 @@
+import { BufferReader, BufferWriter } from '@node-dlc/bufio';
+
+import { MessageType } from '../MessageType';
+import { IDlcMessage } from './DlcMessage';
+
+export abstract class OrderIrcInfo {
+  public static deserialize(buf: Buffer): OrderIrcInfo {
+    const reader = new BufferReader(buf);
+
+    const type = Number(reader.readBigSize());
+
+    switch (type) {
+      case MessageType.OrderIrcInfoV0:
+        return OrderIrcInfoV0.deserialize(buf);
+      default:
+        throw new Error(`Order irc info TLV type must be OrderIrcInfoV0`);
+    }
+  }
+
+  public abstract type: number;
+
+  public abstract toJSON(): IOrderIrcInfoJSON;
+
+  public abstract serialize(): Buffer;
+}
+
+/**
+ * OrderMetadata message contains information about a node and indicates its
+ * desire to enter into a new contract. This is the first step toward
+ * order negotiation.
+ */
+export class OrderIrcInfoV0 extends OrderIrcInfo implements IDlcMessage {
+  public static type = MessageType.OrderIrcInfoV0;
+
+  /**
+   * Deserializes an offer_dlc_v0 message
+   * @param buf
+   */
+  public static deserialize(buf: Buffer): OrderIrcInfoV0 {
+    const instance = new OrderIrcInfoV0();
+    const reader = new BufferReader(buf);
+
+    reader.readBigSize(); // read type
+    instance.length = reader.readBigSize();
+
+    const nickLength = reader.readBigSize();
+    const nickBuf = reader.readBytes(Number(nickLength));
+    instance.nick = nickBuf.toString();
+
+    instance.pubKey = reader.readBytes(33);
+
+    return instance;
+  }
+
+  /**
+   * The type for order_metadata_v0 message. order_metadata_v0 = 62774
+   */
+  public type = OrderIrcInfoV0.type;
+
+  public length: bigint;
+
+  public nick: string;
+
+  public pubKey: Buffer;
+
+  /**
+   * Converts order_metadata_v0 to JSON
+   */
+  public toJSON(): IOrderIrcInfoJSON {
+    return {
+      type: this.type,
+      nick: this.nick,
+      pubKey: this.pubKey.toString('hex'),
+    };
+  }
+
+  /**
+   * Serializes the oracle_event message into a Buffer
+   */
+  public serialize(): Buffer {
+    const writer = new BufferWriter();
+    writer.writeBigSize(this.type);
+
+    const dataWriter = new BufferWriter();
+    dataWriter.writeBigSize(this.nick.length);
+    dataWriter.writeBytes(Buffer.from(this.nick));
+    dataWriter.writeBytes(this.pubKey);
+
+    writer.writeBigSize(dataWriter.size);
+    writer.writeBytes(dataWriter.toBuffer());
+
+    return writer.toBuffer();
+  }
+}
+
+export interface IOrderIrcInfoJSON {
+  type: number;
+  nick: string;
+  pubKey: string;
+}

package/.yalc/@node-dlc/messaging/lib/messages/OrderMetadata.ts

@@ -0,0 +1,119 @@
+import { BufferReader, BufferWriter } from '@node-dlc/bufio';
+
+import { MessageType } from '../MessageType';
+import { IDlcMessage } from './DlcMessage';
+
+export abstract class OrderMetadata {
+  public static deserialize(buf: Buffer): OrderMetadata {
+    const reader = new BufferReader(buf);
+
+    const type = Number(reader.readBigSize());
+
+    switch (type) {
+      case MessageType.OrderMetadataV0:
+        return OrderMetadataV0.deserialize(buf);
+      default:
+        throw new Error(`Order metadata TLV type must be OrderMetadataV0`);
+    }
+  }
+
+  public abstract type: number;
+
+  public abstract toJSON(): IOrderMetadataJSON;
+
+  public abstract serialize(): Buffer;
+}
+
+/**
+ * OrderMetadata message contains information about a node and indicates its
+ * desire to enter into a new contract. This is the first step toward
+ * order negotiation.
+ */
+export class OrderMetadataV0 extends OrderMetadata implements IDlcMessage {
+  public static type = MessageType.OrderMetadataV0;
+
+  /**
+   * Deserializes an offer_dlc_v0 message
+   * @param buf
+   */
+  public static deserialize(buf: Buffer): OrderMetadataV0 {
+    const instance = new OrderMetadataV0();
+    const reader = new BufferReader(buf);
+
+    reader.readBigSize(); // read type
+    instance.length = reader.readBigSize();
+    const offerIdLength = reader.readBigSize();
+    const offerIdBuf = reader.readBytes(Number(offerIdLength));
+    instance.offerId = offerIdBuf.toString();
+
+    if (!reader.eof) {
+      instance.createdAt = reader.readUInt32BE();
+      instance.goodTill = reader.readUInt32BE();
+    }
+
+    return instance;
+  }
+
+  /**
+   * The type for order_metadata_v0 message. order_metadata_v0 = 62774
+   */
+  public type = OrderMetadataV0.type;
+
+  public length: bigint;
+
+  /**
+   * offerId is a unique identifier for an offer
+   * It can be used for updating liquidity for a particular category
+   * For example, how much liquidity is remaining for a particular strategy
+   * which a market maker is providing liquidity for
+   */
+  public offerId: string;
+
+  /**
+   * Timestamp for order creation
+   */
+  public createdAt = 0;
+
+  /**
+   * Amount of time order is good untill
+   */
+  public goodTill = 0;
+
+  /**
+   * Converts order_metadata_v0 to JSON
+   */
+  public toJSON(): IOrderMetadataJSON {
+    return {
+      type: this.type,
+      offerId: this.offerId,
+      createdAt: this.createdAt,
+      goodTill: this.goodTill,
+    };
+  }
+
+  /**
+   * Serializes the oracle_event message into a Buffer
+   */
+  public serialize(): Buffer {
+    const writer = new BufferWriter();
+    writer.writeBigSize(this.type);
+
+    const dataWriter = new BufferWriter();
+    dataWriter.writeBigSize(this.offerId.length);
+    dataWriter.writeBytes(Buffer.from(this.offerId));
+    dataWriter.writeUInt32BE(this.createdAt);
+    dataWriter.writeUInt32BE(this.goodTill);
+
+    writer.writeBigSize(dataWriter.size);
+    writer.writeBytes(dataWriter.toBuffer());
+
+    return writer.toBuffer();
+  }
+}
+
+export interface IOrderMetadataJSON {
+  type: number;
+  offerId: string;
+  createdAt: number;
+  goodTill: number;
+}

package/.yalc/@node-dlc/messaging/lib/messages/OrderNegotiationFields.ts

@@ -0,0 +1,157 @@
+import { BufferReader, BufferWriter } from '@node-dlc/bufio';
+
+import { MessageType } from '../MessageType';
+import { IDlcMessage } from './DlcMessage';
+import { IOrderOfferJSON, OrderOffer } from './OrderOffer';
+
+export abstract class OrderNegotiationFields {
+  public static deserialize(
+    buf: Buffer,
+  ): OrderNegotiationFieldsV0 | OrderNegotiationFieldsV1 {
+    const reader = new BufferReader(buf);
+
+    const type = Number(reader.readBigSize());
+
+    switch (type) {
+      case MessageType.OrderNegotiationFieldsV0:
+        return OrderNegotiationFieldsV0.deserialize(buf);
+      case MessageType.OrderNegotiationFieldsV1:
+        return OrderNegotiationFieldsV1.deserialize(buf);
+      default:
+        throw new Error(
+          `Order Negotiation Fields TLV type must be OrderNegotiationFieldsV0 or OrderNegotiationFieldsV1`,
+        );
+    }
+  }
+
+  public abstract type: number;
+
+  public abstract length: bigint;
+
+  public abstract toJSON():
+    | IOrderNegotiationFieldsV0JSON
+    | IOrderNegotiationFieldsV1JSON;
+
+  public abstract serialize(): Buffer;
+}
+
+/**
+ * OrderNegotiationFields V0 contains preferences of the accepter of a order
+ * offer which are taken into account during DLC construction.
+ */
+export class OrderNegotiationFieldsV0
+  extends OrderNegotiationFields
+  implements IDlcMessage {
+  public static type = MessageType.OrderNegotiationFieldsV0;
+
+  /**
+   * Deserializes an order_negotiation_fields_v0 message
+   * @param buf
+   */
+  public static deserialize(buf: Buffer): OrderNegotiationFieldsV0 {
+    const instance = new OrderNegotiationFieldsV0();
+    const reader = new BufferReader(buf);
+
+    reader.readBigSize(); // read type
+    instance.length = reader.readBigSize();
+
+    return instance;
+  }
+
+  /**
+   * The type for order_negotiation_fields_v0 message. order_negotiation_fields_v0 = 65334
+   */
+  public type = OrderNegotiationFieldsV0.type;
+
+  public length: bigint;
+
+  /**
+   * Converts order_negotiation_fields_v0 to JSON
+   */
+  public toJSON(): IOrderNegotiationFieldsV0JSON {
+    return {
+      type: this.type,
+    };
+  }
+
+  /**
+   * Serializes the order_negotiation_fields_v0 message into a Buffer
+   */
+  public serialize(): Buffer {
+    const writer = new BufferWriter();
+    writer.writeBigSize(this.type);
+    writer.writeBigSize(0);
+
+    return writer.toBuffer();
+  }
+}
+
+/**
+ * OrderNegotiationFields V1 contains preferences of the acceptor of a order
+ * offer which are taken into account during DLC construction.
+ */
+export class OrderNegotiationFieldsV1
+  extends OrderNegotiationFields
+  implements IDlcMessage {
+  public static type = MessageType.OrderNegotiationFieldsV1;
+
+  /**
+   * Deserializes an order_negotiation_fields_v1 message
+   * @param buf
+   */
+  public static deserialize(buf: Buffer): OrderNegotiationFieldsV1 {
+    const instance = new OrderNegotiationFieldsV1();
+    const reader = new BufferReader(buf);
+
+    reader.readBigSize(); // read type
+    instance.length = reader.readBigSize();
+    const newBuf = reader.readBytes();
+    instance.orderOffer = OrderOffer.deserialize(newBuf);
+
+    return instance;
+  }
+
+  /**
+   * The type for order_negotiation_fields_v1 message. order_negotiation_fields_v1 = 65336
+   */
+  public type = OrderNegotiationFieldsV1.type;
+
+  public length: bigint;
+
+  public orderOffer: OrderOffer;
+
+  /**
+   * Converts order_negotiation_fields_v1 to JSON
+   */
+  public toJSON(): IOrderNegotiationFieldsV1JSON {
+    return {
+      type: this.type,
+      orderOffer: this.orderOffer.toJSON(),
+    };
+  }
+
+  /**
+   * Serializes the order_negotiation_fields_v1 message into a Buffer
+   */
+  public serialize(): Buffer {
+    const writer = new BufferWriter();
+    writer.writeBigSize(this.type);
+
+    const dataWriter = new BufferWriter();
+    dataWriter.writeBytes(this.orderOffer.serialize());
+
+    writer.writeBigSize(dataWriter.size);
+    writer.writeBytes(dataWriter.toBuffer());
+
+    return writer.toBuffer();
+  }
+}
+
+export interface IOrderNegotiationFieldsV0JSON {
+  type: number;
+}
+
+export interface IOrderNegotiationFieldsV1JSON {
+  type: number;
+  orderOffer: IOrderOfferJSON;
+}