@parity/product-sdk-signer 0.1.0 → 0.2.0

package/src/index.ts

@@ -1,3 +1,15 @@
+/**
+ * @parity/product-sdk-signer — Account connection and signing, decoupled from where the keys actually live.
+ *
+ * `SignerManager` wraps one or more `SignerProvider` implementations behind a
+ * `Result`-typed API for connecting, listing accounts, and reacting to status or
+ * account changes. The two built-in providers — `HostProvider` (Polkadot
+ * Desktop/Mobile) and `DevProvider` (the well-known Alice/Bob accounts) — let
+ * the same call sites work in production and in tests.
+ *
+ * @packageDocumentation
+ */
+
 // Core manager
 export { SignerManager } from "./signer-manager.js";
 

package/src/providers/dev.ts

@@ -14,6 +14,7 @@ const DEV_PHRASE = "bottom drive obey lake curtain smoke basket hold race lonely
 /** Standard Substrate dev account names. */
 const DEFAULT_DEV_NAMES = ["Alice", "Bob", "Charlie", "Dave", "Eve", "Ferdie"] as const;
 
+/** A well-known Substrate development account name (Alice, Bob, …) used to derive deterministic dev accounts from the standard Substrate dev mnemonic. */
 export type DevAccountName = (typeof DEFAULT_DEV_NAMES)[number];
 
 /** Supported key types for dev account derivation. */

package/src/providers/host.ts

@@ -97,8 +97,8 @@ interface NeverthrowResultAsync<T, E> {
 
 /** @internal */
 export interface AccountsProvider {
-    getNonProductAccounts: () => NeverthrowResultAsync<RawAccount[], unknown>;
-    getNonProductAccountSigner: (account: ProductAccount) => import("polkadot-api").PolkadotSigner;
+    getLegacyAccounts: () => NeverthrowResultAsync<RawAccount[], unknown>;
+    getLegacyAccountSigner: (account: ProductAccount) => import("polkadot-api").PolkadotSigner;
     getProductAccount: (
         dotNsIdentifier: string,
         derivationIndex?: number,
@@ -404,7 +404,7 @@ export class HostProvider implements SignerProvider {
         // Step 3: Fetch non-product accounts
         let rawAccounts: RawAccount[];
         try {
-            rawAccounts = (await provider.getNonProductAccounts().match(
+            rawAccounts = (await provider.getLegacyAccounts().match(
                 (accounts) => accounts,
                 (error) => {
                     throw new Error(`Host rejected account request: ${formatError(error)}`);
@@ -487,7 +487,7 @@ export class HostProvider implements SignerProvider {
                     if (!this.accountsProvider) {
                         throw new Error("Host provider is disconnected");
                     }
-                    return this.accountsProvider.getNonProductAccountSigner({
+                    return this.accountsProvider.getLegacyAccountSigner({
                         dotNsIdentifier: "",
                         derivationIndex: 0,
                         publicKey: raw.publicKey,
@@ -527,7 +527,7 @@ if (import.meta.vitest) {
         } as unknown as import("polkadot-api").PolkadotSigner;
 
         return {
-            getNonProductAccounts: vi.fn().mockReturnValue({
+            getLegacyAccounts: vi.fn().mockReturnValue({
                 match: async (
                     onOk: (v: RawAccountTest[]) => unknown,
                     onErr: (e: unknown) => unknown,
@@ -538,7 +538,7 @@ if (import.meta.vitest) {
                     return onOk(accounts);
                 },
             }),
-            getNonProductAccountSigner: vi.fn().mockReturnValue(mockSigner),
+            getLegacyAccountSigner: vi.fn().mockReturnValue(mockSigner),
             getProductAccount: vi.fn().mockReturnValue({
                 match: async (
                     onOk: (v: RawAccountTest) => unknown,
@@ -622,7 +622,7 @@ if (import.meta.vitest) {
             }
         });
 
-        test("returns HOST_REJECTED when getNonProductAccounts fails", async () => {
+        test("returns HOST_REJECTED when getLegacyAccounts fails", async () => {
             const mockProvider = createMockProvider({ shouldReject: true, error: "Rejected" });
             const provider = new HostProvider({
                 maxRetries: 1,