feat: Viem migration + Passkeys

packages/api-kit/hardhat.config.ts

@@ -1,4 +1,4 @@
-import '@nomicfoundation/hardhat-ethers'
+import '@nomicfoundation/hardhat-viem'
 import dotenv from 'dotenv'
 import { HardhatUserConfig, HttpNetworkUserConfig } from 'hardhat/types'
 import yargs from 'yargs'

packages/api-kit/package.json

@@ -12,14 +12,14 @@
     "API"
   ],
   "scripts": {
-    "test:web3": "export TESTS_PATH=tests/endpoint && export ETH_LIB=web3 && nyc hardhat test",
-    "test:ethers": "export TESTS_PATH=tests/endpoint && export ETH_LIB=ethers && nyc --reporter=lcov  hardhat test",
-    "test:viem": "export TESTS_PATH=tests/endpoint && export ETH_LIB=viem && nyc hardhat test",
-    "test": "yarn test:ethers",
-    "test:ci:web3": "export TESTS_PATH=tests/e2e && export ETH_LIB=web3 && nyc hardhat test",
+    "test:web3": "export TESTS_PATH=tests/endpoint && export ETH_LIB=web3 && nyc --reporter=lcov hardhat test",
+    "test:ethers": "export TESTS_PATH=tests/endpoint && export ETH_LIB=ethers && nyc --reporter=lcov hardhat test",
+    "test:viem": "export TESTS_PATH=tests/endpoint && export ETH_LIB=viem && nyc --reporter=lcov hardhat test",
+    "test": "yarn test:viem",
+    "test:ci:web3": "export TESTS_PATH=tests/e2e && export ETH_LIB=web3 && nyc --reporter=lcov hardhat test",
     "test:ci:ethers": "export TESTS_PATH=tests/e2e && export ETH_LIB=ethers && nyc --reporter=lcov hardhat test",
     "test:ci:viem": "export TESTS_PATH=tests/e2e && export ETH_LIB=viem && nyc --reporter=lcov hardhat test",
-    "test:ci": "yarn test:ci:ethers",
+    "test:ci": "yarn test:ci:viem",
     "format:check": "prettier --check \"*/**/*.{js,json,md,ts}\"",
     "format": "prettier --write \"*/**/*.{js,json,md,ts}\"",
     "unbuild": "rimraf dist .nyc_output cache",
@@ -39,7 +39,8 @@
   ],
   "homepage": "https://github.com/safe-global/safe-core-sdk#readme",
   "devDependencies": {
-    "@nomicfoundation/hardhat-ethers": "^3.0.6",
+    "@nomicfoundation/hardhat-viem": "^2.0.2",
+    "@safe-global/relay-kit": "^3.1.0",
     "@types/chai": "^4.3.16",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.6",
@@ -48,20 +49,21 @@
     "@types/yargs": "^17.0.32",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
+    "ethers": "^6.13.1",
     "hardhat": "2.20.1",
     "mocha": "^10.2.0",
+    "nyc": "^15.1.0",
     "semver": "^7.6.1",
     "sinon": "^14.0.2",
     "sinon-chai": "^3.7.0",
     "tsconfig-paths": "^4.2.0",
-    "viem": "^2.15.1",
     "web3": "^4.7.0",
     "yargs": "^17.7.2"
   },
   "dependencies": {
     "@safe-global/protocol-kit": "^4.1.0",
     "@safe-global/safe-core-sdk-types": "^5.1.0",
-    "ethers": "^6.13.1",
-    "node-fetch": "^2.7.0"
+    "node-fetch": "^2.7.0",
+    "viem": "^2.19.0"
   }
 }

packages/api-kit/src/index.ts

@@ -3,3 +3,9 @@ import SafeApiKit, { SafeApiKitConfig } from './SafeApiKit'
 export * from './types/safeTransactionServiceTypes'
 export { SafeApiKitConfig }
 export default SafeApiKit
+
+declare module 'viem/node_modules/abitype' {
+  export interface Register {
+    AddressType: string
+  }
+}

packages/api-kit/src/types/safeTransactionServiceTypes.ts

