@silencelaboratories/walletprovider-sdk 1.3.0 → 1.4.0

package/LICENSE

@@ -0,0 +1,103 @@
+SILENCE LABORATORIES’ NON-COMMERCIAL USE LICENSE AGREEMENT (SLL)
+
+This is an agreement (License) between You and Silence Laboratories Pte. Ltd., a company incorporated under the laws of Singapore having the registration number UEN 201938700D (Silence Laboratories). By using or accessing this repository(ies)/software made available by Silence Laboratories (each, a Software) in any manner, you agree to the terms of this License. 
+
+You acknowledge and accept that Silence Laboratories and its licensors, as applicable, own all legal right, title and interest in and to the work, software, application, source code, object code, documentation and any other documents in the Software. Further, you acknowledge and agree that Silence Laboratories and its licensors, as applicable, own all registered and unregistered intellectual property rights subsisting in the Software anywhere in the world, whether in source code form or any other form. 
+
+The limited rights granted below in relation to the Software are the only rights granted under this License. No additional rights are granted by Silence Laboratories under this License. 
+
+This License is applicable to all copies of the original and any modified versions of the Software, and derivative works of the Software. This License is applicable to all past and future versions of the Software, unless decided otherwise by Silence Laboratories in its sole discretion.
+
+1. Grant of License
+
+1.1. You are granted a perpetual, limited, revocable, worldwide, royalty-free, non-exclusive, non-transferable, non-sublicensable License to use, reproduce, make available, distribute, publish, copy, modify, merge, combine with another program or create derivative works of the Software in source code or any other form (Resulting Program(s)) solely for Non-Commercial Use (as defined below), and as long as you: 
+
+a. do not use, reproduce, make available, distribute, publish, copy, modify, merge and combine the Software or Resulting Program (a) in any manner that infringes, misappropriates, or otherwise violates any third-party rights, or (b) in any manner that violates any applicable law. 
+
+b. give any other recipients or users of the Software or the Resulting Program a copy of this License; 
+
+c. prominently publish or give notice with each copy of the Resulting Program that, 
+
+i. the Software is used in the Resulting Program, 
+
+ii. (if applicable) you changed or modified the files and any other documents in the Software (including stating the changes or modifications made), and give the relevant date; and 
+
+iii. Silence Laboratories is the owner of the copyright and all other intellectual property rights in the Software by: (A) including the following copyright notice: “\[This repository/software] is licensed under the Silence Laboratories License Agreement, Copyright © Silence Laboratories Pte. Ltd. All Rights Reserved.”, (B), this list of conditions, and (C) the disclaimer below (NOTICE) as a text file; and 
+
+d. require the Resulting Program and any reproduction, distribution, publication, copy, modification, merger therewith, combination with another program or derivative works thereof to the same NOTICE requirement and Non-Commercial Use restrictions set out below; and 
+
+e. make the source code form of the Resulting Program publicly available or make it available upon request (subject to the terms of this License, third party rights, and applicable law); and
+
+f. retain, in the source form of any Resulting Program that you distribute, all copyright, patent, trademark, and attribution notices from the source form of the Software, excluding those notices that do not pertain to any part of the Resulting Program; and
+
+g. If the Software includes a NOTICE text file as part of its distribution, then any Resulting Program that you distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Resulting Program, in at least one of the following places: within a NOTICE text file distributed as part of the Resulting Program; within the source form or documentation, if provided along with the Resulting Program; or, within a display generated by the Resulting Program, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add your own attribution notices within Resulting Programs that you distribute, alongside as an addendum to the NOTICE text from the Software, provided that such additional attribution notices cannot be construed as modifying the License. 
+
+1.2. You may add your own copyright statement to your modifications and provide additional or different license terms and conditions for use, reproduction, or distribution of your modifications, or for any such Resulting Program as a whole, provided your use, reproduction, or distribution of the Software otherwise complies with the conditions stated in this License.
+
+2) Violation of terms of License
+
+2.1. If your use of the Software or the Resulting Program does not comply with the conditions set out in this License or has any intended or unintended commercial application anywhere in the world and at any given point of time, you shall obtain a Commercial Use License from Silence Laboratories, or you must refrain from using the Software immediately. To obtain a copy of the Commercial Use License, reach out to info@silencelaboratories.com.
+
+2.2 Upon Silence Laboratories coming to know of your potential violation of any of the terms of this License, you will be notified in writing (Silence Laboratories Notice) to purchase a Commercial Use License within 30 days of receiving the Silence Laboratories Notice or refrain from using the Software immediately. 
+
+2.3. Any continued use of the Software in violation of this License will automatically result in termination of your rights under this License for the current and any future or past versions of the Software. 
+
+3. Intellectual Property
+
+3.1. This License does not grant you any right to use the name, trade marks, service marks, trade names, logos or any other intellectual property of Silence Laboratories for endorsing, promoting the Resulting Program or other works derived using the Software without obtaining specific written permission from Silence Laboratories (except as required for reasonable and customary use in attributing the usage of the Software to Silence Laboratories as expressly required under this License). 
+
+3.2. You must cause any Resulting Program to carry prominent notices stating that you have made changes to or modified the Software independently and without any involvement from Silence Laboratories in developing the Resulting Program. 
+
+4. Third Party Material
+
+The Software may contain third-party software or other components (including free and open source software) as may be made available by Silence Laboratories on its website https://silencelaboratories.com (OS Components), which are subject to the license terms of the respective third-party licensors. Your dealings or correspondence with third parties and your use of or interaction with any OS Components are solely between you and the third party. Silence Laboratories does not control or endorse, and makes no representations or warranties regarding, any OS Components, and your access to and use of such OS Components are at your own risk. You may modify or replace these OS Components; provided that you comply with the terms of this License, any applicable licensing terms governing use of the OS Components, and applicable laws. Silence Laboratories is not obligated to provide any updates, maintenance, warranty, technical or other support, or services for the resultant modified Software. 
+
+5. Limitation of Liability
+
+TO THE FULLEST EXTENT PERMITTED BY LAW, IN NO EVENT WILL SILENCE LABORATORIES BE LIABLE TO YOU (A) UNDER ANY THEORY OF LIABILITY, WHETHER BASED IN CONTRACT, TORT, NEGLIGENCE, STRICT LIABILITY, WARRANTY, OR OTHERWISE UNDER THIS LICENSE, OR (B) FOR ANY INDIRECT, CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, PUNITIVE OR SPECIAL DAMAGES OR LOST PROFITS, EVEN IF SILENCE LABORATORIES HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THE PROGRAM, THEIR CONSTITUENT COMPONENTS, THE RESULTING PROGRAM AND ANY OUTPUT (COLLECTIVELY, PROGRAM MATERIALS) ARE NOT DESIGNED OR INTENDED FOR USE IN ANY APPLICATION OR SITUATION WHERE FAILURE OR FAULT OF THE PROGRAM MATERIALS COULD REASONABLY BE ANTICIPATED TO LEAD TO SERIOUS INJURY OF ANY PERSON OR PROPERTY, INCLUDING POTENTIAL LOSS OF PROPERTY AND VIRTUAL ASSETS (INCLUDING CRYPTOCURRENCIES, NON-FUNGIBLE TOKENS, ETC.), LOSS OF ACCESS TO A VIRTUAL ASSET WALLET, VIOLATION OF AN INDIVIDUAL’S PRIVACY RIGHTS (EACH, A HIGH-RISK USE). IF YOU ELECT TO USE ANY OF THE PROGRAM MATERIALS FOR A HIGH-RISK USE, YOU DO SO AT YOUR OWN RISK. YOU AGREE TO DESIGN AND IMPLEMENT APPROPRIATE DECISION-MAKING AND RISK-MITIGATION PROCEDURES AND POLICIES IN CONNECTION WITH A HIGH-RISK USE SUCH THAT EVEN IF THERE IS A FAILURE OR FAULT IN ANY OF THE PROGRAM MATERIALS, THE SAFETY OF PERSONS OR PROPERTY AFFECTED BY THE ACTIVITY STAYS AT A LEVEL THAT IS REASONABLE, APPROPRIATE, AND LAWFUL FOR THE FIELD OF THE HIGH-RISK USE.
+
+6. Indemnity
+
+You will indemnify, defend and hold harmless Silence Laboratories and its affiliates, and each of its respective shareholders, directors, officers, employees, agents, successors, and assigns (collectively, the Silence Laboratories Parties) from and against any losses, liabilities, damages, fines, penalties, and expenses (including reasonable attorneys’ fees) incurred by any Silence Laboratories Party in connection with any claim, demand, allegation, lawsuit, proceeding, or investigation (collectively, Claims) arising out of or related to: (a) your access to or use of the Program Products (as well as any results or data generated from such access or use), including any High-Risk Use (defined below); (b) your violation of this License; or (c) your violation, misappropriation or infringement of any rights of another (including intellectual property or other proprietary rights and privacy rights). You will promptly notify the Silence Laboratories Parties of any such Claims, and cooperate with Silence Laboratories Parties in defending such Claims. You will also grant the Silence Laboratories Parties sole control of the defense or settlement, at Silence Laboratories’ sole option, of any Claims. This indemnity is in addition to, and not in lieu of, any other indemnities or remedies set forth in a written agreement between you and Silence Laboratories or the other Silence Laboratories Parties.
+
+7. Contributions
+
+7.1. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Silence Laboratories for inclusion in, or documentation of, any of the products owned or managed by Silence Laboratories (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Silence Laboratories or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems
+
+7.2. Subject to the terms and conditions of this Agreement, You hereby grant to Silence Laboratories and to recipients of software products distributed by Silence Laboratories a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
+
+7.3. Subject to the terms and conditions of this Agreement,You hereby grant to Silence Laboratories and to recipients of software distributed by Silence Laboratories a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. 
+
+7.4. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that Your Contribution, or the Work to which You have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+7.6. You represent that You are legally entitled to grant the above license. If Your employer(s) has rights to intellectual property that You create that includes Your Contributions, You represent that You have received permission to make Contributions on behalf of that employer, that Your employer has waived such rights for Your Contributions to Silence Laboratories, or that Your employer has executed a separate Corporate CLA with Silence Laboratories.
+
+7.6. You represent that each of Your Contributions is Your original creation. You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which You are personally aware and which are associated with any part of Your Contributions.
+
+7.7. You agree to notify Silence Laboratories of any facts or circumstances of which You become aware that would make these representations inaccurate in any respect.
+
+8. Governing Law
+
+This License will be governed by and shall be construed in accordance with the laws of Singapore without regard to any choice or conflict of laws rules. All or any disputes arising out of or touching upon or in relation to this License including the interpretation and validity of the terms thereof and the respective rights and obligations of the parties shall be settled through arbitration. The arbitration proceedings shall be held in Singapore by a sole arbitrator who shall be appointed by Silence Laboratories and whose decision shall be final and binding upon all the parties. Subject to the arbitration clause, the courts in Singapore alone shall have jurisdiction. The language of the arbitration proceedings shall be in English. You and Silence Laboratories agree that any cause of action arising in relation to the License must be commenced within three (3) months after the cause of action accrues or you become aware of the facts giving rise to the cause of action, whichever is later. Otherwise, such cause of action shall be permanently barred. Each party to any arbitration will cover its own fees and costs associated with the arbitration proceedings. The award of the arbitrator will be final and binding, and any judgement on the award rendered by the arbitrator may be entered in any court of competent jurisdiction. The parties to the arbitration shall not appeal any arbitration decision to any court. 
+
+9. Modifications
+
+Silence Laboratories may modify the terms of this License at any time, at its sole discretion. Such modified terms of this License will come into effect immediately upon their publication, unless decided otherwise by Silence Laboratories (Effective Date). By continuing to use or access the Software after the Effective Date, you agree to the modified terms of this License. It is your responsibility to check this License regularly for any modifications.
+
+10. Definition
+
+Non-Commercial Use means your use of the Software as described below, as determined by Silence Laboratories in its sole discretion, for:
+
+a. personal use for research, experiments, personal study, educational purposes, private entertainment, personal projects or amateur pursuits; 
+
+b. use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization or government institution,
+
+in each case, i.e., (1) and (2), without anticipated commercial application. For the sake of clarity, modifying and/or creating a substitute for the Software, or any other use of the Software, for commercial gain, including by way of (a) using the Software for internal business purposes, or (b) resale or distribution for commercial purposes, shall not constitute Non-Commercial Use. 
+
+DISCLAIMER
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS PROGRAM, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+We have last modified this License on 28-01-2025. 
+
+If you have any questions, comments or interest in pursuing any other commercial use cases, please reach out to us at info@silencelaboratories.com.

package/README.md

@@ -58,7 +58,7 @@ The [ephemeral public claim](./docs/walletprovider-sdk.eoaauth.ephclaim.md) will
 
 ## Keygen
 
-The full working example is in the [demo](https://github.com/silence-laboratories/walletprovider-sdk/blob/main/demo/src/routes/%2Bpage.svelte#L172).
+The full working example is in the [demo](https://github.com/silence-laboratories/walletprovider-sdk/blob/main/demo/src/routes/%2Bpage.svelte).
 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 your keys, you need two other components. The [WalletProviderServiceClient](./docs/walletprovider-sdk.walletproviderserviceclient.md) that connects to the Backend part of the SDK, and the **authenticator module**. 
@@ -94,7 +94,7 @@ const eoaAuth = new EOAAuth(
 const wpClient = await createWalletProviderService(clusterConfig);
 
 // Create a new signer instance
-const sdk = new NetworkSigner(wpClient, threshold, partiesNumber, eoaAuth);
+const sdk = new NetworkSigner(wpClient, eoaAuth);
 ```
 
 Now you can generate a key, using the [generateKey](./docs/walletprovider-sdk.networksigner.generatekey.md) method. The method accepts optional permissions. No permissions means _allow all operations_.
@@ -115,13 +115,15 @@ const permissions = {
   ],
 };
 
+let signAlgs = ['secp256k1', 'ed25519'];
+
 // Generate a new key
-let resp: KeygenResponse = await sdk.generateKey(JSON.stringify(permissions));
+let resp: KeygenResponse[] = await sdk.generateKey(threshold, partiesNumber, signAlgs, JSON.stringify(permissions));
 ```
 
 Calling this method will cause to the Digital Wallet window to pop up, requesting the User to sign the request.
 
-The returned [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 returned response [KeygenResponse[]](./docs/walletprovider-sdk.keygenresponse.md) is a list of DKG results, each contains `keyId`, `publicKey` and `signAlg`. The `publicKey` is the public part of the key generated by Silent Network. The `signAlg` is the sign algorithm of the MPC key. Use the `keyId` in subsequent calls to sign.
 
 The ephemeral `sk` key can be later used in subsequent signgen requests for authenticating.
 
@@ -142,7 +144,7 @@ const passkeyUser = {
 
 const passkeyAuth = new PasskeyRegister(rpConfig, passkeyUser);
 // Create a new signer instance
-const sdk = new NetworkSigner(wpClient, +threshold, +partiesNumber, passkeyAuth);
+const sdk = new NetworkSigner(wpClient, passkeyAuth);
 
 // Register a new passkey
 let resp: RegisterPasskeyResponse = await sdk.registerPasskey();
@@ -184,7 +186,7 @@ const passkeyAuth = new PasskeyAuth(
 );
 
 // Create a new signer instance
-const sdk = new NetworkSigner(wpClient, threshold, partiesNumber, passkeyAuth);
+const sdk = new NetworkSigner(wpClient, passkeyAuth);
 ```
 
 Now you can generate a key like in the EOA example by calling the [generateKey](./docs/walletprovider-sdk.networksigner.generatekey.md) method. 
@@ -195,44 +197,99 @@ The `sk` key can be later used in subsequent signgen requests.
 
 ## Signing
 
-The full signing example is [here](https://github.com/silence-laboratories/walletprovider-sdk/blob/main/demo/src/routes/%2Bpage.svelte#L228).
+The full signing example is [here](https://github.com/silence-laboratories/walletprovider-sdk/blob/main/demo/src/routes/%2Bpage.svelte).
 
 The workflow is similar to the keygen process. The core objects to use are the [NetworkSigner](./docs/walletprovider-sdk.networksigner.md), WalletProviderServiceClient, and the [ephemeral authenticator module](./docs/walletprovider-sdk.ephauth.md).
 ```ts
 const authModule = new EphAuth(selectedEphId, ephSK, selectedEphSignAlg);
 // Create a new signer instance
-const sdk = new NetworkSigner(wpClient, threshold, partiesNumber, authModule);
+const sdk = new NetworkSigner(wpClient, authModule);
 ```
 
 
-Use the [NetworkSigner.signMessage](./docs/walletprovider-sdk.networksigner.signMessage.md) method in order to generate a signature.
+Use the [SignRequestBuilder](./docs/walletprovider-sdk.signrequestbuilder.md) builder to generate the sign message payload. Then call the [signMessage](./docs/walletprovider-sdk.networksigner.signmessage.md) method to run the signing process.
 
 ```ts
-let signMessage = JSON.stringify({
-    message: JSON.stringify({
-      userOperation: {
-        sender: '0x8d4cb2540d993fe34c646299f1ab4af3012ff34c',
-        nonce: '0x7',
-        initCode: '0x',
-        callData: '0000189...',
-        callGasLimit: '0x18473',
-        verificationGasLimit: '0x18473',
-        preVerificationGas: '66768',
-        maxFeePerGas: '',
-        maxPriorityFeePerGas: '',
-        paymasterAndData: '0x',
-      },
-      entryPointVersion: 'v0.6.0',
-      entryPointAddress: '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789',
-      chainId: 80002,
-    }),
-    requestType: 'accountAbstractionTx',
-  });
-
-let resp = await sdk.signMessage(selectedKeyId, signMessage);
+const signMessage = new SignRequestBuilder()
+    .setRequest(
+      uuidv4(),
+      JSON.stringify({
+        userOperation: {
+          sender: '0x8d4cb2540d993fe34c646299f1ab4af3012ff34c',
+          nonce: '0x7',
+          initCode: '0x',
+          callData: '0000...',
+          callGasLimit: '0x18473',
+          verificationGasLimit: '0x18473',
+          preVerificationGas: '66768',
+          maxFeePerGas: '',
+          maxPriorityFeePerGas: '',
+          paymasterAndData: '0x',
+        },
+        entryPointVersion: 'v0.6.0',
+        entryPointAddress: '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789',
+        chainId: 80002,
+      }),
+      'accountAbstractionTx',
+    )
+    .setRequest(
+      uuidv4(),
+      '4549502d313931206d657373616765',
+      'rawBytes',
+    )
+    .build();
+
+let resp = await sdk.signMessage( threshold, selectedKeyId, signMessage);
+```
+
+The [SignResponse](./docs/walletprovider-sdk.signresponse.md) contains the signature `sign`, the recovery ID `recid` and the transaction ID `transactionId`.
+
+## Key refresh
+
+The full key refresh example is [here](https://github.com/silence-laboratories/walletprovider-sdk/blob/main/demo/src/routes/%2Bpage.svelte).
+
+The workflow is similar to the keygen process. The core objects to use are the [NetworkSigner](./docs/walletprovider-sdk.networksigner.md), WalletProviderServiceClient, and the [EOAAuth](./docs/walletprovider-sdk.eoaauth.md) module.
+
+
+```ts
+const algSign = 'secp256k1'; // Signing algorithms of ephemeral key
+// Generate ephemeral secret key esk
+const sk = generateEphPrivateKey(algSign);
+// Derive public part epk from esk
+const ephPK = getEphPublicKey(sk, algSign);
+// Arbitrary ID to identify the ephemeral key
+const ephId = uuidv4();
+// Create ephemeral key claim instance based on the ephemeral key
+const ephClaim = new EphKeyClaim(
+  ephId,
+  ephPK,
+  algSign,
+  // Lifetime of one hour
+  60 * 60,
+);
+
+// Create EOA authenticator, signature will include epk
+const eoaAuth = new EOAAuth(
+  accountsFromBrowserWallet[0],
+  new BrowserWallet(),
+  ephClaim
+);
+
+// Create a client that connects to the backend service
+const wpClient = await createWalletProviderService(clusterConfig);
+
+// Create a new signer instance
+const sdk = new NetworkSigner(wpClient, eoaAuth);
+```
+
+Now you can refresh the key (before doing this, make sure you've already generated the key), using the [refreshKey](./docs/walletprovider-sdk.networksigner.refreshkey.md) method.
+
+```ts
+// Refresh the key
+let resp: KeyRefreshResponse = await sdk.refreshKey(threshold, keyId, mpcKeySignAlg);
 ```
+The returned response [KeyRefreshResponse](./docs/walletprovider-sdk.keyrefreshresponse.md) contains `keyId`, `publicKey` and `signAlg` of the refreshed MPC key.
 
-The [SignResponse](./docs/walletprovider-sdk.signresponse.md) contains the signature `sign` and the recovery ID `recid`.
 
 # Development
 

package/dist/{EOAauthentication.d.ts → auth/EOAauthentication.d.ts}

@@ -1,7 +1,6 @@
 /** 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 { MetadataSetupOpts, KeygenSetupOpts } from './setupMessage';
 import { type UserAuthentication } from './authentication';
 import { type TypedDataDomain } from 'viem';
 import { EphKeyClaim } from './ephemeralAuthentication';
@@ -10,7 +9,7 @@ export type FieldDefinition = {
     type: string;
 };
 /** EIP-712 Typed data struct definition.
- * @alpha
+ * @public
  * */
 export type TypedData<T> = {
     /** contains the schema definition of the types that are in `msg` */
@@ -25,7 +24,7 @@ export type TypedData<T> = {
 /**
  * Interface to implement communication between this library, and a Browser Wallet. In order to
  * request the signature from the User.
- * @alpha
+ * @public
  */
 export interface IBrowserWallet {
     /** Sign data using the secret key stored on Browser Wallet
@@ -45,23 +44,27 @@ export interface IBrowserWallet {
      */
     signTypedData<T>(from: string, request: TypedData<T>): Promise<unknown>;
 }
-type RequestToSign<T> = {
-    setup: T;
-    challenge: string;
-};
 export declare const EIP712SilentShardAuthenticationDomain: {
     name: string;
     version: string;
 };
-export declare function createTypedRequest(setup: KeygenSetupOpts | MetadataSetupOpts, aggregated_challenge: string, ephClaim: EphKeyClaim): TypedData<RequestToSign<KeygenSetupOpts | MetadataSetupOpts>>;
+type RequestToSign<T> = {
+    setup: T;
+    challenge: string;
+    eph_claim: string;
+};
+export interface EoaAuthPayload {
+    get eoaRequestSchema(): any;
+}
+export declare function createTypedRequest(request: EoaAuthPayload, final_challenge: string, eph_claim: string): TypedData<RequestToSign<EoaAuthPayload>>;
 /** Present the request to the User using wallet UI, and ask for sign.
  * The signature is the authorization for keygen operation
  */
 export declare function authenticateUsingEOA({ setup, eoa, challenge, browserWallet, ephClaim, }: {
-    setup: KeygenSetupOpts | MetadataSetupOpts;
+    setup: EoaAuthPayload;
     eoa: string;
     challenge: string;
     browserWallet: IBrowserWallet;
-    ephClaim: EphKeyClaim;
+    ephClaim: EphKeyClaim | undefined;
 }): Promise<UserAuthentication>;
 export {};

package/dist/{authentication.d.ts → auth/authentication.d.ts}

@@ -1,60 +1,64 @@
-import { MetadataSetupOpts, KeygenSetupOpts, SignSetupOpts } from './setupMessage';
-import { IBrowserWallet } from './EOAauthentication';
+import { AddEphKeyRequest, RegisterPasskeyRequest } from './../client/networkRequest';
+import { KeygenSetupOpts } from '../setupMessage';
+import { EoaAuthPayload, IBrowserWallet } from './EOAauthentication';
 import { PasskeyUser, RelyingPartyConfig } from './passkeyAuthentication';
-import { EphKeyClaim, SignAlgorithm } from './ephemeralAuthentication';
-/** Type of the request authentication
- * @alpha
+import { EphemeralAuthPayload, EphKeyClaim, EphKeySignAlgorithm } from './ephemeralAuthentication';
+import { RevokeEphKeyRequest } from '../client/networkRequest';
+/** Contains essential information about how to authenticate the user request.
+ * @public
  */
 export type UserCredentials = {
     id: string;
     method: 'eoa' | 'ephemeral' | 'passkey';
     credentials: string;
 };
+/** User signature container.
+ *  It contains the signature of the request and the user credentials (authentication method, id and additional credential information).
+ * @public
+ */
 export type UserAuthentication = {
     credentials: UserCredentials;
     signature: string;
 };
 export interface AuthModule {
-    authenticate({ setup, challenge, }: {
-        setup: KeygenSetupOpts | SignSetupOpts | MetadataSetupOpts;
+    authenticate({ payload, challenge }: {
+        payload: AuthPayload;
         challenge: string;
     }): Promise<UserAuthentication>;
 }
-export interface DkgAuthModule extends AuthModule {
-    get ephClaim(): EphKeyClaim;
-}
+export type AuthPayload = EoaAuthPayload | PasskeyLoginPayload | EphemeralAuthPayload | RegisterPasskeyRequest;
+type PasskeyLoginPayload = KeygenSetupOpts | AddEphKeyRequest | RevokeEphKeyRequest;
 /** The `EOAAuth` implementing Externally Owned Account authentication.
- * @alpha
+ * @public
  */
-export declare class EOAAuth implements DkgAuthModule {
+export declare class EOAAuth {
     /** An interface to the wallet, like MetaMask, that is used to sign the requests */
     private browserWallet;
     /** the ETH address that is used to do EOA authentication */
     private eoa;
-    /** Ephemeral key claim */
-    ephClaim: EphKeyClaim;
+    /** Ephemeral key claim populated for single or batched keys*/
+    private ephClaim;
     /**
      *
      * @param eoa - Ethereum address
      * @param browserWallet - Interface to the wallet provider, like MetaMask, that is used to sign the requests
-     * @param ephClaim - EphKeyClaim instance
+     * @param ephClaimOptions - Either EphKeyClaim or Map of SignatureAlgorithms and their appropriate EphKeyClaims
      */
-    constructor(eoa: string, browserWallet: IBrowserWallet, ephClaim: EphKeyClaim);
+    constructor(eoa: string, browserWallet: IBrowserWallet, ephClaim?: EphKeyClaim);
     private validateInputs;
     /**
      * Prepares a message to present on the Browser Wallet window and requests to sign it.
-     * @param setup - Keygen setup options
-     * @param challenge - the challenge received from the backend
-     *
+     * @param payload - request payload to be sent to the backend
+     * @param challenge - the challenge received from the backend in v1 or generated by client in v2
      * @public
      */
-    authenticate({ setup, challenge, }: {
-        setup: KeygenSetupOpts | MetadataSetupOpts;
+    authenticate({ payload, challenge, }: {
+        payload: EoaAuthPayload;
         challenge: string;
     }): Promise<UserAuthentication>;
 }
 /** The `EphAuth` module is only used for signing requests to the network.
- * @alpha
+ * @public
  * 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.
@@ -70,43 +74,50 @@ export declare class EphAuth implements AuthModule {
      * @param ephSK - Ephemeral secret key
      * @param signAlg - Signature algorithm
      */
-    constructor(ephId: string, ephSK: Uint8Array, signAlg: SignAlgorithm);
+    constructor(ephId: string, ephSK: Uint8Array, signAlg: EphKeySignAlgorithm);
     /**
-     * Prepares a message to present on the Browser Wallet window and requests to sign it.
-     * @param setup - Signgen setup options
-     * @param challenge - the challenge received from the backend
+     * Prepares a message for Ephemeral secret key to sign.
+     * @param payload - request payload to be sent to the backend
+     * @param challenge - the challenge received from the backend in v1 or generated by client in v2
      *
      * @public
      */
-    authenticate({ setup, challenge, }: {
-        setup: SignSetupOpts | MetadataSetupOpts;
+    authenticate({ payload, challenge, }: {
+        payload: EphemeralAuthPayload;
         challenge: string;
     }): Promise<UserAuthentication>;
 }
 /** The `AuthModule` implementing Passkey authentication.
- * @alpha
+ * @public
  */
-export declare class PasskeyAuth implements DkgAuthModule {
+export declare class PasskeyAuth {
     /** Replying party object. Read more: https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredentialCreationOptions#rp */
     private rpConfig;
     /** ID of the acceptable credential by user. App proves that user has passkey credential by passing the value of this field */
     private allowCredentialId;
-    /** Ephemeral key claim */
-    ephClaim: EphKeyClaim;
+    /** Ephemeral key claim populated for non batched requests*/
+    private ephClaim;
     /**
      *
      * @param rpConfig - Passkey relying party configuration. Read more: https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredentialCreationOptions#rp
      * @param allowCredentialId - ID of the acceptable credential by user. App proves that user has passkey credential by passing the value of this field
-     * @param ephClaim - EphKeyClaim instance
+     * @param ephClaimOptions - Either EphKeyClaim or Map of SignatureAlgorithms and their appropriate EphKeyClaims
      */
     constructor(rpConfig: RelyingPartyConfig, allowCredentialId: string, ephClaim: EphKeyClaim);
-    authenticate({ setup, challenge, }: {
-        setup: KeygenSetupOpts | MetadataSetupOpts;
+    /**
+     * Prepares a message for Passkey login flow and prompts user device's authenticator to sign it.
+     * @param payload - request payload to be sent to the backend
+     * @param challenge - the challenge received from the backend in v1 or generated by client in v2
+     * @public
+     */
+    authenticate({ payload, // TODO: Passkey login doesnt require payload, we should clean up this
+    challenge, }: {
+        payload: PasskeyLoginPayload;
         challenge: string;
     }): Promise<UserAuthentication>;
 }
 /** The `AuthModule` implementing Passkey register.
- * @alpha
+ * @public
  */
 export declare class PasskeyRegister implements AuthModule {
     /** Replying party object. Read more: https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredentialCreationOptions#rp */
@@ -119,8 +130,15 @@ export declare class PasskeyRegister implements AuthModule {
      * @param user - Passkey user information, only requires while registering. Read more: https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredentialCreationOptions#user
      */
     constructor(rpConfig: RelyingPartyConfig, user: PasskeyUser);
-    authenticate({ setup, challenge, }: {
-        setup: MetadataSetupOpts;
+    /**
+     * Prepares a message for Passkey register flow and prompts user device's authenticator to sign it.
+     * @param payload - request payload to be sent to the backend
+     * @param challenge - the challenge received from the backend in v1 or generated by client in v2
+     * @public
+     */
+    authenticate({ payload, challenge, }: {
+        payload: RegisterPasskeyRequest;
         challenge: string;
     }): Promise<UserAuthentication>;
 }
+export {};

package/dist/auth/ephemeralAuthentication.d.ts

@@ -0,0 +1,58 @@
+import { UserAuthentication } from './authentication';
+import { SignSetupOpts } from '../setupMessage';
+import { RevokeEphKeyRequest } from '../client/networkRequest';
+/**
+ * Supported signature algorithms for ephemeral signing.
+ * @public
+ */
+export type EphKeySignAlgorithm = 'ed25519' | 'secp256k1';
+export type EphemeralAuthPayload = SignSetupOpts | RevokeEphKeyRequest;
+/** The `EphKeyClaim` object represents the public claim of the ephemeral key.
+ * @public
+ */
+export declare class EphKeyClaim {
+    ephId: string;
+    ephPK: string;
+    signAlg: EphKeySignAlgorithm;
+    expiry: number;
+    /**
+     *
+     * @param ephId - Ephemeral key ID
+     * @param ephPK - Ephemeral public key
+     * @param signAlg - Signature algorithm.
+     * @param expiryInSecs - Expiry date of the ephemeral key in seconds. Default is 1 hour.
+     */
+    constructor(ephId: string, ephPK: Uint8Array, signAlg: EphKeySignAlgorithm, expiryInSecs?: number);
+    private validateInputs;
+    toJSON(): string;
+    /**
+     * Helper method to generate ephemeral keypair and its claim. This uses the generated public key as the ephemeral key ID.
+     *
+     * @param algSign - Signature algorithm
+     * @param expiryInSecs - Expiry date of the ephemeral key in seconds. Default is 1 hour
+     * @returns keypair of ephemeral key and its claim
+     */
+    static generateKeys(algSign: EphKeySignAlgorithm, expiryInSecs?: number): {
+        privKey: Uint8Array;
+        pubKey: Uint8Array;
+        ephClaim: EphKeyClaim;
+    };
+}
+/** 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: EphemeralAuthPayload;
+    challenge: string;
+    ephSK: Uint8Array;
+    ephClaim: EphKeyClaim;
+}): Promise<UserAuthentication>;
+export declare function genHexSignature(msg: Uint8Array, ephSK: Uint8Array, signAlg: EphKeySignAlgorithm): Promise<string>;
+/** Generate Ephemeral `privateKey`
+ * @public
+ */
+export declare function generateEphPrivateKey(algSign: EphKeySignAlgorithm): Uint8Array;
+/** Derive Ephemeral `publicKey` from `privateKey` returned from `generateEphPrivateKey`
+ * @public
+ */
+export declare function getEphPublicKey(ephSK: Uint8Array, algSign: EphKeySignAlgorithm): Uint8Array;

package/dist/{passkeyAuthentication.d.ts → auth/passkeyAuthentication.d.ts}

@@ -1,7 +1,7 @@
 import { UserAuthentication } from './authentication';
 import { EphKeyClaim } from './ephemeralAuthentication';
 /** Information about the user currently registering. Read more: https://w3c.github.io/webauthn/#dom-publickeycredentialcreationoptions-user
- * @alpha
+ * @public
  * */
 export type PasskeyUser = {
     id: string;
@@ -9,7 +9,7 @@ export type PasskeyUser = {
     displayName: string;
 };
 /** The RP responsible for registering and authenticating the user. Read more: https://w3c.github.io/webauthn/#dom-publickeycredentialcreationoptions-rp
- * @alpha
+ * @public
  * */
 export type RelyingPartyConfig = {
     rpName: string;

package/dist/builder/signRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Type of signing transaction.
+ * For `eddsa` it is REQUIRED to encode the message in hex.
+ * @public
+ */
+export type SignRequestType = 'accountAbstractionTx' | 'EIP712' | 'EIP191' | 'rawBytes' | 'eddsa';
+/**
+ * Builder class for constructing request payload for DSG.
+ * The returned value from `build()` is the value of `message` field of SignSetupOpts.
+ * @public
+ */
+export declare class SignRequestBuilder {
+    private signRequest;
+    /**
+     * Sets the transaction ID, message, and request type for the sign request.
+     * Ensures that each transaction ID is only set once.
+     * @param transactionId - The transaction ID.
+     * @param message - The message to be signed.
+     * @param requestType - The type of the sign request.
+     * @returns The builder instance.
+     */
+    setRequest(transactionId: string, message: string, requestType: SignRequestType): SignRequestBuilder;
+    /**
+     * Builds and returns the Map<string, Transaction> as a JSON.
+     * @returns The canonicalized JSON of Map<string, Transaction>.
+     */
+    build(): string;
+}