@silencelaboratories/walletprovider-sdk 4.0.0-hackaton → 4.0.1-hackathon

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.55.1"
+    }
+  ]
+}

package/dist/validator.d.ts

@@ -0,0 +1,6 @@
+import { SignAlgorithm } from './ephemeralAuthentication';
+export declare const throwIfInvalidString: (key: string, value: string) => void;
+export declare const throwIfInvalidEphPK: (ephKey: Uint8Array, signAlg: SignAlgorithm) => void;
+export declare const throwIfInvalidEphSK: (ephKey: Uint8Array, signAlg: SignAlgorithm) => void;
+export declare const throwIfInvalidSignAlg: (signAlg: SignAlgorithm) => void;
+export declare const throwIf: (condition: boolean, message: string) => void;

package/dist/walletProviderServiceClient.d.ts

@@ -0,0 +1,43 @@
+import { AuthModule, DkgAuthModule } from './authentication';
+import { type KeygenResponse, type SignResponse, type OperationStatusResponse, type RegisterPasskeyResponse } from './networkSigner';
+import { MetadataSetupOpts, KeygenSetupOpts, SignSetupOpts } from './setupMessage';
+import { ApiVersion, type ClientConfig, IWalletProviderServiceClient, QueryPath } from './walletProviderServiceClientInterface';
+/**
+ * The Websocket client to the Wallet Provider backend service.
+ * All requests are relayed by this entity to the MPC network.
+ * @alpha
+ */
+export declare class WalletProviderServiceClient implements IWalletProviderServiceClient {
+    walletProviderId: string;
+    walletProviderUrl: string;
+    apiVersion: ApiVersion;
+    /**
+     * Create new client that connects to the backend service
+     * @param config - config containing information about backend service
+     */
+    constructor(config: ClientConfig);
+    getVersion(): ApiVersion;
+    getWalletId(): string;
+    startKeygen({ setups, authModule, }: {
+        setups: KeygenSetupOpts[];
+        authModule: DkgAuthModule;
+    }): Promise<KeygenResponse[]>;
+    startSigngen({ setup, authModule }: {
+        setup: SignSetupOpts;
+        authModule: AuthModule;
+    }): Promise<SignResponse>;
+    addEphemeralKey({ setup, authModule, }: {
+        setup: MetadataSetupOpts;
+        authModule: DkgAuthModule;
+    }): Promise<OperationStatusResponse>;
+    revokeEphemeralKey({ setup, authModule, }: {
+        setup: MetadataSetupOpts;
+        authModule: AuthModule;
+    }): Promise<OperationStatusResponse>;
+    registerPasskey({ setup, authModule, }: {
+        setup: MetadataSetupOpts;
+        authModule: AuthModule;
+    }): Promise<RegisterPasskeyResponse>;
+    connect(path: QueryPath, setupOpts: KeygenSetupOpts[] | SignSetupOpts | MetadataSetupOpts, authModule: AuthModule): Promise<string>;
+    connectV2(path: QueryPath, setupOpts: KeygenSetupOpts[] | SignSetupOpts | MetadataSetupOpts, authModule: AuthModule): Promise<string>;
+}

package/dist/walletProviderServiceClientInterface.d.ts

@@ -0,0 +1,59 @@
+import { AuthModule, UserAuthentication } from './authentication';
+import { KeygenResponse, SignResponse, OperationStatusResponse, RegisterPasskeyResponse } from './networkSigner';
+import { MetadataSetupOpts, KeygenSetupOpts, SignSetupOpts } from './setupMessage';
+/**
+ * The config used to create Wallet Provider Service backend client.
+ * Please refer to {@link https://shipyard.rs/silencelaboratories/crates/wallet-provider-service | example backend service}
+ * implementation for requirements that the backend service must fulfill.
+ * @alpha
+ */
+export type ClientConfig = {
+    /**
+     * The version of the API used to connect to the service
+     */
+    apiVersion: ApiVersion;
+    /**
+     * The id of the Wallet Provider Service
+     * @alpha
+     */
+    walletProviderId: string;
+    /**
+     * The URL used to connect to the service
+     * @alpha
+     */
+    walletProviderUrl: string;
+};
+/**
+ * The API version of the Wallet Provider Service
+ * @public
+ */
+export type ApiVersion = 'v1' | 'v2';
+export type Signer = (challenge: string) => Promise<UserAuthentication>;
+/** Interface for client of  Wallet Provider Service
+ * @alpha
+ */
+export interface IWalletProviderServiceClient {
+    getWalletId(): string;
+    getVersion(): ApiVersion;
+    startKeygen({ setups, authModule }: {
+        setups: KeygenSetupOpts[];
+        authModule: AuthModule;
+    }): Promise<KeygenResponse[]>;
+    startSigngen({ setup, authModule }: {
+        setup: SignSetupOpts;
+        authModule: AuthModule;
+    }): Promise<SignResponse>;
+    addEphemeralKey({ setup, authModule, }: {
+        setup: MetadataSetupOpts;
+        authModule: AuthModule;
+    }): Promise<OperationStatusResponse>;
+    revokeEphemeralKey({ setup, authModule, }: {
+        setup: MetadataSetupOpts;
+        authModule: AuthModule;
+    }): Promise<OperationStatusResponse>;
+    registerPasskey({ setup, authModule, }: {
+        setup: MetadataSetupOpts;
+        authModule: AuthModule;
+    }): Promise<RegisterPasskeyResponse>;
+}
+export type QueryPath = 'signgen' | 'keygen' | 'addEphemeralKey' | 'revokeEphemeralKey' | 'registerPasskey';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@silencelaboratories/walletprovider-sdk",
-  "version": "4.0.0-hackaton",
+  "version": "4.0.1-hackathon",
   "author": "Silence Laboratories",
   "description": "Frontend SDK for Wallet Providers",
   "main": "./dist/index.cjs.js",