@feelyourprotocol/blockchain 8141.0.0

package/dist/esm/db/operation.d.ts

@@ -0,0 +1,45 @@
+import { KeyEncoding, ValueEncoding } from '@feelyourprotocol/util';
+import type { CacheMap } from './manager.ts';
+export type DBTarget = (typeof DBTarget)[keyof typeof DBTarget];
+export declare const DBTarget: {
+    readonly Heads: 0;
+    readonly HeadHeader: 1;
+    readonly HeadBlock: 2;
+    readonly HashToNumber: 3;
+    readonly NumberToHash: 4;
+    readonly TotalDifficulty: 5;
+    readonly Body: 6;
+    readonly Header: 7;
+    readonly CliqueSignerStates: 8;
+    readonly CliqueVotes: 9;
+    readonly CliqueBlockSigners: 10;
+};
+/**
+ * DBOpData is a type which has the purpose of holding the actual data of the Database Operation.
+ * @hidden
+ */
+export interface DBOpData {
+    type?: 'put' | 'del';
+    key: Uint8Array | string;
+    keyEncoding: KeyEncoding;
+    valueEncoding?: ValueEncoding;
+    value?: Uint8Array | object;
+}
+export type DatabaseKey = {
+    blockNumber?: bigint;
+    blockHash?: Uint8Array;
+};
+/**
+ * The DBOp class aids creating database operations which is used by `level` using a more high-level interface
+ */
+export declare class DBOp {
+    operationTarget: DBTarget;
+    baseDBOp: DBOpData;
+    cacheString: string | undefined;
+    private constructor();
+    static get(operationTarget: DBTarget, key?: DatabaseKey): DBOp;
+    static set(operationTarget: DBTarget, value: Uint8Array | object, key?: DatabaseKey): DBOp;
+    static del(operationTarget: DBTarget, key?: DatabaseKey): DBOp;
+    updateCache(cacheMap: CacheMap): void;
+}
+//# sourceMappingURL=operation.d.ts.map

package/dist/esm/db/operation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/db/operation.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAazF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAE5C,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAA;AAE/D,eAAO,MAAM,QAAQ;;;;;;;;;;;;CAYX,CAAA;AAEV;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACpB,GAAG,EAAE,UAAU,GAAG,MAAM,CAAA;IACxB,WAAW,EAAE,WAAW,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,KAAK,CAAC,EAAE,UAAU,GAAG,MAAM,CAAA;CAC5B;AAGD,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,qBAAa,IAAI;IACR,eAAe,EAAE,QAAQ,CAAA;IACzB,QAAQ,EAAE,QAAQ,CAAA;IAClB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAEtC,OAAO;WAqDO,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,WAAW,GAAG,IAAI;WAKvD,GAAG,CACf,eAAe,EAAE,QAAQ,EACzB,KAAK,EAAE,UAAU,GAAG,MAAM,EAC1B,GAAG,CAAC,EAAE,WAAW,GAChB,IAAI;WAcO,GAAG,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,WAAW,GAAG,IAAI;IAM9D,WAAW,CAAC,QAAQ,EAAE,QAAQ;CAYtC"}

package/dist/esm/db/operation.js

