feat: 4337 integration

.github/workflows/test.yml

@@ -26,6 +26,8 @@ jobs:
         run: yarn build
 
       - name: Test
+        env:
+          PRIVATE_KEY: ${{ secrets.TESTING_PRIVATE_KEY }}
         run: yarn test
 
       - name: Upload coverage report

packages/account-abstraction-kit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/account-abstraction-kit-poc",
-  "version": "2.0.3",
+  "version": "2.1.0-alpha.0",
   "description": "Safe Account Abstraction Kit PoC",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
@@ -34,8 +34,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@safe-global/protocol-kit": "^3.0.2",
-    "@safe-global/relay-kit": "^2.0.3",
+    "@safe-global/protocol-kit": "^3.1.0-alpha.0",
+    "@safe-global/relay-kit": "^2.1.0-alpha.0",
     "@safe-global/safe-core-sdk-types": "^4.0.2"
   }
 }

packages/account-abstraction-kit/src/AccountAbstraction.test.ts

@@ -1,5 +1,5 @@
 import Safe, { predictSafeAddress } from '@safe-global/protocol-kit'
-import { GelatoRelayPack, RelayKitBasePack } from '@safe-global/relay-kit'
+import { GelatoRelayPack } from '@safe-global/relay-kit'
 import { EthAdapter, SafeTransaction } from '@safe-global/safe-core-sdk-types'
 import AccountAbstraction from './AccountAbstraction'
 
