@parity/truapi-provider 0.2.1 → 0.2.3-dev-20260928.0

package/README.md

@@ -63,6 +63,26 @@ syncs from the checkpoint in the chain spec on every run.
 anything the client would load for it. `saveDatabase(genesisHash)` forces a write
 at a moment the host chooses.
 
+A light-client connection holds its requests until the chain first syncs, then
+sends them in order. Chain-spec queries, statement-store and Bitswap calls are
+answered at once. To show sync
+progress, watch the chain once something is connected to it:
+
+```js
+const watch = provider.lifecycle(chains.relay);
+for (let state; (state = await watch.next()); ) {
+  // state.phase: { kind: "connecting" } | { kind: "syncing", at, target } | { kind: "ready" }
+  // state.peers: connected peer count
+  // state.health: { kind: "ok" } | { kind: "stalled", reason: "noPeers" | "noProgress" }
+}
+```
+
+The first `next()` resolves with the current state, and each later one with the
+next change. It resolves `undefined` after `watch.close()` or once nothing holds
+the chain. A parachain goes from `connecting` straight to `ready`, so watch its
+relay for warp sync progress. `lifecycle` throws for a chain nothing is
+connected to.
+
 ## Native hosts
 
 Android and iOS do not consume this package. The same `truapi-provider` crate is

package/dist/truapi_provider.d.ts

@@ -1,6 +1,18 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/** What the light client is doing on one chain. */
+export interface ChainLifecycle {
+    phase:
+    | { kind: "connecting" }
+    | { kind: "syncing"; at: number; target: number }
+    | { kind: "ready" };
+    peers: number;
+    health: { kind: "ok" } | { kind: "stalled"; reason: "noPeers" | "noProgress" };
+}
+
+
+
 /**
  * Collects genesis-hash to chain-source registrations from JS.
  */