@@ -0,0 +1,106 @@
+import { EthereumJSErrorWithoutCode, KeyEncoding, ValueEncoding } from '@feelyourprotocol/util';
+import { HEADS_KEY, HEAD_BLOCK_KEY, HEAD_HEADER_KEY, bodyKey, hashToNumberKey, headerKey, numberToHashKey, tdKey, } from "./constants.js";
+export const DBTarget = {
+    Heads: 0,
+    HeadHeader: 1,
+    HeadBlock: 2,
+    HashToNumber: 3,
+    NumberToHash: 4,
+    TotalDifficulty: 5,
+    Body: 6,
+    Header: 7,
+    CliqueSignerStates: 8,
+    CliqueVotes: 9,
+    CliqueBlockSigners: 10,
+};
+/**
+ * The DBOp class aids creating database operations which is used by `level` using a more high-level interface
+ */
+export class DBOp {
+    constructor(operationTarget, key) {
+        this.operationTarget = operationTarget;
+        this.baseDBOp = {
+            key: '',
+            keyEncoding: KeyEncoding.Bytes,
+            valueEncoding: ValueEncoding.Bytes,
+        };
+        switch (operationTarget) {
+            case DBTarget.Heads: {
+                this.baseDBOp.key = HEADS_KEY;
+                this.baseDBOp.valueEncoding = ValueEncoding.JSON;
+                break;
+            }
+            case DBTarget.HeadHeader: {
+                this.baseDBOp.key = HEAD_HEADER_KEY;
+                this.baseDBOp.keyEncoding = KeyEncoding.String;
+                break;
+            }
+            case DBTarget.HeadBlock: {
+                this.baseDBOp.key = HEAD_BLOCK_KEY;
+                this.baseDBOp.keyEncoding = KeyEncoding.String;
+                break;
+            }
+            case DBTarget.HashToNumber: {
+                this.baseDBOp.key = hashToNumberKey(key.blockHash);
+                this.cacheString = 'hashToNumber';
+                break;
+            }
+            case DBTarget.NumberToHash: {
+                this.baseDBOp.key = numberToHashKey(key.blockNumber);
+                this.cacheString = 'numberToHash';
+                break;
+            }
+            case DBTarget.TotalDifficulty: {
+                this.baseDBOp.key = tdKey(key.blockNumber, key.blockHash);
+                this.cacheString = 'td';
+                break;
+            }
+            case DBTarget.Body: {
+                this.baseDBOp.key = bodyKey(key.blockNumber, key.blockHash);
+                this.cacheString = 'body';
+                break;
+            }
+            case DBTarget.Header: {
+                this.baseDBOp.key = headerKey(key.blockNumber, key.blockHash);
+                this.cacheString = 'header';
+                break;
+            }
+        }
+    }
+    static get(operationTarget, key) {
+        return new DBOp(operationTarget, key);
+    }
+    // set operation: note: value/key is not in default order
+    static set(operationTarget, value, key) {
+        const dbOperation = new DBOp(operationTarget, key);
+        dbOperation.baseDBOp.value = value;
+        dbOperation.baseDBOp.type = 'put';
+        if (operationTarget === DBTarget.Heads) {
+            dbOperation.baseDBOp.valueEncoding = ValueEncoding.JSON;
+        }
+        else {
+            dbOperation.baseDBOp.valueEncoding = ValueEncoding.Bytes;
+        }
+        return dbOperation;
+    }
+    static del(operationTarget, key) {
+        const dbOperation = new DBOp(operationTarget, key);
+        dbOperation.baseDBOp.type = 'del';
+        return dbOperation;
+    }
+    updateCache(cacheMap) {
+        if (this.cacheString !== undefined && cacheMap[this.cacheString] !== undefined) {
+            if (this.baseDBOp.type === 'put') {
+                this.baseDBOp.value instanceof Uint8Array &&
+                    cacheMap[this.cacheString].set(this.baseDBOp.key, this.baseDBOp.value);
+            }
+            else if (this.baseDBOp.type === 'del') {
+                cacheMap[this.cacheString].del(this.baseDBOp.key);
+            }
+            else {
+                throw EthereumJSErrorWithoutCode('unsupported db operation on cache');
+            }
+        }
+    }
+}
+//# sourceMappingURL=operation.js.map

