@silencelaboratories/walletprovider-sdk 0.3.0 → 0.4.1

package/dist/utils/encoder.d.ts

@@ -0,0 +1,2 @@
+export declare const arrayBufferToBase64Url: (a: ArrayBuffer) => string;
+export declare const calculateFinalChallenge: (setupOpts: string) => string;

package/dist/utils/validator.d.ts

@@ -0,0 +1,6 @@
+import { SignAlgorithm } from '../auth/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/viemSigner.d.ts

@@ -1,15 +1,15 @@
 import { LocalAccount } from 'viem/accounts';
-import { NetworkSigner } from './networkSigner';
+import { NetworkSigner } from './client/networkSigner';
 import { Address } from 'viem';
 /**
  * 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, keyId: string, publicKey: string, signAlg?: string): LocalAccount;
 /** Computes ETH address from ECDSA `publicKey` returned by Silent Network
  * @public
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@silencelaboratories/walletprovider-sdk",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "author": "Silence Laboratories",
   "description": "Frontend SDK for Wallet Providers",
   "main": "./dist/index.cjs.js",
@@ -16,11 +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",
     "build": "node build.js && npm run build:declaration",
     "build:declaration": "tsc -p . --emitDeclarationOnly",
     "clean": "rimraf dist",
@@ -28,24 +30,26 @@
     "docs": "npm run build:declaration && api-extractor run --local --verbose && api-documenter  markdown -i ./temp -o ./docs"
   },
   "devDependencies": {
-    "@eslint/js": "^9.3.0",
+    "@eslint/js": "9.14.0",
     "@microsoft/api-documenter": "^7.25.2",
     "@microsoft/api-extractor": "^7.46.2",
     "@types/eslint-plugin-security": "^3.0.0",
     "esbuild": "0.24.0",
     "esbuild-node-externals": "^1.15.0",
-    "eslint": "^8.x",
+    "eslint": "9.14.0",
     "eslint-plugin-security": "^3.0.1",
     "globals": "^15.3.0",
     "npm-dts": "^1.3.13",
-    "prettier": "^3.2.5",
+    "prettier": "3.3.3",
     "rimraf": "^6.0.1",
     "typescript": "5.6.3",
-    "typescript-eslint": "^7.11.0"
+    "typescript-eslint": "8.13.0",
+    "vitest": "^2.1.8",
+    "@commitlint/config-conventional": "^12.1.1"
   },
   "dependencies": {
     "@noble/curves": "^1.6.0",
     "js-base64": "^3.7.7",
-    "viem": "2.21.32"
+    "viem": "2.21.54"
   }
 }

package/dist/encoding.d.ts

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

package/dist/ephemeralAuthentication.d.ts

@@ -1,21 +0,0 @@
-import { UserAuthentication } from './authentication';
-import { SignSetupOpts } from './networkSigner';
-export declare class EphClaim {
-    ephId: string;
-    ephPK: string;
-    expiry: number;
-    constructor(ephId: string, ephPK: Uint8Array, 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: EphClaim;
-}): Promise<UserAuthentication>;
-export declare function generateEphPrivateKey(): Uint8Array;
-export declare function getEphPublicKey(ephSK: Uint8Array): Uint8Array;

package/dist/networkSigner.d.ts

@@ -1,182 +0,0 @@
-import { AuthModule, UserAuthentication } from './authentication';
-import { GetQueryPath, QueryPath, type IWalletProviderServiceClient } from './walletProviderServiceClientInterface';
-import { EphClaim } from './ephemeralAuthentication';
-/**
- * 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;
-    /**
-     * Optional credential id used for passkey authentication.
-     *
-     * Returned by Authenticator.
-     */
-    passkeyCredentialId?: 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 AddEphemeralKeyResponse {
-    status: string;
-}
-/** Key parameters used during generation  */
-export declare class KeygenSetupOpts implements GetQueryPath {
-    /** Threshold, number of parties that needs to participate in a protocol in order to produce valid signature */
-    t: number;
-    /** Total number of nodes that participate in Key generation, must be greater or equal than `t` */
-    n: number;
-    /** Optional key label */
-    key_label?: string;
-    /** Metadata for a key. Currently they store the permissions, can be set in a constructor of this class.
-      If permissions are not set, all operations are allowed.
-     */
-    private metadata;
-    constructor({ t, n, key_label, permissions, }: {
-        t: number;
-        n: number;
-        key_label: string | undefined;
-        permissions: string | undefined;
-    });
-    set ephClaim(ephClaim: EphClaim);
-    get queryPath(): QueryPath;
-    get requestSchema(): {
-        Request: {
-            name: string;
-            type: string;
-        }[];
-        KeygenSetupOpts: {
-            name: string;
-            type: string;
-        }[];
-        TaggedValue: {
-            name: string;
-            type: string;
-        }[];
-    };
-}
-/** Parameters used in Signature execution */
-export declare class SignSetupOpts implements GetQueryPath {
-    /** Number of nodes that will participate in the signature execution */
-    t: number;
-    /** Select the key using it's ID */
-    key_id: string;
-    /** The message to sign */
-    message: string;
-    constructor({ t, key_id, message }: {
-        t: number;
-        key_id: string;
-        message: string;
-    });
-    get queryPath(): QueryPath;
-}
-export declare class AddEphemeralKeyOpts implements GetQueryPath {
-    /** Total number of nodes that participate in Adding Ephemeral Key */
-    n: number;
-    /** Select the key using it's ID */
-    key_id: string;
-    /** Metadata for a key. Currently they store the permissions, can be set in a constructor of this class.
-      If permissions are not set, all operations are allowed.
-     */
-    private metadata;
-    constructor({ n, key_id }: {
-        n: number;
-        key_id: string;
-    });
-    set ephClaim(ephClaim: EphClaim);
-    get queryPath(): QueryPath;
-    get requestSchema(): {
-        Request: {
-            name: string;
-            type: string;
-        }[];
-        AddEphemeralKeyOpts: {
-            name: string;
-            type: string;
-        }[];
-        TaggedValue: {
-            name: string;
-            type: string;
-        }[];
-    };
-}
-/** The `user_authentication` contains signature over the `setup` parameter. */
-export type UserAuthenticatedRequest<T> = {
-    setup: T;
-    user_authentication: UserAuthentication;
-};
-/** 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 */
-    wp_client: 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 AddEphemeralKeyResponse}
-     * @public
-     */
-    addEphemeralKey(keyId: string): Promise<AddEphemeralKeyResponse>;
-    private setEphClaimOf;
-}

