Move AA logic to Protocol Kit

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

@@ -1,10 +1,12 @@
-import { RelayAdapter } from '@safe-global/relay-kit'
 import Safe, {
+  calculateChainSpecificProxyAddress,
   EthersAdapter,
   getMultiSendCallOnlyContract,
   getProxyFactoryContract,
-  getSafeContract
+  getSafeContract,
+  getSafeInitializer
 } from '@safe-global/protocol-kit'
+import { RelayAdapter } from '@safe-global/relay-kit'
 import {
   GnosisSafeContract,
   GnosisSafeProxyFactoryContract,
@@ -15,12 +17,7 @@ import {
 } from '@safe-global/safe-core-sdk-types'
 import { ethers } from 'ethers'
 import { AccountAbstractionConfig, OperationType } from './types'
-import {
-  calculateChainSpecificProxyAddress,
-  encodeCreateProxyWithNonce,
-  encodeMultiSendData,
-  getSafeInitializer
-} from './utils/contracts'
+import { encodeCreateProxyWithNonce, encodeMultiSendData } from './utils/contracts'
 
 const safeVersion: SafeVersion = '1.3.0'
 
@@ -56,7 +53,7 @@ class AccountAbstraction {
       this.#ethAdapter,
       safeVersion,
       this.#safeProxyFactoryContract,
-      this.#signer
+      await this.getSignerAddress()
     )
     this.#safeContract = await getSafeContract({
       ethAdapter: this.#ethAdapter,

packages/account-abstraction-kit/src/utils/contracts.ts

@@ -1,17 +1,12 @@
-import { BigNumber } from '@ethersproject/bignumber'
-import { arrayify, BytesLike } from '@ethersproject/bytes'
+import { arrayify } from '@ethersproject/bytes'
 import { pack as solidityPack } from '@ethersproject/solidity'
-import { getCompatibilityFallbackHandlerContract, getSafeContract } from '@safe-global/protocol-kit'
+import { PREDETERMINED_SALT_NONCE } from '@safe-global/protocol-kit'
 import {
-  EthAdapter,
   GnosisSafeContract,
   GnosisSafeProxyFactoryContract,
   MetaTransactionData,
-  SafeTransactionData,
-  SafeVersion
+  SafeTransactionData
 } from '@safe-global/safe-core-sdk-types'
-import { BigNumberish, ethers, Signer } from 'ethers'
-import { PREDETERMINED_SALT_NONCE, ZERO_ADDRESS } from '../constants'
 
 export function encodeCreateProxyWithNonce(
   safeProxyFactoryContract: GnosisSafeProxyFactoryContract,
@@ -25,30 +20,6 @@ export function encodeCreateProxyWithNonce(
   ])
 }
 
