@xyo-network/xl1-rest-block-viewer 2.0.12

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,115 @@
+[![logo][]](https://xyo.network)
+
+# @xyo-network/xl1-rest-block-viewer
+
+[![npm-badge][]][npm-link]
+[![license-badge][]][license-link]
+
+> A BlockViewer over a statically generated REST file layout — anonymous HTTP reads of immutable chain files, no RPC server required.
+
+## About
+
+Finalized XL1 blocks and completed steps never change, so the whole chain can be published once as static files (e.g. to a public Cloudflare R2 bucket behind a CDN) and read forever with plain HTTP GETs. `RestBlockViewer` implements the full `BlockViewer` interface against that layout:
+
+```text
+/chain/head.json                  ← the one mutable file (current head)
+/block/number/<n>.json            ← block by number
+/block/hash/<hash>.json           ← block by hash
+/blocks/step/<level>/<index>.json ← completed step summary (all blocks in the frame)
+/payload/<hash>.json              ← payload by hash
+```
+
+The path builders in `paths.ts` are the shared contract between the publisher that writes these files and this viewer that reads them. Every file except the head pointer is immutable, so responses are cached aggressively (in-memory LRU here, CDN/edge in front). `blocksByStep` serves completed steps only — the in-flight tail step has no file and returns `[]`.
+
+```ts
+import { RestBlockViewer } from '@xyo-network/xl1-rest-block-viewer'
+
+const viewer = await RestBlockViewer.create({
+  baseUrl: 'https://chain.example.com',
+  headPollIntervalMs: 10_000, // optional: emit headUpdated as the head advances
+})
+await viewer.start()
+const head = await viewer.currentBlock()
+```
+
+Reads are anonymous — no S3 client or credentials. Parsed files are validated with the protocol Zod schemas before being returned.
+
+## Install
+
+Using npm:
+
+```sh
+npm i --save @xyo-network/xl1-rest-block-viewer
+```
+
+Using yarn:
+
+```sh
+yarn add @xyo-network/xl1-rest-block-viewer
+```
+
+Using pnpm:
+
+```sh
+pnpm add @xyo-network/xl1-rest-block-viewer
+```
+
+Using bun:
+
+```sh
+bun add @xyo-network/xl1-rest-block-viewer
+```
+
+## What's Inside
+
+- **`RestBlockViewer`** — full `BlockViewer` implementation: blocks by number/hash, walking reads, `currentBlock` head polling with `headUpdated` events, completed-step `blocksByStep`, payloads by hash, and the rate calculations.
+- **`paths.ts`** — the static layout contract (`headPath`, `blockNumberPath`, `blockHashPath`, `blocksStepPath`, `payloadPath`) shared with the publisher.
+
+## Building Locally
+
+```sh
+xy build @xyo-network/xl1-rest-block-viewer
+xy test @xyo-network/xl1-rest-block-viewer
+xy lint @xyo-network/xl1-rest-block-viewer
+```
+
+## Maintainers
+
+<table>
+  <tr>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/arietrouw">
+        <img src="https://github.com/arietrouw.png" width="80" height="80" alt="Arie Trouw" /><br />
+        <sub><b>Arie Trouw</b></sub>
+      </a>
+      <br />
+      <a href="https://arietrouw.com">arietrouw.com</a>
+    </td>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/jonesmac">
+        <img src="https://github.com/jonesmac.png" width="80" height="80" alt="Matt Jones" /><br />
+        <sub><b>Matt Jones</b></sub>
+      </a>
+    </td>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/JoelBCarter">
+        <img src="https://github.com/JoelBCarter.png" width="80" height="80" alt="Joel Carter" /><br />
+        <sub><b>Joel Carter</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+
+## License
+
+See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
+
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-rest-block-viewer.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-rest-block-viewer
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-rest-block-viewer.svg
+[license-link]: ./LICENSE
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/neutral/RestBlockViewer.d.ts

@@ -0,0 +1,169 @@
+import type { Hash } from '@xylabs/sdk-js';
+import type { Payload, WithHashMeta } from '@xyo-network/sdk-js';
+import { LruCacheMap } from '@xyo-network/xl1-driver-memory';
+import type { BlockRate, BlockViewer, ChainId, SignedHydratedBlockWithHashMeta, SingleTimeConfig, TimeDurations, XL1BlockNumber, XL1BlockRange } from '@xyo-network/xl1-protocol-lib';
+import type { CreatableProviderParams } from '@xyo-network/xl1-protocol-sdk';
+import { AbstractCreatableProvider } from '@xyo-network/xl1-protocol-sdk';
+/** Parameters for RestBlockViewer. */
+export interface RestBlockViewerParams extends CreatableProviderParams {
+    /** Base URL of the static chain layout (e.g. a public R2 bucket or CDN domain). */
+    baseUrl: string;
+    /** Optional fetch override (custom agents, auth headers, tests). Defaults to the global fetch. */
+    fetchFn?: typeof globalThis.fetch;
+    headPollIntervalMs?: number;
+}
+/**
+ * A BlockViewer over a statically generated REST file layout (see `paths.ts`).
+ *
+ * Reads are anonymous HTTP GETs against immutable files, so everything except the head
+ * pointer is cached aggressively. `blocksByStep` serves only completed steps — the
+ * in-flight tail step has no static file and returns [].
+ */
+export declare class RestBlockViewer extends AbstractCreatableProvider<RestBlockViewerParams, BlockViewer['eventData']> implements BlockViewer {
+    static readonly defaultMoniker: "BlockViewer";
+    static readonly dependencies: never[];
+    static readonly monikers: "BlockViewer"[];
+    moniker: "BlockViewer";
+    protected blockByHashCache: LruCacheMap<import("@xylabs/sdk-js").BrandedHash, [{
+        schema: "network.xyo.boundwitness" & {
+            readonly __schema: true;
+        };
+        addresses: ((Lowercase<string> & {
+            readonly __hex: true;
+        } & {
+            readonly __address: true;
+        }) | import("@xyo-network/sdk-js").XyoQuantAddress)[];
+        payload_hashes: import("@xylabs/sdk-js").BrandedHash[];
+        payload_schemas: import("@xyo-network/sdk-js").BrandedSchema<string>[];
+        previous_hashes: (import("@xylabs/sdk-js").BrandedHash | null)[];
+        $signatures: import("@xylabs/sdk-js").BrandedHex[];
+        block: XL1BlockNumber;
+        chain: import("@xylabs/sdk-js").BrandedHex;
+        previous: import("@xylabs/sdk-js").BrandedHash | null;
+        $epoch: number;
+        _hash: import("@xylabs/sdk-js").BrandedHash;
+        _dataHash: import("@xylabs/sdk-js").BrandedHash;
+        $destination?: import("@xyo-network/sdk-js").XyoQuantAddress | (Lowercase<string> & {
+            readonly __hex: true;
+        } & {
+            readonly __address: true;
+        }) | undefined;
+        $sourceQuery?: import("@xylabs/sdk-js").BrandedHash | undefined;
+        protocol?: number | undefined;
+        step_hashes?: import("@xylabs/sdk-js").BrandedHash[] | undefined;
+    }, {
+        [x: string]: unknown;
+        schema: import("@xyo-network/sdk-js").BrandedSchema<string>;
+        _hash: import("@xylabs/sdk-js").BrandedHash;
+        _dataHash: import("@xylabs/sdk-js").BrandedHash;
+    }[]], () => void>;
+    protected blockByNumberCache: LruCacheMap<XL1BlockNumber, [{
+        schema: "network.xyo.boundwitness" & {
+            readonly __schema: true;
+        };
+        addresses: ((Lowercase<string> & {
+            readonly __hex: true;
+        } & {
+            readonly __address: true;
+        }) | import("@xyo-network/sdk-js").XyoQuantAddress)[];
+        payload_hashes: import("@xylabs/sdk-js").BrandedHash[];
+        payload_schemas: import("@xyo-network/sdk-js").BrandedSchema<string>[];
+        previous_hashes: (import("@xylabs/sdk-js").BrandedHash | null)[];
+        $signatures: import("@xylabs/sdk-js").BrandedHex[];
+        block: XL1BlockNumber;
+        chain: import("@xylabs/sdk-js").BrandedHex;
+        previous: import("@xylabs/sdk-js").BrandedHash | null;
+        $epoch: number;
+        _hash: import("@xylabs/sdk-js").BrandedHash;
+        _dataHash: import("@xylabs/sdk-js").BrandedHash;
+        $destination?: import("@xyo-network/sdk-js").XyoQuantAddress | (Lowercase<string> & {
+            readonly __hex: true;
+        } & {
+            readonly __address: true;
+        }) | undefined;
+        $sourceQuery?: import("@xylabs/sdk-js").BrandedHash | undefined;
+        protocol?: number | undefined;
+        step_hashes?: import("@xylabs/sdk-js").BrandedHash[] | undefined;
+    }, {
+        [x: string]: unknown;
+        schema: import("@xyo-network/sdk-js").BrandedSchema<string>;
+        _hash: import("@xylabs/sdk-js").BrandedHash;
+        _dataHash: import("@xylabs/sdk-js").BrandedHash;
+    }[]], () => void>;
+    protected payloadCache: LruCacheMap<import("@xylabs/sdk-js").BrandedHash, WithHashMeta<Payload>, () => void>;
+    protected stepCache: LruCacheMap<string, [{
+        schema: "network.xyo.boundwitness" & {
+            readonly __schema: true;
+        };
+        addresses: ((Lowercase<string> & {
+            readonly __hex: true;
+        } & {
+            readonly __address: true;
+        }) | import("@xyo-network/sdk-js").XyoQuantAddress)[];
+        payload_hashes: import("@xylabs/sdk-js").BrandedHash[];
+        payload_schemas: import("@xyo-network/sdk-js").BrandedSchema<string>[];
+        previous_hashes: (import("@xylabs/sdk-js").BrandedHash | null)[];
+        $signatures: import("@xylabs/sdk-js").BrandedHex[];
+        block: XL1BlockNumber;
+        chain: import("@xylabs/sdk-js").BrandedHex;
+        previous: import("@xylabs/sdk-js").BrandedHash | null;
+        $epoch: number;
+        _hash: import("@xylabs/sdk-js").BrandedHash;
+        _dataHash: import("@xylabs/sdk-js").BrandedHash;
+        $destination?: import("@xyo-network/sdk-js").XyoQuantAddress | (Lowercase<string> & {
+            readonly __hex: true;
+        } & {
+            readonly __address: true;
+        }) | undefined;
+        $sourceQuery?: import("@xylabs/sdk-js").BrandedHash | undefined;
+        protocol?: number | undefined;
+        step_hashes?: import("@xylabs/sdk-js").BrandedHash[] | undefined;
+    }, {
+        [x: string]: unknown;
+        schema: import("@xyo-network/sdk-js").BrandedSchema<string>;
+        _hash: import("@xylabs/sdk-js").BrandedHash;
+        _dataHash: import("@xylabs/sdk-js").BrandedHash;
+    }[]][], () => void>;
+    private _headPollHash?;
+    private _headPollInProgress;
+    private _headPollTimer;
+    get baseUrl(): string;
+    protected get fetchFn(): typeof globalThis.fetch;
+    protected get headPollIntervalMs(): number | undefined;
+    static paramsHandler(params: Partial<RestBlockViewerParams>): Promise<{
+        baseUrl: string;
+        fetchFn: typeof fetch | undefined;
+        headPollIntervalMs: number | undefined;
+        context: import("@xyo-network/xl1-protocol-sdk").CreatableProviderContextType;
+        name?: import("@xylabs/sdk-js").CreatableName;
+        statusReporter?: import("@xylabs/sdk-js").CreatableStatusReporter<void> | undefined;
+        logger?: import("@xylabs/sdk-js").Logger;
+        meterProvider?: import("@opentelemetry/api").MeterProvider;
+        traceProvider?: import("@opentelemetry/api").TracerProvider;
+    }>;
+    blockByHash(hash: Hash): Promise<SignedHydratedBlockWithHashMeta | null>;
+    blockByNumber(blockNumber: XL1BlockNumber): Promise<SignedHydratedBlockWithHashMeta | null>;
+    blocksByHash(hash: Hash, limit?: number): Promise<SignedHydratedBlockWithHashMeta[]>;
+    blocksByNumber(blockNumber: XL1BlockNumber, limit?: number): Promise<SignedHydratedBlockWithHashMeta[]>;
+    blocksByStep(stepLevel: number, stepIndex: number): Promise<SignedHydratedBlockWithHashMeta[]>;
+    chainId(): Promise<ChainId>;
+    chainId(blockNumber: XL1BlockNumber): Promise<ChainId>;
+    chainId(blockNumber: 'latest'): Promise<ChainId>;
+    currentBlock(): Promise<SignedHydratedBlockWithHashMeta>;
+    currentBlockHash(): Promise<Hash>;
+    currentBlockNumber(): Promise<XL1BlockNumber>;
+    payloadByHash(hash: Hash): Promise<WithHashMeta<Payload> | null>;
+    payloadsByHash(hashes: Hash[]): Promise<WithHashMeta<Payload>[]>;
+    rate(range: XL1BlockRange, timeUnit?: keyof TimeDurations): Promise<BlockRate>;
+    stepSizeRate(start: XL1BlockNumber, stepIndex: number, count?: number, timeUnit?: keyof TimeDurations): Promise<BlockRate>;
+    timeDurationRate(timeConfig: SingleTimeConfig, startBlockNumber?: XL1BlockNumber, timeUnit?: keyof TimeDurations, toleranceMs?: number, maxAttempts?: number): Promise<BlockRate>;
+    protected startHandler(): Promise<void>;
+    protected stopHandler(): Promise<void>;
+    /** Validates a parsed block file and populates both block caches. */
+    private cacheBlock;
+    private fetchJson;
+    private pollHead;
+    private startHeadPolling;
+    private stopHeadPolling;
+}
+//# sourceMappingURL=RestBlockViewer.d.ts.map

package/dist/neutral/RestBlockViewer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestBlockViewer.d.ts","sourceRoot":"","sources":["../../src/RestBlockViewer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAA;AAC5D,OAAO,KAAK,EACV,SAAS,EAAE,WAAW,EAAE,OAAO,EAC/B,+BAA+B,EAAE,gBAAgB,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAChG,MAAM,+BAA+B,CAAA;AAItC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AAC5E,OAAO,EACL,yBAAyB,EAC1B,MAAM,+BAA+B,CAAA;AAMtC,sCAAsC;AACtC,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE,mFAAmF;IACnF,OAAO,EAAE,MAAM,CAAA;IACf,kGAAkG;IAClG,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAMD;;;;;;GAMG;AACH,qBACa,eAAgB,SAAQ,yBAAyB,CAAC,qBAAqB,EAAE,WAAW,CAAC,WAAW,CAAC,CAAE,YAAW,WAAW;IACpI,MAAM,CAAC,QAAQ,CAAC,cAAc,gBAAqB;IACnD,MAAM,CAAC,QAAQ,CAAC,YAAY,UAAK;IACjC,MAAM,CAAC,QAAQ,CAAC,QAAQ,kBAAuB;IAC/C,OAAO,gBAAiC;IAExC,SAAS,CAAC,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAAwE;IAClG,SAAS,CAAC,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAAkF;IAC9G,SAAS,CAAC,YAAY,uFAAgE;IACtF,SAAS,CAAC,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAAyE;IAE5F,OAAO,CAAC,aAAa,CAAC,CAAM;IAC5B,OAAO,CAAC,mBAAmB,CAAQ;IACnC,OAAO,CAAC,cAAc,CAA8C;IAEpE,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,SAAS,KAAK,OAAO,IAAI,OAAO,UAAU,CAAC,KAAK,CAE/C;IAED,SAAS,KAAK,kBAAkB,uBAE/B;WAEqB,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,qBAAqB,CAAC;;;;;;;;;;;IAapE,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,+BAA+B,GAAG,IAAI,CAAC;IASxE,aAAa,CAAC,WAAW,EAAE,cAAc,GAAG,OAAO,CAAC,+BAA+B,GAAG,IAAI,CAAC;IAS3F,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,SAAK,GAAG,OAAO,CAAC,+BAA+B,EAAE,CAAC;IAgBhF,cAAc,CAAC,WAAW,EAAE,cAAc,EAAE,KAAK,SAAK,GAAG,OAAO,CAAC,+BAA+B,EAAE,CAAC;IAenG,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,+BAA+B,EAAE,CAAC;IAsBpG,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAC3B,OAAO,CAAC,WAAW,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IACtD,OAAO,CAAC,WAAW,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1C,YAAY,IAAI,OAAO,CAAC,+BAA+B,CAAC;IAOxD,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIjC,kBAAkB,IAAI,OAAO,CAAC,cAAc,CAAC;IAI7C,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAKhE,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;IAehE,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC;IAI9E,YAAY,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,SAAI,EAAE,QAAQ,CAAC,EAAE,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC;IAIrH,gBAAgB,CACpB,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,cAAc,EACjC,QAAQ,CAAC,EAAE,MAAM,aAAa,EAC9B,WAAW,CAAC,EAAE,MAAM,EACpB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,SAAS,CAAC;cAII,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;cAO7B,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrD,qEAAqE;IACrE,OAAO,CAAC,UAAU;YAOJ,SAAS;YAOT,QAAQ;IAuBtB,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,eAAe;CAMxB"}

package/dist/neutral/index.d.ts

@@ -0,0 +1,3 @@
+export * from './paths.ts';
+export * from './RestBlockViewer.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,sBAAsB,CAAA"}

package/dist/neutral/index.mjs

@@ -0,0 +1,254 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/paths.ts
+var headPath = () => "chain/head.json";
+var blockNumberPath = (block) => `block/number/${block}.json`;
+var blockHashPath = (hash) => `block/hash/${hash}.json`;
+var blocksStepPath = (stepLevel, stepIndex) => `blocks/step/${stepLevel}/${stepIndex}.json`;
+var payloadPath = (hash) => `payload/${hash}.json`;
+
+// src/RestBlockViewer.ts
+import { assertEx, exists } from "@xylabs/sdk-js";
+import { PayloadZodLoose, WithHashMetaZod } from "@xyo-network/sdk-js";
+import { LruCacheMap } from "@xyo-network/xl1-driver-memory";
+import {
+  asSignedHydratedBlockWithHashMeta,
+  asXL1BlockNumber,
+  BlockViewerMoniker,
+  stepSize
+} from "@xyo-network/xl1-protocol-lib";
+import {
+  AbstractCreatableProvider,
+  asBlocksStepSummary,
+  blocksMaxStep,
+  calculateBlockRate,
+  calculateStepSizeRate,
+  calculateTimeRate,
+  creatableProvider
+} from "@xyo-network/xl1-protocol-sdk";
+var MIN_HEAD_POLL_INTERVAL_MS = 5e3;
+var PayloadFileZod = WithHashMetaZod(PayloadZodLoose);
+var RestBlockViewer = class extends AbstractCreatableProvider {
+  moniker = RestBlockViewer.defaultMoniker;
+  blockByHashCache = new LruCacheMap({ max: 2e3 });
+  blockByNumberCache = new LruCacheMap({ max: 2e3 });
+  payloadCache = new LruCacheMap({ max: 1e4 });
+  stepCache = new LruCacheMap({ max: 4 });
+  _headPollHash;
+  _headPollInProgress = false;
+  _headPollTimer = null;
+  get baseUrl() {
+    return this.params.baseUrl;
+  }
+  get fetchFn() {
+    return this.params.fetchFn ?? globalThis.fetch.bind(globalThis);
+  }
+  get headPollIntervalMs() {
+    return this.params.headPollIntervalMs;
+  }
+  static async paramsHandler(params) {
+    const headPollIntervalMs = params.headPollIntervalMs;
+    if (headPollIntervalMs !== void 0) {
+      assertEx(headPollIntervalMs >= MIN_HEAD_POLL_INTERVAL_MS, () => `headPollIntervalMs must be at least ${MIN_HEAD_POLL_INTERVAL_MS}ms`);
+    }
+    return {
+      ...await super.paramsHandler(params),
+      baseUrl: assertEx(params.baseUrl, () => "baseUrl is required").replace(/\/+$/, ""),
+      fetchFn: params.fetchFn,
+      headPollIntervalMs
+    };
+  }
+  async blockByHash(hash) {
+    return await this.spanAsync("blockByHash", async () => {
+      const cached = this.blockByHashCache.get(hash);
+      if (cached) return cached;
+      const parsed = await this.fetchJson(blockHashPath(hash));
+      return parsed === void 0 ? null : this.cacheBlock(parsed);
+    }, { ...this.context, timeBudgetLimit: 100 });
+  }
+  async blockByNumber(blockNumber) {
+    return await this.spanAsync("blockByNumber", async () => {
+      const cached = this.blockByNumberCache.get(blockNumber);
+      if (cached) return cached;
+      const parsed = await this.fetchJson(blockNumberPath(blockNumber));
+      return parsed === void 0 ? null : this.cacheBlock(parsed);
+    }, { ...this.context, timeBudgetLimit: 100 });
+  }
+  async blocksByHash(hash, limit = 50) {
+    return await this.spanAsync("blocksByHash", async () => {
+      assertEx(limit > 0, () => "limit must be greater than 0");
+      assertEx(limit <= 100, () => "limit must be less than 100");
+      const blocks = [];
+      let current = await this.blockByHash(hash);
+      while (current && blocks.length < limit) {
+        blocks.push(current);
+        const previousHash = current[0].previous;
+        if (previousHash === null) break;
+        current = await this.blockByHash(previousHash);
+      }
+      return blocks;
+    }, { ...this.context, timeBudgetLimit: 300 });
+  }
+  async blocksByNumber(blockNumber, limit = 50) {
+    return await this.spanAsync("blocksByNumber", async () => {
+      assertEx(limit > 0, () => "limit must be greater than 0");
+      assertEx(limit <= 100, () => "limit must be less than 100");
+      const blocks = [];
+      let current = await this.blockByNumber(blockNumber);
+      while (current && blocks.length < limit) {
+        blocks.push(current);
+        if (current[0].block === 0) break;
+        current = await this.blockByNumber(asXL1BlockNumber(current[0].block - 1, true));
+      }
+      return blocks;
+    }, this.context);
+  }
+  async blocksByStep(stepLevel, stepIndex) {
+    return await this.spanAsync("blocksByStep", async () => {
+      assertEx(Number.isInteger(stepIndex) && stepIndex >= 0, () => "stepIndex must be a non-negative integer");
+      stepSize(stepLevel);
+      assertEx(
+        stepLevel <= blocksMaxStep,
+        () => `blocksByStep does not support step levels above ${blocksMaxStep} (requested ${stepLevel})`
+      );
+      const cacheKey = `${stepLevel}|${stepIndex}`;
+      const cached = this.stepCache.get(cacheKey);
+      if (cached) return cached;
+      const parsed = await this.fetchJson(blocksStepPath(stepLevel, stepIndex));
+      if (parsed === void 0) return [];
+      const summary = asBlocksStepSummary(parsed, { required: true });
+      const blocks = summary.blocks.map((b) => asSignedHydratedBlockWithHashMeta(b, true)).toReversed();
+      this.stepCache.set(cacheKey, blocks);
+      return blocks;
+    }, this.context);
+  }
+  async chainId(blockNumber = "latest") {
+    return await this.spanAsync("chainId", async () => {
+      return blockNumber === "latest" ? (await this.currentBlock())[0].chain : assertEx(await this.blockByNumber(blockNumber), () => `Block not found [${blockNumber}]`)[0].chain;
+    }, this.context);
+  }
+  async currentBlock() {
+    return await this.spanAsync("currentBlock", async () => {
+      const parsed = assertEx(await this.fetchJson(headPath()), () => "Head not found");
+      return this.cacheBlock(parsed);
+    }, this.context);
+  }
+  async currentBlockHash() {
+    return (await this.currentBlock())[0]._hash;
+  }
+  async currentBlockNumber() {
+    return (await this.currentBlock())[0].block;
+  }
+  async payloadByHash(hash) {
+    const [payload] = await this.payloadsByHash([hash]);
+    return payload ?? null;
+  }
+  async payloadsByHash(hashes) {
+    return await this.spanAsync("payloadsByHash", async () => {
+      const results = await Promise.all(hashes.map(async (hash) => {
+        const cached = this.payloadCache.get(hash);
+        if (cached) return cached;
+        const parsed = await this.fetchJson(payloadPath(hash));
+        if (parsed === void 0) return;
+        const payload = PayloadFileZod.parse(parsed);
+        this.payloadCache.set(hash, payload);
+        return payload;
+      }));
+      return results.filter(exists);
+    }, this.context);
+  }
+  async rate(range, timeUnit) {
+    return await calculateBlockRate(this, range, timeUnit);
+  }
+  async stepSizeRate(start, stepIndex, count = 1, timeUnit) {
+    return await calculateStepSizeRate(this, start, stepIndex, count, timeUnit);
+  }
+  async timeDurationRate(timeConfig, startBlockNumber, timeUnit, toleranceMs, maxAttempts) {
+    return await calculateTimeRate(this, timeConfig, startBlockNumber, timeUnit, toleranceMs, maxAttempts);
+  }
+  async startHandler() {
+    await super.startHandler();
+    if (this.headPollIntervalMs === void 0) return;
+    await this.pollHead(false);
+    this.startHeadPolling();
+  }
+  async stopHandler() {
+    this.stopHeadPolling();
+    this._headPollHash = void 0;
+    await super.stopHandler();
+  }
+  /** Validates a parsed block file and populates both block caches. */
+  cacheBlock(parsed) {
+    const block = asSignedHydratedBlockWithHashMeta(parsed, true);
+    this.blockByHashCache.set(block[0]._hash, block);
+    this.blockByNumberCache.set(block[0].block, block);
+    return block;
+  }
+  async fetchJson(path) {
+    const response = await this.fetchFn(`${this.baseUrl}/${path}`);
+    if (response.status === 404) return void 0;
+    assertEx(response.ok, () => `Request failed [${response.status}] for ${path}`);
+    return await response.json();
+  }
+  async pollHead(emitOnChange) {
+    if (this._headPollInProgress) return;
+    this._headPollInProgress = true;
+    try {
+      const block = await this.currentBlock();
+      const hash = block[0]._hash;
+      if (this._headPollHash === void 0) {
+        this._headPollHash = hash;
+        return;
+      }
+      if (hash !== this._headPollHash) {
+        this._headPollHash = hash;
+        if (emitOnChange) {
+          await this.emit("headUpdated", { block });
+        }
+      }
+    } catch (ex) {
+      this.logger?.error("Error polling block head", ex);
+    } finally {
+      this._headPollInProgress = false;
+    }
+  }
+  startHeadPolling() {
+    if (this.headPollIntervalMs === void 0) return;
+    this.stopHeadPolling();
+    this._headPollTimer = setInterval(() => {
+      void this.pollHead(true);
+    }, this.headPollIntervalMs);
+  }
+  stopHeadPolling() {
+    if (this._headPollTimer) {
+      clearInterval(this._headPollTimer);
+      this._headPollTimer = null;
+    }
+  }
+};
+__publicField(RestBlockViewer, "defaultMoniker", BlockViewerMoniker);
+__publicField(RestBlockViewer, "dependencies", []);
+__publicField(RestBlockViewer, "monikers", [BlockViewerMoniker]);
+RestBlockViewer = __decorateClass([
+  creatableProvider()
+], RestBlockViewer);
+export {
+  RestBlockViewer,
+  blockHashPath,
+  blockNumberPath,
+  blocksStepPath,
+  headPath,
+  payloadPath
+};
+//# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/paths.ts", "../../src/RestBlockViewer.ts"],
+  "sourcesContent": ["import type { Hash } from '@xylabs/sdk-js'\n\n/**\n * Path contract for the static REST chain layout.\n *\n * These builders are the single source of truth for where files live, shared by the\n * publisher (which writes the static files) and `RestBlockViewer` (which reads them),\n * so the layout cannot drift between the two. Paths are relative \u2014 no leading slash \u2014\n * and joined to a base URL by the consumer.\n *\n * Every file except the head pointer is immutable once written:\n * - block and payload files never change after finalization\n * - step files are only written for completed steps\n * - the head pointer is rewritten as the chain advances and must not be cached long-term\n */\n\n/** The mutable head pointer: the current head SignedHydratedBlockWithHashMeta. */\nexport const headPath = (): string => 'chain/head.json'\n\n/** A block by number: SignedHydratedBlockWithHashMeta. */\nexport const blockNumberPath = (block: number): string => `block/number/${block}.json`\n\n/** A block by hash: the same content as its by-number twin. */\nexport const blockHashPath = (hash: Hash): string => `block/hash/${hash}.json`\n\n/**\n * A completed step's blocks: a BlocksStepSummary payload whose `blocks` array is ordered\n * oldest-first. Only complete steps are published; the in-flight tail step has no file.\n */\nexport const blocksStepPath = (stepLevel: number, stepIndex: number): string => `blocks/step/${stepLevel}/${stepIndex}.json`\n\n/** A payload by hash: WithHashMeta<Payload>. */\nexport const payloadPath = (hash: Hash): string => `payload/${hash}.json`\n", "import type { Hash } from '@xylabs/sdk-js'\nimport { assertEx, exists } from '@xylabs/sdk-js'\nimport type { Payload, WithHashMeta } from '@xyo-network/sdk-js'\nimport { PayloadZodLoose, WithHashMetaZod } from '@xyo-network/sdk-js'\nimport { LruCacheMap } from '@xyo-network/xl1-driver-memory'\nimport type {\n  BlockRate, BlockViewer, ChainId,\n  SignedHydratedBlockWithHashMeta, SingleTimeConfig, TimeDurations, XL1BlockNumber, XL1BlockRange,\n} from '@xyo-network/xl1-protocol-lib'\nimport {\n  asSignedHydratedBlockWithHashMeta, asXL1BlockNumber, BlockViewerMoniker, stepSize,\n} from '@xyo-network/xl1-protocol-lib'\nimport type { CreatableProviderParams } from '@xyo-network/xl1-protocol-sdk'\nimport {\n  AbstractCreatableProvider, asBlocksStepSummary, blocksMaxStep, calculateBlockRate, calculateStepSizeRate, calculateTimeRate, creatableProvider,\n} from '@xyo-network/xl1-protocol-sdk'\n\nimport {\n  blockHashPath, blockNumberPath, blocksStepPath, headPath, payloadPath,\n} from './paths.ts'\n\n/** Parameters for RestBlockViewer. */\nexport interface RestBlockViewerParams extends CreatableProviderParams {\n  /** Base URL of the static chain layout (e.g. a public R2 bucket or CDN domain). */\n  baseUrl: string\n  /** Optional fetch override (custom agents, auth headers, tests). Defaults to the global fetch. */\n  fetchFn?: typeof globalThis.fetch\n  headPollIntervalMs?: number\n}\n\nconst MIN_HEAD_POLL_INTERVAL_MS = 5000\n\nconst PayloadFileZod = WithHashMetaZod(PayloadZodLoose)\n\n/**\n * A BlockViewer over a statically generated REST file layout (see `paths.ts`).\n *\n * Reads are anonymous HTTP GETs against immutable files, so everything except the head\n * pointer is cached aggressively. `blocksByStep` serves only completed steps \u2014 the\n * in-flight tail step has no static file and returns [].\n */\n@creatableProvider()\nexport class RestBlockViewer extends AbstractCreatableProvider<RestBlockViewerParams, BlockViewer['eventData']> implements BlockViewer {\n  static readonly defaultMoniker = BlockViewerMoniker\n  static readonly dependencies = []\n  static readonly monikers = [BlockViewerMoniker]\n  moniker = RestBlockViewer.defaultMoniker\n\n  protected blockByHashCache = new LruCacheMap<Hash, SignedHydratedBlockWithHashMeta>({ max: 2000 })\n  protected blockByNumberCache = new LruCacheMap<XL1BlockNumber, SignedHydratedBlockWithHashMeta>({ max: 2000 })\n  protected payloadCache = new LruCacheMap<Hash, WithHashMeta<Payload>>({ max: 10_000 })\n  protected stepCache = new LruCacheMap<string, SignedHydratedBlockWithHashMeta[]>({ max: 4 })\n\n  private _headPollHash?: Hash\n  private _headPollInProgress = false\n  private _headPollTimer: ReturnType<typeof setInterval> | null = null\n\n  get baseUrl(): string {\n    return this.params.baseUrl\n  }\n\n  protected get fetchFn(): typeof globalThis.fetch {\n    return this.params.fetchFn ?? globalThis.fetch.bind(globalThis)\n  }\n\n  protected get headPollIntervalMs() {\n    return this.params.headPollIntervalMs\n  }\n\n  static override async paramsHandler(params: Partial<RestBlockViewerParams>) {\n    const headPollIntervalMs = params.headPollIntervalMs\n    if (headPollIntervalMs !== undefined) {\n      assertEx(headPollIntervalMs >= MIN_HEAD_POLL_INTERVAL_MS, () => `headPollIntervalMs must be at least ${MIN_HEAD_POLL_INTERVAL_MS}ms`)\n    }\n    return {\n      ...await super.paramsHandler(params),\n      baseUrl: assertEx(params.baseUrl, () => 'baseUrl is required').replace(/\\/+$/, ''),\n      fetchFn: params.fetchFn,\n      headPollIntervalMs,\n    } satisfies RestBlockViewerParams\n  }\n\n  async blockByHash(hash: Hash): Promise<SignedHydratedBlockWithHashMeta | null> {\n    return await this.spanAsync('blockByHash', async () => {\n      const cached = this.blockByHashCache.get(hash)\n      if (cached) return cached\n      const parsed = await this.fetchJson(blockHashPath(hash))\n      return parsed === undefined ? null : this.cacheBlock(parsed)\n    }, { ...this.context, timeBudgetLimit: 100 })\n  }\n\n  async blockByNumber(blockNumber: XL1BlockNumber): Promise<SignedHydratedBlockWithHashMeta | null> {\n    return await this.spanAsync('blockByNumber', async () => {\n      const cached = this.blockByNumberCache.get(blockNumber)\n      if (cached) return cached\n      const parsed = await this.fetchJson(blockNumberPath(blockNumber))\n      return parsed === undefined ? null : this.cacheBlock(parsed)\n    }, { ...this.context, timeBudgetLimit: 100 })\n  }\n\n  async blocksByHash(hash: Hash, limit = 50): Promise<SignedHydratedBlockWithHashMeta[]> {\n    return await this.spanAsync('blocksByHash', async () => {\n      assertEx(limit > 0, () => 'limit must be greater than 0')\n      assertEx(limit <= 100, () => 'limit must be less than 100')\n      const blocks: SignedHydratedBlockWithHashMeta[] = []\n      let current = await this.blockByHash(hash)\n      while (current && blocks.length < limit) {\n        blocks.push(current)\n        const previousHash = current[0].previous\n        if (previousHash === null) break\n        current = await this.blockByHash(previousHash)\n      }\n      return blocks\n    }, { ...this.context, timeBudgetLimit: 300 })\n  }\n\n  async blocksByNumber(blockNumber: XL1BlockNumber, limit = 50): Promise<SignedHydratedBlockWithHashMeta[]> {\n    return await this.spanAsync('blocksByNumber', async () => {\n      assertEx(limit > 0, () => 'limit must be greater than 0')\n      assertEx(limit <= 100, () => 'limit must be less than 100')\n      const blocks: SignedHydratedBlockWithHashMeta[] = []\n      let current = await this.blockByNumber(blockNumber)\n      while (current && blocks.length < limit) {\n        blocks.push(current)\n        if (current[0].block === 0) break\n        current = await this.blockByNumber(asXL1BlockNumber(current[0].block - 1, true))\n      }\n      return blocks\n    }, this.context)\n  }\n\n  async blocksByStep(stepLevel: number, stepIndex: number): Promise<SignedHydratedBlockWithHashMeta[]> {\n    return await this.spanAsync('blocksByStep', async () => {\n      assertEx(Number.isInteger(stepIndex) && stepIndex >= 0, () => 'stepIndex must be a non-negative integer')\n      stepSize(stepLevel) // validates the level against StepSizes\n      assertEx(\n        stepLevel <= blocksMaxStep,\n        () => `blocksByStep does not support step levels above ${blocksMaxStep} (requested ${stepLevel})`,\n      )\n      const cacheKey = `${stepLevel}|${stepIndex}`\n      const cached = this.stepCache.get(cacheKey)\n      if (cached) return cached\n      const parsed = await this.fetchJson(blocksStepPath(stepLevel, stepIndex))\n      // Only completed steps are published; the in-flight tail step has no file\n      if (parsed === undefined) return []\n      const summary = asBlocksStepSummary(parsed, { required: true })\n      // Step files store blocks oldest-first; the viewer interface returns newest-first\n      const blocks = summary.blocks.map(b => asSignedHydratedBlockWithHashMeta(b, true)).toReversed()\n      this.stepCache.set(cacheKey, blocks)\n      return blocks\n    }, this.context)\n  }\n\n  chainId(): Promise<ChainId>\n  chainId(blockNumber: XL1BlockNumber): Promise<ChainId>\n  chainId(blockNumber: 'latest'): Promise<ChainId>\n  async chainId(blockNumber: XL1BlockNumber | 'latest' = 'latest'): Promise<ChainId> {\n    return await this.spanAsync('chainId', async () => {\n      return blockNumber === 'latest'\n        ? (await this.currentBlock())[0].chain\n        : assertEx(await this.blockByNumber(blockNumber), () => `Block not found [${blockNumber}]`)[0].chain\n    }, this.context)\n  }\n\n  async currentBlock(): Promise<SignedHydratedBlockWithHashMeta> {\n    return await this.spanAsync('currentBlock', async () => {\n      const parsed = assertEx(await this.fetchJson(headPath()), () => 'Head not found')\n      return this.cacheBlock(parsed)\n    }, this.context)\n  }\n\n  async currentBlockHash(): Promise<Hash> {\n    return (await this.currentBlock())[0]._hash\n  }\n\n  async currentBlockNumber(): Promise<XL1BlockNumber> {\n    return (await this.currentBlock())[0].block\n  }\n\n  async payloadByHash(hash: Hash): Promise<WithHashMeta<Payload> | null> {\n    const [payload] = await this.payloadsByHash([hash])\n    return payload ?? null\n  }\n\n  async payloadsByHash(hashes: Hash[]): Promise<WithHashMeta<Payload>[]> {\n    return await this.spanAsync('payloadsByHash', async () => {\n      const results = await Promise.all(hashes.map(async (hash) => {\n        const cached = this.payloadCache.get(hash)\n        if (cached) return cached\n        const parsed = await this.fetchJson(payloadPath(hash))\n        if (parsed === undefined) return\n        const payload = PayloadFileZod.parse(parsed)\n        this.payloadCache.set(hash, payload)\n        return payload\n      }))\n      return results.filter(exists)\n    }, this.context)\n  }\n\n  async rate(range: XL1BlockRange, timeUnit?: keyof TimeDurations): Promise<BlockRate> {\n    return await calculateBlockRate(this, range, timeUnit)\n  }\n\n  async stepSizeRate(start: XL1BlockNumber, stepIndex: number, count = 1, timeUnit?: keyof TimeDurations): Promise<BlockRate> {\n    return await calculateStepSizeRate(this, start, stepIndex, count, timeUnit)\n  }\n\n  async timeDurationRate(\n    timeConfig: SingleTimeConfig,\n    startBlockNumber?: XL1BlockNumber,\n    timeUnit?: keyof TimeDurations,\n    toleranceMs?: number,\n    maxAttempts?: number,\n  ): Promise<BlockRate> {\n    return await calculateTimeRate(this, timeConfig, startBlockNumber, timeUnit, toleranceMs, maxAttempts)\n  }\n\n  protected override async startHandler(): Promise<void> {\n    await super.startHandler()\n    if (this.headPollIntervalMs === undefined) return\n    await this.pollHead(false)\n    this.startHeadPolling()\n  }\n\n  protected override async stopHandler(): Promise<void> {\n    this.stopHeadPolling()\n    this._headPollHash = undefined\n    await super.stopHandler()\n  }\n\n  /** Validates a parsed block file and populates both block caches. */\n  private cacheBlock(parsed: unknown): SignedHydratedBlockWithHashMeta {\n    const block = asSignedHydratedBlockWithHashMeta(parsed, true)\n    this.blockByHashCache.set(block[0]._hash, block)\n    this.blockByNumberCache.set(block[0].block, block)\n    return block\n  }\n\n  private async fetchJson(path: string): Promise<unknown> {\n    const response = await this.fetchFn(`${this.baseUrl}/${path}`)\n    if (response.status === 404) return undefined\n    assertEx(response.ok, () => `Request failed [${response.status}] for ${path}`)\n    return await response.json()\n  }\n\n  private async pollHead(emitOnChange: boolean): Promise<void> {\n    if (this._headPollInProgress) return\n    this._headPollInProgress = true\n    try {\n      const block = await this.currentBlock()\n      const hash = block[0]._hash\n      if (this._headPollHash === undefined) {\n        this._headPollHash = hash\n        return\n      }\n      if (hash !== this._headPollHash) {\n        this._headPollHash = hash\n        if (emitOnChange) {\n          await this.emit('headUpdated', { block })\n        }\n      }\n    } catch (ex) {\n      this.logger?.error('Error polling block head', ex)\n    } finally {\n      this._headPollInProgress = false\n    }\n  }\n\n  private startHeadPolling() {\n    if (this.headPollIntervalMs === undefined) return\n    this.stopHeadPolling()\n    this._headPollTimer = setInterval(() => {\n      void this.pollHead(true)\n    }, this.headPollIntervalMs)\n  }\n\n  private stopHeadPolling() {\n    if (this._headPollTimer) {\n      clearInterval(this._headPollTimer)\n      this._headPollTimer = null\n    }\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;AAiBO,IAAM,WAAW,MAAc;AAG/B,IAAM,kBAAkB,CAAC,UAA0B,gBAAgB,KAAK;AAGxE,IAAM,gBAAgB,CAAC,SAAuB,cAAc,IAAI;AAMhE,IAAM,iBAAiB,CAAC,WAAmB,cAA8B,eAAe,SAAS,IAAI,SAAS;AAG9G,IAAM,cAAc,CAAC,SAAuB,WAAW,IAAI;;;AC/BlE,SAAS,UAAU,cAAc;AAEjC,SAAS,iBAAiB,uBAAuB;AACjD,SAAS,mBAAmB;AAK5B;AAAA,EACE;AAAA,EAAmC;AAAA,EAAkB;AAAA,EAAoB;AAAA,OACpE;AAEP;AAAA,EACE;AAAA,EAA2B;AAAA,EAAqB;AAAA,EAAe;AAAA,EAAoB;AAAA,EAAuB;AAAA,EAAmB;AAAA,OACxH;AAeP,IAAM,4BAA4B;AAElC,IAAM,iBAAiB,gBAAgB,eAAe;AAU/C,IAAM,kBAAN,cAA8B,0BAAkG;AAAA,EAIrI,UAAU,gBAAgB;AAAA,EAEhB,mBAAmB,IAAI,YAAmD,EAAE,KAAK,IAAK,CAAC;AAAA,EACvF,qBAAqB,IAAI,YAA6D,EAAE,KAAK,IAAK,CAAC;AAAA,EACnG,eAAe,IAAI,YAAyC,EAAE,KAAK,IAAO,CAAC;AAAA,EAC3E,YAAY,IAAI,YAAuD,EAAE,KAAK,EAAE,CAAC;AAAA,EAEnF;AAAA,EACA,sBAAsB;AAAA,EACtB,iBAAwD;AAAA,EAEhE,IAAI,UAAkB;AACpB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAc,UAAmC;AAC/C,WAAO,KAAK,OAAO,WAAW,WAAW,MAAM,KAAK,UAAU;AAAA,EAChE;AAAA,EAEA,IAAc,qBAAqB;AACjC,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,aAAsB,cAAc,QAAwC;AAC1E,UAAM,qBAAqB,OAAO;AAClC,QAAI,uBAAuB,QAAW;AACpC,eAAS,sBAAsB,2BAA2B,MAAM,uCAAuC,yBAAyB,IAAI;AAAA,IACtI;AACA,WAAO;AAAA,MACL,GAAG,MAAM,MAAM,cAAc,MAAM;AAAA,MACnC,SAAS,SAAS,OAAO,SAAS,MAAM,qBAAqB,EAAE,QAAQ,QAAQ,EAAE;AAAA,MACjF,SAAS,OAAO;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,YAAY,MAA6D;AAC7E,WAAO,MAAM,KAAK,UAAU,eAAe,YAAY;AACrD,YAAM,SAAS,KAAK,iBAAiB,IAAI,IAAI;AAC7C,UAAI,OAAQ,QAAO;AACnB,YAAM,SAAS,MAAM,KAAK,UAAU,cAAc,IAAI,CAAC;AACvD,aAAO,WAAW,SAAY,OAAO,KAAK,WAAW,MAAM;AAAA,IAC7D,GAAG,EAAE,GAAG,KAAK,SAAS,iBAAiB,IAAI,CAAC;AAAA,EAC9C;AAAA,EAEA,MAAM,cAAc,aAA8E;AAChG,WAAO,MAAM,KAAK,UAAU,iBAAiB,YAAY;AACvD,YAAM,SAAS,KAAK,mBAAmB,IAAI,WAAW;AACtD,UAAI,OAAQ,QAAO;AACnB,YAAM,SAAS,MAAM,KAAK,UAAU,gBAAgB,WAAW,CAAC;AAChE,aAAO,WAAW,SAAY,OAAO,KAAK,WAAW,MAAM;AAAA,IAC7D,GAAG,EAAE,GAAG,KAAK,SAAS,iBAAiB,IAAI,CAAC;AAAA,EAC9C;AAAA,EAEA,MAAM,aAAa,MAAY,QAAQ,IAAgD;AACrF,WAAO,MAAM,KAAK,UAAU,gBAAgB,YAAY;AACtD,eAAS,QAAQ,GAAG,MAAM,8BAA8B;AACxD,eAAS,SAAS,KAAK,MAAM,6BAA6B;AAC1D,YAAM,SAA4C,CAAC;AACnD,UAAI,UAAU,MAAM,KAAK,YAAY,IAAI;AACzC,aAAO,WAAW,OAAO,SAAS,OAAO;AACvC,eAAO,KAAK,OAAO;AACnB,cAAM,eAAe,QAAQ,CAAC,EAAE;AAChC,YAAI,iBAAiB,KAAM;AAC3B,kBAAU,MAAM,KAAK,YAAY,YAAY;AAAA,MAC/C;AACA,aAAO;AAAA,IACT,GAAG,EAAE,GAAG,KAAK,SAAS,iBAAiB,IAAI,CAAC;AAAA,EAC9C;AAAA,EAEA,MAAM,eAAe,aAA6B,QAAQ,IAAgD;AACxG,WAAO,MAAM,KAAK,UAAU,kBAAkB,YAAY;AACxD,eAAS,QAAQ,GAAG,MAAM,8BAA8B;AACxD,eAAS,SAAS,KAAK,MAAM,6BAA6B;AAC1D,YAAM,SAA4C,CAAC;AACnD,UAAI,UAAU,MAAM,KAAK,cAAc,WAAW;AAClD,aAAO,WAAW,OAAO,SAAS,OAAO;AACvC,eAAO,KAAK,OAAO;AACnB,YAAI,QAAQ,CAAC,EAAE,UAAU,EAAG;AAC5B,kBAAU,MAAM,KAAK,cAAc,iBAAiB,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;AAAA,MACjF;AACA,aAAO;AAAA,IACT,GAAG,KAAK,OAAO;AAAA,EACjB;AAAA,EAEA,MAAM,aAAa,WAAmB,WAA+D;AACnG,WAAO,MAAM,KAAK,UAAU,gBAAgB,YAAY;AACtD,eAAS,OAAO,UAAU,SAAS,KAAK,aAAa,GAAG,MAAM,0CAA0C;AACxG,eAAS,SAAS;AAClB;AAAA,QACE,aAAa;AAAA,QACb,MAAM,mDAAmD,aAAa,eAAe,SAAS;AAAA,MAChG;AACA,YAAM,WAAW,GAAG,SAAS,IAAI,SAAS;AAC1C,YAAM,SAAS,KAAK,UAAU,IAAI,QAAQ;AAC1C,UAAI,OAAQ,QAAO;AACnB,YAAM,SAAS,MAAM,KAAK,UAAU,eAAe,WAAW,SAAS,CAAC;AAExE,UAAI,WAAW,OAAW,QAAO,CAAC;AAClC,YAAM,UAAU,oBAAoB,QAAQ,EAAE,UAAU,KAAK,CAAC;AAE9D,YAAM,SAAS,QAAQ,OAAO,IAAI,OAAK,kCAAkC,GAAG,IAAI,CAAC,EAAE,WAAW;AAC9F,WAAK,UAAU,IAAI,UAAU,MAAM;AACnC,aAAO;AAAA,IACT,GAAG,KAAK,OAAO;AAAA,EACjB;AAAA,EAKA,MAAM,QAAQ,cAAyC,UAA4B;AACjF,WAAO,MAAM,KAAK,UAAU,WAAW,YAAY;AACjD,aAAO,gBAAgB,YAClB,MAAM,KAAK,aAAa,GAAG,CAAC,EAAE,QAC/B,SAAS,MAAM,KAAK,cAAc,WAAW,GAAG,MAAM,oBAAoB,WAAW,GAAG,EAAE,CAAC,EAAE;AAAA,IACnG,GAAG,KAAK,OAAO;AAAA,EACjB;AAAA,EAEA,MAAM,eAAyD;AAC7D,WAAO,MAAM,KAAK,UAAU,gBAAgB,YAAY;AACtD,YAAM,SAAS,SAAS,MAAM,KAAK,UAAU,SAAS,CAAC,GAAG,MAAM,gBAAgB;AAChF,aAAO,KAAK,WAAW,MAAM;AAAA,IAC/B,GAAG,KAAK,OAAO;AAAA,EACjB;AAAA,EAEA,MAAM,mBAAkC;AACtC,YAAQ,MAAM,KAAK,aAAa,GAAG,CAAC,EAAE;AAAA,EACxC;AAAA,EAEA,MAAM,qBAA8C;AAClD,YAAQ,MAAM,KAAK,aAAa,GAAG,CAAC,EAAE;AAAA,EACxC;AAAA,EAEA,MAAM,cAAc,MAAmD;AACrE,UAAM,CAAC,OAAO,IAAI,MAAM,KAAK,eAAe,CAAC,IAAI,CAAC;AAClD,WAAO,WAAW;AAAA,EACpB;AAAA,EAEA,MAAM,eAAe,QAAkD;AACrE,WAAO,MAAM,KAAK,UAAU,kBAAkB,YAAY;AACxD,YAAM,UAAU,MAAM,QAAQ,IAAI,OAAO,IAAI,OAAO,SAAS;AAC3D,cAAM,SAAS,KAAK,aAAa,IAAI,IAAI;AACzC,YAAI,OAAQ,QAAO;AACnB,cAAM,SAAS,MAAM,KAAK,UAAU,YAAY,IAAI,CAAC;AACrD,YAAI,WAAW,OAAW;AAC1B,cAAM,UAAU,eAAe,MAAM,MAAM;AAC3C,aAAK,aAAa,IAAI,MAAM,OAAO;AACnC,eAAO;AAAA,MACT,CAAC,CAAC;AACF,aAAO,QAAQ,OAAO,MAAM;AAAA,IAC9B,GAAG,KAAK,OAAO;AAAA,EACjB;AAAA,EAEA,MAAM,KAAK,OAAsB,UAAoD;AACnF,WAAO,MAAM,mBAAmB,MAAM,OAAO,QAAQ;AAAA,EACvD;AAAA,EAEA,MAAM,aAAa,OAAuB,WAAmB,QAAQ,GAAG,UAAoD;AAC1H,WAAO,MAAM,sBAAsB,MAAM,OAAO,WAAW,OAAO,QAAQ;AAAA,EAC5E;AAAA,EAEA,MAAM,iBACJ,YACA,kBACA,UACA,aACA,aACoB;AACpB,WAAO,MAAM,kBAAkB,MAAM,YAAY,kBAAkB,UAAU,aAAa,WAAW;AAAA,EACvG;AAAA,EAEA,MAAyB,eAA8B;AACrD,UAAM,MAAM,aAAa;AACzB,QAAI,KAAK,uBAAuB,OAAW;AAC3C,UAAM,KAAK,SAAS,KAAK;AACzB,SAAK,iBAAiB;AAAA,EACxB;AAAA,EAEA,MAAyB,cAA6B;AACpD,SAAK,gBAAgB;AACrB,SAAK,gBAAgB;AACrB,UAAM,MAAM,YAAY;AAAA,EAC1B;AAAA;AAAA,EAGQ,WAAW,QAAkD;AACnE,UAAM,QAAQ,kCAAkC,QAAQ,IAAI;AAC5D,SAAK,iBAAiB,IAAI,MAAM,CAAC,EAAE,OAAO,KAAK;AAC/C,SAAK,mBAAmB,IAAI,MAAM,CAAC,EAAE,OAAO,KAAK;AACjD,WAAO;AAAA,EACT;AAAA,EAEA,MAAc,UAAU,MAAgC;AACtD,UAAM,WAAW,MAAM,KAAK,QAAQ,GAAG,KAAK,OAAO,IAAI,IAAI,EAAE;AAC7D,QAAI,SAAS,WAAW,IAAK,QAAO;AACpC,aAAS,SAAS,IAAI,MAAM,mBAAmB,SAAS,MAAM,SAAS,IAAI,EAAE;AAC7E,WAAO,MAAM,SAAS,KAAK;AAAA,EAC7B;AAAA,EAEA,MAAc,SAAS,cAAsC;AAC3D,QAAI,KAAK,oBAAqB;AAC9B,SAAK,sBAAsB;AAC3B,QAAI;AACF,YAAM,QAAQ,MAAM,KAAK,aAAa;AACtC,YAAM,OAAO,MAAM,CAAC,EAAE;AACtB,UAAI,KAAK,kBAAkB,QAAW;AACpC,aAAK,gBAAgB;AACrB;AAAA,MACF;AACA,UAAI,SAAS,KAAK,eAAe;AAC/B,aAAK,gBAAgB;AACrB,YAAI,cAAc;AAChB,gBAAM,KAAK,KAAK,eAAe,EAAE,MAAM,CAAC;AAAA,QAC1C;AAAA,MACF;AAAA,IACF,SAAS,IAAI;AACX,WAAK,QAAQ,MAAM,4BAA4B,EAAE;AAAA,IACnD,UAAE;AACA,WAAK,sBAAsB;AAAA,IAC7B;AAAA,EACF;AAAA,EAEQ,mBAAmB;AACzB,QAAI,KAAK,uBAAuB,OAAW;AAC3C,SAAK,gBAAgB;AACrB,SAAK,iBAAiB,YAAY,MAAM;AACtC,WAAK,KAAK,SAAS,IAAI;AAAA,IACzB,GAAG,KAAK,kBAAkB;AAAA,EAC5B;AAAA,EAEQ,kBAAkB;AACxB,QAAI,KAAK,gBAAgB;AACvB,oBAAc,KAAK,cAAc;AACjC,WAAK,iBAAiB;AAAA,IACxB;AAAA,EACF;AACF;AA/OE,cADW,iBACK,kBAAiB;AACjC,cAFW,iBAEK,gBAAe,CAAC;AAChC,cAHW,iBAGK,YAAW,CAAC,kBAAkB;AAHnC,kBAAN;AAAA,EADN,kBAAkB;AAAA,GACN;",
+  "names": []
+}

package/dist/neutral/paths.d.ts

@@ -0,0 +1,28 @@
+import type { Hash } from '@xylabs/sdk-js';
+/**
+ * Path contract for the static REST chain layout.
+ *
+ * These builders are the single source of truth for where files live, shared by the
+ * publisher (which writes the static files) and `RestBlockViewer` (which reads them),
+ * so the layout cannot drift between the two. Paths are relative — no leading slash —
+ * and joined to a base URL by the consumer.
+ *
+ * Every file except the head pointer is immutable once written:
+ * - block and payload files never change after finalization
+ * - step files are only written for completed steps
+ * - the head pointer is rewritten as the chain advances and must not be cached long-term
+ */
+/** The mutable head pointer: the current head SignedHydratedBlockWithHashMeta. */
+export declare const headPath: () => string;
+/** A block by number: SignedHydratedBlockWithHashMeta. */
+export declare const blockNumberPath: (block: number) => string;
+/** A block by hash: the same content as its by-number twin. */
+export declare const blockHashPath: (hash: Hash) => string;
+/**
+ * A completed step's blocks: a BlocksStepSummary payload whose `blocks` array is ordered
+ * oldest-first. Only complete steps are published; the in-flight tail step has no file.
+ */
+export declare const blocksStepPath: (stepLevel: number, stepIndex: number) => string;
+/** A payload by hash: WithHashMeta<Payload>. */
+export declare const payloadPath: (hash: Hash) => string;
+//# sourceMappingURL=paths.d.ts.map

package/dist/neutral/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/paths.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;;;;;;;;;;;GAYG;AAEH,kFAAkF;AAClF,eAAO,MAAM,QAAQ,QAAO,MAA2B,CAAA;AAEvD,0DAA0D;AAC1D,eAAO,MAAM,eAAe,GAAI,OAAO,MAAM,KAAG,MAAsC,CAAA;AAEtF,+DAA+D;AAC/D,eAAO,MAAM,aAAa,GAAI,MAAM,IAAI,KAAG,MAAmC,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,MAAM,EAAE,WAAW,MAAM,KAAG,MAAsD,CAAA;AAE5H,gDAAgD;AAChD,eAAO,MAAM,WAAW,GAAI,MAAM,IAAI,KAAG,MAAgC,CAAA"}

package/package.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "http://json.schemastore.org/package.json",
+  "name": "@xyo-network/xl1-rest-block-viewer",
+  "version": "2.0.12",
+  "description": "XYO Layer One BlockViewer over a statically generated REST file layout",
+  "homepage": "https://xylabs.com",
+  "bugs": {
+    "url": "https://github.com/XYOracleNetwork/xl1-protocol/issues",
+    "email": "support@xylabs.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XYOracleNetwork/xl1-protocol.git"
+  },
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XY Labs Development Team",
+    "email": "support@xylabs.com",
+    "url": "https://xylabs.com"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/neutral/index.d.ts",
+      "default": "./dist/neutral/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "!**/*.bench.*",
+    "!**/*.spec.*",
+    "!**/*.test.*",
+    "README.md"
+  ],
+  "dependencies": {
+    "@xyo-network/xl1-driver-memory": "~2.0.12",
+    "@xyo-network/xl1-protocol-sdk": "~2.0.12",
+    "@xyo-network/xl1-protocol-lib": "~2.0.12"
+  },
+  "devDependencies": {
+    "@bitauth/libauth": "~3.0",
+    "@metamask/providers": "^22.1",
+    "@noble/post-quantum": "~0.6.1",
+    "@opentelemetry/api": "^1.9",
+    "@opentelemetry/sdk-trace-base": "^2.7",
+    "@scure/base": "~2.2",
+    "@scure/bip39": "~2.2",
+    "@xylabs/geo": "^6.0",
+    "@xylabs/sdk-js": "^6.0.10",
+    "@xylabs/threads": "~6.0",
+    "@xylabs/toolchain": "~8.1.19",
+    "@xylabs/tsconfig": "~8.1.19",
+    "@xyo-network/address": "^6.0",
+    "@xyo-network/sdk-js": "^6.0",
+    "@xyo-network/sdk-protocol-js": "~6.0",
+    "ajv": "^8.20",
+    "async-mutex": "^0.5",
+    "bn.js": "^5.2",
+    "buffer": "^6.0",
+    "cosmiconfig": "^9.0",
+    "debug": "~4.4",
+    "eslint": "^10.4.1",
+    "ethers": "^6.16",
+    "hash-wasm": "~4.12",
+    "idb": "^8.0",
+    "lru-cache": "^11.3",
+    "observable-fns": "~0.6",
+    "typescript": "~6.0.3",
+    "vite": "^6.0.0 || ^7.0.0 || ^8.0.0",
+    "vitest": "~4.1.8",
+    "webextension-polyfill": "^0.12",
+    "zod": "~4.4"
+  },
+  "peerDependencies": {
+    "@bitauth/libauth": "~3.0",
+    "@metamask/providers": "^22.1",
+    "@noble/post-quantum": "~0.6.1",
+    "@opentelemetry/api": "^1.9",
+    "@opentelemetry/sdk-trace-base": "^2.7",
+    "@scure/base": "~2.2",
+    "@scure/bip39": "~2.2",
+    "@xylabs/geo": "^6.0",
+    "@xylabs/sdk-js": "^6.0",
+    "@xylabs/threads": "~6.0",
+    "@xyo-network/address": "^6.0",
+    "@xyo-network/sdk-js": "^6.0",
+    "@xyo-network/sdk-protocol-js": "~6.0",
+    "ajv": "^8.20",
+    "async-mutex": "^0.5",
+    "bn.js": "^5.2",
+    "buffer": "^6.0",
+    "cosmiconfig": "^9.0",
+    "debug": "~4.4",
+    "ethers": "^6.16",
+    "hash-wasm": "~4.12",
+    "idb": "^8.0",
+    "lru-cache": "^11.3",
+    "observable-fns": "~0.6",
+    "webextension-polyfill": "^0.12",
+    "zod": "~4.4"
+  },
+  "engines": {
+    "node": ">=22.3"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  }
+}