package/dist/esm/db/operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation.js","sourceRoot":"","sources":["../../../src/db/operation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAEzF,OAAO,EACL,SAAS,EACT,cAAc,EACd,eAAe,EACf,OAAO,EACP,eAAe,EACf,SAAS,EACT,eAAe,EACf,KAAK,GACN,MAAM,gBAAgB,CAAA;AAMvB,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,KAAK,EAAE,CAAC;IACR,UAAU,EAAE,CAAC;IACb,SAAS,EAAE,CAAC;IACZ,YAAY,EAAE,CAAC;IACf,YAAY,EAAE,CAAC;IACf,eAAe,EAAE,CAAC;IAClB,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,kBAAkB,EAAE,CAAC;IACrB,WAAW,EAAE,CAAC;IACd,kBAAkB,EAAE,EAAE;CACd,CAAA;AAoBV;;GAEG;AACH,MAAM,OAAO,IAAI;IAKf,YAAoB,eAAyB,EAAE,GAAiB;QAC9D,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QAEtC,IAAI,CAAC,QAAQ,GAAG;YACd,GAAG,EAAE,EAAE;YACP,WAAW,EAAE,WAAW,CAAC,KAAK;YAC9B,aAAa,EAAE,aAAa,CAAC,KAAK;SACnC,CAAA;QAED,QAAQ,eAAe,EAAE,CAAC;YACxB,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpB,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,SAAS,CAAA;gBAC7B,IAAI,CAAC,QAAQ,CAAC,aAAa,GAAG,aAAa,CAAC,IAAI,CAAA;gBAChD,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;gBACzB,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,eAAe,CAAA;gBACnC,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC,MAAM,CAAA;gBAC9C,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;gBACxB,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,cAAc,CAAA;gBAClC,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC,MAAM,CAAA;gBAC9C,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC3B,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,eAAe,CAAC,GAAI,CAAC,SAAU,CAAC,CAAA;gBACpD,IAAI,CAAC,WAAW,GAAG,cAAc,CAAA;gBACjC,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC3B,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,eAAe,CAAC,GAAI,CAAC,WAAY,CAAC,CAAA;gBACtD,IAAI,CAAC,WAAW,GAAG,cAAc,CAAA;gBACjC,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;gBAC9B,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,KAAK,CAAC,GAAI,CAAC,WAAY,EAAE,GAAI,CAAC,SAAU,CAAC,CAAA;gBAC7D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;gBACvB,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnB,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAI,CAAC,WAAY,EAAE,GAAI,CAAC,SAAU,CAAC,CAAA;gBAC/D,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;gBACzB,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;gBACrB,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,SAAS,CAAC,GAAI,CAAC,WAAY,EAAE,GAAI,CAAC,SAAU,CAAC,CAAA;gBACjE,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;gBAC3B,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,GAAG,CAAC,eAAyB,EAAE,GAAiB;QAC5D,OAAO,IAAI,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;IACvC,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,GAAG,CACf,eAAyB,EACzB,KAA0B,EAC1B,GAAiB;QAEjB,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;QAClD,WAAW,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAA;QAClC,WAAW,CAAC,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAA;QAEjC,IAAI,eAAe,KAAK,QAAQ,CAAC,KAAK,EAAE,CAAC;YACvC,WAAW,CAAC,QAAQ,CAAC,aAAa,GAAG,aAAa,CAAC,IAAI,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,QAAQ,CAAC,aAAa,GAAG,aAAa,CAAC,KAAK,CAAA;QAC1D,CAAC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAEM,MAAM,CAAC,GAAG,CAAC,eAAyB,EAAE,GAAiB;QAC5D,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;QAClD,WAAW,CAAC,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAA;QACjC,OAAO,WAAW,CAAA;IACpB,CAAC;IAEM,WAAW,CAAC,QAAkB;QACnC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE,CAAC;YAC/E,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACjC,IAAI,CAAC,QAAQ,CAAC,KAAK,YAAY,UAAU;oBACvC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC1E,CAAC;iBAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACxC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;YACnD,CAAC;iBAAM,CAAC;gBACN,MAAM,0BAA0B,CAAC,mCAAmC,CAAC,CAAA;YACvE,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/esm/helpers.d.ts

@@ -0,0 +1,19 @@
+import type { Chain, Common, GenesisState } from '@feelyourprotocol/common';
+/**
+ * Safe creation of a new Blockchain object awaiting the initialization function,
+ * encouraged method to use when creating a blockchain object.
+ *
+ * @param opts Constructor options, see {@link BlockchainOptions}
+ */
+/**
+ * Merkle genesis root
+ * @param genesisState
+ * @param common
+ * @returns
+ */
+export declare function genGenesisStateRoot(genesisState: GenesisState, common: Common): Promise<Uint8Array>;
+/**
+ * Returns the genesis state root if chain is well known or an empty state's root otherwise
+ */
+export declare function getGenesisStateRoot(chainId: Chain, common: Common): Promise<Uint8Array>;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/esm/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAErE;;;;;GAKG;AAEH;;;;;GAKG;AACH,wBAAsB,mBAAmB,CACvC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,CAAC,CAOrB;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAG7F"}

package/dist/esm/helpers.js

