@xyo-network/xl1-protocol-sdk 3.0.15 → 3.0.16

package/dist/neutral/index.mjs

@@ -3101,7 +3101,7 @@ import {
 } from "@xylabs/sdk-js";
 import { CachingContextZod } from "@xyo-network/xl1-protocol-lib";
 import { z as z19 } from "zod/mini";
-var RuntimeStatusMonitorZod = z19.custom((val) => val !== null && val !== void 0 && typeof val === "object");
+var SystemStatusRunnerZod = z19.custom((val) => val !== null && val !== void 0 && typeof val === "object");
 var ProviderFactoryLocatorZod = z19.lazy(() => z19.custom((val) => val !== null && val !== void 0 && typeof val === "object" && "context" in val && "registry" in val));
 var BaseConfigContextZod = z19.extend(CachingContextZod, {
   config: z19.looseObject(BaseConfigZod.shape),
@@ -3110,7 +3110,7 @@ var BaseConfigContextZod = z19.extend(CachingContextZod, {
 var CreatableProviderContextZod = z19.lazy(() => z19.extend(BaseConfigContextZod, {
   _id: z19.optional(z19.string()),
   locator: ProviderFactoryLocatorZod,
-  statusReporter: z19.optional(RuntimeStatusMonitorZod)
+  statusReporter: z19.optional(SystemStatusRunnerZod)
 }));
 var isBaseConfigContext = zodIsFactory4(BaseConfigContextZod);
 var asBaseConfigContext = zodAsFactory5(BaseConfigContextZod, "asBaseConfigContext");
@@ -6781,10 +6781,71 @@ RestSyncViewer = __decorateClass([
   creatableProvider()
 ], RestSyncViewer);
 
+// src/simple/systemStatus/ConsoleSystemStatusPublisher.ts
+import { assertEx as assertEx50 } from "@xylabs/sdk-js";
+import { SystemStatusPublisherMoniker } from "@xyo-network/xl1-protocol-lib";
+var ConsoleSystemStatusPublisher = class extends AbstractCreatableProvider {
+  moniker = ConsoleSystemStatusPublisher.defaultMoniker;
+  async startHandler() {
+    await super.startHandler();
+    const runner = assertEx50(
+      this.context.statusReporter,
+      () => "ConsoleSystemStatusPublisher requires a SystemStatusRunner (context.statusReporter)"
+    );
+    runner.onGlobalTransition({ to: "started" }, () => {
+      this.logger?.info("All services started.");
+    });
+    runner.onGlobalTransition({ to: "error" }, () => {
+      this.logger?.error("A service entered an error state.");
+    });
+  }
+};
+__publicField(ConsoleSystemStatusPublisher, "connectionTypes", ["memory"]);
+__publicField(ConsoleSystemStatusPublisher, "defaultMoniker", SystemStatusPublisherMoniker);
+__publicField(ConsoleSystemStatusPublisher, "dependencies", []);
+__publicField(ConsoleSystemStatusPublisher, "monikers", [SystemStatusPublisherMoniker]);
+__publicField(ConsoleSystemStatusPublisher, "surface", "node");
+ConsoleSystemStatusPublisher = __decorateClass([
+  creatableProvider()
+], ConsoleSystemStatusPublisher);
+
+// src/simple/systemStatus/SimpleSystemStatusViewer.ts
+import { assertEx as assertEx51 } from "@xylabs/sdk-js";
+import { SystemStatusViewerMoniker } from "@xyo-network/xl1-protocol-lib";
+var SimpleSystemStatusViewer = class extends AbstractCreatableProvider {
+  moniker = SimpleSystemStatusViewer.defaultMoniker;
+  get runner() {
+    return assertEx51(this.context.statusReporter, () => "SystemStatusViewer requires a SystemStatusRunner (context.statusReporter)");
+  }
+  getGlobalStatus() {
+    return this.runner.getGlobalStatus();
+  }
+  getStatus(name) {
+    return this.runner.getStatus(name);
+  }
+  isReady() {
+    return this.runner.isReady();
+  }
+  isShuttingDown() {
+    return this.runner.isShuttingDown();
+  }
+  snapshot() {
+    return this.runner.snapshot();
+  }
+};
+__publicField(SimpleSystemStatusViewer, "connectionTypes", ["memory"]);
+__publicField(SimpleSystemStatusViewer, "defaultMoniker", SystemStatusViewerMoniker);
+__publicField(SimpleSystemStatusViewer, "dependencies", []);
+__publicField(SimpleSystemStatusViewer, "monikers", [SystemStatusViewerMoniker]);
+__publicField(SimpleSystemStatusViewer, "surface", "node");
+SimpleSystemStatusViewer = __decorateClass([
+  creatableProvider()
+], SimpleSystemStatusViewer);
+
 // src/simple/timeSync2/SimpleTimeSyncViewer.ts
 import {
   asHash as asHash5,
-  assertEx as assertEx50,
+  assertEx as assertEx52,
   isDefined as isDefined22
 } from "@xylabs/sdk-js";
 import {
@@ -6806,7 +6867,7 @@ var SimpleTimeSyncViewer = class extends AbstractCreatableProvider {
   async convertTime(fromDomain, toDomain, from) {
     switch (fromDomain) {
       case "xl1": {
-        const [block, payloads] = assertEx50(await this.blockViewer.blockByNumber(asXL1BlockNumber11(from, true)), () => "Block not found");
+        const [block, payloads] = assertEx52(await this.blockViewer.blockByNumber(asXL1BlockNumber11(from, true)), () => "Block not found");
         const timeSchemaIndex = block.payload_schemas.indexOf(TimeSchema);
         const hash = timeSchemaIndex === -1 ? void 0 : block.payload_hashes[timeSchemaIndex];
         const timePayload = asTimePayload2(isDefined22(hash) ? payloads.find((p) => p._hash === hash) : void 0);
@@ -6862,10 +6923,10 @@ var SimpleTimeSyncViewer = class extends AbstractCreatableProvider {
         return [Date.now(), null];
       }
       case "ethereum": {
-        const provider = assertEx50(this.ethProvider, () => "Ethereum provider not configured");
+        const provider = assertEx52(this.ethProvider, () => "Ethereum provider not configured");
         const blockNumber = await provider.getBlockNumber() ?? 0;
         const block = await provider.getBlock(blockNumber);
-        const blockHash = asHash5(assertEx50(block?.hash, () => "Block hash not found"), true);
+        const blockHash = asHash5(assertEx52(block?.hash, () => "Block hash not found"), true);
         return [blockNumber, blockHash];
       }
       default: {
@@ -6880,7 +6941,7 @@ var SimpleTimeSyncViewer = class extends AbstractCreatableProvider {
       // this is for the previous block
       xl1,
       // this is for the previous block
-      xl1Hash: assertEx50(xl1Hash, () => "No xl1 hash available from time sync service"),
+      xl1Hash: assertEx52(xl1Hash, () => "No xl1 hash available from time sync service"),
       epoch: Date.now()
     };
     if (isDefined22(this.ethProvider)) {
@@ -6902,7 +6963,7 @@ SimpleTimeSyncViewer = __decorateClass([
 ], SimpleTimeSyncViewer);
 
 // src/simple/transactionValidation/SimpleTransactionValidationViewer.ts
-import { assertEx as assertEx51 } from "@xylabs/sdk-js";
+import { assertEx as assertEx53 } from "@xylabs/sdk-js";
 import { PayloadBuilder as PayloadBuilder24 } from "@xyo-network/sdk-js";
 import {
   AccountBalanceViewerMoniker as AccountBalanceViewerMoniker3,
@@ -6956,7 +7017,7 @@ var SimpleTransactionValidationViewer = class extends AbstractCreatableProvider
     let head;
     if (isChainQualifiedHeadConfig6(config)) {
       const headBlockResult = await this.blockViewer.blockByHash(config.head);
-      head = headBlockResult == null ? assertEx51(
+      head = headBlockResult == null ? assertEx53(
         void 0,
         () => `Specified a head that is not in the chain [${config.head}]`
       ) : headBlockResult[0];
@@ -7028,7 +7089,7 @@ SimpleTransactionValidationViewer = __decorateClass([
 ], SimpleTransactionValidationViewer);
 
 // src/simple/TransactionViewer/SimpleTransactionViewer.ts
-import { assertEx as assertEx52, exists as exists10 } from "@xylabs/sdk-js";
+import { assertEx as assertEx54, exists as exists10 } from "@xylabs/sdk-js";
 import { BoundWitnessSchema } from "@xyo-network/sdk-js";
 import {
   asSignedHydratedTransactionWithHashMeta as asSignedHydratedTransactionWithHashMeta2,
@@ -7045,7 +7106,7 @@ var SimpleTransactionViewer = class extends AbstractCreatableProvider {
   }
   async byBlockHashAndIndex(blockHash, transactionIndex) {
     return await this.spanAsync("byBlockHashAndIndex", async () => {
-      assertEx52(transactionIndex >= 0, () => "transactionIndex must be greater than or equal to 0");
+      assertEx54(transactionIndex >= 0, () => "transactionIndex must be greater than or equal to 0");
       try {
         const block = await this.blockViewer.blockByHash(blockHash);
         if (!block) return null;
@@ -7110,7 +7171,7 @@ SimpleTransactionViewer = __decorateClass([
 
 // src/simple/windowedBlock/SimpleWindowedBlockViewer.ts
 import {
-  assertEx as assertEx53,
+  assertEx as assertEx55,
   exists as exists11,
   isNull as isNull2
 } from "@xylabs/sdk-js";
@@ -7192,7 +7253,7 @@ var SimpleWindowedBlockViewer = class extends AbstractCreatableProvider {
   }
   async createHandler() {
     await super.createHandler();
-    this._blockViewer = assertEx53(
+    this._blockViewer = assertEx55(
       this.params.blockViewer ?? await this.locator.getInstance(BlockViewerMoniker7),
       () => "BlockViewer instance is required"
     );
@@ -7201,13 +7262,13 @@ var SimpleWindowedBlockViewer = class extends AbstractCreatableProvider {
     this._transactionHashMap = new MemoryMap2();
   }
   currentBlock() {
-    return assertEx53(this._chain.at(-1));
+    return assertEx55(this._chain.at(-1));
   }
   currentBlockHash() {
-    return assertEx53(this._chain.at(-1)?.[0]._hash);
+    return assertEx55(this._chain.at(-1)?.[0]._hash);
   }
   currentBlockNumber() {
-    return assertEx53(this._chain.at(-1)?.[0].block);
+    return assertEx55(this._chain.at(-1)?.[0].block);
   }
   async payloadByHash(hash) {
     const payloads = await this.payloadsByHash([hash]);
@@ -7301,7 +7362,8 @@ var LoggerStatusReporter = class {
   }
 };
 
-// src/status/RuntimeStatusMonitor.ts
+// src/status/SimpleSystemStatusRunner.ts
+import { SystemStatusRunnerMoniker } from "@xyo-network/xl1-protocol-lib";
 var statusPriority = {
   error: 0,
   stopped: 1,
@@ -7324,22 +7386,35 @@ var reduceToMinimumStatus = (statuses) => {
   }
   return minStatus;
 };
-var RuntimeStatusMonitor = class extends LoggerStatusReporter {
+var SimpleSystemStatusRunner = class extends LoggerStatusReporter {
+  moniker = SystemStatusRunnerMoniker;
   globalTransitions = [];
+  progressMap = {};
+  readinessMap = {};
+  reportErrorMap = {};
+  shuttingDown = false;
   transitions = [];
+  updatedAtMap = {};
   getGlobalStatus() {
-    if (Object.keys(this.statusMap).length === 0) return SENTINEL_STATUS;
-    return reduceToMinimumStatus(Object.values(this.statusMap));
+    const statuses = Object.values(this.statusMap);
+    if (statuses.length === 0) return SENTINEL_STATUS;
+    return reduceToMinimumStatus(statuses);
   }
   getStatus(name) {
     return this.statusMap[name];
   }
+  isReady() {
+    if (this.shuttingDown) return false;
+    const entries = Object.values(this.readinessMap);
+    if (entries.length === 0) return false;
+    return entries.every((entry) => entry?.readiness === "ready");
+  }
+  isShuttingDown() {
+    return this.shuttingDown;
+  }
   onGlobalTransition(match, handler) {
     this.globalTransitions.push({ ...match, handler });
   }
-  /**
-   * Register a callback to be called on a specific transition.
-   */
   onTransition(match, handler) {
     this.transitions.push({ ...match, handler });
   }
@@ -7347,12 +7422,45 @@ var RuntimeStatusMonitor = class extends LoggerStatusReporter {
     const previous = this.statusMap[name];
     const previousGlobal = this.getGlobalStatus();
     super.report(name, status, progress);
+    this.updatedAtMap[name] = Date.now();
+    if (progress instanceof Error) {
+      this.reportErrorMap[name] = progress.message;
+    } else if (typeof progress === "number") {
+      this.progressMap[name] = progress;
+    }
     if (previous === status) return;
-    this.runTransitions(this.transitions, previous, status, name);
+    this.runTransitions(this.transitions, previous ?? status, status, name);
     const globalStatus = this.getGlobalStatus();
     if (previousGlobal === globalStatus) return;
     this.runTransitions(this.globalTransitions, previousGlobal, globalStatus);
   }
+  reportReady(name, readiness, error) {
+    const message = error instanceof Error ? error.message : error;
+    this.readinessMap[name] = { readiness, error: message };
+    this.updatedAtMap[name] = Date.now();
+  }
+  setShuttingDown(shuttingDown) {
+    this.shuttingDown = shuttingDown;
+  }
+  snapshot() {
+    const components = Object.entries(this.statusMap).map(([name, lifecycle]) => {
+      const readinessEntry = this.readinessMap[name];
+      return {
+        name,
+        lifecycle,
+        readiness: readinessEntry?.readiness,
+        progress: this.progressMap[name],
+        error: readinessEntry?.error ?? this.reportErrorMap[name],
+        updatedAt: this.updatedAtMap[name] ?? 0
+      };
+    });
+    return {
+      components,
+      globalStatus: this.getGlobalStatus(),
+      isReady: this.isReady(),
+      isShuttingDown: this.shuttingDown
+    };
+  }
   runTransitions(transitions, prev, next, name) {
     for (const {
       from,
@@ -7368,7 +7476,7 @@ var RuntimeStatusMonitor = class extends LoggerStatusReporter {
 };
 
 // src/test/buildRandomChain.ts
-import { asAddress as asAddress2, assertEx as assertEx56 } from "@xylabs/sdk-js";
+import { asAddress as asAddress2, assertEx as assertEx58 } from "@xylabs/sdk-js";
 import {
   Account as Account4,
   asSchema as asSchema9,
@@ -7387,7 +7495,7 @@ import {
 } from "@xyo-network/xl1-protocol-lib";
 
 // src/test/buildBlock.ts
-import { assertEx as assertEx54, isDefined as isDefined23 } from "@xylabs/sdk-js";
+import { assertEx as assertEx56, isDefined as isDefined23 } from "@xylabs/sdk-js";
 import {
   asAnyPayload as asAnyPayload5,
   BoundWitnessBuilder as BoundWitnessBuilder4,
@@ -7470,7 +7578,7 @@ function buildStepHashes(blockNumber, inStepHashes, previousBlockHash, chainStep
         const completedStepReward = calculateCompletedStepReward(i, stepRewardPoolBalance);
         completedStepRewardTransfers.push(createTransferPayload(chainStepRewardAddress2, { [completedStepRewardHolderAddress]: completedStepReward }));
       }
-      step_hashes.push(assertEx54(previousBlockHash, () => `Previous block hash is required for step ${step} at block ${blockNumber}`));
+      step_hashes.push(assertEx56(previousBlockHash, () => `Previous block hash is required for step ${step} at block ${blockNumber}`));
     } else if (isDefined23(inStepHashes.at(i))) {
       step_hashes.push(inStepHashes[i]);
     }
@@ -7524,7 +7632,7 @@ async function buildBlock(options) {
     protocol
   }).meta({ $epoch: Date.now(), $signatures: [] }).signers(signers).payloads(await PayloadBuilder25.addStorageMeta(payloads));
   const [bw, txPayloads] = await builder.build();
-  assertEx54(isBlockBoundWitness(bw), () => "Build of BlockBoundWitness failed");
+  assertEx56(isBlockBoundWitness(bw), () => "Build of BlockBoundWitness failed");
   return [await PayloadBuilder25.addStorageMeta(bw), txPayloads.map((p) => asAnyPayload5(p, true))];
 }
 
@@ -7545,7 +7653,7 @@ async function buildNextBlock(previousBlock, txs, blockPayloads, signers, chainS
 }
 
 // src/test/buildRandomGenesisBlock.ts
-import { asAddress, assertEx as assertEx55 } from "@xylabs/sdk-js";
+import { asAddress, assertEx as assertEx57 } from "@xylabs/sdk-js";
 import {
   Account as Account3,
   asAnyPayload as asAnyPayload6,
@@ -7589,7 +7697,7 @@ var buildRandomTransaction = async (chain, payloads, account, nbf = asXL1BlockNu
 };
 
 // src/test/buildRandomGenesisBlock.ts
-var TestChainId = assertEx55(asAddress("c5fe2e6F6841Cbab12d8C0618Be2DF8C6156cC44"));
+var TestChainId = assertEx57(asAddress("c5fe2e6F6841Cbab12d8C0618Be2DF8C6156cC44"));
 
 // src/test/createGenesisBlock.ts
 import { PayloadBuilder as PayloadBuilder28 } from "@xyo-network/sdk-js";
@@ -7644,7 +7752,7 @@ var createGenesisBlock = async (initialBlockProducer, nextContractAddress, genes
 };
 
 // src/test/buildRandomChain.ts
-var TestGenesisBlockRewardAddress = assertEx56(asAddress2("fa7f0bb865a4bfff3d5e2c726d3e063297014da9"));
+var TestGenesisBlockRewardAddress = assertEx58(asAddress2("fa7f0bb865a4bfff3d5e2c726d3e063297014da9"));
 var buildRandomChain = async (blockProducer, count = 10, previousBlock, chainId, transactionAccount, receiverAddresses) => {
   const chainIdToUse = chainId ?? TestChainId;
   const blocks = [];
@@ -7688,7 +7796,7 @@ var buildRandomChain = async (blockProducer, count = 10, previousBlock, chainId,
         receiverAddress
       ));
     }
-    const previousBlock2 = assertEx56(lastBlock?.[0], () => new Error("No last block"));
+    const previousBlock2 = assertEx58(lastBlock?.[0], () => new Error("No last block"));
     const block = await buildNextBlock(previousBlock2, txs, [], [blockProducer], transactionAccountToUse.address);
     blocks.push(block);
     remaining = remaining - 1;
@@ -7749,13 +7857,13 @@ function getTestProviderContext2(config) {
 }
 
 // src/time/primitives/xl1BlockNumberToEthBlockNumber.ts
-import { assertEx as assertEx57 } from "@xylabs/sdk-js";
+import { assertEx as assertEx59 } from "@xylabs/sdk-js";
 import { asTimePayload as asTimePayload3, TimeSchema as TimeSchema2 } from "@xyo-network/xl1-protocol-lib";
 async function xl1BlockNumberToEthBlockNumber(context, xl1BlockNumber) {
   const blockHash = await hashFromBlockNumber(context, xl1BlockNumber);
   const hydratedBlock = await hydrateBlock(context, blockHash);
   const timePayload = asTimePayload3(hydratedBlock[1].find((p) => p.schema === TimeSchema2), { required: true });
-  return assertEx57(timePayload.ethereum, () => "No ethereum timestamp found on block");
+  return assertEx59(timePayload.ethereum, () => "No ethereum timestamp found on block");
 }
 
 // src/validation/lib/isLocalhost.ts
@@ -7821,6 +7929,7 @@ export {
   ConfigZod,
   ConnectionConfigZod,
   ConnectionsConfigZod,
+  ConsoleSystemStatusPublisher,
   CreatableProviderContextZod,
   DEFAULT_BACKOFF_MS,
   DEFAULT_MAX_ATTEMPTS,
@@ -7871,8 +7980,6 @@ export {
   RpcConnectionConfigZod,
   RpcRemoteConfigBaseZod,
   RpcRemoteConfigZod,
-  RuntimeStatusMonitor,
-  RuntimeStatusMonitorZod,
   S3BucketConfigZod,
   S3ConnectionConfigZod,
   SchemasStepSummarySchema,
@@ -7891,6 +7998,8 @@ export {
   SimpleStakeEventsViewer,
   SimpleStakeTotalsViewer,
   SimpleStakeViewer,
+  SimpleSystemStatusRunner,
+  SimpleSystemStatusViewer,
   SimpleTimeSyncViewer,
   SimpleTransactionValidationViewer,
   SimpleTransactionViewer,
@@ -7902,6 +8011,7 @@ export {
   SimpleXyoPermissions,
   SimpleXyoRunner,
   SimpleXyoSigner,
+  SystemStatusRunnerZod,
   TODO,
   TestGenesisBlockRewardAddress,
   TransactionBuilder,