@parity/product-sdk-host 0.13.0 → 0.14.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { JsonRpcProvider, PolkadotSigner } from 'polkadot-api';
-import { Topic, RemoteStatementStoreSubscribeItem, Statement, StatementProof, SignedStatement, HexString, GenericError, TrUApiClient, AllocatableResource, AllocationOutcome, HostGetUserIdError, HostRequestLoginResponse, HostRequestLoginError, ProductAccountId, ProductAccount as ProductAccount$1, HostAccountGetError, HostAccountGetAliasResponse, LegacyAccount, RingLocation, HostAccountCreateProofError, HostAccountConnectionStatusSubscribeItem, HostDevicePermissionRequest, RemotePermission, HostThemeSubscribeItem, ChatBotRegistrationStatus, HostChatCreateRoomRequest, ChatRoomRegistrationStatus, HostChatRegisterBotRequest, ChatMessageContent, ChatRoom, HostChatActionSubscribeItem, HostPaymentBalanceSubscribeItem, PaymentPurseId, Balance, PaymentTopUpSource, HostPaymentStatusSubscribeItem, HostPushNotificationRequest, NotificationId } from '@parity/truapi';
-export { AllocatableResource, AllocationOutcome, ChatMessageContent, ChatRoom, HexString, HostPaymentBalanceSubscribeItem, HostPaymentStatusSubscribeItem, NotificationId, PaymentTopUpSource, ProductAccountId, HostPushNotificationError as PushNotificationError, RemotePermission, RingLocation, SignedStatement, Statement, StatementProof, ThemeName, ThemeVariant, Topic } from '@parity/truapi';
+import { Topic, RemoteStatementStoreSubscribeItem, Statement, StatementProof, SignedStatement, HexString, scale, TrUApiClient, AllocatableResource, AllocationOutcome, VersionedHostGetUserIdError, HostRequestLoginResponse, VersionedHostRequestLoginError, ProductAccountId, ProductAccount as ProductAccount$1, VersionedHostAccountGetError, ProductProofContext, RingLocation, ContextualAlias as ContextualAlias$1, VersionedHostAccountGetAliasError, LegacyAccount, VersionedHostGetLegacyAccountsError, HostAccountCreateProofResponse, VersionedHostAccountCreateProofError, HostAccountConnectionStatusSubscribeItem, HostDevicePermissionRequest, RemotePermission, HostThemeSubscribeItem, ChatBotRegistrationStatus, HostChatCreateRoomRequest, ChatRoomRegistrationStatus, HostChatRegisterBotRequest, ChatMessageContent, ChatRoom, HostChatActionSubscribeItem, HostPaymentBalanceSubscribeItem, CoinPaymentPurseId, Balance, PaymentTopUpSource, HostPaymentStatusSubscribeItem, HostPushNotificationRequest, NotificationId } from '@parity/truapi';
+export { AllocatableResource, AllocationOutcome, ChatMessageContent, ChatRoom, HexString, HostPaymentBalanceSubscribeItem, HostPaymentStatusSubscribeItem, NotificationId, PaymentTopUpSource, ProductAccountId, ProductProofContext, HostPushNotificationError as PushNotificationError, RemotePermission, RingLocation, SignedStatement, Statement, StatementProof, ThemeName, ThemeVariant, Topic } from '@parity/truapi';
 import { SdkError } from '@parity/product-sdk-errors';
 export { SdkError, isSdkError } from '@parity/product-sdk-errors';
 import { Result } from '@parity/result';