@@ -0,0 +1,30 @@
+import { ChainGenesis } from '@feelyourprotocol/common';
+import { genesisMPTStateRoot } from '@feelyourprotocol/mpt';
+/**
+ * Safe creation of a new Blockchain object awaiting the initialization function,
+ * encouraged method to use when creating a blockchain object.
+ *
+ * @param opts Constructor options, see {@link BlockchainOptions}
+ */
+/**
+ * Merkle genesis root
+ * @param genesisState
+ * @param common
+ * @returns
+ */
+export async function genGenesisStateRoot(genesisState, common) {
+    const genCommon = common.copy();
+    genCommon.setHardforkBy({
+        blockNumber: 0,
+        timestamp: genCommon.genesis().timestamp,
+    });
+    return genesisMPTStateRoot(genesisState);
+}
+/**
+ * Returns the genesis state root if chain is well known or an empty state's root otherwise
+ */
+export async function getGenesisStateRoot(chainId, common) {
+    const chainGenesis = ChainGenesis[chainId];
+    return chainGenesis !== undefined ? chainGenesis.stateRoot : genGenesisStateRoot({}, common);
+}
+//# sourceMappingURL=helpers.js.map

package/dist/esm/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAIrD;;;;;GAKG;AAEH;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,YAA0B,EAC1B,MAAc;IAEd,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,EAAE,CAAA;IAC/B,SAAS,CAAC,aAAa,CAAC;QACtB,WAAW,EAAE,CAAC;QACd,SAAS,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,SAAS;KACzC,CAAC,CAAA;IACF,OAAO,mBAAmB,CAAC,YAAY,CAAC,CAAA;AAC1C,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,OAAc,EAAE,MAAc;IACtE,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;IAC1C,OAAO,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;AAC9F,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+export { Blockchain } from './blockchain.ts';
+export { CasperConsensus, CliqueConsensus, EthashConsensus } from './consensus/index.ts';
+export * from './constructors.ts';
+export { DBOp, DBSaveLookups, DBSetBlockOrHeader, DBSetHashToNumber, DBSetTD, } from './db/helpers.ts';
+export * from './helpers.ts';
+export * from './types.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACxF,cAAc,mBAAmB,CAAA;AACjC,OAAO,EACL,IAAI,EACJ,aAAa,EACb,kBAAkB,EAClB,iBAAiB,EACjB,OAAO,GACR,MAAM,iBAAiB,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+export { Blockchain } from "./blockchain.js";
+export { CasperConsensus, CliqueConsensus, EthashConsensus } from "./consensus/index.js";
+export * from "./constructors.js";
+export { DBOp, DBSaveLookups, DBSetBlockOrHeader, DBSetHashToNumber, DBSetTD, } from "./db/helpers.js";
+export * from "./helpers.js";
+export * from "./types.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACxF,cAAc,mBAAmB,CAAA;AACjC,OAAO,EACL,IAAI,EACJ,aAAa,EACb,kBAAkB,EAClB,iBAAiB,EACjB,OAAO,GACR,MAAM,iBAAiB,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA"}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/dist/esm/types.d.ts

