@silencelaboratories/walletprovider-sdk 1.3.0 → 1.5.0

package/dist/utils/encoder.d.ts

@@ -0,0 +1,7 @@
+export declare const arrayBufferToBase64Url: (a: ArrayBuffer) => string;
+/**
+ *
+ * @param serialized MUST be in canonicalized JSON format
+ * @returns
+ */
+export declare const calculateFinalChallenge: (serialized: string) => string;

package/dist/utils/validator.d.ts

@@ -0,0 +1,9 @@
+import { AuthMethod, AuthPayload } from './../auth/authentication';
+import { EphKeySignAlgorithm } from '../auth/ephemeralAuthentication';
+import { MPCSignAlgorithm } from '../client/networkSigner';
+export declare const throwIfInvalidString: (key: string, value: string) => void;
+export declare const throwIfInvalidEphPK: (ephKey: Uint8Array, signAlg: EphKeySignAlgorithm) => void;
+export declare const throwIfInvalidEphSK: (ephKey: Uint8Array, signAlg: EphKeySignAlgorithm) => void;
+export declare const throwIfInvalidMPCSignAlg: (signAlg: MPCSignAlgorithm) => void;
+export declare const throwIf: (condition: boolean, message: string) => void;
+export declare const throwIfInvalidAuthPayloadType: (payload: AuthPayload, expected_types: any[], authMethod: AuthMethod) => void;

package/dist/viemSigner.d.ts

@@ -1,15 +1,24 @@
 import { LocalAccount } from 'viem/accounts';
-import { NetworkSigner } from './networkSigner';
+import { MPCSignAlgorithm, NetworkSigner } from './client/networkSigner';
 import { Address } from 'viem';
+/**
+ * Options for creating a distributed signing request for signing transactions using Silent Network.
+ * @public
+ */
+export interface DSGOpts {
+    threshold: number;
+    keyId: string;
+    signAlg: MPCSignAlgorithm;
+}
 /**
  * Create a new viem custom account for signing transactions using
  * the MPC network.
- * @param clusterConfig The network cluster configuration.
+ * @param networkSigner API to communicate with the Silent MPC Network.
  * @param keyId The selected Key ID.
  * @param publicKey Associated public key of the selected Key ID.
- * @param threshold The threshold.
+ * @param signAlg The signature algorithm for signing (default: secp256k1).
  */
-export declare function createViemAccount(networkSigner: NetworkSigner, keyId: string, publicKey: string): LocalAccount;
+export declare function createViemAccount(networkSigner: NetworkSigner, publicKey: string, dsgOpts: DSGOpts): LocalAccount;
 /** Computes ETH address from ECDSA `publicKey` returned by Silent Network
  * @public
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@silencelaboratories/walletprovider-sdk",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "author": "Silence Laboratories",
   "description": "Frontend SDK for Wallet Providers",
   "main": "./dist/index.cjs.js",
@@ -16,12 +16,13 @@
   "files": [
     "dist"
   ],
+  "type": "module",
   "scripts": {
     "format": "prettier --write --cache .",
     "formatcheck": "prettier --check --cache .",
     "lint": "eslint --cache ./src/**/*.ts",
     "typecheck": "tsc -p . --noEmit",
-    "test": "vitest",
+    "test": "vitest run",
     "build": "node build.js && npm run build:declaration",
     "build:declaration": "tsc -p . --emitDeclarationOnly",
     "clean": "rimraf dist",
@@ -29,6 +30,7 @@
     "docs": "npm run build:declaration && api-extractor run --local --verbose && api-documenter  markdown -i ./temp -o ./docs"
   },
   "devDependencies": {
+    "@commitlint/config-conventional": "^12.1.1",
     "@eslint/js": "9.14.0",
     "@microsoft/api-documenter": "^7.25.2",
     "@microsoft/api-extractor": "^7.46.2",
@@ -43,11 +45,12 @@
     "rimraf": "^6.0.1",
     "typescript": "5.6.3",
     "typescript-eslint": "8.13.0",
-    "vitest": "^2.1.5"
+    "vitest": "^2.1.8"
   },
   "dependencies": {
     "@noble/curves": "^1.6.0",
     "js-base64": "^3.7.7",
+    "json-canonicalize": "^1.0.6",
     "viem": "2.21.54"
   }
 }

package/dist/encoding.d.ts

@@ -1,4 +0,0 @@
-export declare const decodeBase64: (b64: string) => Uint8Array;
-export declare const encodeBase64: (b: Uint8Array) => string;
-export declare const arrayBufferToBase64Url: (a: ArrayBuffer) => string;
-export declare const calculateFinalChallenge: (setupOpts: string) => string;

package/dist/ephemeralAuthentication.d.ts

@@ -1,44 +0,0 @@
-import { UserAuthentication } from './authentication';
-import { SignSetupOpts } from './setupMessage';
-/**
- * Supported signature algorithms for ephemeral key
- * @alpha
- */
-export type SignAlgorithm = 'ed25519' | 'secp256k1';
-/** The `EphKeyClaim` object represents the public claim of the ephemeral key.
- * @alpha
- */
-export declare class EphKeyClaim {
-    ephId: string;
-    ephPK: string;
-    signAlg: SignAlgorithm;
-    expiry: number;
-    /**
-     *
-     * @param ephId - Ephemeral key ID
-     * @param ephPK - Ephemeral public key
-     * @param signAlg - Signature algorithm.
-     * @param lifetime - Lifetime of the ephemeral key. Default is 1 hour
-     */
-    constructor(ephId: string, ephPK: Uint8Array, signAlg: SignAlgorithm, lifetime?: number);
-    private validateInputs;
-    toJSON(): string;
-}
-/** Locally sign the signature requests to network without asking the user, the ephSK is registered during keygen.
- * The signature is the authorization for signgen operation
- */
-export declare function authenticateUsingEphKey({ setup, challenge, ephSK, ephClaim, }: {
-    setup: SignSetupOpts;
-    challenge: string;
-    ephSK: Uint8Array;
-    ephClaim: EphKeyClaim;
-}): Promise<UserAuthentication>;
-export declare function genHexSignature(msg: Uint8Array, ephSK: Uint8Array, signAlg: SignAlgorithm): Promise<string>;
-/** Generate Ephemeral `privateKey`
- * @public
- */
-export declare function generateEphPrivateKey(algSign: SignAlgorithm): Uint8Array;
-/** Derive Ephemeral `publicKey` from `privateKey` returned from `generateEphPrivateKey`
- * @public
- */
-export declare function getEphPublicKey(ephSK: Uint8Array, algSign: SignAlgorithm): Uint8Array;