package/dist/validator.d.ts

@@ -1,3 +0,0 @@
-export declare const throwIfInvalidString: (key: string, value: string) => void;
-export declare const throwIfInvalidEphKey: (ephKey: Uint8Array) => void;
-export declare const throwIf: (condition: boolean, message: string) => void;

package/dist/walletProviderServiceClient.d.ts

@@ -1,32 +0,0 @@
-import { AuthModule } from './authentication';
-import { type KeygenSetupOpts, type KeygenResponse, type SignSetupOpts, type SignResponse, AddEphemeralKeyOpts, AddEphemeralKeyResponse } from './networkSigner';
-import { type ClientConfig, IWalletProviderServiceClient } 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;
-    passkeyCredentialId?: string;
-    /**
-     * Create new client that connects to the backend service
-     * @param config - config containing information about backend service
-     */
-    constructor(config: ClientConfig);
-    getWalletId(): string;
-    startKeygen({ setup, authModule, }: {
-        setup: KeygenSetupOpts;
-        authModule: AuthModule;
-    }): Promise<KeygenResponse>;
-    startSigngen({ setup, authModule }: {
-        setup: SignSetupOpts;
-        authModule: AuthModule;
-    }): Promise<SignResponse>;
-    addEphemeralKey({ setup, authModule, }: {
-        setup: AddEphemeralKeyOpts;
-        authModule: AuthModule;
-    }): Promise<AddEphemeralKeyResponse>;
-    connect(setupOpts: KeygenSetupOpts | SignSetupOpts | AddEphemeralKeyOpts, authModule: AuthModule): Promise<string>;
-}

package/dist/walletProviderServiceClientInterface.d.ts

@@ -1,43 +0,0 @@
-import { AuthModule, UserAuthentication } from './authentication';
-import { AddEphemeralKeyOpts, KeygenResponse, KeygenSetupOpts, SignResponse, SignSetupOpts, AddEphemeralKeyResponse } from './networkSigner';
-/**
- * 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 id of the Wallet Provider Service
-     * @alpha
-     */
-    walletProviderId: string;
-    /**
-     * The URL used to connect to the service
-     * @alpha
-     */
-    walletProviderUrl: string;
-};
-export type Signer = (challenge: string) => Promise<UserAuthentication>;
-/** Interface for client of  Wallet Provider Service
- * @alpha
- */
-export interface IWalletProviderServiceClient {
-    getWalletId(): string;
-    startKeygen({ setup, authModule }: {
-        setup: KeygenSetupOpts;
-        authModule: AuthModule;
-    }): Promise<KeygenResponse>;
-    startSigngen({ setup, authModule }: {
-        setup: SignSetupOpts;
-        authModule: AuthModule;
-    }): Promise<SignResponse>;
-    addEphemeralKey({ setup, authModule, }: {
-        setup: AddEphemeralKeyOpts;
-        authModule: AuthModule;
-    }): Promise<AddEphemeralKeyResponse>;
-}
-export type QueryPath = 'signgen' | 'keygen' | 'addEphemeralKey';
-export interface GetQueryPath {
-    get queryPath(): QueryPath;
-}