Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 1x 1x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 5x 5x 5x 5x 3x 3x 1x 1x 1x 1x 18x 19x 11x 11x 11x 11x 11x 11x 11x 1x 10x 1x 9x 1x 8x 1x 7x 2x 5x 5x 2x 2x 2x 2x 2x 2x 2x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 1x 2x 4x 3x 3x 3x 6x 6x 6x 3x 1x 1x 1x 1x 2x 2x 2x 2x 1x | import { BufferReader, BufferWriter } from '@node-dlc/bufio';
import { IOrderMetadataJSON } from '..';
import { MessageType } from '../MessageType';
import { deserializeTlv } from '../serialize/deserializeTlv';
import { getTlv } from '../serialize/getTlv';
import {
validateBigInt,
validateBuffer,
validateNumber,
} from '../validation/validate';
import { BatchFundingGroup, IBatchFundingGroupJSON } from './BatchFundingGroup';
import {
ContractInfo,
IContractInfoV0JSON,
IContractInfoV1JSON,
} from './ContractInfo';
import { IDlcMessage } from './DlcMessage';
import {
IOrderIrcInfoJSON,
OrderIrcInfo,
OrderIrcInfoV0,
} from './OrderIrcInfo';
import { OrderMetadata, OrderMetadataV0 } from './OrderMetadata';
import { IOrderPositionInfoJSON, OrderPositionInfo } from './OrderPositionInfo';
const LOCKTIME_THRESHOLD = 500000000;
export abstract class OrderOffer {
public static deserialize(buf: Buffer): OrderOffer {
const reader = new BufferReader(buf);
const type = Number(reader.readUInt16BE());
switch (type) {
case MessageType.OrderOfferV0:
return OrderOfferV0.deserialize(buf);
default:
throw new Error(`Order offer TLV type must be OrderOfferV0`);
}
}
public abstract type: number;
public abstract validate(): void;
public abstract toJSON(): IOrderOfferJSON;
public abstract serialize(): Buffer;
}
/**
* 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.
*/
export class OrderOfferV0 extends OrderOffer implements IDlcMessage {
public static type = MessageType.OrderOfferV0;
/**
* Deserializes an offer_dlc_v0 message
* @param buf
*/
public static deserialize(buf: Buffer): OrderOfferV0 {
const instance = new OrderOfferV0();
const reader = new BufferReader(buf);
reader.readUInt16BE(); // read type
instance.chainHash = reader.readBytes(32);
instance.contractInfo = ContractInfo.deserialize(getTlv(reader));
instance.offerCollateralSatoshis = reader.readUInt64BE();
instance.feeRatePerVb = reader.readUInt64BE();
instance.cetLocktime = reader.readUInt32BE();
instance.refundLocktime = reader.readUInt32BE();
while (!reader.eof) {
const buf = getTlv(reader);
const tlvReader = new BufferReader(buf);
const { type } = deserializeTlv(tlvReader);
switch (Number(type)) {
case MessageType.OrderMetadataV0:
instance.metadata = OrderMetadataV0.deserialize(buf);
break;
case MessageType.OrderIrcInfoV0:
instance.ircInfo = OrderIrcInfoV0.deserialize(buf);
break;
case MessageType.OrderPositionInfoV0:
instance.positionInfo = OrderPositionInfo.deserialize(buf);
break;
case MessageType.BatchFundingGroup:
if (!instance.batchFundingGroups) {
instance.batchFundingGroups = [];
}
instance.batchFundingGroups.push(BatchFundingGroup.deserialize(buf));
break;
default:
break;
}
}
return instance;
}
/**
* The type for order_offer_v0 message. order_offer_v0 = 62770
*/
public type = OrderOfferV0.type;
public chainHash: Buffer;
public contractInfo: ContractInfo;
public offerCollateralSatoshis: bigint;
public feeRatePerVb: bigint;
public cetLocktime: number;
public refundLocktime: number;
public metadata?: OrderMetadata;
public ircInfo?: OrderIrcInfo;
public positionInfo?: OrderPositionInfo;
public batchFundingGroups?: BatchFundingGroup[];
public validate(): void {
validateBuffer(this.chainHash, 'chainHash', OrderOfferV0.name, 32);
this.contractInfo.validate();
validateBigInt(
this.offerCollateralSatoshis,
'offerCollateralSatoshis',
OrderOfferV0.name,
);
validateBigInt(this.feeRatePerVb, 'feeRatePerVb', OrderOfferV0.name);
validateNumber(this.cetLocktime, 'cetLocktime', OrderOfferV0.name);
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
*/
public toJSON(): IOrderOfferJSON {
const tlvs = [];
Eif (this.metadata) tlvs.push(this.metadata.toJSON());
if (this.ircInfo) tlvs.push(this.ircInfo.toJSON());
Iif (this.positionInfo) tlvs.push(this.positionInfo.toJSON());
Iif (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
*/
public serialize(): Buffer {
const writer = new 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());
Iif (this.batchFundingGroups)
this.batchFundingGroups.forEach((fundingInfo) =>
writer.writeBytes(fundingInfo.serialize()),
);
return writer.toBuffer();
}
}
export interface IOrderOfferJSON {
type: number;
chainHash: string;
contractInfo: IContractInfoV0JSON | IContractInfoV1JSON;
offerCollateralSatoshis: number;
feeRatePerVb: number;
cetLocktime: number;
refundLocktime: number;
tlvs: (
| IOrderMetadataJSON
| IOrderIrcInfoJSON
| IOrderPositionInfoJSON
| IBatchFundingGroupJSON
)[];
}
export class OrderOfferContainer {
private offers: OrderOffer[] = [];
/**
* Adds an OrderOffer to the container.
* @param offer The OrderOffer to add.
*/
public addOffer(offer: OrderOffer): void {
this.offers.push(offer);
}
/**
* Returns all OrderOffers in the container.
* @returns An array of OrderOffer instances.
*/
public getOffers(): OrderOffer[] {
return this.offers;
}
/**
* Serializes all OrderOffers in the container to a Buffer.
* @returns A Buffer containing the serialized OrderOffers.
*/
public serialize(): Buffer {
const writer = new 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.
*/
public static deserialize(buf: Buffer): OrderOfferContainer {
const reader = new 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;
}
}
|