Enhance code

storyprotocol · Nov 12, 2024 · 827438d · 827438d
1 parent bf765e5
commit 827438d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/packages/core-sdk/src/resources/ipAccount.ts b/packages/core-sdk/src/resources/ipAccount.ts
@@ -72,7 +72,7 @@ export class IPAccountClient {
    *   @param request.deadline The deadline of the transaction signature.
    *   @param request.signature The signature of the transaction, EIP-712 encoded.
    *   @param request.value [Optional] The amount of Ether to send.
-   *   @param request.txOptions [Optional]. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+   *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
    * @returns Tx hash for the transaction.
    */
   public async executeWithSig(

diff --git a/packages/core-sdk/src/utils/sign.ts b/packages/core-sdk/src/utils/sign.ts
@@ -76,6 +76,18 @@ export const getDeadline = (deadline?: bigint | number | string): bigint => {
   return deadline ? timestamp + BigInt(deadline) : timestamp + 1000n;
 };
 
+/**
+ * Get the signature.
+ * @param param - The parameter object containing necessary data to get the signature.
+ * @param param.state - The IP Account's state.
+ * @param param.to - The recipient address.
+ * @param param.encodeData - The encoded data.
+ * @param param.wallet - The wallet client.
+ * @param param.verifyingContract - The verifying contract.
+ * @param param.deadline - The deadline.
+ * @param param.chainId - The chain ID.
+ * @returns A Promise that resolves to the signature.
+ */
 export const getSignature = async ({
   state,
   to,