signet.js 0.0.10-beta1 → 0.0.10-beta3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signet.js",
-  "version": "0.0.10-beta1",
+  "version": "0.0.10-beta3",
   "description": "A TypeScript library for handling multi-chain transactions and signatures using Signet MPC",
   "type": "module",
   "exports": {

package/types/index.d.cts

@@ -934,16 +934,6 @@ interface SignatureErrorData {
     responder: string;
     error: string;
 }
-interface RequestIdArgs {
-    address: Address;
-    payload: Hex;
-    path: string;
-    keyVersion: number;
-    chainId: bigint;
-    algo: string;
-    dest: string;
-    params: string;
-}
 
 /**
  * Implementation of the ChainSignatureContract for EVM chains.
@@ -1001,33 +991,27 @@ declare class ChainSignatureContract extends ChainSignatureContract$2 {
     /**
      * Generates the request ID for a signature request allowing to track the response.
      *
-     * @param request - The signature request object containing:
-     *   @param request.address - The contract/wallet address calling the signing contract
-     *   @param request.payload - The data payload to be signed as a hex string
-     *   @param request.path - The derivation path for the key
-     *   @param request.keyVersion - The version of the key to use
-     *   @param request.chainId - The chain ID as a bigint
-     *   @param request.algo - The signing algorithm to use
-     *   @param request.dest - The destination for the signature
-     *   @param request.params - Additional parameters for the signing process
+     * @param args - The signature request object containing:
+     *   @param args.payload - The data payload to be signed as a hex string
+     *   @param args.path - The derivation path for the key
+     *   @param args.keyVersion - The version of the key to use
+     * @param options - The signature request object containing:
+     *   @param options.algo - The signing algorithm to use
+     *   @param options.dest - The destination for the signature
+     *   @param options.params - Additional parameters for the signing process
      * @returns A hex string representing the unique request ID
      *
      * @example
      * ```typescript
      * const requestId = ChainSignatureContract.getRequestId({
-     *   address: walletClient.account.address,
      *   payload: payload: `0x${Buffer.from(args.payload).toString('hex')}`,,
      *   path: '',
-     *   keyVersion: 0,
-     *   chainId: 1n,
-     *   algo: '',
-     *   dest: '',
-     *   params: ''
+     *   keyVersion: 0
      * });
      * console.log(requestId); // 0x...
      * ```
      */
-    getRequestId(request: RequestIdArgs): Hex;
+    getRequestId(args: SignArgs, options?: SignOptions['sign']): Hex;
     getErrorFromEvents(requestId: Hex, fromBlock: bigint): Promise<SignatureErrorData | undefined>;
     /**
      * Searches for SignatureResponded events that match the given requestId.

package/types/index.d.ts

@@ -934,16 +934,6 @@ interface SignatureErrorData {
     responder: string;
     error: string;
 }
-interface RequestIdArgs {
-    address: Address;
-    payload: Hex;
-    path: string;
-    keyVersion: number;
-    chainId: bigint;
-    algo: string;
-    dest: string;
-    params: string;
-}
 
 /**
  * Implementation of the ChainSignatureContract for EVM chains.
@@ -1001,33 +991,27 @@ declare class ChainSignatureContract extends ChainSignatureContract$2 {
     /**
      * Generates the request ID for a signature request allowing to track the response.
      *
-     * @param request - The signature request object containing:
-     *   @param request.address - The contract/wallet address calling the signing contract
-     *   @param request.payload - The data payload to be signed as a hex string
-     *   @param request.path - The derivation path for the key
-     *   @param request.keyVersion - The version of the key to use
-     *   @param request.chainId - The chain ID as a bigint
-     *   @param request.algo - The signing algorithm to use
-     *   @param request.dest - The destination for the signature
-     *   @param request.params - Additional parameters for the signing process
+     * @param args - The signature request object containing:
+     *   @param args.payload - The data payload to be signed as a hex string
+     *   @param args.path - The derivation path for the key
+     *   @param args.keyVersion - The version of the key to use
+     * @param options - The signature request object containing:
+     *   @param options.algo - The signing algorithm to use
+     *   @param options.dest - The destination for the signature
+     *   @param options.params - Additional parameters for the signing process
      * @returns A hex string representing the unique request ID
      *
      * @example
      * ```typescript
      * const requestId = ChainSignatureContract.getRequestId({
-     *   address: walletClient.account.address,
      *   payload: payload: `0x${Buffer.from(args.payload).toString('hex')}`,,
      *   path: '',
-     *   keyVersion: 0,
-     *   chainId: 1n,
-     *   algo: '',
-     *   dest: '',
-     *   params: ''
+     *   keyVersion: 0
      * });
      * console.log(requestId); // 0x...
      * ```
      */
-    getRequestId(request: RequestIdArgs): Hex;
+    getRequestId(args: SignArgs, options?: SignOptions['sign']): Hex;
     getErrorFromEvents(requestId: Hex, fromBlock: bigint): Promise<SignatureErrorData | undefined>;
     /**
      * Searches for SignatureResponded events that match the given requestId.