feat(protocol-kit): Add EIP-1193 provider support

.github/workflows/test_contracts.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         node-version: [18.x]
-        provider: [ethers, web3]
+        provider: [ethers, web3, viem]
         contract-version: [v1.0.0, v1.1.1, v1.2.0, v1.3.0, v1.4.1]
     steps:
       - uses: actions/checkout@v3

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

@@ -1,5 +1,5 @@
 import Safe from '@safe-global/protocol-kit'
-import { EthAdapter } from '@safe-global/safe-core-sdk-types'
+import { Eip1193Provider } from '@safe-global/safe-core-sdk-types'
 import SafeApiKit from '@safe-global/api-kit/index'
 import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
@@ -8,7 +8,7 @@ import { getServiceClient } from '../utils/setupServiceClient'
 chai.use(chaiAsPromised)
 
 let safeApiKit: SafeApiKit
-let ethAdapter: EthAdapter
+let provider: Eip1193Provider
 let protocolKit: Safe
 
 const generateRandomUUID = (): string => {
@@ -24,12 +24,12 @@ const safeAddress = '0x3296b3DD454B7c3912F7F477787B503918C50082'
 
 describe('addMessage', () => {
   before(async () => {
-    ;({ safeApiKit, ethAdapter } = await getServiceClient(
+    ;({ safeApiKit, provider } = await getServiceClient(
       '0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d'
     ))
 
     protocolKit = await Safe.create({
-      ethAdapter,
+      provider,
       safeAddress
     })
   })

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

@@ -5,7 +5,7 @@ import Safe, {
   SigningMethod,
   buildContractSignature
 } from '@safe-global/protocol-kit'
-import { EthAdapter, SafeMessage } from '@safe-global/safe-core-sdk-types'
+import { Eip1193Provider, SafeMessage } from '@safe-global/safe-core-sdk-types'
 import SafeApiKit from '@safe-global/api-kit/index'
 import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
@@ -15,8 +15,8 @@ chai.use(chaiAsPromised)
 
 let safeApiKit1: SafeApiKit
 let protocolKit: Safe
-let ethAdapter1: EthAdapter
-let ethAdapter2: EthAdapter
+let provider1: Eip1193Provider
+let provider2: Eip1193Provider
 
 const generateRandomUUID = (): string => {
   return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
@@ -32,11 +32,11 @@ const signerSafeAddress = '0x83aB93f078A8fbbe6a677b1C488819e0ae981128'
 
 describe('addMessageSignature', () => {
   before(async () => {
-    ;({ safeApiKit: safeApiKit1, ethAdapter: ethAdapter1 } = await getServiceClient(
+    ;({ safeApiKit: safeApiKit1, provider: provider1 } = await getServiceClient(
       '0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d',
       'https://safe-transaction-goerli.staging.5afe.dev/api'
     ))
-    ;({ ethAdapter: ethAdapter2 } = await getServiceClient(
+    ;({ provider: provider2 } = await getServiceClient(
       '0x6cbed15c793ce57650b9877cf6fa156fbef513c4e6134f022a85b1ffdd59b2a1'
     ))
   })
@@ -56,7 +56,7 @@ describe('addMessageSignature', () => {
   describe('when adding a new message', () => {
     beforeEach(async () => {
       protocolKit = await Safe.create({
-        ethAdapter: ethAdapter1,
+        provider: provider1,
         safeAddress
       })
     })
@@ -66,7 +66,7 @@ describe('addMessageSignature', () => {
       let safeMessage: SafeMessage = protocolKit.createMessage(rawMessage)
       safeMessage = await protocolKit.signMessage(safeMessage, 'eth_sign')
 
-      let signerAddress = (await ethAdapter1.getSignerAddress()) || '0x'
+      let signerAddress = (await protocolKit.getSafeProvider().getSignerAddress()) || '0x'
 
       await chai.expect(
         safeApiKit1.addMessage(safeAddress, {
@@ -75,11 +75,11 @@ describe('addMessageSignature', () => {
         })
       ).to.be.fulfilled
 
-      protocolKit = await protocolKit.connect({ ethAdapter: ethAdapter2 })
+      protocolKit = await protocolKit.connect({ provider: provider2 })
       safeMessage = await protocolKit.signMessage(safeMessage, 'eth_signTypedData_v4')
 
       const safeMessageHash = await protocolKit.getSafeMessageHash(hashSafeMessage(rawMessage))
-      signerAddress = (await ethAdapter2.getSignerAddress()) || '0x'
+      signerAddress = (await protocolKit.getSafeProvider().getSignerAddress()) || '0x'
 
       await chai.expect(
         safeApiKit1.addMessageSignature(
@@ -95,7 +95,7 @@ describe('addMessageSignature', () => {
 
     it('should allow to add a confirmation signature using a Safe signer', async () => {
       protocolKit = await protocolKit.connect({
-        ethAdapter: ethAdapter1,
+        provider: provider1,
         safeAddress
       })
 
@@ -105,7 +105,7 @@ describe('addMessageSignature', () => {
       let safeMessage: SafeMessage = protocolKit.createMessage(rawMessage)
       safeMessage = await protocolKit.signMessage(safeMessage, 'eth_sign')
 
-      const signerAddress = (await ethAdapter1.getSignerAddress()) || '0x'
+      const signerAddress = (await protocolKit.getSafeProvider().getSignerAddress()) || '0x'
       const ethSig = safeMessage.getSignature(signerAddress) as EthSafeSignature
 
       await chai.expect(
@@ -116,7 +116,7 @@ describe('addMessageSignature', () => {
       ).to.be.fulfilled
 
       protocolKit = await protocolKit.connect({
-        ethAdapter: ethAdapter1,
+        provider: provider1,
         safeAddress: signerSafeAddress
       })
       let signerSafeMessage = protocolKit.createMessage(rawMessage)
@@ -127,7 +127,7 @@ describe('addMessageSignature', () => {
       )
 
       protocolKit = await protocolKit.connect({
-        ethAdapter: ethAdapter2,
+        provider: provider2,
         safeAddress: signerSafeAddress
       })
       signerSafeMessage = await protocolKit.signMessage(
@@ -142,7 +142,7 @@ describe('addMessageSignature', () => {
       )
 
       protocolKit = await protocolKit.connect({
-        ethAdapter: ethAdapter1,
+        provider: provider1,
         safeAddress
       })
 

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

@@ -4,7 +4,7 @@ import Safe, {
   SigningMethod,
   buildContractSignature
 } from '@safe-global/protocol-kit'
-import { EthAdapter, SafeTransactionDataPartial } from '@safe-global/safe-core-sdk-types'
+import { Eip1193Provider, SafeTransactionDataPartial } from '@safe-global/safe-core-sdk-types'
 import SafeApiKit from '@safe-global/api-kit/index'
 import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
@@ -14,27 +14,27 @@ chai.use(chaiAsPromised)
 
 let safeApiKit1: SafeApiKit
 let protocolKit: Safe
-let ethAdapter1: EthAdapter
-let ethAdapter2: EthAdapter
+let provider1: Eip1193Provider
+let provider2: Eip1193Provider
 
 const safeAddress = '0x3296b3DD454B7c3912F7F477787B503918C50082'
 const signerSafeAddress = '0x83aB93f078A8fbbe6a677b1C488819e0ae981128'
 
 describe('proposeTransaction', () => {
   before(async () => {
-    ;({ safeApiKit: safeApiKit1, ethAdapter: ethAdapter1 } = await getServiceClient(
+    ;({ safeApiKit: safeApiKit1, provider: provider1 } = await getServiceClient(
       '0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d',
       'https://safe-transaction-goerli.staging.5afe.dev/api'
     ))
-    ;({ ethAdapter: ethAdapter2 } = await getServiceClient(
+    ;({ provider: provider2 } = await getServiceClient(
       '0x6cbed15c793ce57650b9877cf6fa156fbef513c4e6134f022a85b1ffdd59b2a1',
       'https://safe-transaction-goerli.staging.5afe.dev/api'
     ))
   })
 
   beforeEach(async () => {
     protocolKit = await Safe.create({
-      ethAdapter: ethAdapter1,
+      provider: provider1,
       safeAddress
     })
   })
@@ -52,7 +52,7 @@ describe('proposeTransaction', () => {
     // EOA signature
     tx = await protocolKit.signTransaction(tx)
 
-    const signerAddress = (await ethAdapter1.getSignerAddress()) || '0x'
+    const signerAddress = (await provider1.getSignerAddress()) || '0x'
     const ethSig = tx.getSignature(signerAddress) as EthSafeSignature
 
     const txOptions = {
@@ -67,7 +67,7 @@ describe('proposeTransaction', () => {
 
     // Signer Safe signature
     protocolKit = await protocolKit.connect({
-      ethAdapter: ethAdapter1,
+      provider: provider1,
       safeAddress: signerSafeAddress
     })
 
@@ -81,7 +81,7 @@ describe('proposeTransaction', () => {
     )
 
     protocolKit = await protocolKit.connect({
-      ethAdapter: ethAdapter2,
+      provider: provider2,
       safeAddress: signerSafeAddress
     })
     signerSafeTx = await protocolKit.signTransaction(
@@ -96,7 +96,7 @@ describe('proposeTransaction', () => {
     )
 
     protocolKit = await protocolKit.connect({
-      ethAdapter: ethAdapter1,
+      provider: provider1,
       safeAddress
     })
 

packages/api-kit/tests/endpoint/index.test.ts

@@ -7,7 +7,7 @@ import SafeApiKit, {
 } from '@safe-global/api-kit/index'
 import * as httpRequests from '@safe-global/api-kit/utils/httpRequests'
 import Safe from '@safe-global/protocol-kit'
-import { EthAdapter } from '@safe-global/safe-core-sdk-types'
+import { Eip1193Provider } from '@safe-global/safe-core-sdk-types'
 import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
 import sinon from 'sinon'
@@ -28,19 +28,19 @@ const tokenAddress = '0x210EC22dD6b1c174E5cA1A261DD9791e0755cc6D'
 const eip3770TokenAddress = `${config.EIP_3770_PREFIX}:${tokenAddress}`
 const safeTxHash = '0xede78ed72e9a8afd2b7a21f35c86f56cba5fffb2fff0838e253b7a41d19ceb48'
 const txServiceBaseUrl = 'https://safe-transaction-goerli.safe.global/api'
-const provider = getDefaultProvider(config.JSON_RPC)
+const defaultProvider = getDefaultProvider(config.JSON_RPC)
 const signer = new Wallet(
   '0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d',
-  provider
+  defaultProvider
 )
-let ethAdapter: EthAdapter
+let provider: Eip1193Provider
 let safeApiKit: SafeApiKit
 let delegatorAddress: string
 let eip3770DelegatorAddress: string
 
 describe('Endpoint tests', () => {
   before(async () => {
-    ;({ safeApiKit, ethAdapter } = await getServiceClient(
+    ;({ safeApiKit, provider } = await getServiceClient(
       '0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d'
     ))
     delegatorAddress = await signer.getAddress()
@@ -364,7 +364,7 @@ describe('Endpoint tests', () => {
       }
       const origin = 'Safe Core SDK: Safe API Kit'
       const signerAddress = await signer.getAddress()
-      const safeSdk = await Safe.create({ ethAdapter, safeAddress })
+      const safeSdk = await Safe.create({ provider, safeAddress })
       const safeTransaction = await safeSdk.createTransaction({
         transactions: [safeTransactionData],
         options
@@ -413,7 +413,7 @@ describe('Endpoint tests', () => {
       }
       const origin = 'Safe Core SDK: Safe API Kit'
       const signerAddress = await signer.getAddress()
-      const safeSdk = await Safe.create({ ethAdapter, safeAddress })
+      const safeSdk = await Safe.create({ provider, safeAddress })
       const safeTransaction = await safeSdk.createTransaction({
         transactions: [safeTransactionData],
         options

packages/api-kit/tests/utils/setupEthAdapter.ts

@@ -1,35 +1,17 @@
-import { AbstractSigner, Provider } from 'ethers'
-import { EthAdapter } from '@safe-global/safe-core-sdk-types'
-import {
-  EthersAdapter,
-  EthersAdapterConfig,
-  Web3Adapter,
-  Web3AdapterConfig
-} from '@safe-global/protocol-kit'
 import { ethers, web3 } from 'hardhat'
+import { Eip1193Provider } from '@safe-global/safe-core-sdk-types'
 
-export async function getEthAdapter(
-  signerOrProvider: AbstractSigner | Provider
-): Promise<EthAdapter> {
-  let ethAdapter: EthAdapter
+export function getEip1193Provider(): Eip1193Provider {
   switch (process.env.ETH_LIB) {
     case 'web3':
-      const signerAddress =
-        signerOrProvider instanceof AbstractSigner ? await signerOrProvider.getAddress() : undefined
-
-      const web3AdapterConfig: Web3AdapterConfig = {
-        web3,
-        signerAddress
-      }
-
-      ethAdapter = new Web3Adapter(web3AdapterConfig)
-      break
+      return web3.currentProvider as Eip1193Provider
     case 'ethers':
-      const ethersAdapterConfig: EthersAdapterConfig = { ethers, signerOrProvider }
-      ethAdapter = new EthersAdapter(ethersAdapterConfig)
-      break
+      return {
+        request: async (request) => {
+          return ethers.provider.send(request.method, [...((request.params as unknown[]) ?? [])])
+        }
+      }
     default:
       throw new Error('Ethereum library not supported')
   }
-  return ethAdapter
 }

packages/api-kit/tests/utils/setupServiceClient.ts

@@ -1,22 +1,22 @@
 import { getDefaultProvider, Wallet } from 'ethers'
-import { EthAdapter } from '@safe-global/safe-core-sdk-types'
+import { Eip1193Provider } from '@safe-global/safe-core-sdk-types'
 import SafeApiKit from '@safe-global/api-kit/index'
 import config from '../utils/config'
-import { getEthAdapter } from '../utils/setupEthAdapter'
+import { getEip1193Provider } from '../utils/setupEthAdapter'
 
 interface ServiceClientConfig {
   safeApiKit: SafeApiKit
-  ethAdapter: EthAdapter
+  provider: Eip1193Provider
   signer: Wallet
 }
 
 export async function getServiceClient(
   signerPk: string,
   txServiceUrl?: string
 ): Promise<ServiceClientConfig> {
-  const provider = getDefaultProvider(config.JSON_RPC)
-  const signer = new Wallet(signerPk, provider)
-  const ethAdapter = await getEthAdapter(signer)
+  const signer = new Wallet(signerPk, getDefaultProvider(config.JSON_RPC))
+  const provider = getEip1193Provider()
   const safeApiKit = new SafeApiKit({ chainId: config.CHAIN_ID, txServiceUrl })
-  return { safeApiKit, ethAdapter, signer }
+
+  return { safeApiKit, provider, signer }
 }

packages/protocol-kit/package.json

@@ -33,6 +33,11 @@
     "test:hardhat:ethers:v1.2.0": "export TEST_NETWORK=hardhat && export ETH_LIB=ethers && export SAFE_VERSION=1.2.0 && hardhat deploy && nyc hardhat test",
     "test:hardhat:ethers:v1.3.0": "export TEST_NETWORK=hardhat && export ETH_LIB=ethers && export SAFE_VERSION=1.3.0 && hardhat deploy && nyc hardhat test",
     "test:hardhat:ethers:v1.4.1": "export TEST_NETWORK=hardhat && export ETH_LIB=ethers && export SAFE_VERSION=1.4.1 && hardhat deploy && nyc hardhat test",
+    "test:hardhat:viem:v1.0.0": "export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.0.0 && hardhat deploy && nyc hardhat test",
+    "test:hardhat:viem:v1.1.1": "export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.1.1 && hardhat deploy && nyc hardhat test",
+    "test:hardhat:viem:v1.2.0": "export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.2.0 && hardhat deploy && nyc hardhat test",
+    "test:hardhat:viem:v1.3.0": "export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.3.0 && hardhat deploy && nyc hardhat test",
+    "test:hardhat:viem:v1.4.1": "export TEST_NETWORK=hardhat && export ETH_LIB=viem && export SAFE_VERSION=1.4.1 && hardhat deploy && nyc hardhat test",
     "coverage": "nyc report --reporter=lcov",
     "format:check": "prettier --check \"*/**/*.{js,json,md,ts}\"",
     "format": "prettier --write \"*/**/*.{js,json,md,ts}\"",
@@ -60,7 +65,6 @@
     "@safe-global/safe-contracts-v1.4.1": "npm:@safe-global/[email protected]",
     "@safe-global/safe-core-sdk-types": "^4.0.1",
     "@typechain/ethers-v6": "^0.5.0",
-    "@typechain/web3-v1": "^6.0.7",
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.6",
@@ -78,16 +82,15 @@
     "nyc": "^15.1.0",
     "tsconfig-paths": "^4.2.0",
     "typechain": "^8.3.2",
+    "viem": "^2.9.19",
+    "web3": "^4.7.0",
     "yargs": "^17.7.2"
   },
   "dependencies": {
     "@noble/hashes": "^1.3.3",
     "@safe-global/safe-deployments": "^1.33.0",
     "ethereumjs-util": "^7.1.5",
     "ethers": "^6.7.1",
-    "semver": "^7.5.4",
-    "web3": "^1.10.3",
-    "web3-core": "^1.10.3",
-    "web3-utils": "^1.10.3"
+    "semver": "^7.5.4"
   }
 }