@typeberry/lib 0.4.1-bb6dbac → 0.4.1-c2b0fdd

package/index.d.ts

@@ -180,6 +180,15 @@ declare class Compatibility {
 }
 
 declare function isBrowser(): boolean;
+/**
+ * Get current time in milliseconds (works in both Node and browser).
+ *
+ * Node.js implementation converts hrtime bigint nanoseconds to milliseconds.
+ * This is safe because dividing nanoseconds by 1_000_000 yields milliseconds,
+ * which remain well below Number.MAX_SAFE_INTEGER for practical runtimes
+ * (would take ~285 years to overflow).
+ */
+declare const now: () => number;
 /**
  * A function to perform runtime assertions.
  *
@@ -212,7 +221,7 @@ declare function assertEmpty<T extends Record<string, never>>(value: T): void;
 /** Debug print an object. */
 declare function inspect<T>(val: T): string;
 /** Utility function to measure time taken for some operation [ms]. */
-declare const measure: (id: string) => () => string;
+declare function measure(id: string): () => string;
 /** A class that adds `toString` method that prints all properties of an object. */
 declare abstract class WithDebug {
     toString(): string;
@@ -240,6 +249,8 @@ declare function lazyInspect<T>(obj: T): {
  */
 declare const workspacePathFix: (workspacePath: string) => (p: string) => string;
 
+declare const env: NodeJS.ProcessEnv;
+
 /**
  * `Opaque<Type, Token>` constructs a unique type which is a subset of Type with a
  * specified unique token Token. It means that base type cannot be assigned to unique type by accident.
@@ -400,16 +411,18 @@ declare const index$w_assertEmpty: typeof assertEmpty;
 declare const index$w_assertNever: typeof assertNever;
 declare const index$w_check: typeof check;
 declare const index$w_deepEqual: typeof deepEqual;
+declare const index$w_env: typeof env;
 declare const index$w_inspect: typeof inspect;
 declare const index$w_isBrowser: typeof isBrowser;
 declare const index$w_lazyInspect: typeof lazyInspect;
 declare const index$w_measure: typeof measure;
+declare const index$w_now: typeof now;
 declare const index$w_resultToString: typeof resultToString;
 declare const index$w_safeAllocUint8Array: typeof safeAllocUint8Array;
 declare const index$w_seeThrough: typeof seeThrough;
 declare const index$w_workspacePathFix: typeof workspacePathFix;
 declare namespace index$w {
-  export { index$w_CURRENT_SUITE as CURRENT_SUITE, index$w_CURRENT_VERSION as CURRENT_VERSION, index$w_Compatibility as Compatibility, index$w_DEFAULT_SUITE as DEFAULT_SUITE, index$w_DEFAULT_VERSION as DEFAULT_VERSION, index$w_ErrorsCollector as ErrorsCollector, index$w_GpVersion as GpVersion, index$w_MAX_LENGTH as MAX_LENGTH, index$w_Result as Result, index$w_TEST_COMPARE_USING as TEST_COMPARE_USING, index$w_TestSuite as TestSuite, index$w_WithDebug as WithDebug, index$w___OPAQUE_TYPE__ as __OPAQUE_TYPE__, index$w_asOpaqueType as asOpaqueType, index$w_assertEmpty as assertEmpty, index$w_assertNever as assertNever, index$w_check as check, index$w_deepEqual as deepEqual, index$w_inspect as inspect, index$w_isBrowser as isBrowser, index$w_lazyInspect as lazyInspect, index$w_measure as measure, index$w_resultToString as resultToString, index$w_safeAllocUint8Array as safeAllocUint8Array, index$w_seeThrough as seeThrough, index$w_workspacePathFix as workspacePathFix };
+  export { index$w_CURRENT_SUITE as CURRENT_SUITE, index$w_CURRENT_VERSION as CURRENT_VERSION, index$w_Compatibility as Compatibility, index$w_DEFAULT_SUITE as DEFAULT_SUITE, index$w_DEFAULT_VERSION as DEFAULT_VERSION, index$w_ErrorsCollector as ErrorsCollector, index$w_GpVersion as GpVersion, index$w_MAX_LENGTH as MAX_LENGTH, index$w_Result as Result, index$w_TEST_COMPARE_USING as TEST_COMPARE_USING, index$w_TestSuite as TestSuite, index$w_WithDebug as WithDebug, index$w___OPAQUE_TYPE__ as __OPAQUE_TYPE__, index$w_asOpaqueType as asOpaqueType, index$w_assertEmpty as assertEmpty, index$w_assertNever as assertNever, index$w_check as check, index$w_deepEqual as deepEqual, index$w_env as env, index$w_inspect as inspect, index$w_isBrowser as isBrowser, index$w_lazyInspect as lazyInspect, index$w_measure as measure, index$w_now as now, index$w_resultToString as resultToString, index$w_safeAllocUint8Array as safeAllocUint8Array, index$w_seeThrough as seeThrough, index$w_workspacePathFix as workspacePathFix };
   export type { index$w_DeepEqualOptions as DeepEqualOptions, index$w_ErrorResult as ErrorResult, index$w_OK as OK, index$w_OkResult as OkResult, index$w_Opaque as Opaque, index$w_TaggedError as TaggedError, index$w_TokenOf as TokenOf, index$w_WithOpaque as WithOpaque };
 }
 
@@ -7200,6 +7213,8 @@ declare class Channel {
 
 /** Standardized worker config. */
 interface WorkerConfig<TParams = void, TBlocks = BlocksDb, TStates = StatesDb> {
+    /** Node name. */
+    readonly nodeName: string;
     /** Chain spec. */
     readonly chainSpec: ChainSpec;
     /** Worker parameters. */
@@ -7213,11 +7228,13 @@ interface WorkerConfig<TParams = void, TBlocks = BlocksDb, TStates = StatesDb> {
  * Worker config with in-thread database.
  */
 declare class DirectWorkerConfig<TParams = void, TBlocks = BlocksDb, TStates = StatesDb> implements WorkerConfig<TParams, TBlocks, TStates> {
+    readonly nodeName: string;
     readonly chainSpec: ChainSpec;
     readonly workerParams: TParams;
     private readonly blocksDb;
     private readonly statesDb;
-    static new<T, B, S>({ chainSpec, blocksDb, statesDb, params, }: {
+    static new<T, B, S>({ nodeName, chainSpec, blocksDb, statesDb, params, }: {
+        nodeName: string;
         chainSpec: ChainSpec;
         blocksDb: B;
         statesDb: S;
@@ -7282,6 +7299,20 @@ type Options = {
     workingDir: string;
     modules: Map<string, Level>;
 };
+/**
+ * Find a configured log level for given module.
+ *
+ * The function will attempt to find the most detailed level for given module
+ * by checking if logging is configured for it's parent modules if it's not for
+ * the specific name.
+ *
+ * E.g. `consensus/voting`
+ *
+ * We can have no level configured for `consensus/voting`, but if there is a `WARN`
+ * level for `consensus`, this function would return `Level.WARN` even though
+ * the default log level might be `Level.LOG`.
+ */
+declare function findLevel(options: Options, moduleName: string): Level;
 /**
  * A function to parse logger definition (including modules) given as a string.
  *
@@ -7292,6 +7323,45 @@ type Options = {
  */
 declare function parseLoggerOptions(input: string, defaultLevel: Level, workingDir?: string): Options;
 
+type TransportBuilder = (minLevel: Level, options: Options) => Transport;
+/**
+ * An interface for the logger `Transport`.
+ */
+interface Transport {
+    /** INSANE message */
+    insane(levelAndName: readonly [Level, string], _strings: TemplateStringsArray, _data: unknown[]): void;
+    /** TRACE message */
+    trace(levelAndName: readonly [Level, string], strings: TemplateStringsArray, data: unknown[]): void;
+    /** DEBUG/LOG message */
+    log(levelAndName: readonly [Level, string], strings: TemplateStringsArray, data: unknown[]): void;
+    /** INFO message */
+    info(levelAndName: readonly [Level, string], strings: TemplateStringsArray, data: unknown[]): void;
+    /** WARN message */
+    warn(levelAndName: readonly [Level, string], strings: TemplateStringsArray, data: unknown[]): void;
+    /** ERROR message */
+    error(levelAndName: readonly [Level, string], strings: TemplateStringsArray, data: unknown[]): void;
+}
+
+/** An optimized logger that ignores `TRACE`, `DEBUG` and `LOG` messages.
+ *
+ * Use the `create` method to instantiate the right instance of a more specialized logger.
+ */
+declare class ConsoleTransport implements Transport {
+    protected options: Options;
+    /**
+     * Creates a new optimized logger which ignores messages that are below the
+     * `minimalLevel`.
+     */
+    static create(minimalLevel: Level, options: Options): ConsoleTransport;
+    protected constructor(options: Options);
+    insane(_levelAndName: readonly [Level, string], _strings: TemplateStringsArray, _data: unknown[]): void;
+    trace(_levelAndName: readonly [Level, string], _strings: TemplateStringsArray, _data: unknown[]): void;
+    log(_levelAndName: readonly [Level, string], _strings: TemplateStringsArray, _data: unknown[]): void;
+    info(_levelAndName: readonly [Level, string], _strings: TemplateStringsArray, _data: unknown[]): void;
+    warn(levelAndName: readonly [Level, string], strings: TemplateStringsArray, data: unknown[]): void;
+    error(levelAndName: readonly [Level, string], strings: TemplateStringsArray, data: unknown[]): void;
+}
+
 /**
  * A logger instance.
  */
@@ -7317,7 +7387,7 @@ declare class Logger {
      *
      * Changing the options affects all previously created loggers.
      */
-    static configureAllFromOptions(options: Options): void;
+    static configureAllFromOptions(options: Options, createTransport?: TransportBuilder): void;
     /**
      * Global configuration of all loggers.
      *
@@ -7344,17 +7414,20 @@ declare class Logger {
     error(strings: TemplateStringsArray, ...data: unknown[]): void;
 }
 
+type index$c_ConsoleTransport = ConsoleTransport;
+declare const index$c_ConsoleTransport: typeof ConsoleTransport;
 type index$c_Level = Level;
 declare const index$c_Level: typeof Level;
 type index$c_Logger = Logger;
 declare const index$c_Logger: typeof Logger;
+type index$c_Options = Options;
+type index$c_Transport = Transport;
+type index$c_TransportBuilder = TransportBuilder;
+declare const index$c_findLevel: typeof findLevel;
 declare const index$c_parseLoggerOptions: typeof parseLoggerOptions;
 declare namespace index$c {
-  export {
-    index$c_Level as Level,
-    index$c_Logger as Logger,
-    index$c_parseLoggerOptions as parseLoggerOptions,
-  };
+  export { index$c_ConsoleTransport as ConsoleTransport, index$c_Level as Level, index$c_Logger as Logger, index$c_findLevel as findLevel, index$c_parseLoggerOptions as parseLoggerOptions };
+  export type { index$c_Options as Options, index$c_Transport as Transport, index$c_TransportBuilder as TransportBuilder };
 }
 
 /** Size of the transfer memo. */
@@ -9438,6 +9511,7 @@ declare class Importer {
     private readonly stf;
     private readonly state;
     private currentHash;
+    private readonly metrics;
     constructor(spec: ChainSpec, pvm: PvmBackend, hasher: TransitionHasher, logger: Logger, blocks: BlocksDb, states: StatesDb<SerializedState<LeafDb>>);
     /** Do some extra work for preparation for the next epoch. */
     prepareForNextEpoch(): Promise<void>;
@@ -9812,6 +9886,20 @@ declare function createImporter(config: Config): Promise<{
  */
 declare function main(config: Config, comms: ImporterInternal): Promise<void>;
 
+/**
+ * Block importer metrics for JAM implementation.
+ *
+ * https://github.com/polkadot-fellows/JIPs/blob/main/JIP-3.md#block-authoringimporting-events
+ */
+declare function createMetrics(): {
+    recordBlockImportComplete(totalDurationMs: number, success: boolean): void;
+    recordBlockImportingStarted(slot: number): void;
+    recordBlockVerificationFailed(reason: string): void;
+    recordBlockVerified(durationMs: number): void;
+    recordBlockExecutionFailed(reason: string): void;
+    recordBlockExecuted(durationMs: number, cost: number): void;
+};
+
 declare const WORKER: url.URL;
 
 type index$6_Config = Config;
@@ -9821,10 +9909,11 @@ declare const index$6_ImporterConfig: typeof ImporterConfig;
 type index$6_ImporterInternal = ImporterInternal;
 declare const index$6_WORKER: typeof WORKER;
 declare const index$6_createImporter: typeof createImporter;
+declare const index$6_createMetrics: typeof createMetrics;
 declare const index$6_main: typeof main;
 declare const index$6_protocol: typeof protocol;
 declare namespace index$6 {
-  export { index$6_ImporterConfig as ImporterConfig, index$6_WORKER as WORKER, index$6_createImporter as createImporter, index$6_main as main, index$6_protocol as protocol };
+  export { index$6_ImporterConfig as ImporterConfig, index$6_WORKER as WORKER, index$6_createImporter as createImporter, index$6_createMetrics as createMetrics, index$6_main as main, index$6_protocol as protocol };
   export type { index$6_Config as Config, index$6_ImporterApi as ImporterApi, index$6_ImporterInternal as ImporterInternal };
 }