package/dist/networkSigner.d.ts

@@ -1,117 +0,0 @@
-import { AuthModule } from './authentication';
-import { type IWalletProviderServiceClient } from './walletProviderServiceClientInterface';
-/**
- * Response from the network for keygen requests
- * @alpha
- */
-export interface KeygenResponse {
-    /**
-     * Unique ID of produced key used in subsequent API calls.
-     */
-    keyId: string;
-    /**
-     * Public key encoded with SEC1 format.
-     *
-     * If point is uncompressed it's in a form of 0x04 || X || Y
-     *
-     * If point is compressed it's in a form Y || X,
-     *
-     * where Y is set to 0x02 if Y-coord is even, or 0x03 if Y-coord is odd
-     */
-    publicKey: string;
-}
-/**
- * Response from the network for sign request
- * @alpha
- */
-export interface SignResponse {
-    /**
-     * Hexstring of length 128 bytes, in a form: r || s
-     */
-    sign: string;
-    /**
-     * Recovery id, either 0, or 1
-     */
-    recid: number;
-}
-/**
- * Response from the network for adding ephemeral key request
- * @alpha
- */
-export interface OperationStatusResponse {
-    /**
-     * Status of the request.
-     */
-    status: string;
-}
-/**
- * Response from the network for registering passkey request
- * @alpha
- */
-export interface RegisterPasskeyResponse {
-    /**
-     * The registered passkey credential id. This helps both the user and the network to identify the passkey.
-     * @alpha
-     */
-    passkeyCredentialId: string;
-}
-/** The networkSigner contains an API to communicate with the Silent MPC Network. Call to sign and keygen require
- * the Auth module, that is used to prompt the User before executing the request.
- * @alpha
- */
-export declare class NetworkSigner {
-    /** Authentication module, used to get confirmation from the User before request execution */
-    authModule: AuthModule;
-    /** Number of nodes that needs to participate in protocol in order to generate valid signature. Also known as `t`. */
-    threshold: number;
-    /** Number of nodes that participate in keygen operation. Also known as `n`. */
-    totalNodes: number;
-    /** Wallet Provider backend client */
-    wpClient: IWalletProviderServiceClient;
-    /**
-     * Facade class used to execute operations on Silent Network.
-     * @param wpClient - Wallet Provider backend client
-     * @param threshold - Number of nodes that needs to participate in protocol in order to generate valid signature. Also known as `t`.
-     * @param totalNodes - Number of nodes that participate in keygen operation. Also known as `n`.
-     * @param authModule - Authentication module, used to get confirmation from the User before request execution
-     */
-    constructor(wpClient: IWalletProviderServiceClient, threshold: number, totalNodes: number, authModule: AuthModule);
-    /** Generate a distributed key that's generated by Silent Network.
-     * Uses `authModule` to authenticate the User with the Silent Network.
-     * @param permissions - optional permissions that will be stored in the key metadata.
-     * The permissions are validated during sign requests.
-     * @returns {@link KeygenResponse} containing `keyId` and the `pubKey` public part of the key
-     * @public
-     */
-    generateKey(permissions?: string): Promise<KeygenResponse>;
-    /** Generate a signature by the distributed key of Silent Network.
-     * Uses `authModule` to authenticate the sign request by the User.
-     * The network chooses `t` nodes to execute the protocol.
-     * @param keyId - the key id returned from `keygen`
-     * @param message - the message to sign by the MPC network
-     * @returns {@link SignResponse}
-     * @public
-     */
-    signMessage(keyId: string, message: string): Promise<SignResponse>;
-    /** Add new ephemeral key to an exist distributed key on the network.
-     * Uses `authModule` to authenticate the request by the User.
-     * @param keyId - the key id returned from `keygen`
-     * @returns {@link OperationStatusResponse}
-     * @public
-     */
-    addEphemeralKey(keyId: string): Promise<OperationStatusResponse>;
-    /** Revoke ephemeral key of an exist distributed key on the network.
-     * Uses `authModule` to authenticate the request by the User.
-     * @param keyId - the key id returned from `keygen`
-     * @returns {@link OperationStatusResponse}
-     * @public
-     */
-    revokeEphemeralKey(keyId: string): Promise<OperationStatusResponse>;
-    /** Register new user's passkey on the network. This will try to register to all the available nodes on the network.
-     * Uses `authModule` to authenticate the request by the User.
-     * @returns {@link RegisterPasskeyResponse}
-     * @public
-     */
-    registerPasskey(): Promise<RegisterPasskeyResponse>;
-    private setEphClaimOf;
-}

package/dist/validator.d.ts

@@ -1,6 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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({ setup, authModule, }: {
-        setup: 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

@@ -1,59 +0,0 @@
-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({ setup, authModule }: {
-        setup: 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';