feat(protocol-kit): Add Abitype for Safe Contract v1.4.1 + ethers.js

packages/protocol-kit/scripts/generateTypechainFiles.ts

@@ -103,7 +103,10 @@ function generateTypes(typechainTarget: string) {
   generateTypechainFiles(
     typechainTarget,
     `${outDirSrc}${typechainTarget}/v1.4.1`,
-    safeContracts_V1_4_1
+    // removed Safe Contract v1.4.1 for ethers-v6
+    typechainTarget === 'ethers-v6'
+      ? safeContracts_V1_4_1.replace(`${safeContractsPath}/v1.4.1/safe.json `, '')
+      : safeContracts_V1_4_1
   )
   generateTypechainFiles(
     typechainTarget,

packages/protocol-kit/src/adapters/ethers/contracts/Safe/SafeContractEthers.ts

@@ -6,7 +6,6 @@ import { toTxResult } from '@safe-global/protocol-kit/adapters/ethers/utils'
 import { Gnosis_safe as Safe_V1_0_0 } from '@safe-global/protocol-kit/typechain/src/ethers-v6/v1.0.0/Gnosis_safe'
 import { Gnosis_safe as Safe_V1_1_1 } from '@safe-global/protocol-kit/typechain/src/ethers-v6/v1.1.1/Gnosis_safe'
 import { Gnosis_safe as Safe_V1_2_0 } from '@safe-global/protocol-kit/typechain/src/ethers-v6/v1.2.0/Gnosis_safe'
-import { Safe as Safe_V1_4_1 } from '@safe-global/protocol-kit/typechain/src/ethers-v6/v1.4.1/Safe'
 import {
   SafeContract,
   SafeSetupConfig,
@@ -16,7 +15,7 @@ import {
 } from '@safe-global/safe-core-sdk-types'
 
 abstract class SafeContractEthers implements SafeContract {
-  constructor(public contract: Safe_V1_4_1 | Safe_V1_2_0 | Safe_V1_1_1 | Safe_V1_0_0) {}
+  constructor(public contract: Safe_V1_2_0 | Safe_V1_1_1 | Safe_V1_0_0) {}
 
   abstract setup(
     setupConfig: SafeSetupConfig,

packages/protocol-kit/src/adapters/ethers/contracts/Safe/v1.4.1/SafeContract_v1_4_1_Ethers.ts

@@ -0,0 +1,285 @@
+import SafeBaseContractEthers from '@safe-global/protocol-kit/adapters/ethers/contracts/Safe/SafeBaseContractEthers'
+import EthersAdapter from '@safe-global/protocol-kit/adapters/ethers/EthersAdapter'
+import {
+  EthersTransactionOptions,
+  EthersTransactionResult
+} from '@safe-global/protocol-kit/adapters/ethers/types'
+import SafeContract_v1_4_1_Contract, {
+  SafeContract_v1_4_1_Abi
+} from '@safe-global/protocol-kit/contracts/AbiType/Safe/v1.4.1/SafeContract_v1_4_1'
+import { SafeTransaction } from 'packages/safe-core-sdk-types'
+import { toTxResult } from '@safe-global/protocol-kit/adapters/ethers/utils'
+import safe_1_4_1_ContractArtifacts from '@safe-global/protocol-kit/contracts/AbiType/assets/Safe/v1.4.1/safe_l2'
+import { SENTINEL_ADDRESS } from '@safe-global/protocol-kit/adapters/ethers/utils/constants'
+import { SafeVersion } from 'packages/safe-core-sdk-types'
+import {
+  EncodeSafeFunction,
+  EstimateGasSafeFunction
+} from '@safe-global/protocol-kit/contracts/AbiType/Safe/SafeBaseContract'
+
+/**
+ * SafeContract_v1_4_1_Ethers is the implementation specific to the Safe contract version 1.4.1.
+ *
+ * This class specializes in handling interactions with the Safe contract version 1.4.1 using Ethers.js v6.
+ *
+ * @extends SafeBaseContractEthers<SafeContract_v1_4_1_Abi> - Inherits from SafeBaseContractEthers with ABI specific to Safe contract version 1.4.1.
+ * @implements SafeContract_v1_4_1_Contract - Implements the interface specific to Safe contract version 1.4.1.
+ */
+class SafeContract_v1_4_1_Ethers
+  extends SafeBaseContractEthers<SafeContract_v1_4_1_Abi>
+  implements SafeContract_v1_4_1_Contract
+{
+  safeVersion: SafeVersion
+
+  /**
+   * Constructs an instance of SafeContract_v1_4_1_Ethers
+   *
+   * @param chainId - The chain ID where the contract resides.
+   * @param ethersAdapter - An instance of EthersAdapter.
+   * @param isL1SafeSingleton - A flag indicating if the contract is a L1 Safe Singleton.
+   * @param customContractAddress - Optional custom address for the contract. If not provided, the address is derived from the Safe deployments based on the chainId and safeVersion.
+   * @param customContractAbi - Optional custom ABI for the contract. If not provided, the default ABI for version 1.4.1 is used.
+   */
+  constructor(
+    chainId: bigint,
+    ethersAdapter: EthersAdapter,
+    isL1SafeSingleton = false,
+    customContractAddress?: string,
+    customContractAbi?: SafeContract_v1_4_1_Abi
+  ) {
+    const safeVersion = '1.4.1'
+    const defaultAbi = safe_1_4_1_ContractArtifacts.abi
+
+    super(
+      chainId,
+      ethersAdapter,
+      defaultAbi,
+      safeVersion,
+      isL1SafeSingleton,
+      customContractAddress,
+      customContractAbi
+    )
+
+    this.safeVersion = safeVersion
+  }
+
+  async VERSION(): Promise<[string]> {
+    return [await this.contract.VERSION()]
+  }
+
+  async approvedHashes([owner, txHash]: readonly [string, string]): Promise<[bigint]> {
+    return [await this.contract.approvedHashes(owner, txHash)]
+  }
+
+  async checkNSignatures(
+    args: readonly [dataHash: string, data: string, signatures: string, requiredSignatures: bigint]
+  ): Promise<[]> {
+    // this method just checks whether the signature provided is valid for the provided data and hash. Reverts otherwise.
+    await this.contract.checkNSignatures(...args)
+    return []
+  }
+
+  async checkSignatures(
+    args: readonly [dataHash: string, data: string, signatures: string]
+  ): Promise<[]> {
+    await this.contract.checkSignatures(...args)
+    return []
+  }
+
+  async domainSeparator(): Promise<[string]> {
+    return [await this.contract.domainSeparator()]
+  }
+
+  async encodeTransactionData(
+    args: readonly [
+      to: string,
+      value: bigint,
+      data: string,
+      operation: number,
+      safeTxGas: bigint,
+      baseGas: bigint,
+      gasPrice: bigint,
+      gasToken: string,
+      refundReceiver: string,
+      _nonce: bigint
+    ]
+  ): Promise<[string]> {
+    return [await this.contract.encodeTransactionData(...args)]
+  }
+
+  async getChainId(): Promise<[bigint]> {
+    return [await this.contract.getChainId()]
+  }
+
+  getModulesPaginated(
+    args: readonly [start: string, pageSize: bigint]
+  ): Promise<[modules: string[], next: string]> {
+    return this.contract.getModulesPaginated(...args)
+  }
+
+  async getOwners(): Promise<readonly [string[]]> {
+    return [await this.contract.getOwners()]
+  }
+
+  async getStorageAt(args: readonly [offset: bigint, length: bigint]): Promise<[string]> {
+    return [await this.contract.getStorageAt(...args)]
+  }
+
+  async getThreshold(): Promise<[bigint]> {
+    return [await this.contract.getThreshold()]
+  }
+
+  async getTransactionHash(
+    args: readonly [
+      to: string,
+      value: bigint,
+      data: string,
+      operation: number,
+      safeTxGas: bigint,
+      baseGas: bigint,
+      gasPrice: bigint,
+      gasToken: string,
+      refundReceiver: string,
+      _nonce: bigint
+    ]
+  ): Promise<[string]> {
+    return [await this.contract.getTransactionHash(...args)]
+  }
+
+  async isModuleEnabled(args: readonly [moduleAddress: string]): Promise<[boolean]> {
+    return [await this.contract.isModuleEnabled(...args)]
+  }
+
+  async isOwner(args: readonly [address: string]): Promise<[boolean]> {
+    return [await this.contract.isOwner(...args)]
+  }
+
+  async nonce(): Promise<[bigint]> {
+    return [await this.contract.nonce()]
+  }
+
+  async signedMessages(args: readonly [messageHash: string]): Promise<[bigint]> {
+    return [await this.contract.signedMessages(...args)]
+  }
+
+  encode: EncodeSafeFunction<SafeContract_v1_4_1_Abi> = (functionToEncode, args) => {
+    return this.contract.interface.encodeFunctionData(functionToEncode, args)
+  }
+
+  estimateGas: EstimateGasSafeFunction<SafeContract_v1_4_1_Abi> = (
+    functionToEstimate,
+    args,
+    options = {}
+  ) => {
+    return this.contract.getFunction(functionToEstimate).estimateGas(...args, options)
+  }
+
+  // Custom method (not defined in the Safe Contract)
+  async approveHash(
+    hash: string,
+    options?: EthersTransactionOptions
+  ): Promise<EthersTransactionResult> {
+    const gasLimit = options?.gasLimit || (await this.estimateGas('approveHash', [hash], options))
+    const txResponse = await this.contract.approveHash(hash, { ...options, gasLimit })
+
+    return toTxResult(txResponse, options)
+  }
+
+  // Custom method (not defined in the Safe Contract)
+  async execTransaction(
+    safeTransaction: SafeTransaction,
+    options?: EthersTransactionOptions
+  ): Promise<EthersTransactionResult> {
+    const gasLimit =
+      options?.gasLimit ||
+      (await this.estimateGas(
+        'execTransaction',
+        [
+          safeTransaction.data.to,
+          BigInt(safeTransaction.data.value),
+          safeTransaction.data.data,
+          safeTransaction.data.operation,
+          BigInt(safeTransaction.data.safeTxGas),
+          BigInt(safeTransaction.data.baseGas),
+          BigInt(safeTransaction.data.gasPrice),
+          safeTransaction.data.gasToken,
+          safeTransaction.data.refundReceiver,
+          safeTransaction.encodedSignatures()
+        ],
+        options
+      ))
+
+    const txResponse = await this.contract.execTransaction(
+      safeTransaction.data.to,
+      safeTransaction.data.value,
+      safeTransaction.data.data,
+      safeTransaction.data.operation,
+      safeTransaction.data.safeTxGas,
+      safeTransaction.data.baseGas,
+      safeTransaction.data.gasPrice,
+      safeTransaction.data.gasToken,
+      safeTransaction.data.refundReceiver,
+      safeTransaction.encodedSignatures(),
+      { ...options, gasLimit }
+    )
+
+    return toTxResult(txResponse, options)
+  }
+
+  // Custom method (not defined in the Safe Contract)
+  getAddress(): Promise<string> {
+    return this.contract.getAddress()
+  }
+
+  // Custom method (not defined in the Safe Contract)
+  // TODO: review this custom method
+  async getModules(): Promise<string[]> {
+    const [modules] = await this.contract.getModulesPaginated(SENTINEL_ADDRESS, 10)
+    return modules
+  }
+
+  // Custom method (not defined in the Safe Contract)
+  async isValidTransaction(
+    safeTransaction: SafeTransaction,
+    options: EthersTransactionOptions = {}
+  ) {
+    try {
+      const gasLimit =
+        options?.gasLimit ||
+        (await this.estimateGas(
+          'execTransaction',
+          [
+            safeTransaction.data.to,
+            BigInt(safeTransaction.data.value),
+            safeTransaction.data.data,
+            safeTransaction.data.operation,
+            BigInt(safeTransaction.data.safeTxGas),
+            BigInt(safeTransaction.data.baseGas),
+            BigInt(safeTransaction.data.gasPrice),
+            safeTransaction.data.gasToken,
+            safeTransaction.data.refundReceiver,
+            safeTransaction.encodedSignatures()
+          ],
+          options
+        ))
+
+      return await this.contract.execTransaction.staticCall(
+        safeTransaction.data.to,
+        BigInt(safeTransaction.data.value),
+        safeTransaction.data.data,
+        safeTransaction.data.operation,
+        BigInt(safeTransaction.data.safeTxGas),
+        BigInt(safeTransaction.data.baseGas),
+        BigInt(safeTransaction.data.gasPrice),
+        safeTransaction.data.gasToken,
+        safeTransaction.data.refundReceiver,
+        safeTransaction.encodedSignatures(),
+        { ...options, gasLimit }
+      )
+    } catch (error) {
+      return false
+    }
+  }
+}
+
+export default SafeContract_v1_4_1_Ethers