@atomiqlabs/chain-solana 13.5.13 → 13.5.14

package/src/solana/btcrelay/headers/SolanaBtcHeader.ts

@@ -1,116 +1,116 @@
-import {BtcHeader} from "@atomiqlabs/base";
-import {Buffer} from "buffer";
-
-export type SolanaBtcHeaderType = {
-    version: number,
-    reversedPrevBlockhash: number[],
-    merkleRoot: number[],
-    timestamp: number,
-    nbits: number,
-    nonce: number,
-    hash: Buffer
-}
-
-/**
- * Represents bitcoin blockheader data to be submitted to the Solana BTC relay program.
- *
- * @category BTC Relay
- */
-export class SolanaBtcHeader implements BtcHeader {
-
-    /**
-     * Version field of the blockheader.
-     */
-    private readonly version: number;
-    /**
-     * Previous block hash in little-endian representation.
-     */
-    private readonly reversedPrevBlockhash: number[];
-    /**
-     * Merkle root in little-endian representation.
-     */
-    private readonly merkleRoot: number[];
-    /**
-     * Block timestamp in UNIX seconds.
-     */
-    private readonly timestamp: number;
-    /**
-     * Compact target (`nBits`) field.
-     */
-    private readonly nbits: number;
-    /**
-     * Nonce field.
-     */
-    private readonly nonce: number;
-    /**
-     * Reversed block hash bytes.
-     */
-    private readonly hash: Buffer;
-
-    /**
-     * Constructs the bitcoin blockheader
-     *
-     * @param obj Blockheader fields
-     *
-     * @internal
-     */
-    constructor(obj: SolanaBtcHeaderType) {
-        this.version = obj.version;
-        this.reversedPrevBlockhash = obj.reversedPrevBlockhash;
-        this.merkleRoot = obj.merkleRoot;
-        this.timestamp = obj.timestamp;
-        this.nbits = obj.nbits;
-        this.nonce = obj.nonce;
-        this.hash = obj.hash;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getMerkleRoot(): Buffer {
-        return Buffer.from(this.merkleRoot);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getNbits(): number {
-        return this.nbits;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getNonce(): number {
-        return this.nonce;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getReversedPrevBlockhash(): Buffer {
-        return Buffer.from(this.reversedPrevBlockhash);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getTimestamp(): number {
-        return this.timestamp;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getVersion(): number {
-        return this.version;
-    }
-
-    /**
-     * Returns block hash bytes in little-endian representation.
-     */
-    getHash(): Buffer {
-        return this.hash;
-    }
-
-}
+import {BtcHeader} from "@atomiqlabs/base";
+import {Buffer} from "buffer";
+
+export type SolanaBtcHeaderType = {
+    version: number,
+    reversedPrevBlockhash: number[],
+    merkleRoot: number[],
+    timestamp: number,
+    nbits: number,
+    nonce: number,
+    hash: Buffer
+}
+
+/**
+ * Represents bitcoin blockheader data to be submitted to the Solana BTC relay program.
+ *
+ * @category BTC Relay
+ */
+export class SolanaBtcHeader implements BtcHeader {
+
+    /**
+     * Version field of the blockheader.
+     */
+    private readonly version: number;
+    /**
+     * Previous block hash in little-endian representation.
+     */
+    private readonly reversedPrevBlockhash: number[];
+    /**
+     * Merkle root in little-endian representation.
+     */
+    private readonly merkleRoot: number[];
+    /**
+     * Block timestamp in UNIX seconds.
+     */
+    private readonly timestamp: number;
+    /**
+     * Compact target (`nBits`) field.
+     */
+    private readonly nbits: number;
+    /**
+     * Nonce field.
+     */
+    private readonly nonce: number;
+    /**
+     * Reversed block hash bytes.
+     */
+    private readonly hash: Buffer;
+
+    /**
+     * Constructs the bitcoin blockheader
+     *
+     * @param obj Blockheader fields
+     *
+     * @internal
+     */
+    constructor(obj: SolanaBtcHeaderType) {
+        this.version = obj.version;
+        this.reversedPrevBlockhash = obj.reversedPrevBlockhash;
+        this.merkleRoot = obj.merkleRoot;
+        this.timestamp = obj.timestamp;
+        this.nbits = obj.nbits;
+        this.nonce = obj.nonce;
+        this.hash = obj.hash;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getMerkleRoot(): Buffer {
+        return Buffer.from(this.merkleRoot);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getNbits(): number {
+        return this.nbits;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getNonce(): number {
+        return this.nonce;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getReversedPrevBlockhash(): Buffer {
+        return Buffer.from(this.reversedPrevBlockhash);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getTimestamp(): number {
+        return this.timestamp;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getVersion(): number {
+        return this.version;
+    }
+
+    /**
+     * Returns block hash bytes in little-endian representation.
+     */
+    getHash(): Buffer {
+        return this.hash;
+    }
+
+}

package/src/solana/btcrelay/headers/SolanaBtcStoredHeader.ts

@@ -1,148 +1,148 @@
-import {BtcStoredHeader, StatePredictorUtils} from "@atomiqlabs/base";
-import {SolanaBtcHeader, SolanaBtcHeaderType} from "./SolanaBtcHeader";
-import {Buffer} from "buffer";
-
-export type SolanaBtcStoredHeaderType = {
-    chainWork: number[],
-    header: SolanaBtcHeaderType | SolanaBtcHeader,
-    lastDiffAdjustment: number,
-    blockheight: number,
-    prevBlockTimestamps: number[]
-}
-
-/**
- * Represents a bitcoin blockheader that has already been stored and committed in the Solana BTC relay program.
- *
- * @category BTC Relay
- */
-export class SolanaBtcStoredHeader implements BtcStoredHeader<SolanaBtcHeader> {
-
-    /**
-     * Total accumulated chainwork for this header.
-     */
-    private readonly chainWork: number[];
-    /**
-     * Stored bitcoin blockheader.
-     */
-    private readonly header: SolanaBtcHeader;
-    /**
-     * Timestamp of the last difficulty adjustment.
-     */
-    private readonly lastDiffAdjustment: number;
-    /**
-     * Blockheight of the stored header.
-     */
-    private readonly blockheight: number;
-    /**
-     * Previous block timestamps tracked for median-time-past checks.
-     */
-    private readonly prevBlockTimestamps: number[];
-
-    /**
-     * Constructs the stored bitcoin blockheader from Solana event data.
-     *
-     * @param obj Decoded stored-header fields
-     *
-     * @internal
-     */
-    constructor(obj: SolanaBtcStoredHeaderType) {
-        this.chainWork = obj.chainWork;
-        this.header = obj.header instanceof SolanaBtcHeader ? obj.header : new SolanaBtcHeader(obj.header);
-        this.lastDiffAdjustment = obj.lastDiffAdjustment;
-        this.blockheight = obj.blockheight;
-        this.prevBlockTimestamps = obj.prevBlockTimestamps;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getBlockheight(): number {
-        return this.blockheight;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getChainWork(): Buffer {
-        return Buffer.from(this.chainWork);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getHeader(): SolanaBtcHeader {
-        return this.header;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getLastDiffAdjustment(): number {
-        return this.lastDiffAdjustment;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getPrevBlockTimestamps(): number[] {
-        return this.prevBlockTimestamps;
-    }
-
-    /**
-     * Computes prevBlockTimestamps for a next block, shifting the old block timestamps to the left & appending
-     *  this block's timestamp to the end
-     *
-     * @private
-     */
-    private computeNextBlockTimestamps(): number[] {
-        const prevBlockTimestamps = [...this.prevBlockTimestamps];
-        for(let i=1;i<10;i++) {
-            prevBlockTimestamps[i-1] = prevBlockTimestamps[i];
-        }
-        prevBlockTimestamps[9] = this.header.getTimestamp();
-        return prevBlockTimestamps;
-    }
-
-    /**
-     * Computes total chain work after a new header with "nbits" is added to the chain
-     *
-     * @param nbits
-     * @private
-     */
-    private computeNextChainWork(nbits: number): number[] {
-        const chainWork = [...this.chainWork];
-        StatePredictorUtils.addInPlace(chainWork, [...StatePredictorUtils.getDifficulty(nbits)]);
-        return chainWork;
-    }
-
-    /**
-     * Computes lastDiffAdjustment, this changes only once every DIFF_ADJUSTMENT_PERIOD blocks
-     *
-     * @param headerTimestamp
-     * @private
-     */
-    private computeNextLastDiffAdjustment(headerTimestamp: number) {
-        const blockheight = this.blockheight+1;
-
-        let lastDiffAdjustment = this.lastDiffAdjustment;
-        if(blockheight % StatePredictorUtils.DIFF_ADJUSTMENT_PERIOD === 0) {
-            lastDiffAdjustment = headerTimestamp;
-        }
-
-        return lastDiffAdjustment;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    computeNext(header: SolanaBtcHeader): SolanaBtcStoredHeader {
-        return new SolanaBtcStoredHeader({
-            chainWork: this.computeNextChainWork(header.getNbits()),
-            prevBlockTimestamps: this.computeNextBlockTimestamps(),
-            blockheight: this.blockheight+1,
-            lastDiffAdjustment: this.computeNextLastDiffAdjustment(header.getTimestamp()),
-            header
-        });
-    }
-
-}
+import {BtcStoredHeader, StatePredictorUtils} from "@atomiqlabs/base";
+import {SolanaBtcHeader, SolanaBtcHeaderType} from "./SolanaBtcHeader";
+import {Buffer} from "buffer";
+
+export type SolanaBtcStoredHeaderType = {
+    chainWork: number[],
+    header: SolanaBtcHeaderType | SolanaBtcHeader,
+    lastDiffAdjustment: number,
+    blockheight: number,
+    prevBlockTimestamps: number[]
+}
+
+/**
+ * Represents a bitcoin blockheader that has already been stored and committed in the Solana BTC relay program.
+ *
+ * @category BTC Relay
+ */
+export class SolanaBtcStoredHeader implements BtcStoredHeader<SolanaBtcHeader> {
+
+    /**
+     * Total accumulated chainwork for this header.
+     */
+    private readonly chainWork: number[];
+    /**
+     * Stored bitcoin blockheader.
+     */
+    private readonly header: SolanaBtcHeader;
+    /**
+     * Timestamp of the last difficulty adjustment.
+     */
+    private readonly lastDiffAdjustment: number;
+    /**
+     * Blockheight of the stored header.
+     */
+    private readonly blockheight: number;
+    /**
+     * Previous block timestamps tracked for median-time-past checks.
+     */
+    private readonly prevBlockTimestamps: number[];
+
+    /**
+     * Constructs the stored bitcoin blockheader from Solana event data.
+     *
+     * @param obj Decoded stored-header fields
+     *
+     * @internal
+     */
+    constructor(obj: SolanaBtcStoredHeaderType) {
+        this.chainWork = obj.chainWork;
+        this.header = obj.header instanceof SolanaBtcHeader ? obj.header : new SolanaBtcHeader(obj.header);
+        this.lastDiffAdjustment = obj.lastDiffAdjustment;
+        this.blockheight = obj.blockheight;
+        this.prevBlockTimestamps = obj.prevBlockTimestamps;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getBlockheight(): number {
+        return this.blockheight;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getChainWork(): Buffer {
+        return Buffer.from(this.chainWork);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getHeader(): SolanaBtcHeader {
+        return this.header;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getLastDiffAdjustment(): number {
+        return this.lastDiffAdjustment;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getPrevBlockTimestamps(): number[] {
+        return this.prevBlockTimestamps;
+    }
+
+    /**
+     * Computes prevBlockTimestamps for a next block, shifting the old block timestamps to the left & appending
+     *  this block's timestamp to the end
+     *
+     * @private
+     */
+    private computeNextBlockTimestamps(): number[] {
+        const prevBlockTimestamps = [...this.prevBlockTimestamps];
+        for(let i=1;i<10;i++) {
+            prevBlockTimestamps[i-1] = prevBlockTimestamps[i];
+        }
+        prevBlockTimestamps[9] = this.header.getTimestamp();
+        return prevBlockTimestamps;
+    }
+
+    /**
+     * Computes total chain work after a new header with "nbits" is added to the chain
+     *
+     * @param nbits
+     * @private
+     */
+    private computeNextChainWork(nbits: number): number[] {
+        const chainWork = [...this.chainWork];
+        StatePredictorUtils.addInPlace(chainWork, [...StatePredictorUtils.getDifficulty(nbits)]);
+        return chainWork;
+    }
+
+    /**
+     * Computes lastDiffAdjustment, this changes only once every DIFF_ADJUSTMENT_PERIOD blocks
+     *
+     * @param headerTimestamp
+     * @private
+     */
+    private computeNextLastDiffAdjustment(headerTimestamp: number) {
+        const blockheight = this.blockheight+1;
+
+        let lastDiffAdjustment = this.lastDiffAdjustment;
+        if(blockheight % StatePredictorUtils.DIFF_ADJUSTMENT_PERIOD === 0) {
+            lastDiffAdjustment = headerTimestamp;
+        }
+
+        return lastDiffAdjustment;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    computeNext(header: SolanaBtcHeader): SolanaBtcStoredHeader {
+        return new SolanaBtcStoredHeader({
+            chainWork: this.computeNextChainWork(header.getNbits()),
+            prevBlockTimestamps: this.computeNextBlockTimestamps(),
+            blockheight: this.blockheight+1,
+            lastDiffAdjustment: this.computeNextLastDiffAdjustment(header.getTimestamp()),
+            header
+        });
+    }
+
+}