@@ -0,0 +1,219 @@
+import type { Block, BlockHeader } from '@feelyourprotocol/block';
+import type { Common, ConsensusAlgorithm, GenesisState } from '@feelyourprotocol/common';
+import type { DB, DBObject } from '@feelyourprotocol/util';
+import type { EventEmitter } from 'eventemitter3';
+import type { Blockchain } from './index.ts';
+export type OnBlock = (block: Block, reorg: boolean) => Promise<void> | void;
+export type BlockchainEvent = {
+    deletedCanonicalBlocks: (data: Block[], resolve?: (result?: any) => void) => void;
+};
+export interface BlockchainInterface {
+    consensus: Consensus | undefined;
+    /**
+     * Adds a block to the blockchain.
+     *
+     * @param block - The block to be added to the blockchain.
+     */
+    putBlock(block: Block): Promise<void>;
+    /**
+     * Deletes a block from the blockchain. All child blocks in the chain are
+     * deleted and any encountered heads are set to the parent block.
+     *
+     * @param blockHash - The hash of the block to be deleted
+     */
+    delBlock(blockHash: Uint8Array): Promise<void>;
+    /**
+     * Returns a block by its hash or number.
+     */
+    getBlock(blockId: Uint8Array | number | bigint): Promise<Block>;
+    /**
+     * Iterates through blocks starting at the specified iterator head and calls
+     * the onBlock function on each block.
+     *
+     * @param name - Name of the state root head
+     * @param onBlock - Function called on each block with params (block: Block,
+     * @param maxBlocks - optional maximum number of blocks to iterate through
+     * reorg: boolean)
+     */
+    iterator(name: string, onBlock: OnBlock, maxBlocks?: number, releaseLockOnCallback?: boolean): Promise<number>;
+    /**
+     * Returns a shallow copy of the blockchain that may share state with the original
+     */
+    shallowCopy(): BlockchainInterface;
+    /**
+     * Validates a block header, throwing if invalid. It is being validated against the reported `parentHash`.
+     * @param header - header to be validated
+     * @param height - If this is an uncle header, this is the height of the block that is including it
+     */
+    validateHeader(header: BlockHeader, height?: bigint): Promise<void>;
+    /**
+     * Returns the specified iterator head.
+     *
+     * @param name - Optional name of the iterator head (default: 'vm')
+     */
+    getIteratorHead(name?: string): Promise<Block>;
+    /**
+     * Set header hash of a certain `tag`.
+     * When calling the iterator, the iterator will start running the first child block after the header hash currently stored.
+     * @param tag - The tag to save the headHash to
+     * @param headHash - The head hash to save
+     */
+    setIteratorHead(tag: string, headHash: Uint8Array): Promise<void>;
+    /**
+     * Gets total difficulty for a block specified by hash and number
+     */
+    getTotalDifficulty?(hash: Uint8Array, number?: bigint): Promise<bigint>;
+    /**
+     * Returns the latest full block in the canonical chain.
+     */
+    getCanonicalHeadBlock(): Promise<Block>;
+    /**
+     * Optional events emitter
+     */
+    events?: EventEmitter<BlockchainEvent>;
+}
+export interface GenesisOptions {
+    /**
+     * The blockchain only initializes successfully if it has a genesis block. If
+     * there is no block available in the DB and a `genesisBlock` is provided,
+     * then the provided `genesisBlock` will be used as genesis. If no block is
+     * present in the DB and no block is provided, then the genesis block as
+     * provided from the `common` will be used.
+     */
+    genesisBlock?: Block;
+    /**
+     * If you are using a custom chain {@link Common}, pass the genesis state.
+     *
+     * Pattern 1 (with genesis state see {@link GenesisState} for format):
+     *
+     * ```javascript
+     * {
+     *   '0x0...01': '0x100', // For EoA
+     * }
+     * ```
+     *
+     * Pattern 2 (with complex genesis state, containing contract accounts and storage).
+     * Note that in {@link AccountState} there are two
+     * accepted types. This allows to easily insert accounts in the genesis state:
+     *
+     * A complex genesis state with Contract and EoA states would have the following format:
+     *
+     * ```javascript
+     * {
+     *   '0x0...01': '0x100', // For EoA
+     *   '0x0...02': ['0x1', '0xRUNTIME_BYTECODE', [[storageKey1, storageValue1], [storageKey2, storageValue2]]] // For contracts
+     * }
+     * ```
+     */
+    genesisState?: GenesisState;
+    /**
+     * State root of the genesis state
+     */
+    genesisStateRoot?: Uint8Array;
+}
+export type ConsensusDict = {
+    [consensusAlgorithm: ConsensusAlgorithm | string]: Consensus;
+};
+/**
+ * This are the options that the Blockchain constructor can receive.
+ */
+export interface BlockchainOptions extends GenesisOptions {
+    /**
+     * Specify the chain and hardfork by passing a {@link Common} instance.
+     *
+     * If not provided this defaults to chain `mainnet` and hardfork `chainstart`
+     *
+     */
+    common?: Common;
+    /**
+     * Set the HF to the fork determined by the head block and update on head updates.
+     *
+     * Note: for HFs where the transition is also determined by a total difficulty
+     * threshold (merge HF) the calculated TD is additionally taken into account
+     * for HF determination.
+     *
+     * Default: `false` (HF is set to whatever default HF is set by the {@link Common} instance)
+     */
+    hardforkByHeadBlockNumber?: boolean;
+    /**
+     * Database to store blocks and metadata.
+     * Can be any database implementation that adheres to the `DB` interface
+     */
+    db?: DB<Uint8Array | string | number, Uint8Array | string | DBObject>;
+    /**
+     * This flag indicates if protocol-given consistency checks on
+     * block headers and included uncles and transactions should be performed,
+     * see Block#validate for details.
+     *
+     */
+    validateBlocks?: boolean;
+    /**
+     * Validate the consensus with the respective consensus implementation passed
+     * to `consensusDict` (see respective option) `CasperConsensus` (which effectively
+     * does nothing) is available by default.
+     *
+     * For the build-in validation classes the following validations take place.
+     * - 'pow' with 'ethash' algorithm (validates the proof-of-work)
+     * - 'poa' with 'clique' algorithm (verifies the block signatures)
+     * Default: `false`.
+     */
+    validateConsensus?: boolean;
+    /**
+     * Optional dictionary with consensus objects (adhering to the {@link Consensus} interface)
+     * if consensus validation is wished for certain consensus algorithms.
+     *
+     * Since consensus validation moved to the Ethereum consensus layer with Proof-of-Stake
+     * consensus is not validated by default. For `ConsensusAlgorithm.Ethash` and
+     * `ConsensusAlgorithm.Clique` consensus validation can be activated by passing in the
+     * respective consensus validation objects `EthashConsensus` or `CliqueConsensus`.
+     *
+     * ```ts
+     * import { CliqueConsensus, createBlockchain } from '@feelyourprotocol/blockchain'
+     * import type { ConsensusDict } from '@feelyourprotocol/blockchain'
+     *
+     * const consensusDict: ConsensusDict = {}
+     * consensusDict[ConsensusAlgorithm.Clique] = new CliqueConsensus()
+     * const blockchain = await createBlockchain({ common, consensusDict })
+     * ```
+     *
+     * Additionally it is possible to provide a fully custom consensus implementation.
+     * Note that this needs a custom `Common` object passed to the blockchain where
+     * the `ConsensusAlgorithm` string matches the string used here.
+     */
+    consensusDict?: ConsensusDict;
+}
+/**
+ * Interface that a consensus class needs to implement.
+ */
+export interface Consensus {
+    algorithm: ConsensusAlgorithm | string;
+    /**
+     * Initialize genesis for consensus mechanism
+     * @param genesisBlock genesis block
+     */
+    genesisInit(genesisBlock: Block): Promise<void>;
+    /**
+     * Set up consensus mechanism
+     */
+    setup({ blockchain }: ConsensusOptions): Promise<void>;
+    /**
+     * Validate block consensus parameters
+     * @param block block to be validated
+     */
+    validateConsensus(block: Block): Promise<void>;
+    validateDifficulty(header: BlockHeader): Promise<void>;
+    /**
+     * Update consensus on new block
+     * @param block new block
+     * @param commonAncestor common ancestor block header (optional)
+     * @param ancientHeaders array of ancestor block headers (optional)
+     */
+    newBlock(block: Block, commonAncestor?: BlockHeader, ancientHeaders?: BlockHeader[]): Promise<void>;
+}
+/**
+ * Options when initializing a class that implements the Consensus interface.
+ */
+export interface ConsensusOptions {
+    blockchain: Blockchain;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAClF,OAAO,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AAE5E,MAAM,MAAM,eAAe,GAAG;IAC5B,sBAAsB,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,CAAA;CAClF,CAAA;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,SAAS,GAAG,SAAS,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErC;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE9C;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;IAE/D;;;;;;;;OAQG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,qBAAqB,CAAC,EAAE,OAAO,GAC9B,OAAO,CAAC,MAAM,CAAC,CAAA;IAElB;;OAEG;IACH,WAAW,IAAI,mBAAmB,CAAA;IAElC;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnE;;;;OAIG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;IAE9C;;;;;OAKG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;OAEG;IACH,kBAAkB,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEvE;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,KAAK,CAAC,CAAA;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC,eAAe,CAAC,CAAA;CACvC;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,KAAK,CAAA;IAEpB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAA;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,MAAM,GAAG,SAAS,CAAA;CAC7D,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;;;;;OAQG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IAEnC;;;OAGG;IACH,EAAE,CAAC,EAAE,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC,CAAA;IAErE;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,kBAAkB,GAAG,MAAM,CAAA;IACtC;;;OAGG;IACH,WAAW,CAAC,YAAY,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/C;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtD;;;OAGG;IACH,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE9C,kBAAkB,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtD;;;;;OAKG;IACH,QAAQ,CACN,KAAK,EAAE,KAAK,EACZ,cAAc,CAAC,EAAE,WAAW,EAC5B,cAAc,CAAC,EAAE,WAAW,EAAE,GAC7B,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,UAAU,CAAA;CACvB"}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}