@silencelaboratories/walletprovider-sdk 0.0.7 → 0.0.9

package/README.md

@@ -46,19 +46,46 @@ Frontend uses [WalletProviderServiceClient](./docs/walletprovider-sdk.walletprov
 
 For description of classes, interfaces, types, please refer to [documentation](./docs/walletprovider-sdk.md).
 
+## Authentication
+
+
+Users authenticate using an EOA wallet during **key generation** and register an ephemeral signing key pair and associates it with their identity.
+
+Frontend can later use the ephemeral signing key pair to authorize **signing requests** for duration of the session without the need for repeated user interaction, providing a seamless and secure authentication mechanism.
+
+We use [EOAAuth](./docs/walletprovider-sdk.eoaauth.md) to authenticate the user **during keygen**. The `EOAAuth` object is created with the user's wallet address, ephemeral public key, and lifetime of the key in seconds.
+
+We then use [EphAuth](./docs/walletprovider-sdk.ephauth.md) to authenticate the user **during signing**. The `EphAuth` object is created with the user's wallet address and ephemeral keypair.
+
 ## Keygen
 
-The full working example is in the [demo](./demo/src/routes/%2Bpage.svelte#L87).
+
+The full working example is in the [demo](https://github.com/silence-laboratories/walletprovider-sdk/blob/a75d7a009fb4d3629d353d53f8c27c34190c9035/demo/src/routes/%2Bpage.svelte#L89).
 The core object to use is the [NetworkSigner](./docs/walletprovider-sdk.networksigner.md).
 
 It allows to generate keys and do signatures. In order to create, you need two other components. The [WalletProviderServiceClient](./docs/walletprovider-sdk.walletproviderserviceclient.md) that connects to the Backend part of the SDK, and the authentication module. Currently we provide EOA authentication via [EOAAuth](./docs/walletprovider-sdk.eoaauth.md).
 
+
 Let's create the `NetworkSigner`
 
 ```ts
+// Generate ephemeral secret key esk
+const sk = ed.utils.randomPrivateKey();
+ephSK = sk;
+// Derive public part epk from esk
+ephPK = await ed.getPublicKeyAsync(sk);
+
+// Create a client that connects to the backend service
 const wpClient = await createWalletProviderService(clusterConfig);
-// Authenticate using EOA
-const eoaAuth = new EOAAuth(accountsFromBrowserWallet[0], new BrowserWallet());
+
+// Create EOA authenticator, signature will include epk
+const eoaAuth = new EOAAuth(
+  accountsFromBrowserWallet[0],
+  new BrowserWallet(),
+  ephPK,
+  // Lifetime of one hour
+  60 * 60,
+);
 
 // Create a new signer instance
 const sdk = new NetworkSigner(wpClient, threshold, partiesNumber, eoaAuth);
@@ -90,9 +117,19 @@ Calling this method will cause to the Browser Wallet window to pop up, requestin
 
 The [KeygenResponse](./docs/walletprovider-sdk.keygenresponse.md) contains `keyId` and `publicKey`. The `publicKey` is the public part of the key generated by Silent Network. Use the `keyId` in subsequent calls to sign.
 
+The `esk` key can be later used by the frontend in subsequent signgen requests for authenticating.
+
 ## Signing
 
-The full signing example is [here](./demo/src/routes/%2Bpage.svelte#L158).
+The full signing example is [here](https://github.com/silence-laboratories/walletprovider-sdk/blob/a75d7a009fb4d3629d353d53f8c27c34190c9035/demo/src/routes/%2Bpage.svelte#L170).
+
+Let's create NetworkSigner for signing. Note the `EphAuth` is used to avoid user interaction when generating the signatures.
+```ts
+const authModule = new EphAuth(accountsFromBrowserWallet[0], ephSK!);
+// Create a new signer instance
+const sdk = new NetworkSigner(wpClient, threshold, partiesNumber, authModule);
+```
+
 
 Use the [NetworkSigner.authenticateAndSign](./docs/walletprovider-sdk.networksigner.authenticateandsign.md) method in order to generate a signature.
 

package/dist/EOAauthentication.d.ts

@@ -1,9 +1,14 @@
 /** Externally Owned Account (EOA) atuhentication. Uses secret key stored on a wallet to sign requests.
  * The requests are presented to the user in a readable form by using TypedData (EIP712).
  */
-import { KeygenSetupOpts, type SignSetupOpts } from './networkSigner.ts';
+import { KeygenSetupOpts, SignSetupOpts } from './networkSigner.ts';
 import { type UserAuthentication } from './authentication.ts';
-import type { TypedDataDomain } from 'viem';
+import { type TypedDataDomain } from 'viem';
+export type EphClaim = {
+    eoa: string;
+    ephPK: string;
+    expiry: number;
+};
 export type FieldDefinition = {
     name: string;
     type: string;
@@ -47,10 +52,22 @@ export interface IBrowserWallet {
 /** Present the request to the User using wallet UI, and ask for sign.
  * The signature is the authorization for the operation
  */
-export declare function authenticateUsingEOA({ setup, user_id, challenge, browserWallet, }: {
-    setup: KeygenSetupOpts | SignSetupOpts;
+export declare function authenticateUsingEOA({ setup, user_id, challenge, browserWallet, ephPK, lifetime, }: {
+    setup: KeygenSetupOpts;
     user_id: string;
     challenge: string;
     browserWallet: IBrowserWallet;
+    ephPK: Uint8Array;
+    lifetime: number;
+}): Promise<UserAuthentication>;
+/** Present the request to the User using wallet UI, and ask for sign.
+ * The signature is the authorization for the operation
+ */
+export declare function authenticateUsingEphKey({ setup, user_id, challenge, ephSK, ephPK, }: {
+    setup: SignSetupOpts;
+    user_id: string;
+    challenge: string;
+    ephSK: Uint8Array;
+    ephPK: Uint8Array;
 }): Promise<UserAuthentication>;
 //# sourceMappingURL=EOAauthentication.d.ts.map

package/dist/EOAauthentication.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EOAauthentication.d.ts","sourceRoot":"","sources":["../src/EOAauthentication.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAmB,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAE5C,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;KAEK;AACL,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IACzB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9C,wCAAwC;IACxC,MAAM,EAAE,eAAe,CAAC;IACxB,yEAAyE;IACzE,WAAW,EAAE,MAAM,CAAC;IACpB,6CAA6C;IAC7C,OAAO,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACzE;AAgJD;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,KAAK,EACL,OAAO,EACP,SAAS,EACT,aAAa,GACd,EAAE;IACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,cAAc,CAAC;CAC/B,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA4B9B"}
+{"version":3,"file":"EOAauthentication.d.ts","sourceRoot":"","sources":["../src/EOAauthentication.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAmB,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAS,KAAK,eAAe,EAAE,MAAM,MAAM,CAAC;AAQnD,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;KAEK;AACL,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IACzB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9C,wCAAwC;IACxC,MAAM,EAAE,eAAe,CAAC;IACxB,yEAAyE;IACzE,WAAW,EAAE,MAAM,CAAC;IACpB,6CAA6C;IAC7C,OAAO,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACzE;AAuGD;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,KAAK,EACL,OAAO,EACP,SAAS,EACT,aAAa,EACb,KAAK,EACL,QAAQ,GACT,EAAE;IACD,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,cAAc,CAAC;IAC9B,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA8B9B;AACD;;GAEG;AACH,wBAAsB,uBAAuB,CAAC,EAC5C,KAAK,EACL,OAAO,EACP,SAAS,EACT,KAAK,EACL,KAAK,GACN,EAAE;IACD,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,UAAU,CAAC;IAClB,KAAK,EAAE,UAAU,CAAC;CACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA0B9B"}

package/dist/authentication.d.ts

@@ -32,7 +32,11 @@ export declare class EOAAuth implements AuthModule {
     userId: string;
     /** An interface to the wallet, like MetaMask, that is used to sign the requests */
     browserWallet: IBrowserWallet;
-    constructor(userId: string, browserWallet: IBrowserWallet);
+    /** Public key of the ephemeral key */
+    ephPK: Uint8Array;
+    /** Lifetime of the ephemeral key */
+    lifetime: number;
+    constructor(userId: string, browserWallet: IBrowserWallet, ephPK: Uint8Array, lifetime?: number);
     /**
      * Prepares a message to present on the Browser Wallet window and requests to sign it.
      * @param setup - either Keygen or Sign setup options
@@ -45,4 +49,22 @@ export declare class EOAAuth implements AuthModule {
         challenge: string;
     }): Promise<UserAuthentication>;
 }
+/** An Ephmeral key used to locally sign the signature requests to network.
+ * This eph key is registered during keygen. The key is used to sign the requests without
+ * asking the user to sign the request each time.
+ * The auth module is only used for signing requests to the network.
+ * */
+export declare class EphAuth implements AuthModule {
+    /** User ID, typically the ETH address that is used to do authentication */
+    userId: string;
+    /** Secret key of the ephemeral keypair */
+    ephSK: Uint8Array;
+    /** Public key of the ephemeral keypair */
+    ephPK: Uint8Array;
+    constructor(userId: string, ephSK: Uint8Array);
+    authenticate({ setup, challenge, }: {
+        setup: KeygenSetupOpts | SignSetupOpts;
+        challenge: string;
+    }): Promise<UserAuthentication>;
+}
 //# sourceMappingURL=authentication.d.ts.map

package/dist/authentication.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"authentication.d.ts","sourceRoot":"","sources":["../src/authentication.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,cAAc,EAAwB,MAAM,qBAAqB,CAAC;AAE3E;;GAEG;AACH,oBAAY,UAAU;IACpB,oDAAoD;IACpD,GAAG,IAAA;IACH,wBAAwB;IACxB,IAAI,IAAA;CACL;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,eAAe,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EACX,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,OAAQ,YAAW,UAAU;IACxC,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,aAAa,EAAE,cAAc,CAAC;gBAElB,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc;IAKzD;;;;;;OAMG;IACG,YAAY,CAAC,EACjB,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAQhC"}
+{"version":3,"file":"authentication.d.ts","sourceRoot":"","sources":["../src/authentication.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,cAAc,EAAiD,MAAM,qBAAqB,CAAC;AAGpG;;GAEG;AACH,oBAAY,UAAU;IACpB,oDAAoD;IACpD,GAAG,IAAA;IACH,wBAAwB;IACxB,IAAI,IAAA;CACL;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,eAAe,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EACX,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,OAAQ,YAAW,UAAU;IACxC,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,aAAa,EAAE,cAAc,CAAC;IAC9B,sCAAsC;IACtC,KAAK,EAAE,UAAU,CAAC;IAClB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;gBAEL,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,GAAE,MAAa;IAOrG;;;;;;OAMG;IACG,YAAY,CAAC,EACjB,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAUhC;AAED;;;;KAIK;AACL,qBAAa,OAAQ,YAAW,UAAU;IACxC,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,KAAK,EAAE,UAAU,CAAC;IAClB,0CAA0C;IAC1C,KAAK,EAAE,UAAU,CAAC;gBAEN,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU;IAKvC,YAAY,CAAC,EACjB,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAShC"}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { NetworkSigner, SignResponse, KeygenResponse } from './networkSigner.ts';
-export { AuthMethod, EOAAuth } from './authentication.ts';
+export { AuthMethod, EOAAuth, EphAuth } from './authentication.ts';
 export type { IBrowserWallet, TypedData } from './EOAauthentication.ts';
 export type { ClientConfig, IWalletProviderServiceClient } from './walletProviderServiceClientInterface.ts';
 export { WalletProviderServiceClient } from './walletProviderServiceClient.ts';
+export { computeAddress } from './viemSigner.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE1D,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExE,YAAY,EAAE,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAC5G,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExE,YAAY,EAAE,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAC5G,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC"}