-export async function encodeSetupCallData(
-  ethAdapter: EthAdapter,
-  safeVersion: SafeVersion,
-  safeContract: GnosisSafeContract,
-  owners: string[],
-  chainId: number
-): Promise<string> {
-  const compatibilityFallbackhandlerAddress = await getCompatibilityFallbackHandlerContract({
-    ethAdapter,
-    safeVersion,
-    chainId
-  })
-  return safeContract.encode('setup', [
-    owners,
-    BigNumber.from(1) as BigNumberish,
-    ZERO_ADDRESS,
-    '0x' as BytesLike,
-    compatibilityFallbackhandlerAddress,
-    ZERO_ADDRESS,
-    BigNumber.from(0) as BigNumberish,
-    ZERO_ADDRESS
-  ])
-}
-
 export function encodeExecTransaction(
   safeContract: GnosisSafeContract,
   transaction: SafeTransactionData,
@@ -80,53 +51,3 @@ function encodeMetaTransaction(tx: MetaTransactionData): string {
 export function encodeMultiSendData(txs: MetaTransactionData[]): string {
   return '0x' + txs.map((tx) => encodeMetaTransaction(tx)).join('')
 }
-
-export async function getSafeInitializer(
-  ethAdapter: EthAdapter,
-  safeContract: GnosisSafeContract,
-  signerAddress: string,
-  chainId: number
-): Promise<string> {
-  const safeVersion = await safeContract.getVersion()
-  const initializer = await encodeSetupCallData(
-    ethAdapter,
-    safeVersion,
-    safeContract,
-    [signerAddress],
-    chainId
-  )
-  return initializer
-}
-
-export async function calculateChainSpecificProxyAddress(
-  ethAdapter: EthAdapter,
-  safeVersion: SafeVersion,
-  safeProxyFactoryContract: GnosisSafeProxyFactoryContract,
-  signer: Signer
-): Promise<string> {
-  const chainId = await ethAdapter.getChainId()
-  const safeSingletonContract = await getSafeContract({ ethAdapter, safeVersion, chainId })
-  const deployer = safeProxyFactoryContract.getAddress()
-  const signerAddress = await signer.getAddress()
-
-  const deploymentCode = ethers.utils.solidityPack(
-    ['bytes', 'uint256'],
-    [safeProxyFactoryContract.proxyCreationCode(), safeSingletonContract.getAddress()]
-  )
-  const salt = ethers.utils.solidityKeccak256(
-    ['bytes32', 'uint256'],
-    [
-      ethers.utils.solidityKeccak256(
-        ['bytes'],
-        [await getSafeInitializer(ethAdapter, safeSingletonContract, signerAddress, chainId)]
-      ),
-      PREDETERMINED_SALT_NONCE
-    ]
-  )
-  const derivedAddress = ethers.utils.getCreate2Address(
-    deployer,
-    salt,
-    ethers.utils.keccak256(deploymentCode)
-  )
-  return derivedAddress
-}

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

@@ -0,0 +1,91 @@
+import {
+  EthAdapter,
+  GnosisSafeContract,
+  GnosisSafeProxyFactoryContract,
+  SafeVersion
+} from '@safe-global/safe-core-sdk-types'
+import { BigNumber, BigNumberish, BytesLike, ethers } from 'ethers'
+import {
+  getCompatibilityFallbackHandlerContract,
+  getSafeContract
+} from '../contracts/safeDeploymentContracts'
+import { ZERO_ADDRESS } from '../utils/constants'
+
+
+// keccak256(toUtf8Bytes('Safe Account Abstraction'))
+export const PREDETERMINED_SALT_NONCE =
+  '0xb1073742015cbcf5a3a4d9d1ae33ecf619439710b89475f92e2abd2117e90f90'
+
+  // TO-DO: Merge with encodeSetupCallData from the SafeFactory class
+export async function encodeDefaultSetupCallData(
+  ethAdapter: EthAdapter,
+  safeVersion: SafeVersion,
+  safeContract: GnosisSafeContract,
+  owners: string[],
+  chainId: number
+): Promise<string> {
+  const compatibilityFallbackhandlerAddress = await getCompatibilityFallbackHandlerContract({
+    ethAdapter,
+    safeVersion,
+    chainId
+  })
+  return safeContract.encode('setup', [
+    owners,
+    BigNumber.from(1) as BigNumberish,
+    ZERO_ADDRESS,
+    '0x' as BytesLike,
+    compatibilityFallbackhandlerAddress,
+    ZERO_ADDRESS,
+    BigNumber.from(0) as BigNumberish,
+    ZERO_ADDRESS
+  ])
+}
+
+export async function getSafeInitializer(
+  ethAdapter: EthAdapter,
+  safeContract: GnosisSafeContract,
+  signerAddress: string,
+  chainId: number
+): Promise<string> {
+  const safeVersion = await safeContract.getVersion()
+  const initializer = await encodeDefaultSetupCallData(
+    ethAdapter,
+    safeVersion,
+    safeContract,
+    [signerAddress],
+    chainId
+  )
+  return initializer
+}
+
+export async function calculateChainSpecificProxyAddress(
+  ethAdapter: EthAdapter,
+  safeVersion: SafeVersion,
+  safeProxyFactoryContract: GnosisSafeProxyFactoryContract,
+  signerAddress: string
+): Promise<string> {
+  const chainId = await ethAdapter.getChainId()
+  const safeSingletonContract = await getSafeContract({ ethAdapter, safeVersion, chainId })
+  const deployer = safeProxyFactoryContract.getAddress()
+
+  const deploymentCode = ethers.utils.solidityPack(
+    ['bytes', 'uint256'],
+    [safeProxyFactoryContract.proxyCreationCode(), safeSingletonContract.getAddress()]
+  )
+  const salt = ethers.utils.solidityKeccak256(
+    ['bytes32', 'uint256'],
+    [
+      ethers.utils.solidityKeccak256(
+        ['bytes'],
+        [await getSafeInitializer(ethAdapter, safeSingletonContract, signerAddress, chainId)]
+      ),
+      PREDETERMINED_SALT_NONCE
+    ]
+  )
+  const derivedAddress = ethers.utils.getCreate2Address(
+    deployer,
+    salt,
+    ethers.utils.keccak256(deploymentCode)
+  )
+  return derivedAddress
+}

packages/protocol-kit/src/index.ts

@@ -33,12 +33,18 @@ import {
   getSafeContract,
   getSignMessageLibContract
 } from './contracts/safeDeploymentContracts'
+import {
+  calculateChainSpecificProxyAddress,
+  getSafeInitializer,
+  PREDETERMINED_SALT_NONCE
+} from './contracts/utils'
 import ContractManager from './managers/contractManager'
 import Safe from './Safe'
 import SafeFactory, { DeploySafeProps, SafeFactoryConfig } from './safeFactory'
 import {
   AddOwnerTxParams,
   ConnectSafeConfig,
+  ContractNetworksConfig,
   CreateTransactionProps,
   PredictSafeProps,
   RemoveOwnerTxParams,
@@ -47,8 +53,6 @@ import {
   SafeDeploymentConfig,
   SwapOwnerTxParams
 } from './types'
-
-import { ContractNetworksConfig } from './types'
 import { SafeTransactionOptionalProps } from './utils/transactions/types'
 import { standardizeSafeTransactionData } from './utils/transactions/utils'
 
@@ -97,7 +101,10 @@ export {
   getMultiSendContract,
   getMultiSendCallOnlyContract,
   getSignMessageLibContract,
-  getCreateCallContract
+  getCreateCallContract,
+  getSafeInitializer,
+  calculateChainSpecificProxyAddress,
+  PREDETERMINED_SALT_NONCE
 }
 
 export default Safe

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

@@ -1,5 +1,5 @@
 import { BigNumber } from '@ethersproject/bignumber'
-import { SafeAccountConfig, SafeDeploymentConfig } from './'
+import { SafeAccountConfig, SafeDeploymentConfig } from '../types'
 
 export const validateSafeAccountConfig = ({ owners, threshold }: SafeAccountConfig): void => {
   if (owners.length <= 0) throw new Error('Owner list must have at least one owner')