@lodestar/utils 1.17.0-dev.eedfaa188f → 1.17.0-dev.f62bc13d89

package/lib/command.d.ts

@@ -0,0 +1,36 @@
+import type { Options, Argv } from "yargs";
+export interface CliExample {
+    command: string;
+    title?: string;
+    description?: string;
+}
+export interface CliOptionDefinition<T = any> extends Options {
+    example?: Omit<CliExample, "title">;
+    type: T extends string ? "string" : T extends number ? "number" : T extends boolean ? "boolean" : T extends Array<unknown> ? "array" : never;
+}
+export type CliCommandOptions<OwnArgs> = Required<{
+    [K in keyof OwnArgs]: undefined extends OwnArgs[K] ? CliOptionDefinition<OwnArgs[K]> : // If arg cannot be undefined it must specify a default value or be provided by the user
+    CliOptionDefinition<OwnArgs[K]> & (Required<Pick<Options, "default">> | {
+        demandOption: true;
+    });
+}>;
+export interface CliCommand<OwnArgs = Record<never, never>, ParentArgs = Record<never, never>, R = any> {
+    command: string;
+    describe: string;
+    /**
+     * The folder in docs/pages that the cli.md should be placed in.  If not provided no
+     * cli flags page will be generated for the command
+     */
+    docsFolder?: string;
+    examples?: CliExample[];
+    options?: CliCommandOptions<OwnArgs>;
+    subcommands?: CliCommand<any, OwnArgs & ParentArgs>[];
+    handler?: (args: OwnArgs & ParentArgs) => Promise<R>;
+}
+/**
+ * Register a CliCommand type to yargs. Recursively registers subcommands too.
+ * @param yargs
+ * @param cliCommand
+ */
+export declare function registerCommandToYargs(yargs: Argv, cliCommand: CliCommand<any, any>): void;
+//# sourceMappingURL=command.d.ts.map

package/lib/command.js

@@ -0,0 +1,26 @@
+/**
+ * Register a CliCommand type to yargs. Recursively registers subcommands too.
+ * @param yargs
+ * @param cliCommand
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function registerCommandToYargs(yargs, cliCommand) {
+    yargs.command({
+        command: cliCommand.command,
+        describe: cliCommand.describe,
+        builder: (yargsBuilder) => {
+            yargsBuilder.options(cliCommand.options ?? {});
+            for (const subcommand of cliCommand.subcommands ?? []) {
+                registerCommandToYargs(yargsBuilder, subcommand);
+            }
+            if (cliCommand.examples) {
+                for (const example of cliCommand.examples) {
+                    yargsBuilder.example(`$0 ${example.command}`, example.description ?? "");
+                }
+            }
+            return yargs;
+        },
+        handler: cliCommand.handler ?? function emptyHandler() { },
+    });
+}
+//# sourceMappingURL=command.js.map

package/lib/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAgDA;;;;GAIG;AACH,8DAA8D;AAC9D,MAAM,UAAU,sBAAsB,CAAC,KAAW,EAAE,UAAgC;IAClF,KAAK,CAAC,OAAO,CAAC;QACZ,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,OAAO,EAAE,CAAC,YAAY,EAAE,EAAE;YACxB,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAC/C,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,WAAW,IAAI,EAAE,EAAE;gBACrD,sBAAsB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;aAClD;YACD,IAAI,UAAU,CAAC,QAAQ,EAAE;gBACvB,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,QAAQ,EAAE;oBACzC,YAAY,CAAC,OAAO,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;iBAC1E;aACF;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,SAAS,YAAY,KAAU,CAAC;KAChE,CAAC,CAAC;AACL,CAAC"}

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export * from "./yaml/index.js";
 export * from "./assert.js";
 export * from "./base64.js";
 export * from "./bytes.js";
+export * from "./command.js";
 export * from "./err.js";
 export * from "./errors.js";
 export * from "./format.js";

package/lib/index.js

@@ -2,6 +2,7 @@ export * from "./yaml/index.js";
 export * from "./assert.js";
 export * from "./base64.js";
 export * from "./bytes.js";
+export * from "./command.js";
 export * from "./err.js";
 export * from "./errors.js";
 export * from "./format.js";

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAC,KAAK,EAAoB,MAAM,YAAY,CAAC;AACpD,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAwB,OAAO,EAAC,MAAM,YAAY,CAAC;AAC1D,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAC,KAAK,EAAoB,MAAM,YAAY,CAAC;AACpD,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAwB,OAAO,EAAC,MAAM,YAAY,CAAC;AAC1D,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC"}

package/lib/retry.d.ts

@@ -19,6 +19,9 @@ export type RetryOptions = {
      * Milliseconds to wait before retrying again
      */
     retryDelay?: number;
