v1.1.4 (#15)

* Refacto signing (#13)

* fix: sendBatchTransactions

* feat: verifyMessage

* clean: package.json

* update: refacto isSupportedNetwork

* fix: readMe verify message

Author: yoanslvy

.eslintrc

@@ -6,22 +6,19 @@
     "no-loops",
     "prettier",
     "import",
-    "simple-import-sort",
-    "jest"
+    "simple-import-sort"
   ],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
     "prettier",
     "plugin:import/recommended",
-    "plugin:import/typescript",
-    "plugin:jest/recommended"
+    "plugin:import/typescript"
   ],
   "rules": {
     "no-console": 1,
     "no-loops/no-loops": 0,
-    "jest/expect-expect": 0,
     "import/no-named-as-default-member": 0,
     "prettier/prettier": 1,
     "simple-import-sort/imports": "error",

README.md

@@ -105,7 +105,7 @@ const txBatch = [
   { to: DESTINATION, value: VALUE, data: txCallData },
   { to: DESTINATION, value: VALUE, data: txCallData }
 ]
-const txHash = await connectViemClient.sendTransaction(tx)
+const txHash = await connectViemClient.sendBatchTransactions(tx)
 ```
 
 This function relays a batch of transaction data to the targeted addresses. The transaction fees can be sponsored as well.
@@ -146,6 +146,18 @@ const signature = await connectViemAccount.signMessage({ message: 'hello' })
 
 Sign the given message using the EOA, owner of the smart wallet.
 
+### Verify Message
+
+```javascript
+const signature = await connectViemAccount.verifyMessage({
+  message: 'hello',
+  address,
+  signature
+})
+```
+
+Verify the given signature and message signed by the the smart wallet.
+
 ### Sign Transaction
 
 ```javascript

jest.config.json

@@ -1,6 +1,6 @@
 {
   "name": "@cometh/connect-sdk-viem",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Viem SDK Cometh Connect",
@@ -19,7 +19,6 @@
     "build": "rimraf dist && yarn build:ts",
     "prettier-format": "prettier --config .prettierrc 'src/**/*.ts' --write",
     "lint": "eslint . --ext .ts",
-    "test": "jest",
     "prepare": "husky install"
   },
   "repository": {
@@ -35,33 +34,28 @@
   "devDependencies": {
     "@rollup/plugin-typescript": "^11.1.0",
     "@tsconfig/recommended": "^1.0.2",
-    "@types/jest": "^29.4.0",
     "@typescript-eslint/eslint-plugin": "^5.53.0",
     "@typescript-eslint/parser": "^5.53.0",
     "eslint": "^8.34.0",
     "eslint-config-prettier": "^8.0.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-import-resolver-typescript": "^3.5.2",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.1.6",
-    "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-no-loops": "^0.3.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "husky": "^8.0.3",
-    "jest": "^29.2.2",
     "prettier": "2.8.4",
     "rollup": "^3.21.3",
-    "ts-jest": "^29.0.3",
     "ts-loader": "^9.4.2",
     "typescript": "^5.1.3",
     "webpack": "^5.81.0",
     "webpack-cli": "^5.0.2"
   },
   "dependencies": {
     "@babel/traverse": "^7.23.4",
-    "@cometh/connect-sdk": "^1.2.8",
+    "@cometh/connect-sdk": "^1.2.10",
     "@rainbow-me/rainbowkit": "^1.3.0",
     "@types/babel__core": "^7.20.0",
     "viem": "^1.16.2",

package.json

@@ -21,7 +21,7 @@ export const getConnectViemAccount = (
       message: SignableMessage
     }): Promise<Hash> {
       const signedMessage = await wallet.signMessage(message.toString())
-      return `0x${signedMessage}`
+      return signedMessage as `0x${string}`
     },
     /* eslint-disable */
     /* @ts-ignore */

src/account/getConnectViemAccount.ts

@@ -19,9 +19,8 @@ import {
   polygonZkEvmTestnet
 } from 'viem/chains'
 
-import { connectWalletActions } from '../customActions'
-import { ComethAccountActions } from '../customActions/connectWalletActions'
-import { musterTestnet, redstoneHolesky } from '../customChains'
+import { ComethAccountActions, connectWalletActions } from '../customActions'
+import { muster, musterTestnet, redstoneHolesky } from '../customChains'
 
 const supportedChains = [
   polygon,
@@ -33,6 +32,7 @@ const supportedChains = [
   polygonZkEvm,
   polygonZkEvmTestnet,
   musterTestnet,
+  muster,
   redstoneHolesky
 ]
 
@@ -52,11 +52,13 @@ export type ConnectClient<
 
 export type ConnectClientParams = {
   wallet: ComethWallet
+  apiKey: string
   rpc?: string
 }
 
 export const getConnectViemClient = ({
   wallet,
+  apiKey,
   rpc
 }: ConnectClientParams): ConnectClient => {
   const chain = supportedChains.find(
@@ -66,5 +68,5 @@ export const getConnectViemClient = ({
   return createPublicClient({
     chain,
     transport: http(rpc)
-  }).extend(connectWalletActions(wallet))
+  }).extend(connectWalletActions(wallet, apiKey))
 }

src/client/getConnectViemClient.ts

@@ -11,13 +11,14 @@ import {
 } from 'viem'
 
 import { getTransaction } from './getTransaction'
+import { sendBatchTransactions, sendBatchTransactionsWithConnectParameters } from './sendBatchTransactions'
 import {
   sendTransaction,
   SendTransactionWithConnectParameters
 } from './sendTransaction'
-import { sendTransactions, SendTransactionsWithConnectParameters } from './sendTransactions'
-import { signMessage, SignMessageReturnType, SignMessageWithConnectParameters } from './signMessage'
+import { signMessage, SignMessageWithConnectParameters } from './signMessage'
 import { simulateContract, SimulateContractWithConnectParameters } from './simulateContract'
+import { verifyMessage, VerifyMessageWithConnectParameters } from './verifyMessage'
 import {
   writeContract,
   WriteContractWithConnectParameters
@@ -193,14 +194,18 @@ export type ComethAccountActions<
   *   value: 10000000000000000n
   * }])
   */
-  sendTransactions: (
-    args: SendTransactionsWithConnectParameters<TSmartAccount>
-  ) => ReturnType<typeof sendTransactions<TChain, TSmartAccount>>,
+  sendBatchTransactions: (
+    args: sendBatchTransactionsWithConnectParameters
+  ) => ReturnType<typeof sendBatchTransactions<TChain, TSmartAccount>>,
 
   signMessage: (
     args: SignMessageWithConnectParameters<TSmartAccount>
   ) => ReturnType<typeof signMessage>,
 
+  verifyMessage: (
+    args: VerifyMessageWithConnectParameters
+  ) => ReturnType<typeof verifyMessage>,
+
   simulateContract: <
     TChain extends Chain | undefined,
     const TAbi extends Abi | readonly unknown[],
@@ -221,7 +226,7 @@ export type ComethAccountActions<
 
 
 export const connectWalletActions =
-  (wallet: ComethWallet) =>
+  (wallet: ComethWallet, apiKey: string) =>
     <
       TTransport extends Transport,
       TChain extends Chain | undefined = Chain | undefined,
@@ -234,11 +239,11 @@ export const connectWalletActions =
           ...args,
           wallet
         } as SendTransactionWithConnectParameters),
