style: apply prettier
This commit is contained in:
d-yokoi
parent
c74ab67ccf
commit
03632f1507
24 changed files with 2321 additions and 1958 deletions
ts_src
365
ts_src/block.ts
365
ts_src/block.ts
|
|
@ -1,17 +1,22 @@
|
|||
import { Transaction } from './transaction'
|
||||
import * as types from './types'
|
||||
import * as bcrypto from './crypto'
|
||||
import { reverseBuffer } from './bufferutils'
|
||||
import { Transaction } from './transaction';
|
||||
import * as types from './types';
|
||||
import * as bcrypto from './crypto';
|
||||
import { reverseBuffer } from './bufferutils';
|
||||
|
||||
const fastMerkleRoot = require('merkle-lib/fastRoot')
|
||||
const typeforce = require('typeforce')
|
||||
const varuint = require('varuint-bitcoin')
|
||||
const fastMerkleRoot = require('merkle-lib/fastRoot');
|
||||
const typeforce = require('typeforce');
|
||||
const varuint = require('varuint-bitcoin');
|
||||
|
||||
const errorMerkleNoTxes = new TypeError('Cannot compute merkle root for zero transactions')
|
||||
const errorWitnessNotSegwit = new TypeError('Cannot compute witness commit for non-segwit block')
|
||||
const errorMerkleNoTxes = new TypeError(
|
||||
'Cannot compute merkle root for zero transactions',
|
||||
);
|
||||
const errorWitnessNotSegwit = new TypeError(
|
||||
'Cannot compute witness commit for non-segwit block',
|
||||
);
|
||||
|
||||
function txesHaveWitnessCommit (transactions: Array<Transaction>): boolean {
|
||||
return transactions instanceof Array &&
|
||||
function txesHaveWitnessCommit(transactions: Array<Transaction>): boolean {
|
||||
return (
|
||||
transactions instanceof Array &&
|
||||
transactions[0] &&
|
||||
transactions[0].ins &&
|
||||
transactions[0].ins instanceof Array &&
|
||||
|
|
@ -19,255 +24,281 @@ function txesHaveWitnessCommit (transactions: Array<Transaction>): boolean {
|
|||
transactions[0].ins[0].witness &&
|
||||
transactions[0].ins[0].witness instanceof Array &&
|
||||
transactions[0].ins[0].witness.length > 0
|
||||
);
|
||||
}
|
||||
|
||||
function anyTxHasWitness (transactions: Array<Transaction>): boolean {
|
||||
return transactions instanceof Array &&
|
||||
transactions.some(tx =>
|
||||
typeof tx === 'object' &&
|
||||
tx.ins instanceof Array &&
|
||||
tx.ins.some(input =>
|
||||
typeof input === 'object' &&
|
||||
input.witness instanceof Array &&
|
||||
input.witness.length > 0
|
||||
)
|
||||
function anyTxHasWitness(transactions: Array<Transaction>): boolean {
|
||||
return (
|
||||
transactions instanceof Array &&
|
||||
transactions.some(
|
||||
tx =>
|
||||
typeof tx === 'object' &&
|
||||
tx.ins instanceof Array &&
|
||||
tx.ins.some(
|
||||
input =>
|
||||
typeof input === 'object' &&
|
||||
input.witness instanceof Array &&
|
||||
input.witness.length > 0,
|
||||
),
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
export class Block {
|
||||
version: number
|
||||
prevHash?: Buffer
|
||||
merkleRoot?: Buffer
|
||||
timestamp: number
|
||||
witnessCommit?: Buffer
|
||||
bits: number
|
||||
nonce: number
|
||||
transactions?: Array<Transaction>
|
||||
version: number;
|
||||
prevHash?: Buffer;
|
||||
merkleRoot?: Buffer;
|
||||
timestamp: number;
|
||||
witnessCommit?: Buffer;
|
||||
bits: number;
|
||||
nonce: number;
|
||||
transactions?: Array<Transaction>;
|
||||
|
||||
constructor () {
|
||||
this.version = 1
|
||||
this.timestamp = 0
|
||||
this.bits = 0
|
||||
this.nonce = 0
|
||||
this.prevHash = undefined
|
||||
this.merkleRoot = undefined
|
||||
this.witnessCommit = undefined
|
||||
this.transactions = undefined
|
||||
constructor() {
|
||||
this.version = 1;
|
||||
this.timestamp = 0;
|
||||
this.bits = 0;
|
||||
this.nonce = 0;
|
||||
this.prevHash = undefined;
|
||||
this.merkleRoot = undefined;
|
||||
this.witnessCommit = undefined;
|
||||
this.transactions = undefined;
|
||||
}
|
||||
|
||||
static fromBuffer (buffer: Buffer): Block {
|
||||
if (buffer.length < 80) throw new Error('Buffer too small (< 80 bytes)')
|
||||
static fromBuffer(buffer: Buffer): Block {
|
||||
if (buffer.length < 80) throw new Error('Buffer too small (< 80 bytes)');
|
||||
|
||||
let offset: number = 0
|
||||
let offset: number = 0;
|
||||
const readSlice = (n: number): Buffer => {
|
||||
offset += n
|
||||
return buffer.slice(offset - n, offset)
|
||||
}
|
||||
offset += n;
|
||||
return buffer.slice(offset - n, offset);
|
||||
};
|
||||
|
||||
const readUInt32 = (): number => {
|
||||
const i = buffer.readUInt32LE(offset)
|
||||
offset += 4
|
||||
return i
|
||||
}
|
||||
const i = buffer.readUInt32LE(offset);
|
||||
offset += 4;
|
||||
return i;
|
||||
};
|
||||
|
||||
const readInt32 = (): number => {
|
||||
const i = buffer.readInt32LE(offset)
|
||||
offset += 4
|
||||
return i
|
||||
}
|
||||
const i = buffer.readInt32LE(offset);
|
||||
offset += 4;
|
||||
return i;
|
||||
};
|
||||
|
||||
const block = new Block()
|
||||
block.version = readInt32()
|
||||
block.prevHash = readSlice(32)
|
||||
block.merkleRoot = readSlice(32)
|
||||
block.timestamp = readUInt32()
|
||||
block.bits = readUInt32()
|
||||
block.nonce = readUInt32()
|
||||
const block = new Block();
|
||||
block.version = readInt32();
|
||||
block.prevHash = readSlice(32);
|
||||
block.merkleRoot = readSlice(32);
|
||||
block.timestamp = readUInt32();
|
||||
block.bits = readUInt32();
|
||||
block.nonce = readUInt32();
|
||||
|
||||
if (buffer.length === 80) return block
|
||||
if (buffer.length === 80) return block;
|
||||
|
||||
const readVarInt = (): number => {
|
||||
const vi = varuint.decode(buffer, offset)
|
||||
offset += varuint.decode.bytes
|
||||
return vi
|
||||
}
|
||||
const vi = varuint.decode(buffer, offset);
|
||||
offset += varuint.decode.bytes;
|
||||
return vi;
|
||||
};
|
||||
|
||||
const readTransaction = (): any => {
|
||||
const tx = Transaction.fromBuffer(buffer.slice(offset), true)
|
||||
offset += tx.byteLength()
|
||||
return tx
|
||||
}
|
||||
const tx = Transaction.fromBuffer(buffer.slice(offset), true);
|
||||
offset += tx.byteLength();
|
||||
return tx;
|
||||
};
|
||||
|
||||
const nTransactions = readVarInt()
|
||||
block.transactions = []
|
||||
const nTransactions = readVarInt();
|
||||
block.transactions = [];
|
||||
|
||||
for (var i = 0; i < nTransactions; ++i) {
|
||||
const tx = readTransaction()
|
||||
block.transactions.push(tx)
|
||||
const tx = readTransaction();
|
||||
block.transactions.push(tx);
|
||||
}
|
||||
|
||||
let witnessCommit = block.getWitnessCommit()
|
||||
let witnessCommit = block.getWitnessCommit();
|
||||
// This Block contains a witness commit
|
||||
if (witnessCommit) block.witnessCommit = witnessCommit
|
||||
if (witnessCommit) block.witnessCommit = witnessCommit;
|
||||
|
||||
return block
|
||||
return block;
|
||||
}
|
||||
|
||||
static fromHex (hex: string): Block {
|
||||
return Block.fromBuffer(Buffer.from(hex, 'hex'))
|
||||
static fromHex(hex: string): Block {
|
||||
return Block.fromBuffer(Buffer.from(hex, 'hex'));
|
||||
}
|
||||
|
||||
static calculateTarget (bits: number): Buffer {
|
||||
const exponent = ((bits & 0xff000000) >> 24) - 3
|
||||
const mantissa = bits & 0x007fffff
|
||||
const target = Buffer.alloc(32, 0)
|
||||
target.writeUIntBE(mantissa, 29 - exponent, 3)
|
||||
return target
|
||||
static calculateTarget(bits: number): Buffer {
|
||||
const exponent = ((bits & 0xff000000) >> 24) - 3;
|
||||
const mantissa = bits & 0x007fffff;
|
||||
const target = Buffer.alloc(32, 0);
|
||||
target.writeUIntBE(mantissa, 29 - exponent, 3);
|
||||
return target;
|
||||
}
|
||||
|
||||
static calculateMerkleRoot (transactions: Array<Transaction>, forWitness?: boolean): Buffer {
|
||||
typeforce([{ getHash: types.Function }], transactions)
|
||||
if (transactions.length === 0) throw errorMerkleNoTxes
|
||||
if (forWitness && !txesHaveWitnessCommit(transactions)) throw errorWitnessNotSegwit
|
||||
static calculateMerkleRoot(
|
||||
transactions: Array<Transaction>,
|
||||
forWitness?: boolean,
|
||||
): Buffer {
|
||||
typeforce([{ getHash: types.Function }], transactions);
|
||||
if (transactions.length === 0) throw errorMerkleNoTxes;
|
||||
if (forWitness && !txesHaveWitnessCommit(transactions))
|
||||
throw errorWitnessNotSegwit;
|
||||
|
||||
const hashes = transactions.map(transaction => transaction.getHash(forWitness!))
|
||||
const hashes = transactions.map(transaction =>
|
||||
transaction.getHash(forWitness!),
|
||||
);
|
||||
|
||||
const rootHash = fastMerkleRoot(hashes, bcrypto.hash256)
|
||||
const rootHash = fastMerkleRoot(hashes, bcrypto.hash256);
|
||||
|
||||
return forWitness
|
||||
? bcrypto.hash256(Buffer.concat([rootHash, transactions[0].ins[0].witness[0]]))
|
||||
: rootHash
|
||||
? bcrypto.hash256(
|
||||
Buffer.concat([rootHash, transactions[0].ins[0].witness[0]]),
|
||||
)
|
||||
: rootHash;
|
||||
}
|
||||
|
||||
getWitnessCommit (): Buffer | null {
|
||||
if (!txesHaveWitnessCommit(this.transactions!)) return null
|
||||
getWitnessCommit(): Buffer | null {
|
||||
if (!txesHaveWitnessCommit(this.transactions!)) return null;
|
||||
|
||||
// The merkle root for the witness data is in an OP_RETURN output.
|
||||
// There is no rule for the index of the output, so use filter to find it.
|
||||
// The root is prepended with 0xaa21a9ed so check for 0x6a24aa21a9ed
|
||||
// If multiple commits are found, the output with highest index is assumed.
|
||||
let witnessCommits = this.transactions![0].outs
|
||||
.filter(out => out.script.slice(0, 6).equals(Buffer.from('6a24aa21a9ed', 'hex')))
|
||||
.map(out => out.script.slice(6, 38))
|
||||
if (witnessCommits.length === 0) return null
|
||||
let witnessCommits = this.transactions![0].outs.filter(out =>
|
||||
out.script.slice(0, 6).equals(Buffer.from('6a24aa21a9ed', 'hex')),
|
||||
).map(out => out.script.slice(6, 38));
|
||||
if (witnessCommits.length === 0) return null;
|
||||
// Use the commit with the highest output (should only be one though)
|
||||
let result = witnessCommits[witnessCommits.length - 1]
|
||||
let result = witnessCommits[witnessCommits.length - 1];
|
||||
|
||||
if (!(result instanceof Buffer && result.length === 32)) return null
|
||||
return result
|
||||
if (!(result instanceof Buffer && result.length === 32)) return null;
|
||||
return result;
|
||||
}
|
||||
|
||||
hasWitnessCommit (): boolean {
|
||||
if (this.witnessCommit instanceof Buffer &&
|
||||
this.witnessCommit.length === 32) return true
|
||||
if (this.getWitnessCommit() !== null) return true
|
||||
return false
|
||||
hasWitnessCommit(): boolean {
|
||||
if (
|
||||
this.witnessCommit instanceof Buffer &&
|
||||
this.witnessCommit.length === 32
|
||||
)
|
||||
return true;
|
||||
if (this.getWitnessCommit() !== null) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
hasWitness (): boolean {
|
||||
return anyTxHasWitness(this.transactions!)
|
||||
hasWitness(): boolean {
|
||||
return anyTxHasWitness(this.transactions!);
|
||||
}
|
||||
|
||||
byteLength (headersOnly: boolean): number {
|
||||
if (headersOnly || !this.transactions) return 80
|
||||
byteLength(headersOnly: boolean): number {
|
||||
if (headersOnly || !this.transactions) return 80;
|
||||
|
||||
return 80 + varuint.encodingLength(this.transactions.length) +
|
||||
return (
|
||||
80 +
|
||||
varuint.encodingLength(this.transactions.length) +
|
||||
this.transactions.reduce((a, x) => a + x.byteLength(), 0)
|
||||
);
|
||||
}
|
||||
|
||||
getHash (): Buffer {
|
||||
return bcrypto.hash256(this.toBuffer(true))
|
||||
getHash(): Buffer {
|
||||
return bcrypto.hash256(this.toBuffer(true));
|
||||
}
|
||||
|
||||
getId (): string {
|
||||
return reverseBuffer(this.getHash()).toString('hex')
|
||||
getId(): string {
|
||||
return reverseBuffer(this.getHash()).toString('hex');
|
||||
}
|
||||
|
||||
getUTCDate (): Date {
|
||||
const date = new Date(0) // epoch
|
||||
date.setUTCSeconds(this.timestamp)
|
||||
getUTCDate(): Date {
|
||||
const date = new Date(0); // epoch
|
||||
date.setUTCSeconds(this.timestamp);
|
||||
|
||||
return date
|
||||
return date;
|
||||
}
|
||||
|
||||
// TODO: buffer, offset compatibility
|
||||
toBuffer (headersOnly: boolean): Buffer {
|
||||
const buffer: Buffer = Buffer.allocUnsafe(this.byteLength(headersOnly))
|
||||
toBuffer(headersOnly: boolean): Buffer {
|
||||
const buffer: Buffer = Buffer.allocUnsafe(this.byteLength(headersOnly));
|
||||
|
||||
let offset: number = 0
|
||||
let offset: number = 0;
|
||||
const writeSlice = (slice: Buffer): void => {
|
||||
slice.copy(buffer, offset)
|
||||
offset += slice.length
|
||||
}
|
||||
slice.copy(buffer, offset);
|
||||
offset += slice.length;
|
||||
};
|
||||
|
||||
const writeInt32 = (i: number): void => {
|
||||
buffer.writeInt32LE(i, offset)
|
||||
offset += 4
|
||||
}
|
||||
buffer.writeInt32LE(i, offset);
|
||||
offset += 4;
|
||||
};
|
||||
const writeUInt32 = (i: number): void => {
|
||||
buffer.writeUInt32LE(i, offset)
|
||||
offset += 4
|
||||
}
|
||||
buffer.writeUInt32LE(i, offset);
|
||||
offset += 4;
|
||||
};
|
||||
|
||||
writeInt32(this.version)
|
||||
writeSlice(this.prevHash!)
|
||||
writeSlice(this.merkleRoot!)
|
||||
writeUInt32(this.timestamp)
|
||||
writeUInt32(this.bits)
|
||||
writeUInt32(this.nonce)
|
||||
writeInt32(this.version);
|
||||
writeSlice(this.prevHash!);
|
||||
writeSlice(this.merkleRoot!);
|
||||
writeUInt32(this.timestamp);
|
||||
writeUInt32(this.bits);
|
||||
writeUInt32(this.nonce);
|
||||
|
||||
if (headersOnly || !this.transactions) return buffer
|
||||
if (headersOnly || !this.transactions) return buffer;
|
||||
|
||||
varuint.encode(this.transactions.length, buffer, offset)
|
||||
offset += varuint.encode.bytes
|
||||
varuint.encode(this.transactions.length, buffer, offset);
|
||||
offset += varuint.encode.bytes;
|
||||
|
||||
this.transactions.forEach(tx => {
|
||||
const txSize = tx.byteLength() // TODO: extract from toBuffer?
|
||||
tx.toBuffer(buffer, offset)
|
||||
offset += txSize
|
||||
})
|
||||
const txSize = tx.byteLength(); // TODO: extract from toBuffer?
|
||||
tx.toBuffer(buffer, offset);
|
||||
offset += txSize;
|
||||
});
|
||||
|
||||
return buffer
|
||||
return buffer;
|
||||
}
|
||||
|
||||
toHex (headersOnly: boolean): string {
|
||||
return this.toBuffer(headersOnly).toString('hex')
|
||||
toHex(headersOnly: boolean): string {
|
||||
return this.toBuffer(headersOnly).toString('hex');
|
||||
}
|
||||
|
||||
checkTxRoots (): boolean {
|
||||
checkTxRoots(): boolean {
|
||||
// If the Block has segwit transactions but no witness commit,
|
||||
// there's no way it can be valid, so fail the check.
|
||||
let hasWitnessCommit = this.hasWitnessCommit()
|
||||
if (!hasWitnessCommit && this.hasWitness()) return false
|
||||
return this.__checkMerkleRoot() &&
|
||||
let hasWitnessCommit = this.hasWitnessCommit();
|
||||
if (!hasWitnessCommit && this.hasWitness()) return false;
|
||||
return (
|
||||
this.__checkMerkleRoot() &&
|
||||
(hasWitnessCommit ? this.__checkWitnessCommit() : true)
|
||||
);
|
||||
}
|
||||
|
||||
checkMerkleRoot (): boolean {
|
||||
console.warn('Deprecation Warning: Block method checkMerkleRoot will be ' +
|
||||
'deprecated in v5. Please use checkTxRoots instead.')
|
||||
return this.checkTxRoots()
|
||||
checkMerkleRoot(): boolean {
|
||||
console.warn(
|
||||
'Deprecation Warning: Block method checkMerkleRoot will be ' +
|
||||
'deprecated in v5. Please use checkTxRoots instead.',
|
||||
);
|
||||
return this.checkTxRoots();
|
||||
}
|
||||
|
||||
__checkMerkleRoot (): boolean {
|
||||
if (!this.transactions) throw errorMerkleNoTxes
|
||||
__checkMerkleRoot(): boolean {
|
||||
if (!this.transactions) throw errorMerkleNoTxes;
|
||||
|
||||
const actualMerkleRoot = Block.calculateMerkleRoot(this.transactions)
|
||||
return this.merkleRoot!.compare(actualMerkleRoot) === 0
|
||||
const actualMerkleRoot = Block.calculateMerkleRoot(this.transactions);
|
||||
return this.merkleRoot!.compare(actualMerkleRoot) === 0;
|
||||
}
|
||||
|
||||
__checkWitnessCommit (): boolean {
|
||||
if (!this.transactions) throw errorMerkleNoTxes
|
||||
if (!this.hasWitnessCommit()) throw errorWitnessNotSegwit
|
||||
__checkWitnessCommit(): boolean {
|
||||
if (!this.transactions) throw errorMerkleNoTxes;
|
||||
if (!this.hasWitnessCommit()) throw errorWitnessNotSegwit;
|
||||
|
||||
const actualWitnessCommit = Block.calculateMerkleRoot(this.transactions, true)
|
||||
return this.witnessCommit!.compare(actualWitnessCommit) === 0
|
||||
const actualWitnessCommit = Block.calculateMerkleRoot(
|
||||
this.transactions,
|
||||
true,
|
||||
);
|
||||
return this.witnessCommit!.compare(actualWitnessCommit) === 0;
|
||||
}
|
||||
|
||||
checkProofOfWork (): boolean {
|
||||
const hash: Buffer = reverseBuffer(this.getHash())
|
||||
const target = Block.calculateTarget(this.bits)
|
||||
checkProofOfWork(): boolean {
|
||||
const hash: Buffer = reverseBuffer(this.getHash());
|
||||
const target = Block.calculateTarget(this.bits);
|
||||
|
||||
return hash.compare(target) <= 0
|
||||
return hash.compare(target) <= 0;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue