@parity/product-sdk-host 0.1.0

package/LICENSE

@@ -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/dist/index.d.ts

@@ -0,0 +1,337 @@
+import { JsonRpcProvider } from 'polkadot-api/ws-provider/web';
+import * as polkadot_api from 'polkadot-api';
+export { HexString, assertEnumVariant, enumValue, fromHex, isEnumVariant, resultErr, resultOk, toHex, unwrapResultOrThrow } from '@novasamatech/host-api';
+
+/** Subset of product-sdk's hostLocalStorage that the KV store uses. */
+interface HostLocalStorage {
+    readString(key: string): Promise<string | null>;
+    writeString(key: string, value: string): Promise<void>;
+    readJSON<T>(key: string): Promise<T | null>;
+    writeJSON<T>(key: string, value: T): Promise<void>;
+    /**
+     * Clear a specific key from storage.
+     * @param key - The key to clear
+     */
+    clear(key: string): Promise<void>;
+}
+/** Proof types returned from createProof (matches product-sdk SCALE-decoded types). */
+type StatementProof = {
+    tag: "Sr25519";
+    value: {
+        signature: Uint8Array;
+        signer: Uint8Array;
+    };
+} | {
+    tag: "Ed25519";
+    value: {
+        signature: Uint8Array;
+        signer: Uint8Array;
+    };
+} | {
+    tag: "Secp256k1Ecdsa";
+    value: {
+        signature: Uint8Array;
+        signer: Uint8Array;
+    };
+} | {
+    tag: "EcdsaRecoverable";
+    value: {
+        signature: Uint8Array;
+    };
+};
+/** The statement store interface provided by the host API via product-sdk. */
+interface HostStatementStore {
+    /**
+     * Subscribe to statements matching the given topics.
+     * @param topics - Topic filters as Uint8Array[]
+     * @param callback - Called with batches of SignedStatement[]
+     * @returns Subscription object with unsubscribe method
+     */
+    subscribe(topics: Uint8Array[], callback: (statements: unknown[]) => void): {
+        unsubscribe: () => void;
+    };
+    /**
+     * Create a proof for a statement using the given account.
+     * @param accountId - The account ID tuple [ss58Address, chainPrefix] from product-sdk
+     * @param statement - The unsigned statement
+     * @returns The proof (signature + signer info)
+     */
+    createProof(accountId: [string, number], statement: unknown): Promise<StatementProof>;
+    /**
+     * Submit a signed statement to the bulletin chain.
+     * @param signedStatement - Statement with attached proof
+     */
+    submit(signedStatement: unknown): Promise<void>;
+}
+
+/**
+ * Detect if running inside a Host container (Polkadot Browser / Polkadot Desktop).
+ *
+ * The SDK is designed to run exclusively inside a host container. This function
+ * is primarily useful for early validation or informational purposes.
+ *
+ * Uses product-sdk's sandboxProvider as primary detection.
+ * Falls back to manual signal checks when product-sdk is not installed.
+ */
+declare function isInsideContainer(): Promise<boolean>;
+/**
+ * Get the Host API localStorage instance when running inside a container.
+ * Returns null outside a container or when product-sdk is unavailable.
+ */
+declare function getHostLocalStorage(): Promise<HostLocalStorage | null>;
+/**
+ * Get a PAPI-compatible JSON-RPC provider that routes through the host connection.
+ *
+ * When running inside a Polkadot container, this wraps the chain connection via the
+ * host's `createPapiProvider`, enabling shared connections and efficient routing.
+ * Returns `null` when `@novasamatech/product-sdk` is unavailable.
+ *
+ * @param genesisHash - Genesis hash of the target chain (`0x`-prefixed hex string).
+ * @returns A host-routed `JsonRpcProvider`, or `null` if unavailable.
+ */
+declare function getHostProvider(genesisHash: `0x${string}`): Promise<JsonRpcProvider | null>;
+/**
+ * Synchronous container detection — fast heuristic check without product-sdk.
+ *
+ * Checks for iframe, webview marker, and host message port signals.
+ * Use this when you need a quick sync check (e.g., in hot code paths).
+ * For full detection including product-sdk, use {@link isInsideContainer} (async).
+ */
+declare function isInsideContainerSync(): boolean;
+/**
+ * Get the host API statement store when running inside a container.
+ *
+ * Returns a statement store with `subscribe`, `createProof`, and `submit` methods
+ * that communicate through the host's native binary protocol — bypassing JSON-RPC
+ * entirely. Returns `null` when `@novasamatech/product-sdk` is unavailable.
+ *
+ * @returns The host statement store, or `null` if unavailable.
+ */
+declare function getStatementStore(): Promise<HostStatementStore | null>;
+
+/**
+ * Shared chain network configuration — single source of truth for
+ * chain-specific endpoints used by multiple packages.
+ */
+/** Bulletin chain RPC endpoints by environment. */
+declare const BULLETIN_RPCS: {
+    readonly paseo: readonly ["wss://paseo-bulletin-rpc.polkadot.io"];
+    readonly polkadot: string[];
+    readonly kusama: string[];
+};
+/** Default bulletin endpoint (first paseo endpoint). */
+declare const DEFAULT_BULLETIN_ENDPOINT: string;
+
+/**
+ * The TruApi type - provides low-level methods for communicating with the host.
+ *
+ * Methods include:
+ * - `navigateTo(url)` — Navigate to a URL within the host
+ * - `permission(permissions)` — Request permissions from the host
+ * - `localStorageRead/Write/Clear` — Host-backed storage
+ * - `sign(payload)` — Request transaction signing
+ * - `deriveEntropy(context)` — Derive deterministic entropy
+ * - `themeSubscribe()` — Subscribe to host theme changes
+ * - And many more...
+ */
+type TruApi = any;
+/**
+ * Get the TruAPI instance for direct low-level access.
+ *
+ * Returns the `hostApi` object from `@novasamatech/product-sdk` which provides
+ * methods for communicating directly with the host container. Returns `null`
+ * when running outside a container or when the SDK is unavailable.
+ *
+ * For most use cases, prefer the higher-level functions like `getHostLocalStorage()`,
+ * `getHostProvider()`, etc. Use this when you need direct access to host methods
+ * like `navigateTo()`, `permission()`, or `deriveEntropy()`.
+ *
+ * @example
+ * ```ts
+ * import { getTruApi, enumValue } from "@parity/product-sdk-host";
+ *
+ * const truApi = await getTruApi();
+ * if (truApi) {
+ *   // Request permission
+ *   const result = await truApi.permission([enumValue("ChainSubmit")]);
+ *
+ *   // Navigate to a URL
+ *   await truApi.navigateTo("polkadot://settings");
+ *
+ *   // Subscribe to theme changes
+ *   const sub = truApi.themeSubscribe(undefined, (theme) => {
+ *     console.log("Theme changed:", theme);
+ *   });
+ * }
+ * ```
+ *
+ * @returns The TruAPI instance, or `null` if unavailable.
+ */
+declare function getTruApi(): Promise<TruApi | null>;
+/**
+ * Get the preimage manager for bulletin chain operations.
+ *
+ * The preimage manager handles uploading and looking up preimages (arbitrary data)
+ * on the bulletin chain through the host's optimized path.
+ *
+ * @returns The preimage manager, or `null` if unavailable.
+ *
+ * @example
+ * ```ts
+ * import { getPreimageManager } from "@parity/product-sdk-host";
+ *
+ * const manager = await getPreimageManager();
+ * if (manager) {
+ *   // Submit a preimage
+ *   const key = await manager.submit(new Uint8Array([1, 2, 3]));
+ *
+ *   // Look up a preimage
+ *   const sub = manager.lookup(key, (data) => {
+ *     if (data) console.log("Found:", data);
+ *   });
+ * }
+ * ```
+ */
+declare function getPreimageManager(): Promise<PreimageManager | null>;
+/**
+ * Preimage manager interface for bulletin chain operations.
+ */
+interface PreimageManager {
+    /**
+     * Submit a preimage to the bulletin chain.
+     * @param data - The data to submit.
+     * @returns The preimage key (hex string).
+     */
+    submit(data: Uint8Array): Promise<string>;
+    /**
+     * Look up a preimage by key.
+     * @param key - The preimage key (hex string).
+     * @param callback - Called with the data when found, or null if not yet available.
+     * @returns Subscription handle with unsubscribe method.
+     */
+    lookup(key: string, callback: (preimage: Uint8Array | null) => void): {
+        unsubscribe: () => void;
+        onInterrupt: (cb: () => void) => () => void;
+    };
+}
+/**
+ * Get the accounts provider for managing host accounts.
+ *
+ * @returns The accounts provider, or `null` if unavailable.
+ */
+declare function getAccountsProvider(): Promise<AccountsProvider | null>;
+/**
+ * Account from the host wallet.
+ */
+interface HostAccount {
+    publicKey: Uint8Array;
+    name?: string;
+}
+/**
+ * A product account — an app-scoped derived account managed by the host wallet.
+ *
+ * The host derives a unique keypair for each app (identified by `dotNsIdentifier`)
+ * so apps get their own account that the user controls but is scoped to the app.
+ */
+interface ProductAccount {
+    /** App identifier (e.g., "mark3t.dot"). */
+    dotNsIdentifier: string;
+    /** Derivation index within the app scope. Default: 0 */
+    derivationIndex: number;
+    /** Raw public key (32 bytes). */
+    publicKey: Uint8Array;
+}
+/**
+ * A contextual alias obtained from Ring VRF.
+ *
+ * Proves account membership in a ring without revealing which account.
+ */
+interface ContextualAlias {
+    /** Ring context (32 bytes). */
+    context: Uint8Array;
+    /** The Ring VRF alias bytes. */
+    alias: Uint8Array;
+}
+/**
+ * Neverthrow-style ResultAsync returned by product-sdk methods.
+ *
+ * Use `.match(onOk, onErr)` to handle success/error cases.
+ */
+interface ResultAsync<T, E> {
+    match: <A, B = A>(ok: (t: T) => A, err: (e: E) => B) => Promise<A | B>;
+}
+/**
+ * Accounts provider interface from @novasamatech/product-sdk.
+ *
+ * Provides methods for accessing host wallet accounts, product accounts,
+ * and Ring VRF operations.
+ */
+interface AccountsProvider {
+    /**
+     * Get non-product accounts (user's external wallets connected to the host).
+     *
+     * @returns ResultAsync resolving to array of accounts.
+     */
+    getNonProductAccounts: () => ResultAsync<HostAccount[], unknown>;
+    /**
+     * Get a signer for a non-product account.
+     *
+     * @param account - The product account (used for public key lookup).
+     * @returns A PolkadotSigner for signing transactions.
+     */
+    getNonProductAccountSigner: (account: ProductAccount) => polkadot_api.PolkadotSigner;
+    /**
+     * Get an app-scoped product account from the host.
+     *
+     * Product accounts are derived by the host wallet for each app, identified
+     * by `dotNsIdentifier` (e.g., "mark3t.dot"). The user controls these accounts
+     * but they are scoped to the requesting app.
+     *
+     * @param dotNsIdentifier - App identifier (e.g., "mark3t.dot").
+     * @param derivationIndex - Derivation index within the app scope. Default: 0
+     * @returns ResultAsync resolving to the account.
+     */
+    getProductAccount: (dotNsIdentifier: string, derivationIndex?: number) => ResultAsync<HostAccount, unknown>;
+    /**
+     * Get a signer for a product account.
+     *
+     * @param account - The product account.
+     * @returns A PolkadotSigner for signing transactions.
+     */
+    getProductAccountSigner: (account: ProductAccount) => polkadot_api.PolkadotSigner;
+    /**
+     * Get a contextual alias for a product account via Ring VRF.
+     *
+     * Aliases prove account membership in a ring without revealing which
+     * account produced the alias.
+     *
+     * @param dotNsIdentifier - App identifier.
+     * @param derivationIndex - Derivation index. Default: 0
+     * @returns ResultAsync resolving to the contextual alias.
+     */
+    getProductAccountAlias: (dotNsIdentifier: string, derivationIndex?: number) => ResultAsync<ContextualAlias, unknown>;
+    /**
+     * Create a Ring VRF proof for anonymous operations.
+     *
+     * Proves that the signer is a member of the ring at the given location
+     * without revealing which member.
+     *
+     * @param dotNsIdentifier - App identifier.
+     * @param derivationIndex - Derivation index.
+     * @param location - Ring location on-chain.
+     * @param message - Message to sign.
+     * @returns ResultAsync resolving to the proof bytes.
+     */
+    createRingVRFProof: (dotNsIdentifier: string, derivationIndex: number, location: unknown, message: Uint8Array) => ResultAsync<Uint8Array, unknown>;
+    /**
+     * Subscribe to account connection status changes.
+     *
+     * @param callback - Called with status string ("connected" | "disconnected").
+     * @returns Unsubscribe handle.
+     */
+    subscribeAccountConnectionStatus: (callback: (status: string) => void) => {
+        unsubscribe: () => void;
+    } | (() => void);
+}
+
+export { type AccountsProvider, BULLETIN_RPCS, type ContextualAlias, DEFAULT_BULLETIN_ENDPOINT, type HostAccount, type HostLocalStorage, type HostStatementStore, type PreimageManager, type ProductAccount, type ResultAsync, type StatementProof, type TruApi, getAccountsProvider, getHostLocalStorage, getHostProvider, getPreimageManager, getStatementStore, getTruApi, isInsideContainer, isInsideContainerSync };