@@ -82,6 +94,14 @@ export class ChainProviderHandle {
      * the light client already holds as many connections as it allows.
      */
     connect(genesis_hash: string): Promise<Connection>;
+    /**
+     * Watch what the light client is doing on the chain identified by the
+     * `0x`-prefixed genesis hash. Throws when nothing is connected to it.
+     *
+     * A parachain goes from `connecting` straight to `ready`; watch its relay
+     * for warp sync progress.
+     */
+    lifecycle(genesis_hash: string): LifecycleWatch;
     /**
      * Read the stored blob for the `0x`-prefixed genesis hash into this
      * provider, so the next [`connect`](ChainProviderHandle::connect) to that
@@ -133,6 +153,26 @@ export class Connection {
     send(request: string): void;
 }
 
+/**
+ * A live watch on one chain's lifecycle, from
+ * [`ChainProviderHandle::lifecycle`].
+ */
+export class LifecycleWatch {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Stop the watch; pending `next()` calls resolve to `undefined`.
+     */
+    close(): void;
+    /**
+     * Resolve with the current state on the first call and with the next
+     * change after that, or with `undefined` once the watch is closed or the
+     * chain stops running.
+     */
+    next(): Promise<ChainLifecycle | undefined>;
+}
+
 /**
  * The genesis hashes of a network registered via
  * [`ChainProviderBuilder::add_network`], as `0x`-prefixed hex strings.
@@ -174,6 +214,7 @@ export interface InitOutput {
     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_lifecyclewatch_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;
@@ -183,22 +224,25 @@ export interface InitOutput {
     readonly chainproviderbuilder_setDatabaseContent: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
     readonly chainproviderbuilder_setStorage: (a: number, b: number, c: number) => void;
     readonly chainproviderhandle_connect: (a: number, b: number, c: number) => number;
+    readonly chainproviderhandle_lifecycle: (a: number, b: number, c: number, d: number) => void;
     readonly chainproviderhandle_loadDatabase: (a: number, b: number, c: number) => number;
     readonly chainproviderhandle_saveDatabase: (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 lifecyclewatch_close: (a: number) => void;
+    readonly lifecyclewatch_next: (a: number) => number;
     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 setLogLevel: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_20031: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_20033: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_3926: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_3926_2: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_3926_3: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_7481: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_20550: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_20552: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_3964: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_3964_2: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_3964_3: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_7556: (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;

package/dist/truapi_provider.js

@@ -215,6 +215,32 @@ export class ChainProviderHandle {
         const ret = wasm.chainproviderhandle_connect(this.__wbg_ptr, ptr0, len0);
         return takeObject(ret);
     }
+    /**
+     * Watch what the light client is doing on the chain identified by the
+     * `0x`-prefixed genesis hash. Throws when nothing is connected to it.
+     *
+     * A parachain goes from `connecting` straight to `ready`; watch its relay
+     * for warp sync progress.
+     * @param {string} genesis_hash
+     * @returns {LifecycleWatch}
+     */
+    lifecycle(genesis_hash) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            const ptr0 = passStringToWasm0(genesis_hash, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+            const len0 = WASM_VECTOR_LEN;
+            wasm.chainproviderhandle_lifecycle(retptr, this.__wbg_ptr, ptr0, len0);
+            var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+            var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
+            }
+            return LifecycleWatch.__wrap(r0);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
     /**
      * Read the stored blob for the `0x`-prefixed genesis hash into this
      * provider, so the next [`connect`](ChainProviderHandle::connect) to that
@@ -306,6 +332,46 @@ export class Connection {
 }
 if (Symbol.dispose) Connection.prototype[Symbol.dispose] = Connection.prototype.free;
 
+/**
+ * A live watch on one chain's lifecycle, from
+ * [`ChainProviderHandle::lifecycle`].
+ */
+export class LifecycleWatch {
+    static __wrap(ptr) {
+        const obj = Object.create(LifecycleWatch.prototype);
+        obj.__wbg_ptr = ptr;
+        LifecycleWatchFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        LifecycleWatchFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_lifecyclewatch_free(ptr, 0);
+    }
+    /**
+     * Stop the watch; pending `next()` calls resolve to `undefined`.
+     */
+    close() {
+        wasm.lifecyclewatch_close(this.__wbg_ptr);
+    }
+    /**
+     * Resolve with the current state on the first call and with the next
+     * change after that, or with `undefined` once the watch is closed or the
+     * chain stops running.
+     * @returns {ChainLifecycle | undefined}
+     */
+    next() {
+        const ret = wasm.lifecyclewatch_next(this.__wbg_ptr);
+        return takeObject(ret);
+    }
+}
+if (Symbol.dispose) LifecycleWatch.prototype[Symbol.dispose] = LifecycleWatch.prototype.free;
+
 /**
  * The genesis hashes of a network registered via
  * [`ChainProviderBuilder::add_network`], as `0x`-prefixed hex strings.
@@ -551,7 +617,7 @@ function __wbg_get_imports() {
                     const a = state0.a;
                     state0.a = 0;
                     try {
-                        return __wasm_bindgen_func_elem_20033(a, state0.b, arg0, arg1);
+                        return __wasm_bindgen_func_elem_20552(a, state0.b, arg0, arg1);
                     } finally {
                         state0.a = a;
                     }
@@ -578,6 +644,10 @@ function __wbg_get_imports() {
             const ret = getObject(arg0).now();
             return ret;
         },
+        __wbg_parse_1c0d8a8656d7e016: function() { return handleError(function (arg0, arg1) {
+            const ret = JSON.parse(getStringFromWasm0(arg0, arg1));
+            return addHeapObject(ret);
+        }, arguments); },
         __wbg_performance_3fcf6e32a7e1ed0a: function(arg0) {
             const ret = getObject(arg0).performance;
             return addHeapObject(ret);
@@ -672,28 +742,28 @@ function __wbg_get_imports() {
             console.warn(getObject(arg0));
         },
         __wbindgen_cast_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 1864, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_20031);
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 1891, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_20550);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000002: function(arg0, arg1) {
             // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("CloseEvent")], shim_idx: 20, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_3926);
+            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_3964);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000003: function(arg0, arg1) {
             // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("Event")], shim_idx: 20, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_3926_2);
+            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_3964_2);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000004: function(arg0, arg1) {
             // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("MessageEvent")], shim_idx: 20, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_3926_3);
+            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_3964_3);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000005: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [], shim_idx: 714, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_7481);
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [], shim_idx: 726, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_7556);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000006: function(arg0, arg1) {
@@ -720,26 +790,26 @@ function __wbg_get_imports() {
     };
 }
 
-function __wasm_bindgen_func_elem_7481(arg0, arg1) {
-    wasm.__wasm_bindgen_func_elem_7481(arg0, arg1);
+function __wasm_bindgen_func_elem_7556(arg0, arg1) {
+    wasm.__wasm_bindgen_func_elem_7556(arg0, arg1);
 }
 
-function __wasm_bindgen_func_elem_3926(arg0, arg1, arg2) {
-    wasm.__wasm_bindgen_func_elem_3926(arg0, arg1, addHeapObject(arg2));
+function __wasm_bindgen_func_elem_3964(arg0, arg1, arg2) {
+    wasm.__wasm_bindgen_func_elem_3964(arg0, arg1, addHeapObject(arg2));
 }
 
-function __wasm_bindgen_func_elem_3926_2(arg0, arg1, arg2) {
-    wasm.__wasm_bindgen_func_elem_3926_2(arg0, arg1, addHeapObject(arg2));
+function __wasm_bindgen_func_elem_3964_2(arg0, arg1, arg2) {
+    wasm.__wasm_bindgen_func_elem_3964_2(arg0, arg1, addHeapObject(arg2));
 }
 
-function __wasm_bindgen_func_elem_3926_3(arg0, arg1, arg2) {
-    wasm.__wasm_bindgen_func_elem_3926_3(arg0, arg1, addHeapObject(arg2));
+function __wasm_bindgen_func_elem_3964_3(arg0, arg1, arg2) {
+    wasm.__wasm_bindgen_func_elem_3964_3(arg0, arg1, addHeapObject(arg2));
 }
 
-function __wasm_bindgen_func_elem_20031(arg0, arg1, arg2) {
+function __wasm_bindgen_func_elem_20550(arg0, arg1, arg2) {
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.__wasm_bindgen_func_elem_20031(retptr, arg0, arg1, addHeapObject(arg2));
+        wasm.__wasm_bindgen_func_elem_20550(retptr, arg0, arg1, addHeapObject(arg2));
         var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
         var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
         if (r1) {
@@ -750,8 +820,8 @@ function __wasm_bindgen_func_elem_20031(arg0, arg1, arg2) {
     }
 }
 
-function __wasm_bindgen_func_elem_20033(arg0, arg1, arg2, arg3) {
-    wasm.__wasm_bindgen_func_elem_20033(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
+function __wasm_bindgen_func_elem_20552(arg0, arg1, arg2, arg3) {
+    wasm.__wasm_bindgen_func_elem_20552(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
 
 
@@ -765,6 +835,9 @@ const ChainProviderHandleFinalization = (typeof FinalizationRegistry === 'undefi
 const ConnectionFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_connection_free(ptr, 1));
+const LifecycleWatchFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_lifecyclewatch_free(ptr, 1));
 const NetworkChainsFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_networkchains_free(ptr, 1));

package/dist/truapi_provider_bg.wasm.d.ts

@@ -4,6 +4,7 @@ export const memory: WebAssembly.Memory;
 export const __wbg_chainproviderbuilder_free: (a: number, b: number) => void;
 export const __wbg_chainproviderhandle_free: (a: number, b: number) => void;
 export const __wbg_connection_free: (a: number, b: number) => void;
+export const __wbg_lifecyclewatch_free: (a: number, b: number) => void;
 export const __wbg_networkchains_free: (a: number, b: number) => void;
 export const chainproviderbuilder_addLightChain: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const chainproviderbuilder_addNetwork: (a: number, b: number, c: number, d: number) => void;
@@ -13,22 +14,25 @@ export const chainproviderbuilder_new: () => number;
 export const chainproviderbuilder_setDatabaseContent: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
 export const chainproviderbuilder_setStorage: (a: number, b: number, c: number) => void;
 export const chainproviderhandle_connect: (a: number, b: number, c: number) => number;
+export const chainproviderhandle_lifecycle: (a: number, b: number, c: number, d: number) => void;
 export const chainproviderhandle_loadDatabase: (a: number, b: number, c: number) => number;
 export const chainproviderhandle_saveDatabase: (a: number, b: number, c: number) => number;
 export const connection_close: (a: number) => void;
 export const connection_nextResponse: (a: number) => number;
 export const connection_send: (a: number, b: number, c: number) => void;
+export const lifecyclewatch_close: (a: number) => void;
+export const lifecyclewatch_next: (a: number) => number;
 export const networkchains_assethub: (a: number, b: number) => void;
 export const networkchains_bulletin: (a: number, b: number) => void;
 export const networkchains_people: (a: number, b: number) => void;
 export const networkchains_relay: (a: number, b: number) => void;
 export const setLogLevel: (a: number, b: number) => void;
-export const __wasm_bindgen_func_elem_20031: (a: number, b: number, c: number, d: number) => void;
-export const __wasm_bindgen_func_elem_20033: (a: number, b: number, c: number, d: number) => void;
-export const __wasm_bindgen_func_elem_3926: (a: number, b: number, c: number) => void;
-export const __wasm_bindgen_func_elem_3926_2: (a: number, b: number, c: number) => void;
-export const __wasm_bindgen_func_elem_3926_3: (a: number, b: number, c: number) => void;
-export const __wasm_bindgen_func_elem_7481: (a: number, b: number) => void;
+export const __wasm_bindgen_func_elem_20550: (a: number, b: number, c: number, d: number) => void;
+export const __wasm_bindgen_func_elem_20552: (a: number, b: number, c: number, d: number) => void;
+export const __wasm_bindgen_func_elem_3964: (a: number, b: number, c: number) => void;
+export const __wasm_bindgen_func_elem_3964_2: (a: number, b: number, c: number) => void;
+export const __wasm_bindgen_func_elem_3964_3: (a: number, b: number, c: number) => void;
+export const __wasm_bindgen_func_elem_7556: (a: number, b: number) => void;
 export const __wbindgen_export: (a: number, b: number) => number;
 export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_export3: (a: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parity/truapi-provider",
-  "version": "0.2.1",
+  "version": "0.2.3-dev-20260928.0",
   "description": "Network provider backends for the TrUAPI ChainProvider: an embedded smoldot light client and remote WebSocket JSON-RPC nodes, compiled to WebAssembly for browser hosts",
   "license": "MIT AND Apache-2.0",
   "author": "Parity Technologies <admin@parity.io>",