@@ -156,13 +156,12 @@ declare function getStatementStore(): Promise<HostStatementStore | null>;
  * chain-specific endpoints used by multiple packages.
  */
 /**
- * Bulletin Chain RPC endpoints per network environment. `paseo` (Paseo Next v2),
- * `summit`, and `devnet` (public Paseo testnet) are populated today; `polkadot`
- * and `kusama` are reserved for when those Bulletin deployments go live.
+ * Bulletin Chain RPC endpoints per network environment. `paseo` (Paseo Next v2)
+ * and `devnet` (public Paseo testnet) are populated today; `polkadot` and
+ * `kusama` are reserved for when those Bulletin deployments go live.
  */
 declare const BULLETIN_RPCS: {
     readonly paseo: readonly ["wss://paseo-bulletin-next-rpc.polkadot.io"];
-    readonly summit: readonly ["wss://summit-bulletin-rpc.polkadot.io"];
     readonly devnet: readonly ["wss://bulletin-paseo.tservices.es:8443"];
     readonly polkadot: string[];
     readonly kusama: string[];
@@ -189,34 +188,25 @@ declare const DEFAULT_BULLETIN_ENDPOINT: string;
  */
 
 /**
- * The structured error payload `@parity/truapi` surfaces on the `Err` channel of
- * a host call, once unwrapped from the versioned wire envelope. Every host error
- * union is built from these:
- *
- * - the catch-all {@link GenericError} (`{ reason }`),
- * - a unit tagged variant (`{ tag }`), or
- * - a tagged variant carrying a reason (`{ tag, value: { reason } }`).
- *
- * `GenericError` is imported from `@parity/truapi`; the `{ tag }` members are a
- * deliberate widening of truapi's per-domain named variants (the formatter is
- * tag-agnostic). truapi has no umbrella error union to import today — once it
- * exports a canonical tagged-error union from codegen, replace these local
- * members with that import so the type is protocol-sourced rather than
- * hand-widened.
- *
- * This is the *payload* the host public API carries inside a
- * {@link HostCallFailedError} on the `err` channel of its `Result` returns — not
- * the error type consumers branch on.
+ * What a `Domain`-tagged call error carries. Widened from truapi's per-domain
+ * `Versioned*Error` types (all `{ tag: "V1", value: <domain error> }` today)
+ * so one payload type covers every call.
  */
-type HostErrorPayload = GenericError | {
-    tag: string;
-    value?: undefined;
-} | {
+type VersionedDomainError = {
     tag: string;
-    value: {
-        reason: string;
-    };
+    value?: unknown;
 };
+/**
+ * The error a host call puts on its `Err` channel — truapi's canonical
+ * {@link scale.CallErrorValue} envelope. `Denied` / `Unsupported` /
+ * `MalformedFrame` / `HostFailure` are transport-level failures; `Domain`
+ * wraps the actual per-domain error in a versioned envelope, which
+ * {@link formatHostError} digs through when rendering.
+ *
+ * This is the payload {@link HostCallFailedError} carries — not the error
+ * type consumers branch on.
+ */
+type HostErrorPayload = scale.CallErrorValue<VersionedDomainError>;
 /**
  * Extract a human-readable message from a host-side error.
  *
@@ -426,10 +416,24 @@ type ProductAccount = ProductAccountId & Omit<ProductAccount$1, "publicKey"> & {
  *
  * Proves account membership in a ring without revealing which account.
  *
- * Derived from `@parity/truapi`'s alias response, with both fields decoded to bytes.
+ * Derived from `@parity/truapi`'s `ContextualAlias`, with both fields decoded to bytes.
  */
 type ContextualAlias = {
-    [K in keyof HostAccountGetAliasResponse]: Uint8Array;
+    [K in keyof ContextualAlias$1]: Uint8Array;
+};
+/**
+ * A Ring VRF proof plus the values needed to verify it downstream (e.g.
+ * against a precompile): the alias it commits to, and the ring member index /
+ * revision the proof was generated against.
+ *
+ * Derived from `@parity/truapi`'s `HostAccountCreateProofResponse`, with the
+ * byte fields decoded.
+ */
+type RingVRFProof = Omit<HostAccountCreateProofResponse, "proof" | "contextualAlias"> & {
+    /** Raw ring VRF proof bytes. */
+    proof: Uint8Array;
+    /** Alias derived for the request's context. */
+    contextualAlias: ContextualAlias;
 };
 /**
  * Accounts provider handle, backed by `truApi.account.*` / `truApi.signing.*`.
@@ -437,17 +441,28 @@ type ContextualAlias = {
  * user identity, connection status, and `PolkadotSigner` factories.
  *
  * Lookup methods return a neverthrow `ResultAsync` (use `.match(ok, err)`);
- * the signer factories return a synchronous PAPI `PolkadotSigner`.
+ * the signer factories return a synchronous PAPI `PolkadotSigner`. The `err`
+ * channel carries truapi's canonical `CallErrorValue` envelope around the
+ * per-call versioned domain error, exactly as the generated client returns it.
  */
 interface AccountsProvider {
     getUserId(): ResultAsync$1<{
         primaryUsername: string;
-    }, HostGetUserIdError>;
-    requestLogin(reason?: string): ResultAsync$1<HostRequestLoginResponse, HostRequestLoginError>;
-    getProductAccount(dotNsIdentifier: string, derivationIndex?: number): ResultAsync$1<ProductAccount, HostAccountGetError>;
-    getProductAccountAlias(dotNsIdentifier: string, derivationIndex?: number): ResultAsync$1<ContextualAlias, HostAccountGetError>;
-    getLegacyAccounts(): ResultAsync$1<HostAccount[], HostAccountGetError>;
-    createRingVRFProof(dotNsIdentifier: string, derivationIndex: number, location: RingLocation, message: Uint8Array): ResultAsync$1<Uint8Array, HostAccountCreateProofError>;
+    }, scale.CallErrorValue<VersionedHostGetUserIdError>>;
+    requestLogin(reason?: string): ResultAsync$1<HostRequestLoginResponse, scale.CallErrorValue<VersionedHostRequestLoginError>>;
+    getProductAccount(dotNsIdentifier: string, derivationIndex?: number): ResultAsync$1<ProductAccount, scale.CallErrorValue<VersionedHostAccountGetError>>;
+    /**
+     * Derive the contextual alias for a proof context and ring. The host
+     * selects the member key within the ring — no per-account addressing.
+     */
+    getProductAccountAlias(context: ProductProofContext, location: RingLocation): ResultAsync$1<ContextualAlias, scale.CallErrorValue<VersionedHostAccountGetAliasError>>;
+    getLegacyAccounts(): ResultAsync$1<HostAccount[], scale.CallErrorValue<VersionedHostGetLegacyAccountsError>>;
+    /**
+     * Generate a Ring VRF proof binding `message` to the product-scoped
+     * `context`. The host selects the member key within the ring; the result
+     * carries the proof plus its verification values ({@link RingVRFProof}).
+     */
+    createRingVRFProof(context: ProductProofContext, location: RingLocation, message: Uint8Array): ResultAsync$1<RingVRFProof, scale.CallErrorValue<VersionedHostAccountCreateProofError>>;
     /**
      * Build a `PolkadotSigner` for a product account. Signing routes through the
      * host's `createTransaction` path: the host decodes the metadata and forwards
@@ -669,9 +684,10 @@ declare function getChatManager(): Promise<ChatManager | null>;
  * `truApi.payment.*`.
  *
  * Exposes balance subscription, top-up, payment requests, and payment-status
- * subscription. Distinct from the CoinPayment / merchant-payments surface
- * (RFC-0017): RFC-0006 is the user-initiated balance / top-up / payment-request
- * flow.
+ * subscription. The flow is distinct from the CoinPayment / merchant-payments
+ * surface (RFC-0017) — RFC-0006 is the user-initiated balance / top-up /
+ * payment-request flow — but both operate on the same CoinPayment purses,
+ * hence the shared `CoinPaymentPurseId` (omitted = the main purse).
  *
  * @module
  */
@@ -685,9 +701,9 @@ declare function getChatManager(): Promise<ChatManager | null>;
  * `PaymentTopUpSource` — used directly rather than re-aliased.
  */
 interface PaymentManager {
-    subscribeBalance(callback: (balance: HostPaymentBalanceSubscribeItem) => void, purse?: PaymentPurseId): HostSubscription;
-    topUp(amount: Balance, source: PaymentTopUpSource, into?: PaymentPurseId): Promise<void>;
-    requestPayment(amount: Balance, destination: HexString, from?: PaymentPurseId): Promise<{
+    subscribeBalance(callback: (balance: HostPaymentBalanceSubscribeItem) => void, purse?: CoinPaymentPurseId): HostSubscription;
+    topUp(amount: Balance, source: PaymentTopUpSource, into?: CoinPaymentPurseId): Promise<void>;
+    requestPayment(amount: Balance, destination: HexString, from?: CoinPaymentPurseId): Promise<{
         id: string;
     }>;
     subscribePaymentStatus(paymentId: string, callback: (status: HostPaymentStatusSubscribeItem) => void): HostSubscription;
@@ -998,4 +1014,4 @@ declare function broadcastTransaction(genesisHash: HexString, transaction: HexSt
  */
 declare function stopTransaction(genesisHash: HexString, operationId: string): Promise<Result<void, HostError>>;
 
-export { type AccountsProvider, BULLETIN_RPCS, ChainNotSupportedError, type ChainProperties, type ChainSpec, type ChatBotRegistrationResult, type ChatManager, type ChatReceivedAction, type ChatRoomRegistrationResult, type ContextualAlias, DEFAULT_BULLETIN_ENDPOINT, type DevicePermissionKind, type Feature, type HostAccount, HostCallFailedError, HostError, type HostErrorPayload, type HostLocalStorage, type HostStatementStore, type HostSubscription, HostUnavailableError, type NotificationManager, type PaymentManager, type PreimageManager, type ProductAccount, type PushNotificationInput, type RemotePermissionItem, type ResultAsync, type StatementTopicFilter, type StatementsPage, type ThemeMode, type ThemeProvider, type TruApi, broadcastTransaction, createHostLocalStorage, createHostPreimageManager, createProofAuthorized, deriveEntropy, featureSupported, formatHostError, fromHex, getAccountsProvider, getChainSpec, getChatManager, getHostLocalStorage, getHostProvider, getNotificationManager, getPaymentManager, getPreimageManager, getStatementStore, getThemeProvider, getTruApi, isChainSupported, isHostError, isInsideContainer, navigateTo, requestDevicePermission, requestPermission, requestResourceAllocation, stopTransaction, toHex };
+export { type AccountsProvider, BULLETIN_RPCS, ChainNotSupportedError, type ChainProperties, type ChainSpec, type ChatBotRegistrationResult, type ChatManager, type ChatReceivedAction, type ChatRoomRegistrationResult, type ContextualAlias, DEFAULT_BULLETIN_ENDPOINT, type DevicePermissionKind, type Feature, type HostAccount, HostCallFailedError, HostError, type HostErrorPayload, type HostLocalStorage, type HostStatementStore, type HostSubscription, HostUnavailableError, type NotificationManager, type PaymentManager, type PreimageManager, type ProductAccount, type PushNotificationInput, type RemotePermissionItem, type ResultAsync, type RingVRFProof, type StatementTopicFilter, type StatementsPage, type ThemeMode, type ThemeProvider, type TruApi, broadcastTransaction, createHostLocalStorage, createHostPreimageManager, createProofAuthorized, deriveEntropy, featureSupported, formatHostError, fromHex, getAccountsProvider, getChainSpec, getChatManager, getHostLocalStorage, getHostProvider, getNotificationManager, getPaymentManager, getPreimageManager, getStatementStore, getThemeProvider, getTruApi, isChainSupported, isHostError, isInsideContainer, navigateTo, requestDevicePermission, requestPermission, requestResourceAllocation, stopTransaction, toHex };

package/dist/index.js

@@ -9,21 +9,25 @@ import { unifyMetadata, decAnyMetadata } from '@polkadot-api/substrate-bindings'
 import { AccountId } from 'polkadot-api';
 
 // src/errors.ts
-function isHostErrorPayload(error) {
-  if (error == null || typeof error !== "object") return false;
-  const obj = error;
-  return typeof obj.reason === "string" || typeof obj.tag === "string";
+function isTagged(value) {
+  return value != null && typeof value === "object" && typeof value.tag === "string";
+}
+function hasReason(value) {
+  return value != null && typeof value === "object" && typeof value.reason === "string";
 }
 function formatHostError(error) {
   if (error instanceof Error) return error.message;
   if (typeof error === "string") return error;
-  if (isHostErrorPayload(error)) {
-    if ("tag" in error) {
-      if (error.value != null && typeof error.value.reason === "string") {
-        return `${error.tag}: ${error.value.reason}`;
-      }
-      return error.tag;
+  if (isTagged(error)) {
+    if (error.tag === "Domain" && isTagged(error.value) && error.value.value !== void 0) {
+      return formatHostError(error.value.value);
+    }
+    if (hasReason(error.value)) {
+      return `${error.tag}: ${error.value.reason}`;
     }
+    return error.tag;
+  }
+  if (hasReason(error)) {
     return error.reason;
   }
   if (error != null && typeof error === "object" && "message" in error) {
@@ -552,7 +556,6 @@ async function getStatementStore() {
 // src/chains.ts
 var BULLETIN_RPCS = {
   paseo: ["wss://paseo-bulletin-next-rpc.polkadot.io"],
-  summit: ["wss://summit-bulletin-rpc.polkadot.io"],
   devnet: ["wss://bulletin-paseo.tservices.es:8443"],
   polkadot: [],
   kusama: []
@@ -593,8 +596,8 @@ function adaptAccountsProvider(client) {
         derivationIndex
       }));
     },
-    getProductAccountAlias(dotNsIdentifier, derivationIndex = 0) {
-      return account.getAccountAlias({ productAccountId: { dotNsIdentifier, derivationIndex } }).map((response) => ({
+    getProductAccountAlias(context, location) {
+      return account.getAccountAlias({ context, ringLocation: location }).map((response) => ({
         context: fromHex(response.context),
         alias: fromHex(response.alias)
       }));
@@ -607,12 +610,20 @@ function adaptAccountsProvider(client) {
         }))
       );
     },
-    createRingVRFProof(dotNsIdentifier, derivationIndex, location, message) {
+    createRingVRFProof(context, location, message) {
       return account.createAccountProof({
-        productAccountId: { dotNsIdentifier, derivationIndex },
+        context,
         ringLocation: location,
-        context: toHex(message)
-      }).map((response) => fromHex(response.proof));
+        message: toHex(message)
+      }).map((response) => ({
+        proof: fromHex(response.proof),
+        contextualAlias: {
+          context: fromHex(response.contextualAlias.context),
+          alias: fromHex(response.contextualAlias.alias)
+        },
+        ringIndex: response.ringIndex,
+        ringRevision: response.ringRevision
+      }));
     },
     getProductAccountSigner(account_) {
       const productAccountId = {