-      sendTransactions: (args) =>
-        sendTransactions(client, {
+      sendBatchTransactions: (args) =>
+        sendBatchTransactions(client, {
           ...args,
           wallet
-        } as SendTransactionsWithConnectParameters),
+        } as sendBatchTransactionsWithConnectParameters),
       writeContract: (args) =>
         writeContract(client, {
           ...args,
@@ -249,11 +254,16 @@ export const connectWalletActions =
           ...args,
           wallet
         } as SignMessageWithConnectParameters),
+      verifyMessage: (args) =>
+        verifyMessage(client, {
+          ...args,
+          apiKey
+        } as VerifyMessageWithConnectParameters),
       simulateContract: (args) =>
         simulateContract(client, {
           ...args,
           wallet
         } as SimulateContractWithConnectParameters)
     })
 
-export { getTransaction, sendTransaction, sendTransactions, simulateContract, writeContract }
+export { getTransaction, sendBatchTransactions, sendTransaction, simulateContract, verifyMessage, writeContract }

src/customActions/connectWalletActions.ts

@@ -70,7 +70,7 @@ export const getTransaction = async ({
   let txFailureEvent
 
   while (!txSuccessEvent && !txFailureEvent) {
-    sleep(2000)
+    sleep(3000)
     txSuccessEvent = await _catchSuccessEvent(
       client,
       from,
@@ -116,6 +116,6 @@ export const getTransaction = async ({
     return txResponse
   }
 
-  sleep(2000)
+  sleep(3000)
   return getTransaction({ client, wallet, safeTxHash })
 }

src/customActions/getTransaction.ts

@@ -9,27 +9,32 @@ import {
   SendTransactionReturnType,
   Transport
 } from 'viem'
-import { GetAccountParameter } from 'viem/_types/types/account'
 
 import { deepHexlify } from '../utils/utils'
+import { getTransaction } from './getTransaction'
 
-export type SendTransactionsWithConnectParameters<
-  TAccount extends Account | undefined = Account | undefined
-> = {
+export type sendBatchTransactionsWithConnectParameters = {
   transactions: { to: Address; value: bigint; data: Hex }[]
-} & GetAccountParameter<TAccount> & {
-    wallet: ComethWallet
-  }
+} & {
+  wallet: ComethWallet
+}
 
-export async function sendTransactions<
+export async function sendBatchTransactions<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined
 >(
   client: Client<Transport, TChain, TAccount>,
-  args: SendTransactionsWithConnectParameters<TAccount>
+  args: sendBatchTransactionsWithConnectParameters
 ): Promise<SendTransactionReturnType> {
   const { transactions, wallet } = args
 
   const result = await wallet.sendBatchTransactions(deepHexlify(transactions))
-  return result.safeTxHash as Hash
+
+  const txReceipt = await getTransaction({
+    client,
+    wallet,
+    safeTxHash: result.safeTxHash as Hash
+  })
+
+  return txReceipt.transactionHash as Hash
 }

src/customActions/sendTransactions.ts renamed to src/customActions/sendBatchTransactions.ts

@@ -8,6 +8,8 @@ import {
   ToHexErrorType
 } from 'viem/utils'
 
+import { getConnectViemAccount } from '../account'
+
 export type SignMessageWithConnectParameters<
   TAccount extends Account | undefined = Account | undefined
 > = GetAccountParameter<TAccount> & {
@@ -31,9 +33,7 @@ export async function signMessage<
 ): Promise<SignMessageReturnType> {
   const { message, wallet } = args
 
-  const signature = (await wallet.signMessage(
-    message as string
-  )) as `0x${string}`
+  const account = getConnectViemAccount(wallet)
 
-  return signature
+  return await account.signMessage({ message })
 }