@node-dlc/messaging
Version:
DLC Messaging Protocol
225 lines • 9.78 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.OrderOfferContainer = exports.OrderOfferV0 = exports.OrderOffer = void 0;
const bufio_1 = require("@node-dlc/bufio");
const MessageType_1 = require("../MessageType");
const deserializeTlv_1 = require("../serialize/deserializeTlv");
const getTlv_1 = require("../serialize/getTlv");
const validate_1 = require("../validation/validate");
const BatchFundingGroup_1 = require("./BatchFundingGroup");
const ContractInfo_1 = require("./ContractInfo");
const OrderIrcInfo_1 = require("./OrderIrcInfo");
const OrderMetadata_1 = require("./OrderMetadata");
const OrderPositionInfo_1 = require("./OrderPositionInfo");
const LOCKTIME_THRESHOLD = 500000000;
class OrderOffer {
static deserialize(buf) {
const reader = new bufio_1.BufferReader(buf);
const type = Number(reader.readUInt16BE());
switch (type) {
case MessageType_1.MessageType.OrderOfferV0:
return OrderOfferV0.deserialize(buf);
default:
throw new Error(`Order offer TLV type must be OrderOfferV0`);
}
}
}
exports.OrderOffer = OrderOffer;
/**
* OrderOffer message contains information about a node and indicates its
* desire to enter into a new contract. This is the first step toward
* order negotiation.
*/
class OrderOfferV0 extends OrderOffer {
constructor() {
super(...arguments);
/**
* The type for order_offer_v0 message. order_offer_v0 = 62770
*/
this.type = OrderOfferV0.type;
}
/**
* Deserializes an offer_dlc_v0 message
* @param buf
*/
static deserialize(buf) {
const instance = new OrderOfferV0();
const reader = new bufio_1.BufferReader(buf);
reader.readUInt16BE(); // read type
instance.chainHash = reader.readBytes(32);
instance.contractInfo = ContractInfo_1.ContractInfo.deserialize((0, getTlv_1.getTlv)(reader));
instance.offerCollateralSatoshis = reader.readUInt64BE();
instance.feeRatePerVb = reader.readUInt64BE();
instance.cetLocktime = reader.readUInt32BE();
instance.refundLocktime = reader.readUInt32BE();
while (!reader.eof) {
const buf = (0, getTlv_1.getTlv)(reader);
const tlvReader = new bufio_1.BufferReader(buf);
const { type } = (0, deserializeTlv_1.deserializeTlv)(tlvReader);
switch (Number(type)) {
case MessageType_1.MessageType.OrderMetadataV0:
instance.metadata = OrderMetadata_1.OrderMetadataV0.deserialize(buf);
break;
case MessageType_1.MessageType.OrderIrcInfoV0:
instance.ircInfo = OrderIrcInfo_1.OrderIrcInfoV0.deserialize(buf);
break;
case MessageType_1.MessageType.OrderPositionInfoV0:
instance.positionInfo = OrderPositionInfo_1.OrderPositionInfo.deserialize(buf);
break;
case MessageType_1.MessageType.BatchFundingGroup:
if (!instance.batchFundingGroups) {
instance.batchFundingGroups = [];
}
instance.batchFundingGroups.push(BatchFundingGroup_1.BatchFundingGroup.deserialize(buf));
break;
default:
break;
}
}
return instance;
}
validate() {
(0, validate_1.validateBuffer)(this.chainHash, 'chainHash', OrderOfferV0.name, 32);
this.contractInfo.validate();
(0, validate_1.validateBigInt)(this.offerCollateralSatoshis, 'offerCollateralSatoshis', OrderOfferV0.name);
(0, validate_1.validateBigInt)(this.feeRatePerVb, 'feeRatePerVb', OrderOfferV0.name);
(0, validate_1.validateNumber)(this.cetLocktime, 'cetLocktime', OrderOfferV0.name);
(0, validate_1.validateNumber)(this.refundLocktime, 'refundLocktime', OrderOfferV0.name);
// 1. Type is set automatically in class
// 2. chain_hash must be validated as input by end user
// 3. offer_collateral_satoshis must be greater than or equal to 1000
if (this.offerCollateralSatoshis < 1000) {
throw new Error('offer_collateral_satoshis must be greater than or equal to 1000');
}
if (this.cetLocktime < 0) {
throw new Error('cet_locktime must be greater than or equal to 0');
}
if (this.refundLocktime < 0) {
throw new Error('refund_locktime must be greater than or equal to 0');
}
// 4. cet_locktime and refund_locktime must either both be unix timestamps, or both be block heights.
// https://en.bitcoin.it/wiki/NLockTime
// https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki#detailed-specification
// https://github.com/bitcoin/bitcoin/blob/master/src/script/script.h#L39
if (!((this.cetLocktime < LOCKTIME_THRESHOLD &&
this.refundLocktime < LOCKTIME_THRESHOLD) ||
(this.cetLocktime >= LOCKTIME_THRESHOLD &&
this.refundLocktime >= LOCKTIME_THRESHOLD))) {
throw new Error('cetLocktime and refundLocktime must be in same units');
}
// 5. cetLocktime must be less than refundLocktime
if (this.cetLocktime >= this.refundLocktime) {
throw new Error('cetLocktime must be less than refundLocktime');
}
// 6. validate contractInfo
this.contractInfo.validate();
// totalCollaterial should be > offerCollaterial (logical validation)
if (this.contractInfo.totalCollateral <= this.offerCollateralSatoshis) {
throw new Error('totalCollateral should be greater than offerCollateral');
}
}
/**
* Converts order_offer_v0 to JSON
*/
toJSON() {
const tlvs = [];
if (this.metadata)
tlvs.push(this.metadata.toJSON());
if (this.ircInfo)
tlvs.push(this.ircInfo.toJSON());
if (this.positionInfo)
tlvs.push(this.positionInfo.toJSON());
if (this.batchFundingGroups)
this.batchFundingGroups.forEach((fundingInfo) => tlvs.push(fundingInfo.toJSON()));
return {
type: this.type,
chainHash: this.chainHash.toString('hex'),
contractInfo: this.contractInfo.toJSON(),
offerCollateralSatoshis: Number(this.offerCollateralSatoshis),
feeRatePerVb: Number(this.feeRatePerVb),
cetLocktime: this.cetLocktime,
refundLocktime: this.refundLocktime,
tlvs,
};
}
/**
* Serializes the order_offer_v0 message into a Buffer
*/
serialize() {
const writer = new bufio_1.BufferWriter();
writer.writeUInt16BE(this.type);
writer.writeBytes(this.chainHash);
writer.writeBytes(this.contractInfo.serialize());
writer.writeUInt64BE(this.offerCollateralSatoshis);
writer.writeUInt64BE(this.feeRatePerVb);
writer.writeUInt32BE(this.cetLocktime);
writer.writeUInt32BE(this.refundLocktime);
if (this.metadata)
writer.writeBytes(this.metadata.serialize());
if (this.ircInfo)
writer.writeBytes(this.ircInfo.serialize());
if (this.positionInfo)
writer.writeBytes(this.positionInfo.serialize());
if (this.batchFundingGroups)
this.batchFundingGroups.forEach((fundingInfo) => writer.writeBytes(fundingInfo.serialize()));
return writer.toBuffer();
}
}
exports.OrderOfferV0 = OrderOfferV0;
OrderOfferV0.type = MessageType_1.MessageType.OrderOfferV0;
class OrderOfferContainer {
constructor() {
this.offers = [];
}
/**
* Adds an OrderOffer to the container.
* @param offer The OrderOffer to add.
*/
addOffer(offer) {
this.offers.push(offer);
}
/**
* Returns all OrderOffers in the container.
* @returns An array of OrderOffer instances.
*/
getOffers() {
return this.offers;
}
/**
* Serializes all OrderOffers in the container to a Buffer.
* @returns A Buffer containing the serialized OrderOffers.
*/
serialize() {
const writer = new bufio_1.BufferWriter();
// Write the number of offers in the container first.
writer.writeBigSize(this.offers.length);
// Serialize each offer and write it.
this.offers.forEach((offer) => {
const serializedOffer = offer.serialize();
// Optionally, write the length of the serialized offer for easier deserialization.
writer.writeBigSize(serializedOffer.length);
writer.writeBytes(serializedOffer);
});
return writer.toBuffer();
}
/**
* Deserializes a Buffer into an OrderOfferContainer with OrderOffers.
* @param buf The Buffer to deserialize.
* @returns An OrderOfferContainer instance.
*/
static deserialize(buf) {
const reader = new bufio_1.BufferReader(buf);
const container = new OrderOfferContainer();
const offersCount = reader.readBigSize();
for (let i = 0; i < offersCount; i++) {
// Optionally, read the length of the serialized offer if it was written during serialization.
const offerLength = reader.readBigSize();
const offerBuf = reader.readBytes(Number(offerLength));
const offer = OrderOffer.deserialize(offerBuf); // Adjust based on actual implementation.
container.addOffer(offer);
}
return container;
}
}
exports.OrderOfferContainer = OrderOfferContainer;
//# sourceMappingURL=OrderOffer.js.map