@parity/truapi-provider 0.1.1-dev-20260714-3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Parity Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,19 @@
+@parity/truapi-provider
+
+This package ships the `truapi-provider` Rust crate compiled to WebAssembly. It
+is licensed MIT (see LICENSE) except for the vendored browser light-client
+platform, which is licensed Apache-2.0 (see LICENSE-APACHE).
+
+Vendored components (compiled into truapi_provider_bg.wasm)
+----------------------------------------------------------
+
+The crate's src/light_platform_web/{platform,helpers,socket}.rs
+  Copyright 2019-2026 Parity Technologies (UK) Ltd.
+  Vendored from subxt-lightclient 0.50.1 (github.com/paritytech/subxt,
+  crates/lightclient), which is dual-licensed Apache-2.0 OR GPL-3.0; used here
+  under Apache-2.0. The `onmessage` handler in socket.rs was modified to ignore
+  non-ArrayBuffer frames instead of panicking; otherwise the copy is faithful.
+
+The embedded light client itself (the `smoldot` / `smoldot-light` crates,
+GPL-3.0-or-later WITH Classpath-exception-2.0) is an ordinary Cargo dependency,
+linked under the Classpath exception; its source is not vendored here.

package/README.md

@@ -0,0 +1,69 @@
+# @parity/truapi-provider
+
+Network provider backends for the TrUAPI `ChainProvider` contract, compiled to
+WebAssembly for browser hosts. It embeds a [smoldot](https://github.com/smol-dot/smoldot)
+light client and a remote WebSocket JSON-RPC backend behind one API, and bundles
+the chain-spec catalog so a host can `connect(genesisHash)` without shipping its
+own specs.
+
+It is the browser counterpart to the native (iOS/Android) provider that the same
+crate exposes over UniFFI, so chain access behaves identically across hosts.
+
+## Usage
+
+The bundle is `wasm-bindgen` glue plus a `.wasm` binary. Instantiate the module
+once per page/worker, then open a connection per genesis hash. Connections share
+the single embedded light client.
+
+```js
+import init, { ChainProviderBuilder } from "@parity/truapi-provider";
+import wasmUrl from "@parity/truapi-provider/truapi_provider_bg.wasm?url";
+
+await init({ module_or_path: wasmUrl });
+
+// A bundled network is resolved from the genesis hash alone (relay wiring and
+// statement-store placement come from the catalog); no per-chain registration.
+const provider = new ChainProviderBuilder().build();
+const connection = await provider.connect("0x77af…");
+
+connection.send(
+  '{"jsonrpc":"2.0","id":1,"method":"chainSpec_v1_genesisHash","params":[]}',
+);
+const response = await connection.nextResponse(); // undefined once closed
+connection.close();
+```
+
+Add a remote node instead of the light client with
+`builder.addRpcChain(genesisHash, "wss://node.example")`, or a light client for
+an unbundled chain with `builder.addLightChain(genesisHash, specification)`.
+
+## Building
+
+The `dist/` bundle is generated and gitignored. Rebuild it from the Rust crate:
+
+```bash
+npm run build:wasm      # wasm-pack --target web, features "js networks"
+```
+
+`wasm-pack` is required (`cargo install wasm-pack`). Set `TRUAPI_WASM_PROFILE=dev`
+for a fast unoptimized build. The repo's `make wasm` target rebuilds this bundle
+alongside the host runtime.
+
+## Publishing
+
+Publishing goes through `paritytech/npm_publish_automation`, so no local npm
+token is needed:
+
+- **Stable release** — a `release:`-prefixed commit on `main` triggers
+  [`release.yml`](../../../.github/workflows/release.yml), which publishes the
+  committed version to `latest`.
+- **Dev snapshot** — run the [`Dev publish`](../../../.github/workflows/dev-publish.yml)
+  workflow (`workflow_dispatch`, optional `npm_tag_suffix`). It stamps a unique
+  `<next-patch>-dev-<YYYYMMDD>[-suffix].<N>` version and publishes it under a
+  `dev-<YYYYMMDD>[-suffix]` dist-tag, so `latest` is never moved. Consumers pin
+  the exact version it prints.
+
+## License
+
+MIT AND Apache-2.0. See [LICENSE](LICENSE), [LICENSE-APACHE](LICENSE-APACHE), and
+[NOTICE](NOTICE).

package/dist/truapi_provider.d.ts

@@ -0,0 +1,172 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Collects genesis-hash to chain-source registrations from JS.
+ */
+export class ChainProviderBuilder {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Register an embedded light-client chain identified by the
+     * `0x`-prefixed genesis hash. Use this for a relay or standalone chain;
+     * parachains are served through the bundled catalog (`addNetwork`), which
+     * supplies their relay wiring and statement-store placement.
+     */
+    addLightChain(genesis_hash: string, specification: string): void;
+    /**
+     * Register every chain of the bundled network `name` (relay plus system
+     * parachains, with relay wiring and statement-store placement supplied by
+     * the catalog). Returns the network's genesis hashes.
+     */
+    addNetwork(name: string): NetworkChains;
+    /**
+     * Register a remote JSON-RPC node for the chain identified by the
+     * `0x`-prefixed genesis hash. A later registration for the same hash
+     * replaces the earlier one.
+     */
+    addRpcChain(genesis_hash: string, url: string): void;
+    /**
+     * Build the provider, consuming the builder.
+     */
+    build(): ChainProviderHandle;
+    /**
+     * Create an empty builder.
+     */
+    constructor();
+    /**
+     * Seed a warm-start database blob (from
+     * [`snapshot`](ChainProviderHandle::snapshot)) for the `0x`-prefixed
+     * genesis hash, so its light client resumes from that finalized state
+     * instead of re-syncing from the checkpoint.
+     */
+    setDatabase(genesis_hash: string, blob: string): void;
+}
+
+/**
+ * A built provider; hand out one per page/worker.
+ */
+export class ChainProviderHandle {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Open a connection to the chain identified by the `0x`-prefixed genesis
+     * hash. Rejects when the chain is not registered or the transport fails.
+     */
+    connect(genesis_hash: string): Promise<Connection>;
+    /**
+     * Produce a warm-start database blob for the `0x`-prefixed genesis hash.
+     * Persist it and feed it back via
+     * [`setDatabase`](ChainProviderBuilder::set_database) on a later run.
+     */
+    snapshot(genesis_hash: string): Promise<string>;
+}
+
+/**
+ * A live JSON-RPC connection: a raw string pipe.
+ */
+export class Connection {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Close the connection; pending `nextResponse()` calls resolve to
+     * `undefined`.
+     */
+    close(): void;
+    /**
+     * Resolve with the next JSON-RPC response or notification, or
+     * `undefined` once the connection is closed or dead.
+     */
+    nextResponse(): Promise<string | undefined>;
+    /**
+     * Queue a JSON-RPC request string.
+     */
+    send(request: string): void;
+}
+
+/**
+ * The genesis hashes of a network registered via
+ * [`ChainProviderBuilder::add_network`], as `0x`-prefixed hex strings.
+ */
+export class NetworkChains {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Asset Hub genesis hash.
+     */
+    readonly assethub: string;
+    /**
+     * Bulletin-chain genesis hash.
+     */
+    readonly bulletin: string;
+    /**
+     * People-chain genesis hash.
+     */
+    readonly people: string;
+    /**
+     * Relay-chain genesis hash.
+     */
+    readonly relay: string;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_chainproviderbuilder_free: (a: number, b: number) => void;
+    readonly __wbg_chainproviderhandle_free: (a: number, b: number) => void;
+    readonly __wbg_connection_free: (a: number, b: number) => void;
+    readonly __wbg_networkchains_free: (a: number, b: number) => void;
+    readonly chainproviderbuilder_addLightChain: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly chainproviderbuilder_addNetwork: (a: number, b: number, c: number, d: number) => void;
+    readonly chainproviderbuilder_addRpcChain: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly chainproviderbuilder_build: (a: number, b: number) => void;
+    readonly chainproviderbuilder_new: () => number;
+    readonly chainproviderbuilder_setDatabase: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly chainproviderhandle_connect: (a: number, b: number, c: number) => number;
+    readonly chainproviderhandle_snapshot: (a: number, b: number, c: number) => number;
+    readonly connection_close: (a: number) => void;
+    readonly connection_nextResponse: (a: number) => number;
+    readonly connection_send: (a: number, b: number, c: number) => void;
+    readonly networkchains_assethub: (a: number, b: number) => void;
+    readonly networkchains_bulletin: (a: number, b: number) => void;
+    readonly networkchains_people: (a: number, b: number) => void;
+    readonly networkchains_relay: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_12601: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_12603: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_3625: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_3625_2: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_3625_3: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_6911: (a: number, b: number) => void;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number) => void;
+    readonly __wbindgen_export4: (a: number, b: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export5: (a: number, b: number, c: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;