@@ -1,4 +1,4 @@
-import { Signer, TypedDataDomain, TypedDataField } from 'ethers'
+import { Account, Chain, Transport, TypedDataDomain, TypedDataParameter, WalletClient } from 'viem'
 import {
   SafeMultisigTransactionResponse,
   SafeTransactionData,
@@ -77,14 +77,14 @@ export type AddSafeDelegateProps = {
   safeAddress?: string
   delegateAddress: string
   delegatorAddress: string
-  signer: Signer
+  signer: WalletClient<Transport, Chain, Account>
   label: string
 }
 
 export type DeleteSafeDelegateProps = {
   delegateAddress: string
   delegatorAddress: string
-  signer: Signer
+  signer: WalletClient<Transport, Chain, Account>
 }
 
 export type SafeDelegateResponse = {
@@ -253,7 +253,7 @@ export type GetSafeMessageListProps = {
 
 export type EIP712TypedData = {
   domain: TypedDataDomain
-  types: TypedDataField
+  types: TypedDataParameter
   message: Record<string, unknown>
 }
 

packages/api-kit/src/utils/signDelegate.ts

@@ -1,10 +1,14 @@
-import { Signer } from 'ethers'
+import { Chain, Account, Transport, WalletClient } from 'viem'
 
-export async function signDelegate(signer: Signer, delegateAddress: string, chainId: bigint) {
+export async function signDelegate(
+  walletClient: WalletClient<Transport, Chain, Account>,
+  delegateAddress: string,
+  chainId: bigint
+) {
   const domain = {
     name: 'Safe Transaction Service',
     version: '1.0',
-    chainId: chainId
+    chainId: Number(chainId)
   }
 
   const types = {
@@ -16,5 +20,10 @@ export async function signDelegate(signer: Signer, delegateAddress: string, chai
 
   const totp = Math.floor(Date.now() / 1000 / 3600)
 
-  return signer.signTypedData(domain, types, { delegateAddress, totp })
+  return walletClient.signTypedData({
+    domain,
+    types,
+    primaryType: 'Delegate',
+    message: { delegateAddress, totp }
+  })
 }

packages/api-kit/tests/e2e/addSafeDelegate.test.ts

@@ -1,4 +1,6 @@
-import { ethers, Signer } from 'ethers'
+import { Address, createWalletClient, http } from 'viem'
+import { privateKeyToAccount } from 'viem/accounts'
+import { sepolia } from 'viem/chains'
 import SafeApiKit, { AddSafeDelegateProps } from '@safe-global/api-kit/index'
 import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
@@ -11,17 +13,22 @@ const PRIVATE_KEY_1 = '0x83a415ca62e11f5fa5567e98450d0f82ae19ff36ef876c10a8d448c
 const PRIVATE_KEY_2 = '0xb0057716d5917badaf911b193b12b910811c1497b5bada8d7711f758981c3773'
 
 let safeApiKit: SafeApiKit
-let signer: Signer
+let signer: AddSafeDelegateProps['signer']
+let delegatorAddress: Address
 
 describe('addSafeDelegate', () => {
   before(async () => {
     safeApiKit = getApiKit('https://safe-transaction-sepolia.staging.5afe.dev/api')
-    signer = new ethers.Wallet(PRIVATE_KEY_1)
+    signer = createWalletClient({
+      chain: sepolia,
+      transport: http(),
+      account: privateKeyToAccount(PRIVATE_KEY_1)
+    })
+    delegatorAddress = signer.account.address
   })
 
   it('should fail if Label is empty', async () => {
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'
-    const delegatorAddress = await signer.getAddress()
     const delegateConfig: AddSafeDelegateProps = {
       delegateAddress,
       delegatorAddress,
@@ -35,7 +42,6 @@ describe('addSafeDelegate', () => {
 
   it('should fail if Safe delegate address is empty', async () => {
     const delegateAddress = ''
-    const delegatorAddress = await signer.getAddress()
     const delegateConfig: AddSafeDelegateProps = {
       delegateAddress,
       delegatorAddress,
@@ -64,7 +70,6 @@ describe('addSafeDelegate', () => {
   it('should fail if Safe address is not checksummed', async () => {
     const safeAddress = '0xF8ef84392f7542576F6b9d1b140334144930Ac78'.toLowerCase()
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'
-    const delegatorAddress = await signer.getAddress()
     const delegateConfig: AddSafeDelegateProps = {
       safeAddress,
       delegateAddress,
@@ -80,7 +85,6 @@ describe('addSafeDelegate', () => {
   it('should fail if Safe delegate address is not checksummed', async () => {
     const safeAddress = '0xF8ef84392f7542576F6b9d1b140334144930Ac78'
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'.toLowerCase()
-    const delegatorAddress = await signer.getAddress()
     const delegateConfig: AddSafeDelegateProps = {
       safeAddress,
       delegateAddress,
@@ -96,23 +100,22 @@ describe('addSafeDelegate', () => {
   it('should fail if Safe delegator address is not checksummed', async () => {
     const safeAddress = '0xF8ef84392f7542576F6b9d1b140334144930Ac78'
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'
-    const delegatorAddress = (await signer.getAddress()).toLowerCase()
+    const delegatorAddressLowerCase = delegatorAddress.toLowerCase()
     const delegateConfig: AddSafeDelegateProps = {
       safeAddress,
       delegateAddress,
-      delegatorAddress,
+      delegatorAddress: delegatorAddressLowerCase,
       signer,
       label: 'Label'
     }
     await chai
       .expect(safeApiKit.addSafeDelegate(delegateConfig))
-      .to.be.rejectedWith(`Address ${delegatorAddress} is not checksumed`)
+      .to.be.rejectedWith(`Address ${delegatorAddressLowerCase} is not checksumed`)
   })
 
   it('should fail if Safe does not exist', async () => {
     const safeAddress = '0x1dF62f291b2E969fB0849d99D9Ce41e2F137006e'
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'
-    const delegatorAddress = await signer.getAddress()
     const delegateConfig: AddSafeDelegateProps = {
       safeAddress,
       delegateAddress,
@@ -128,8 +131,12 @@ describe('addSafeDelegate', () => {
   it('should fail if the signer is not an owner of the Safe', async () => {
     const safeAddress = '0xF8ef84392f7542576F6b9d1b140334144930Ac78'
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'
-    const nonOwnerSigner = new ethers.Wallet(PRIVATE_KEY_2)
-    const delegatorAddress = await nonOwnerSigner.getAddress()
+    const nonOwnerSigner = createWalletClient({
+      chain: sepolia,
+      transport: http(),
+      account: privateKeyToAccount(PRIVATE_KEY_2)
+    })
+    const delegatorAddress = (await nonOwnerSigner.getAddresses())[0]
     const delegateConfig: AddSafeDelegateProps = {
       safeAddress,
       delegateAddress,
@@ -147,7 +154,6 @@ describe('addSafeDelegate', () => {
   it('should add a new delegate', async () => {
     const safeAddress = '0xF8ef84392f7542576F6b9d1b140334144930Ac78'
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'
-    const delegatorAddress = await signer.getAddress()
     const delegateConfig: AddSafeDelegateProps = {
       safeAddress,
       delegateAddress,
@@ -170,7 +176,6 @@ describe('addSafeDelegate', () => {
 
   it('should add a new delegate without specifying a Safe', async () => {
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'
-    const delegatorAddress = await signer.getAddress()
     const delegateConfig: AddSafeDelegateProps = {
       delegateAddress,
       delegatorAddress,
@@ -200,7 +205,6 @@ describe('addSafeDelegate', () => {
     const eip3770SafeAddress = `${config.EIP_3770_PREFIX}:${safeAddress}`
     const delegateAddress = '0x9cCBDE03eDd71074ea9c49e413FA9CDfF16D263B'
     const eip3770DelegateAddress = `${config.EIP_3770_PREFIX}:${delegateAddress}`
-    const delegatorAddress = await signer.getAddress()
     const eip3770DelegatorAddress = `${config.EIP_3770_PREFIX}:${delegatorAddress}`
     const delegateConfig: AddSafeDelegateProps = {
       safeAddress: eip3770SafeAddress,

packages/api-kit/tests/e2e/addSafeOperation.test.ts

@@ -1,15 +1,20 @@
 import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
-import { ethers } from 'ethers'
 import sinon from 'sinon'
 import sinonChai from 'sinon-chai'
 import Safe from '@safe-global/protocol-kit'
 import SafeApiKit from '@safe-global/api-kit/index'
-import { Safe4337Pack } from '@safe-global/relay-kit'
+import { getAddSafeOperationProps } from '@safe-global/api-kit/utils/safeOperation'
+import { BundlerClient, Safe4337Pack } from '@safe-global/relay-kit'
 import { generateTransferCallData } from '@safe-global/relay-kit/packs/safe-4337/testing-utils/helpers'
-import { RPC_4337_CALLS } from '@safe-global/relay-kit/packs/safe-4337/constants'
+import {
+  ENTRYPOINT_ABI,
+  ENTRYPOINT_ADDRESS_V06,
+  RPC_4337_CALLS
+} from '@safe-global/relay-kit/packs/safe-4337/constants'
+// Needs to be imported from dist folder in order to mock the getEip4337BundlerProvider function
+import * as safe4337Utils from '@safe-global/relay-kit/dist/src/packs/safe-4337/utils'
 import { getKits } from '../utils/setupKits'
-import { getAddSafeOperationProps } from '@safe-global/api-kit/utils/safeOperation'
 
 chai.use(chaiAsPromised)
 chai.use(sinonChai)
@@ -18,7 +23,7 @@ const SIGNER_PK = '0x83a415ca62e11f5fa5567e98450d0f82ae19ff36ef876c10a8d448c788a
 const SAFE_ADDRESS = '0x60C4Ab82D06Fd7dFE9517e17736C2Dcc77443EF0' // 1/2 Safe (v1.4.1) with signer above being an owner + 4337 module enabled
 const PAYMASTER_TOKEN_ADDRESS = '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238'
 const PAYMASTER_ADDRESS = '0x0000000000325602a77416A16136FDafd04b299f'
-const BUNDLER_URL = `https://bundler.url`
+const BUNDLER_URL = 'https://bundler.url'
 const TX_SERVICE_URL = 'https://safe-transaction-sepolia.staging.5afe.dev/api'
 
 let safeApiKit: SafeApiKit
@@ -33,35 +38,42 @@ describe('addSafeOperation', () => {
     operation: 0
   }
 
+  const requestStub = sinon.stub()
   // Setup mocks for the bundler client
-  const providerStub = sinon.stub(ethers.JsonRpcProvider.prototype, 'send')
-
-  providerStub.withArgs(RPC_4337_CALLS.CHAIN_ID, []).returns(Promise.resolve('0xaa36a7'))
-  providerStub
-    .withArgs(RPC_4337_CALLS.SUPPORTED_ENTRY_POINTS, [])
-    .returns(Promise.resolve(['0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789']))
-  providerStub
-    .withArgs('pimlico_getUserOperationGasPrice', [])
-    .returns(
-      Promise.resolve({ fast: { maxFeePerGas: '0x3b9aca00', maxPriorityFeePerGas: '0x3b9aca00' } })
-    )
-  providerStub.withArgs(RPC_4337_CALLS.ESTIMATE_USER_OPERATION_GAS, sinon.match.any).returns(
-    Promise.resolve({
-      preVerificationGas: BigInt(Date.now()),
-      callGasLimit: BigInt(Date.now()),
-      verificationGasLimit: BigInt(Date.now())
-    })
-  )
-
-  providerStub.callThrough()
-
   before(async () => {
+    sinon.stub(safe4337Utils, 'getEip4337BundlerProvider').returns({
+      request: requestStub,
+      readContract: sinon
+        .stub()
+        .withArgs({
+          address: ENTRYPOINT_ADDRESS_V06,
+          abi: ENTRYPOINT_ABI,
+          functionName: 'getNonce',
+          args: [SAFE_ADDRESS, BigInt(0)]
+        })
+        .resolves(123n)
+    } as unknown as BundlerClient)
     ;({ safeApiKit, protocolKit } = await getKits({
       safeAddress: SAFE_ADDRESS,
       signer: SIGNER_PK,
       txServiceUrl: TX_SERVICE_URL
     }))
 
+    requestStub.withArgs({ method: RPC_4337_CALLS.CHAIN_ID }).resolves('0xaa36a7')
+    requestStub
+      .withArgs({ method: RPC_4337_CALLS.SUPPORTED_ENTRY_POINTS })
+      .resolves([ENTRYPOINT_ADDRESS_V06])
+    requestStub
+      .withArgs({ method: 'pimlico_getUserOperationGasPrice' })
+      .resolves({ fast: { maxFeePerGas: '0x3b9aca00', maxPriorityFeePerGas: '0x3b9aca00' } })
+    requestStub
+      .withArgs({ method: RPC_4337_CALLS.ESTIMATE_USER_OPERATION_GAS, params: sinon.match.any })
+      .resolves({
+        preVerificationGas: BigInt(Date.now()),
+        callGasLimit: BigInt(Date.now()),
+        verificationGasLimit: BigInt(Date.now())
+      })
+
     safe4337Pack = await Safe4337Pack.init({
       provider: protocolKit.getSafeProvider().provider,
       signer: protocolKit.getSafeProvider().signer,
@@ -74,6 +86,10 @@ describe('addSafeOperation', () => {
     })
   })
 
+  after(() => {
+    sinon.restore()
+  })
+
   describe('should fail', () => {
     it('if safeAddress is empty', async () => {
       const safeOperation = await safe4337Pack.createTransaction({ transactions: [transferUSDC] })