@@ -153,11 +153,9 @@ describe('AccountAbstraction', () => {
       const relayResponseMock = { taskId: '0xTaskID' }
 
       it('should return the Gelato taskId of the relayed transaction', async () => {
-        GelatoRelayPackMock.prototype.createRelayedTransaction.mockResolvedValueOnce(safeTxMock)
+        GelatoRelayPackMock.prototype.createTransaction.mockResolvedValueOnce(safeTxMock)
         safeInstanceMock.signTransaction.mockResolvedValueOnce(signedSafeTxMock)
-        GelatoRelayPackMock.prototype.executeRelayTransaction.mockResolvedValueOnce(
-          relayResponseMock
-        )
+        GelatoRelayPackMock.prototype.executeTransaction.mockResolvedValueOnce(relayResponseMock)
         accountAbstraction.setRelayKit(
           new GelatoRelayPack({ protocolKit: accountAbstraction.protocolKit })
         )
@@ -166,20 +164,20 @@ describe('AccountAbstraction', () => {
 
         expect(result).toBe(relayResponseMock)
 
-        expect(GelatoRelayPackMock.prototype.createRelayedTransaction).toHaveBeenCalledTimes(1)
-        expect(GelatoRelayPackMock.prototype.createRelayedTransaction).toHaveBeenCalledWith({
+        expect(GelatoRelayPackMock.prototype.createTransaction).toHaveBeenCalledTimes(1)
+        expect(GelatoRelayPackMock.prototype.createTransaction).toHaveBeenCalledWith({
           transactions: transactionsMock,
           options: optionsMock
         })
 
         expect(safeInstanceMock.signTransaction).toHaveBeenCalledTimes(1)
         expect(safeInstanceMock.signTransaction).toHaveBeenCalledWith(safeTxMock)
 
-        expect(GelatoRelayPackMock.prototype.executeRelayTransaction).toHaveBeenCalledTimes(1)
-        expect(GelatoRelayPackMock.prototype.executeRelayTransaction).toHaveBeenCalledWith(
-          signedSafeTxMock,
-          optionsMock
-        )
+        expect(GelatoRelayPackMock.prototype.executeTransaction).toHaveBeenCalledTimes(1)
+        expect(GelatoRelayPackMock.prototype.executeTransaction).toHaveBeenCalledWith({
+          executable: signedSafeTxMock,
+          options: optionsMock
+        })
       })
 
       it('should throw if the protocol-kit is not initialized', async () => {
@@ -192,21 +190,22 @@ describe('AccountAbstraction', () => {
           'protocolKit not initialized. Call init() first'
         )
 
-        expect(GelatoRelayPackMock.prototype.createRelayedTransaction).not.toHaveBeenCalled()
+        expect(GelatoRelayPackMock.prototype.createTransaction).not.toHaveBeenCalled()
         expect(safeInstanceMock.signTransaction).not.toHaveBeenCalled()
-        expect(GelatoRelayPackMock.prototype.executeRelayTransaction).not.toHaveBeenCalled()
+        expect(GelatoRelayPackMock.prototype.executeTransaction).not.toHaveBeenCalled()
       })
 
       it('should throw if relay-kit is not initialized', async () => {
-        accountAbstraction.setRelayKit(undefined as unknown as RelayKitBasePack)
+        const accountAbstraction = new AccountAbstraction(ethersAdapter as unknown as EthAdapter)
+        await accountAbstraction.init()
 
         expect(accountAbstraction.relayTransaction(transactionsMock, optionsMock)).rejects.toThrow(
           'relayKit not initialized. Call setRelayKit(pack) first'
         )
 
-        expect(GelatoRelayPackMock.prototype.createRelayedTransaction).not.toHaveBeenCalled()
+        expect(GelatoRelayPackMock.prototype.createTransaction).not.toHaveBeenCalled()
         expect(safeInstanceMock.signTransaction).not.toHaveBeenCalled()
-        expect(GelatoRelayPackMock.prototype.executeRelayTransaction).not.toHaveBeenCalled()
+        expect(GelatoRelayPackMock.prototype.executeTransaction).not.toHaveBeenCalled()
       })
     })
   })

packages/account-abstraction-kit/src/AccountAbstraction.ts

@@ -3,7 +3,8 @@ import { RelayKitBasePack } from '@safe-global/relay-kit'
 import {
   MetaTransactionData,
   MetaTransactionOptions,
-  EthAdapter
+  EthAdapter,
+  SafeTransaction
 } from '@safe-global/safe-core-sdk-types'
 
 /**
@@ -91,14 +92,14 @@ class AccountAbstraction {
       throw new Error('relayKit not initialized. Call setRelayKit(pack) first')
     }
 
-    const relayedTransaction = await this.relayKit.createRelayedTransaction({
+    const relayedTransaction = (await this.relayKit.createTransaction({
       transactions,
       options
-    })
+    })) as SafeTransaction
 
     const signedSafeTransaction = await this.protocolKit.signTransaction(relayedTransaction)
 
-    return await this.relayKit.executeRelayTransaction(signedSafeTransaction, options)
+    return this.relayKit.executeTransaction({ executable: signedSafeTransaction, options })
   }
 }
 

packages/protocol-kit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/protocol-kit",
-  "version": "3.0.2",
+  "version": "3.1.0-alpha.0",
   "description": "SDK to interact with Safe smart contracts",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

packages/protocol-kit/src/Safe.ts

@@ -19,6 +19,7 @@ import {
 import {
   encodeSetupCallData,
   getChainSpecificDefaultSaltNonce,
+  getPredictedSafeAddressInitCode,
   predictSafeAddress
 } from './contracts/utils'
 import { DEFAULT_SAFE_VERSION } from './contracts/config'
@@ -188,6 +189,26 @@ class Safe {
     })
   }
 
+  /**
+   * Returns the initialization code to deploy a Safe account based on the predicted address.
+   *
+   * @returns The Safe configuration
+   */
+  async getInitCode(): Promise<string> {
+    if (!this.#predictedSafe) {
+      throw new Error('The Safe already exists')
+    }
+
+    const chainId = await this.#ethAdapter.getChainId()
+
+    return getPredictedSafeAddressInitCode({
+      ethAdapter: this.#ethAdapter,
+      chainId,
+      customContracts: this.#contractManager.contractNetworks?.[chainId.toString()],
+      ...this.#predictedSafe
+    })
+  }
+
   /**
    * Returns the address of the current SafeProxy contract.
    *

packages/protocol-kit/src/contracts/utils.ts

@@ -66,12 +66,13 @@ export interface encodeSetupCallDataProps {
 export function encodeCreateProxyWithNonce(
   safeProxyFactoryContract: SafeProxyFactoryContract,
   safeSingletonAddress: string,
-  initializer: string
+  initializer: string,
+  salt?: string
 ) {
   return safeProxyFactoryContract.encode('createProxyWithNonce', [
     safeSingletonAddress,
     initializer,
-    PREDETERMINED_SALT_NONCE
+    salt || PREDETERMINED_SALT_NONCE
   ])
 }
 
@@ -183,6 +184,64 @@ export function getChainSpecificDefaultSaltNonce(chainId: bigint): string {
   return `0x${Buffer.from(keccak_256(PREDETERMINED_SALT_NONCE + chainId)).toString('hex')}`
 }
 
+export async function getPredictedSafeAddressInitCode({
+  ethAdapter,
+  chainId,
+  safeAccountConfig,
+  safeDeploymentConfig = {},
+  isL1SafeSingleton = false,
+  customContracts
+}: PredictSafeAddressProps): Promise<string> {
+  validateSafeAccountConfig(safeAccountConfig)
+  validateSafeDeploymentConfig(safeDeploymentConfig)
+
+  const {
+    safeVersion = DEFAULT_SAFE_VERSION,
+    saltNonce = getChainSpecificDefaultSaltNonce(chainId)
+  } = safeDeploymentConfig
+
+  const safeProxyFactoryContract = await memoizedGetProxyFactoryContract({
+    ethAdapter,
+    safeVersion,
+    customContracts,
+    chainId: chainId.toString()
+  })
+
+  const safeContract = await memoizedGetSafeContract({
+    ethAdapter,
+    safeVersion,
+    isL1SafeSingleton,
+    customContracts,
+    chainId: chainId.toString()
+  })
+
+  const initializer = await encodeSetupCallData({
+    ethAdapter,
+    safeAccountConfig,
+    safeContract,
+    customContracts,
+    customSafeVersion: safeVersion // it is more efficient if we provide the safeVersion manually
+  })
+
+  const encodedNonce = toBuffer(ethAdapter.encodeParameters(['uint256'], [saltNonce])).toString(
+    'hex'
+  )
+  const safeSingletonAddress = await safeContract.getAddress()
+  const initCodeCallData = encodeCreateProxyWithNonce(
+    safeProxyFactoryContract,
+    safeSingletonAddress,
+    initializer,
+    '0x' + encodedNonce
+  )
+  const safeProxyFactoryAddress = await safeProxyFactoryContract.getAddress()
+  const initCode = `0x${[safeProxyFactoryAddress, initCodeCallData].reduce(
+    (acc, x) => acc + x.replace('0x', ''),
+    ''
+  )}`
+
+  return initCode
+}
+
 export async function predictSafeAddress({
   ethAdapter,
   chainId,
@@ -232,13 +291,10 @@ export async function predictSafeAddress({
   const encodedNonce = toBuffer(ethAdapter.encodeParameters(['uint256'], [saltNonce])).toString(
     'hex'
   )
-
   const salt = keccak256(
     toBuffer('0x' + keccak256(toBuffer(initializer)).toString('hex') + encodedNonce)
   )
-
   const input = ethAdapter.encodeParameters(['address'], [await safeContract.getAddress()])
-
   const from = await safeProxyFactoryContract.getAddress()
 
   // On the zkSync Era chain, the counterfactual deployment address is calculated differently
@@ -250,13 +306,12 @@ export async function predictSafeAddress({
   }
 
   const constructorData = toBuffer(input).toString('hex')
-
   const initCode = proxyCreationCode + constructorData
-
   const proxyAddress =
     '0x' + generateAddress2(toBuffer(from), toBuffer(salt), toBuffer(initCode)).toString('hex')
+  const predictedAddress = ethAdapter.getChecksummedAddress(proxyAddress)
 
-  return ethAdapter.getChecksummedAddress(proxyAddress)
+  return predictedAddress
 }
 
 export const validateSafeAccountConfig = ({ owners, threshold }: SafeAccountConfig): void => {

packages/protocol-kit/src/index.ts

@@ -39,7 +39,8 @@ import {
   PREDETERMINED_SALT_NONCE,
   encodeCreateProxyWithNonce,
   encodeSetupCallData,
-  predictSafeAddress
+  predictSafeAddress,
+  getPredictedSafeAddressInitCode
 } from './contracts/utils'
 import ContractManager from './managers/contractManager'
 import SafeFactory, { DeploySafeProps, SafeFactoryConfig } from './safeFactory'
@@ -159,6 +160,7 @@ export {
   getSignMessageLibContract,
   isGasTokenCompatibleWithHandlePayment,
   predictSafeAddress,
+  getPredictedSafeAddressInitCode,
   standardizeSafeTransactionData,
   validateEip3770Address,
   validateEthereumAddress,

packages/relay-kit/.env.sample

@@ -0,0 +1 @@
+PRIVATE_KEY=

packages/relay-kit/jest.config.js

@@ -8,7 +8,8 @@ const config = {
     '^@safe-global/protocol-kit/typechain/(.*)$': '<rootDir>/../protocol-kit/typechain/$1',
     '^@safe-global/protocol-kit/(.*)$': '<rootDir>/../protocol-kit/src/$1',
     '^@safe-global/relay-kit/(.*)$': '<rootDir>/src/$1'
-  }
+  },
+  testTimeout: 10000
 }
 
 module.exports = config

packages/relay-kit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/relay-kit",
-  "version": "2.0.3",
+  "version": "2.1.0-alpha.0",
   "description": "Safe Relay Kit",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
@@ -36,7 +36,9 @@
   },
   "dependencies": {
     "@gelatonetwork/relay-sdk": "^5.5.0",
-    "@safe-global/protocol-kit": "^3.0.2",
-    "@safe-global/safe-core-sdk-types": "^4.0.2"
+    "@safe-global/protocol-kit": "^3.1.0-alpha.0",
+    "@safe-global/safe-core-sdk-types": "^4.0.2",
+    "@safe-global/safe-modules-deployments": "^2.0.0",
+    "ethers": "^6.7.1"
   }
 }