@silencelaboratories/walletprovider-sdk 0.0.5 → 0.0.7

package/dist/networkSigner.d.ts

@@ -1,18 +1,32 @@
 import { AuthModule, UserAuthentication } from './authentication.ts';
 import { type IWalletProviderServiceClient } from './walletProviderServiceClientInterface.ts';
+/**
+ * Response from the network for keygen requests
+ * @alpha
+ */
 export interface KeygenResponse {
-    key_id: string;
-    public_key: string;
+    keyId: string;
+    publicKey: string;
 }
+/**
+ * Response from the network for sign request
+ * @alpha
+ */
 export interface SignResponse {
-    sign?: string;
-    recid?: number;
-    preSignId?: string;
+    sign: string;
+    recid: number;
 }
+/** Key parameters used during generation  */
 export declare class KeygenSetupOpts {
+    /** 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.
+     */
     metadata: [number, string][];
     constructor({ t, n, key_label, permissions }: {
         t: number;
@@ -21,25 +35,60 @@ export declare class KeygenSetupOpts {
         permissions?: string;
     });
 }
+/** Parameters used in Signature execution */
 export type SignSetupOpts = {
+    /** Nymber 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;
 };
+/** Verifies if passed `params` object is of type SignSetupOpts */
 export declare function isSignSetupOpts(params: KeygenSetupOpts | SignSetupOpts): params is SignSetupOpts;
+/** The `user_authentication` contains signature over the `setup` parameter. */
 export type UserAuthenticatedRequest<T> = {
     setup: T;
     user_authentication: UserAuthentication;
-    ttl: number;
 };
+/** 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;
-    ttl: number;
+    /** Wallet Provider backend client */
     wp_client: IWalletProviderServiceClient;
-    constructor(wp_client: IWalletProviderServiceClient, threshold: number, totalNodes: number, authModule: AuthModule, ttl?: number);
+    /**
+     * 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);
+    /** API to generate a distributed key that's generated by Silent Network.
+     * Uses `authModule` to get authentication of the request from the User
+     * @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
+     * @alpha
+     */
     authenticateAndCreateKey(permissions?: string): Promise<KeygenResponse>;
+    /** Generate a signature. 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 `authenticateAndCreateKey`
+     * @param message - the message to sign by the MPC network
+     * @returns {@link SignResponse}
+     * @public
+     * @alpha
+     */
     authenticateAndSign(keyId: string, message: string): Promise<SignResponse>;
 }
 //# sourceMappingURL=networkSigner.d.ts.map

package/dist/networkSigner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"networkSigner.d.ts","sourceRoot":"","sources":["../src/networkSigner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAU,KAAK,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEtG,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAID,qBAAa,eAAe;IAC1B,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;gBAEjB,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE;CAUjH;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAGF,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,GAAG,MAAM,IAAI,aAAa,CAEhG;AAGD,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI;IACxC,KAAK,EAAE,CAAC,CAAC;IACT,mBAAmB,EAAE,kBAAkB,CAAC;IAExC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,qBAAa,aAAa;IACxB,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,4BAA4B,CAAC;gBAGtC,SAAS,EAAE,4BAA4B,EACvC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU,EACtB,GAAG,GAAE,MAAW;IAcZ,wBAAwB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAuBvE,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAejF"}
+{"version":3,"file":"networkSigner.d.ts","sourceRoot":"","sources":["../src/networkSigner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAU,KAAK,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEtG;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAGD,6CAA6C;AAC7C,qBAAa,eAAe;IAC1B,+GAA+G;IAC/G,CAAC,EAAE,MAAM,CAAC;IACV,kGAAkG;IAClG,CAAC,EAAE,MAAM,CAAC;IACV,yBAAyB;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;gBAEjB,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE;CAUjH;AAED,6CAA6C;AAC7C,MAAM,MAAM,aAAa,GAAG;IAC1B,uEAAuE;IACvE,CAAC,EAAE,MAAM,CAAC;IACV,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,kEAAkE;AAClE,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,GAAG,MAAM,IAAI,aAAa,CAEhG;AAED,+EAA+E;AAC/E,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI;IACxC,KAAK,EAAE,CAAC,CAAC;IACT,mBAAmB,EAAE,kBAAkB,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,qBAAa,aAAa;IACxB,6FAA6F;IAC7F,UAAU,EAAE,UAAU,CAAC;IACvB,qHAAqH;IACrH,SAAS,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,SAAS,EAAE,4BAA4B,CAAC;IAExC;;;;;;OAMG;gBACS,QAAQ,EAAE,4BAA4B,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;IAYjH;;;;;;;OAOG;IACU,wBAAwB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAuBpF;;;;;;;OAOG;IACU,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAexF"}

package/dist/walletProviderServiceClient.d.ts

@@ -1,8 +1,17 @@
 import { type KeygenSetupOpts, type KeygenResponse, type SignSetupOpts, type SignResponse } from './networkSigner';
 import { type ClientConfig, IWalletProviderServiceClient, type Signer } 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;
+    /**
+     * Create new client that connects to the backend service
+     * @param config - config containing information about backend service
+     */
     constructor(config: ClientConfig);
     getWalletId(): string;
     startKeygen({ setup, signer }: {
@@ -13,6 +22,6 @@ export declare class WalletProviderServiceClient implements IWalletProviderServi
         setup: SignSetupOpts;
         signer: Signer;
     }): Promise<SignResponse>;
-    connect(params: KeygenSetupOpts | SignSetupOpts, signer: Signer): Promise<KeygenResponse | SignResponse>;
+    connect(params: KeygenSetupOpts | SignSetupOpts, signer: Signer): Promise<string>;
 }
 //# sourceMappingURL=walletProviderServiceClient.d.ts.map

package/dist/walletProviderServiceClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"walletProviderServiceClient.d.ts","sourceRoot":"","sources":["../src/walletProviderServiceClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EAElB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,KAAK,YAAY,EAAE,4BAA4B,EAAE,KAAK,MAAM,EAAE,MAAM,wCAAwC,CAAC;AAStH,qBAAa,2BAA4B,YAAW,4BAA4B;IAC9E,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE,YAAY;IAKhC,WAAW,IAAI,MAAM;IAIf,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAInG,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAItG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,YAAY,CAAC;CAkFzG"}
+{"version":3,"file":"walletProviderServiceClient.d.ts","sourceRoot":"","sources":["../src/walletProviderServiceClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EAElB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,KAAK,YAAY,EAAE,4BAA4B,EAAE,KAAK,MAAM,EAAE,MAAM,wCAAwC,CAAC;AAStH;;;;GAIG;AACH,qBAAa,2BAA4B,YAAW,4BAA4B;IAC9E,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;gBACS,MAAM,EAAE,YAAY;IAKhC,WAAW,IAAI,MAAM;IAIf,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAYnG,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAatG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAkFlF"}

package/dist/walletProviderServiceClientInterface.d.ts

@@ -1,11 +1,27 @@
 import { UserAuthentication } from './authentication';
 import { KeygenResponse, KeygenSetupOpts, SignResponse, SignSetupOpts } 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;
-    secretKey: string;
 };
 export type Signer = (challenge: string) => Promise<UserAuthentication>;
+/** Interface for client of  Wallet Provider Service
+ * @alpha
+ */
 export interface IWalletProviderServiceClient {
     getWalletId(): string;
     startKeygen({ setup, signer }: {

package/dist/walletProviderServiceClientInterface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"walletProviderServiceClientInterface.d.ts","sourceRoot":"","sources":["../src/walletProviderServiceClientInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE/F,MAAM,MAAM,YAAY,GAAG;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAExE,MAAM,WAAW,4BAA4B;IAC3C,WAAW,IAAI,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAClG"}
+{"version":3,"file":"walletProviderServiceClientInterface.d.ts","sourceRoot":"","sources":["../src/walletProviderServiceClientInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,WAAW,IAAI,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAClG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@silencelaboratories/walletprovider-sdk",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Frontend SDK for Wallet Providers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,17 +15,20 @@
     "build": "bun run scripts/build.mjs && bun run build:declaration",
     "build:declaration": "tsc -p . --emitDeclarationOnly",
     "test": "bun test",
-    "test:watch": "bun test --watch"
+    "test:watch": "bun test --watch",
+    "docs": "bun run build:declaration && api-extractor run --local --verbose && api-documenter  markdown -i ./temp -o ./docs"
   },
   "type": "module",
   "devDependencies": {
     "@eslint/js": "^9.3.0",
+    "@microsoft/api-documenter": "^7.25.2",
+    "@microsoft/api-extractor": "^7.46.2",
     "@types/bun": "^1.1.2",
-    "eslint": "9.x",
+    "eslint": "^8.x",
     "globals": "^15.3.0",
     "prettier": "^3.2.5",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^7.10.0"
+    "typescript-eslint": "^7.11.0"
   },
   "dependencies": {
     "@noble/secp256k1": "^2.1.0",