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 312 313 314 315 | 1x 1x 1x 1x 1x 1x 1x 55x 55x 55x 55x 1x 1x 56x 56x 56x 56x 56x 56x 56x 56x 60x 25x 24x 2x 2x 2x 2x 1x 1x 1x 1x 1x 5x 27x 27x 27x 27x 27x 27x 27x 27x 27x 1x 1x | import { BufferReader, BufferWriter } from '@node-dlc/bufio';
import { MessageType } from '../MessageType';
import { getTlv } from '../serialize/getTlv';
import {
ContractDescriptor,
ContractDescriptorV0JSON,
ContractDescriptorV1,
ContractDescriptorV1JSON,
} from './ContractDescriptor';
import { DlcMessage, IDlcMessage } from './DlcMessage';
import { DigitDecompositionEventDescriptorV0 } from './EventDescriptor';
import { OracleEventV0 } from './OracleEventV0';
import { OracleInfoV0, OracleInfoV0JSON } from './OracleInfoV0';
export abstract class ContractInfo extends DlcMessage {
public static deserialize(buf: Buffer): ContractInfoV0 | ContractInfoV1 {
const reader = new BufferReader(buf);
const type = Number(reader.readBigSize());
switch (type) {
case MessageType.ContractInfoV0:
return ContractInfoV0.deserialize(buf);
case MessageType.ContractInfoV1:
return ContractInfoV1.deserialize(buf);
default:
throw new Error(
`Contract info TLV type must be ContractInfoV0 or ContractInfoV1`,
);
}
}
public abstract type: number;
public abstract length: bigint;
public abstract totalCollateral: bigint;
public abstract validate(): void;
public abstract toJSON(): IContractInfoV0JSON | IContractInfoV1JSON;
public abstract serialize(): Buffer;
}
/**
* ContractInfo V0 contains information about a contract's outcomes,
* their corresponding payouts, and the oracles to be used.
*/
export class ContractInfoV0 implements IDlcMessage {
public static type = MessageType.ContractInfoV0;
/**
* Deserializes an contract_info_v0 message
* @param buf
*/
public static deserialize(buf: Buffer): ContractInfoV0 {
const instance = new ContractInfoV0();
const reader = new BufferReader(buf);
reader.readBigSize(); // read type
instance.length = reader.readBigSize();
instance.totalCollateral = reader.readUInt64BE();
instance.contractDescriptor = ContractDescriptor.deserialize(
getTlv(reader),
);
instance.oracleInfo = OracleInfoV0.deserialize(getTlv(reader));
return instance;
}
/**
* The type for contract_info_v0 message. contract_info_v0 = 55342
*/
public type = ContractInfoV0.type;
public length: bigint;
public totalCollateral: bigint;
public contractDescriptor: ContractDescriptor;
public oracleInfo: OracleInfoV0;
/**
* Validates correctness of all fields in the message
* https://github.com/discreetlogcontracts/dlcspecs/blob/master/Messaging.md#the-contract_info-type
* @throws Will throw an error if validation fails
*/
public validate(): void {
this.oracleInfo.validate();
switch (this.contractDescriptor.type) {
case MessageType.ContractDescriptorV1:
// eslint-disable-next-line no-case-declarations
const contractDescriptor = this
.contractDescriptor as ContractDescriptorV1;
contractDescriptor.validate();
// roundingmod should not be greater than totalCollateral
for (const interval of contractDescriptor.roundingIntervals.intervals) {
if (interval.roundingMod > this.totalCollateral) {
throw new Error(
`Rounding modulus ${interval.roundingMod} is greater than total collateral ${this.totalCollateral}`,
);
}
}
switch (this.oracleInfo.announcement.oracleEvent.eventDescriptor.type) {
case MessageType.DigitDecompositionEventDescriptorV0:
// eslint-disable-next-line no-case-declarations
const eventDescriptor = this.oracleInfo.announcement.oracleEvent
.eventDescriptor as DigitDecompositionEventDescriptorV0;
Eif (eventDescriptor.nbDigits !== contractDescriptor.numDigits)
throw new Error(
'DigitDecompositionEventDescriptorV0 and ContractDescriptorV1 must have the same numDigits',
);
// Sanity check. Shouldn't be hit since there are other validations which should catch this in OracleEventV0.
// eslint-disable-next-line no-case-declarations
const oracleEvent = this.oracleInfo.announcement
.oracleEvent as OracleEventV0;
if (
oracleEvent.oracleNonces.length !== contractDescriptor.numDigits
) {
throw new Error(
'oracleEvent.oracleNonces.length and contractDescriptor.numDigits must be the same',
);
}
break;
default:
throw new Error(
'Only ContractDescriptorV1 can be used with DigitDecompositionEventDescriptor',
);
}
}
}
/**
* Converts contract_info_v0 to JSON
*/
public toJSON(): IContractInfoV0JSON {
return {
type: this.type,
totalCollateral: Number(this.totalCollateral),
contractDescriptor: this.contractDescriptor.toJSON(),
oracleInfo: this.oracleInfo.toJSON(),
};
}
/**
* Serializes the contract_info_v0 message into a Buffer
*/
public serialize(): Buffer {
const writer = new BufferWriter();
writer.writeBigSize(this.type);
const dataWriter = new BufferWriter();
dataWriter.writeUInt64BE(this.totalCollateral);
dataWriter.writeBytes(this.contractDescriptor.serialize());
dataWriter.writeBytes(this.oracleInfo.serialize());
writer.writeBigSize(dataWriter.size);
writer.writeBytes(dataWriter.toBuffer());
return writer.toBuffer();
}
}
/**
* ContractInfo V1 contains information about a contract's outcomes,
* their corresponding payouts, and the oracles to be used.
*/
export class ContractInfoV1 implements IDlcMessage {
public static type = MessageType.ContractInfoV1;
/**
* Deserializes an contract_info_v0 message
* @param buf
*/
public static deserialize(buf: Buffer): ContractInfoV1 {
const instance = new ContractInfoV1();
const reader = new BufferReader(buf);
reader.readBigSize(); // read type
instance.length = reader.readBigSize();
instance.totalCollateral = reader.readUInt64BE();
reader.readBigSize(); // read num_disjoint_events
while (!reader.eof) {
const contractDescriptor = ContractDescriptor.deserialize(getTlv(reader));
const oracleInfo = OracleInfoV0.deserialize(getTlv(reader));
instance.contractOraclePairs.push({ contractDescriptor, oracleInfo });
}
return instance;
}
/**
* The type for contract_info_v1 message. contract_info_v0 = 55342
*/
public type = ContractInfoV1.type;
public length: bigint;
public totalCollateral: bigint;
public contractOraclePairs: IContractOraclePair[] = [];
/**
* Validates correctness of all fields in the message
* https://github.com/discreetlogcontracts/dlcspecs/blob/master/Messaging.md#the-contract_info-type
* @throws Will throw an error if validation fails
*/
public validate(): void {
this.contractOraclePairs.forEach((oraclePair) => {
oraclePair.oracleInfo.validate();
switch (oraclePair.contractDescriptor.type) {
case MessageType.ContractDescriptorV1:
// eslint-disable-next-line no-case-declarations
const contractDescriptor = oraclePair.contractDescriptor as ContractDescriptorV1;
contractDescriptor.validate();
switch (
oraclePair.oracleInfo.announcement.oracleEvent.eventDescriptor.type
) {
case MessageType.DigitDecompositionEventDescriptorV0:
// eslint-disable-next-line no-case-declarations
const eventDescriptor = oraclePair.oracleInfo.announcement
.oracleEvent
.eventDescriptor as DigitDecompositionEventDescriptorV0;
if (eventDescriptor.nbDigits !== contractDescriptor.numDigits)
throw new Error(
'DigitDecompositionEventDescriptorV0 and ContractDescriptorV1 must have the same numDigits',
);
// eslint-disable-next-line no-case-declarations
const oracleEvent = oraclePair.oracleInfo.announcement
.oracleEvent as OracleEventV0;
if (
oracleEvent.oracleNonces.length !== contractDescriptor.numDigits
) {
throw new Error(
'oracleEvent.oracleNonces.length and contractDescriptor.numDigits must be the same',
);
}
}
}
});
}
/**
* Converts contract_info_v1 to JSON
*/
public toJSON(): IContractInfoV1JSON {
return {
type: this.type,
totalCollateral: Number(this.totalCollateral),
contractOraclePairs: this.contractOraclePairs.map((oraclePairs) => {
return {
contractDescriptor: oraclePairs.contractDescriptor.toJSON(),
oracleInfo: oraclePairs.oracleInfo.toJSON(),
};
}),
};
}
/**
* Serializes the contract_info_v1 message into a Buffer
*/
public serialize(): Buffer {
const writer = new BufferWriter();
writer.writeBigSize(this.type);
const dataWriter = new BufferWriter();
dataWriter.writeUInt64BE(this.totalCollateral);
dataWriter.writeBigSize(this.contractOraclePairs.length);
for (const contractOraclePair of this.contractOraclePairs) {
const { contractDescriptor, oracleInfo } = contractOraclePair;
dataWriter.writeBytes(contractDescriptor.serialize());
dataWriter.writeBytes(oracleInfo.serialize());
}
writer.writeBigSize(dataWriter.size);
writer.writeBytes(dataWriter.toBuffer());
return writer.toBuffer();
}
}
interface IContractOraclePair {
contractDescriptor: ContractDescriptor;
oracleInfo: OracleInfoV0;
}
interface IContractOraclePairJSON {
contractDescriptor: ContractDescriptorV0JSON | ContractDescriptorV1JSON;
oracleInfo: OracleInfoV0JSON;
}
export interface IContractInfoV0JSON {
type: number;
totalCollateral: number;
contractDescriptor: ContractDescriptorV0JSON | ContractDescriptorV1JSON;
oracleInfo: OracleInfoV0JSON;
}
export interface IContractInfoV1JSON {
type: number;
totalCollateral: number;
contractOraclePairs: IContractOraclePairJSON[];
}
|