+    /**
+     * Abort signal to stop retrying
+     */
     signal?: AbortSignal;
 };
 /**

package/lib/retry.js

@@ -1,3 +1,4 @@
+import { ErrorAborted } from "./errors.js";
 import { sleep } from "./sleep.js";
 /**
  * Retry a given function on error.
@@ -13,10 +14,15 @@ export async function retry(fn, opts) {
     const onRetry = opts?.onRetry;
     let lastError = Error("RetryError");
     for (let i = 1; i <= maxAttempts; i++) {
+        // If not the first attempt
+        if (i > 1) {
+            if (opts?.signal?.aborted) {
+                throw new ErrorAborted("retry");
+            }
+            // Invoke right before retrying
+            onRetry?.(lastError, i);
+        }
         try {
-            // If not the first attempt, invoke right before retrying
-            if (i > 1)
-                onRetry?.(lastError, i);
             return await fn(i);
         }
         catch (e) {

package/lib/retry.js.map

@@ -1 +1 @@
-{"version":3,"file":"retry.js","sourceRoot":"","sources":["../src/retry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,YAAY,CAAC;AA0BjC;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAI,EAAuC,EAAE,IAAmB;IACzF,MAAM,UAAU,GAAG,IAAI,EAAE,OAAO,IAAI,CAAC,CAAC;IACtC,0CAA0C;IAC1C,MAAM,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC;IACnC,MAAM,WAAW,GAAG,IAAI,EAAE,WAAW,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,CAAC;IAE9B,IAAI,SAAS,GAAU,KAAK,CAAC,YAAY,CAAC,CAAC;IAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,EAAE,EAAE;QACrC,IAAI;YACF,yDAAyD;YACzD,IAAI,CAAC,GAAG,CAAC;gBAAE,OAAO,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YAEnC,OAAO,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,SAAS,GAAG,CAAU,CAAC;YAEvB,IAAI,CAAC,KAAK,WAAW,EAAE;gBACrB,kFAAkF;gBAClF,MAAM;aACP;iBAAM,IAAI,WAAW,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE;gBACjD,MAAM;aACP;iBAAM,IAAI,IAAI,EAAE,UAAU,KAAK,SAAS,EAAE;gBACzC,MAAM,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;aAC7C;SACF;KACF;IACD,MAAM,SAAS,CAAC;AAClB,CAAC"}
+{"version":3,"file":"retry.js","sourceRoot":"","sources":["../src/retry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AACzC,OAAO,EAAC,KAAK,EAAC,MAAM,YAAY,CAAC;AA6BjC;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAI,EAAuC,EAAE,IAAmB;IACzF,MAAM,UAAU,GAAG,IAAI,EAAE,OAAO,IAAI,CAAC,CAAC;IACtC,0CAA0C;IAC1C,MAAM,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC;IACnC,MAAM,WAAW,GAAG,IAAI,EAAE,WAAW,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,CAAC;IAE9B,IAAI,SAAS,GAAU,KAAK,CAAC,YAAY,CAAC,CAAC;IAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,EAAE,EAAE;QACrC,2BAA2B;QAC3B,IAAI,CAAC,GAAG,CAAC,EAAE;YACT,IAAI,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;gBACzB,MAAM,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;aACjC;YACD,+BAA+B;YAC/B,OAAO,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;SACzB;QAED,IAAI;YACF,OAAO,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;SACpB;QAAC,OAAO,CAAC,EAAE;YACV,SAAS,GAAG,CAAU,CAAC;YAEvB,IAAI,CAAC,KAAK,WAAW,EAAE;gBACrB,kFAAkF;gBAClF,MAAM;aACP;iBAAM,IAAI,WAAW,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE;gBACjD,MAAM;aACP;iBAAM,IAAI,IAAI,EAAE,UAAU,KAAK,SAAS,EAAE;gBACzC,MAAM,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;aAC7C;SACF;KACF;IACD,MAAM,SAAS,CAAC;AAClB,CAAC"}

package/package.json

@@ -11,7 +11,7 @@
   "bugs": {
     "url": "https://github.com/ChainSafe/lodestar/issues"
   },
-  "version": "1.17.0-dev.eedfaa188f",
+  "version": "1.17.0-dev.f62bc13d89",
   "type": "module",
   "exports": "./lib/index.js",
   "files": [
@@ -43,14 +43,12 @@
     "any-signal": "3.0.1",
     "bigint-buffer": "^1.1.5",
     "case": "^1.6.3",
-    "chalk": "^5.2.0",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.5",
-    "@types/triple-beam": "^1.3.2",
-    "prom-client": "^15.1.0",
-    "triple-beam": "^1.3.0"
+    "@types/yargs": "^17.0.24",
+    "prom-client": "^15.1.0"
   },
   "keywords": [
     "ethereum",
@@ -58,5 +56,5 @@
     "beacon",
     "blockchain"
   ],
-  "gitHead": "eb3c150b099bc9d65f894cf16ad9df766e58912f"
+  "gitHead": "8dc957a84d6bd0d7ab0aa78563bd689647793e15"
 }