feat(protocol-kit): Add Abitype for contract types and use EIP-1193 #604

DaniSomoza · 2023-11-24T10:04:28Z

What it solves

Resolves #582

Contracts Implemented

How this PR fixes it

Classes And Types Implemented

Type SafeBaseContract: This Type uses abitype utilities to extract The Functions and Types from a given Abi.
Type SafeContract_v1_3_0_Contract: This Type uses the SafeBaseContract utility to extract The Functions and Types for a Safe contract version 1.3.0.
SafeBaseContract: Abstract class that serves as a base for creating a Safe contract for a specific adapter (Ethers.js, Web3.js, or viem.js). This class is designed to be extended by adapter-specific abstract classes, such as SafeBaseContractEthers (Implemented), SafeBaseContractWeb3 (pending implementation), and SafeBaseContractViem (pending implementation). It includes the core logic for selecting the appropriate ABI and the address from Safe deployments and determining the correct L1 or L2 contract version of the Safe.
SafeBaseContractEthers: This Abstract class extends SafeBaseContract to specifically integrate with the Ethers.js v6 library. This abstract class sets up the Ethers v6 Contract object that interacts with a Safe contract version. Subclasses of SafeBaseContractEthers are expected to represent specific versions of the Safe contract. Example subclasses: SafeContract_v1_4_1_Ethers (pending implementation), SafeContract_v1_3_0_Ethers (Implemented), SafeContract_v1_2_0_Ethers (pending implementation)...
SafeContract_v1_3_0_Ethers: This class specializes in handling interactions with the Safe contract version 1.3.0 using Ethers.js v6. Inherits from SafeBaseContractEthers and Implements the SafeContract_v1_3_0_Contract

Guides

Add a `v1.4.1` Safe Contract For `Ethers.js` (Easy)

Create Types for the v1.4.1 Safe contract: Create a SafeContract_v1_4_1.ts file in packages/protocol-kit/src/contracts/AbiType/Safe/v1.4.1/SafeContract_v1_4_1.ts. Use the implemented SafeContract_v1_3_0.ts as a model.
Create SafeContract_v1_4_1_Ethers Class: Create a SafeContract_v1_4_1_Ethers.ts file in packages/protocol-kit/src/adapters/ethers/contracts/Safe/v1.4.1/SafeContract_v1_4_1_Ethers.ts. Use the implemented SafeContract_v1_3_0_Ethers.ts as a model.
Update the contractInstancesEthers.ts file to use the new class.
Remove the old SafeContract_V1_4_1_Ethers.ts
Update the generateTypechainFiles.ts script to remove the generation of the Safe Contract v1.4.1 For Ethers.js.

Add `Web3.js` for `v1.3.0` Safe Contract (Medium)

Create a SafeBaseContractWeb3: Create a SafeBaseContractWeb3.ts file in packages/protocol-kit/src/adapters/web3/contracts/Safe/SafeBaseContractWeb3.ts. Use the implemented SafeBaseContractEthers.ts as a model.
Create a SafeContract_v1_3_0_Web3: Create a SafeContract_v1_3_0_Web3.ts file in packages/protocol-kit/src/adapters/web3/contracts/Safe/v1.3.0/SafeContract_v1_3_0_Web3.ts`.
Update the contractInstancesEthers.ts file to use the new class.
Remove the old SafeContract_V1_3_0_Web3.ts
Update the generateTypechainFiles.ts script to remove the generation of the Safe Contract v1.3.0 For Web3.js.

Add another contract like `safeProxyFactory` `v1.3.0` contract for Ethers (Hard):

Create a safeProxyFactoryContract.ts types file. In the packages/protocol-kit/src/contracts/AbiType create a safeProxyFactoryContract.ts types using the Abi of the contract. See the implemented SafeBaseContract.ts file.
Create a safeProxyFactoryBaseContract.ts in 'src/adapters' see src/adapters/SafeBaseContract.ts file as example.
Create a safeProxyFactoryBaseContractEthers.ts see src/adapters/ethers/contracts/Safe/SafeBaseContractEthers.ts as example.
Create a safeProxyFactory_v1_3_0_Ethers.ts: see the SafeContract_v1_3_0_Ethers file as example.
Update the contractInstancesEthers.ts file to use the new class.
Remove the old safeProxyFactory_V1_3_0_Ethers.ts
Update the generateTypechainFiles.ts script to remove the generation of the safeProxyFactory v1.3.0 For Ethers.js.

coveralls · 2023-11-24T10:06:26Z

Pull Request Test Coverage Report for Build 6979367114

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+22.9%) to 100.0%

Totals
Change from base Build 6972470735:	22.9%
Covered Lines:	25
Relevant Lines:	25

💛 - Coveralls

coveralls · 2023-11-24T10:06:28Z

Pull Request Test Coverage Report for Build 8452514007

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
5 unchanged lines in 1 file lost coverage.
Overall coverage decreased (-0.9%) to 73.632%

Files with Coverage Reduction	New Missed Lines	%
packages/api-kit/src/SafeApiKit.ts	5	61.48%

Totals
Change from base Build 8099779389:	-0.9%
Covered Lines:	476
Relevant Lines:	597

💛 - Coveralls

packages/protocol-kit/src/adapters/ethers/contracts/contractInstancesEthers.ts

* Create abstract class `SafeBaseContractWeb3` * Implement class `SafeContract_v1_3_0_Web3` * feat(protocol-kit): Add Abitype for Safe Contract 1.4.1 + Web3.js (#637) * Create Types for the v1.4.1 Safe contract * Implement class `SafeContract_v1_4_1_Web3`

…624) * Create Types for the v1.4.1 Safe contract * Create `SafeContract_v1_4_1_Ethers` Class * feat(protocol-kit): Add Abitype for Safe Contract v1.2.0 + ethers.js (#627) * Create Types for the v1.2.0 Safe contract * Create `SafeContract_v1_2_0_Ethers` Class * Add arg names to contract functions --------- Co-authored-by: Daniel Somoza <daniel.somoza@safe.global>

* Rename old 1.1.1 Safe contract implementations (for Ethers.js + Web3.js) * Create Types for the v1.1.1 Safe contract * Implement `SafeContract_v1_1_1_Web3` class * Implement `SafeContract_v1_1_1_Ethers` class * Various fixes in Safe contract v1.1.1 implementations * Update `contractInstancesEthers.ts` to use the new class * Update `contractInstancesWeb3.ts` to use the new class * Remove contract 1.1.1 from typechain generation script * Remove old SafeContract v1.1.1 implementations * Fix `getModulesPaginated` function in 1.1.1 contract implementations * Fix binding issues in `mapToTypechainContract` function for contract v1.1.1 implementations

…pe + Fixes (#644) * Rename old Safe contract v1.2.0 Web3 implementation * Implement new `SafeContract_v1_2_0_Web3` class * Update `contractInstancesWeb3.ts` to use the new class * Remove contract 1.2.0 from typechain generation script * Remove old SafeContract v1.2.0 implementation * Move typechain mapper functions to individual Safe contract implementations for ethers.js * Call `getModules` contract method directly for Safe contract v1.2.0 * fix: Handle return value of Safe contract's `getModulesPaginated` method correctly * Fix `getMessageHash` return value in SafeContract_v1_2_0_Ethers * Refactor `getModules` method in SafeContract classes * Fix binding issues in typechain mapper functions for Safe contract v1.3.0 + v1.4.1

…-init

packages/protocol-kit/src/SafeProvider.ts

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

packages/protocol-kit/tests/e2e/safeProvider.test.ts

packages/protocol-kit/src/SafeProvider.ts

packages/protocol-kit/src/managers/contractManager.ts

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

packages/protocol-kit/src/SafeProvider.ts

* remove API reference from api-kit and protocol-kit * chore: update relay-kit information to refer ERC-4337 --------- Co-authored-by: Yago Pérez Vázquez <yago@safe.global>

…e-sdk into Abitype-1_3_0-safe-contract # Conflicts: # packages/account-abstraction-kit/package.json # packages/api-kit/package.json # packages/auth-kit/package.json # packages/onramp-kit/package.json # packages/protocol-kit/package.json # packages/relay-kit/package.json # packages/safe-core-sdk-types/package.json

…-global/safe-core-sdk into Abitype-1_3_0-safe-contract # Conflicts: # packages/safe-core-sdk-types/package.json

Add abitype

40d4f76

DaniSomoza added 2 commits November 24, 2023 11:09

removed unrelated @truffle/hdwallet-provider

6ec1e63

removed v1.3.0 Safe contract for Ethers from Typechain

982c84c

DaniSomoza changed the title ~~Add abitype~~ feat(protocol-kit): Add Abitype for Safe Contract v1.3.0 and Ethers Nov 24, 2023

DaniSomoza linked an issue Nov 24, 2023 that may be closed by this pull request

Use AbiType to type v1.3.0 contracts #582

Closed

Add Jsdoc

f353665

This was referenced Nov 27, 2023

Use AbiType to type v1.4.1 contracts #608

Closed

Use AbiType to type v1.2.0 contracts #609

Closed

Use AbiType to type v1.1.1 contracts #610

Closed

tmjssz mentioned this pull request Nov 29, 2023

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

Merged

This was referenced Nov 30, 2023

Use AbiType to type v1.3.0 contracts with Web3.js adapter #625

Closed

Use AbiType to type v1.4.1 contracts with Web3.js adapter #626

Closed

tmjssz mentioned this pull request Nov 30, 2023

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

Merged

Merge branch 'development' into Abitype-1_3_0-safe-contract

a9f0dc1

tmjssz reviewed Dec 5, 2023

View reviewed changes

packages/protocol-kit/src/adapters/ethers/contracts/contractInstancesEthers.ts Outdated Show resolved Hide resolved

tmjssz mentioned this pull request Dec 6, 2023

feat(protocol-kit): Add Abitype for Safe Contract 1.3.0 + Web3.js #633

Merged

remove duplicated import

a491fb2

tmjssz mentioned this pull request Dec 11, 2023

feat(protocol-kit): Add Abitype for Safe Contract 1.4.1 + Web3.js #637

Merged

tmjssz and others added 2 commits December 13, 2023 14:53

This was referenced Dec 15, 2023

feat(protocol-kit): Migrate Safe Contract v1.1.1 to Abitype #643

Merged

feat(protocol-kit): Migrate Safe Contract v1.2.0 for web3.js to Abitype + Fixes #644

Merged

Merge branch 'development' into Abitype-1_3_0-safe-contract

42f6535

This was referenced Jan 8, 2024

Use AbiType to type ProxyFactory contract #653

Closed

Use AbiType to type MultiSend contract #654

Closed

tmjssz mentioned this pull request Jan 12, 2024

feat(protocol-kit): Migrate Safe Proxy Factory contract to Abitype #664

Merged

yagopv and others added 12 commits May 8, 2024 18:03

Merge pull request #807 from safe-global/fix/abitype-as-dep

04ebc77

Merge branch 'development' into Abitype-1_3_0-safe-contract

5e9a8c3

Release alpha version

3f98f03

chore: bump dependencies with minor changes

17b9607

Rename methods

16b26f9

Remove some draft code

8e32572

Rename ContractManager to follow same approach

fc5498f

fix BaseContract provider (#811)

c73d1a1

remove unused properties from contract assets (#809)

fefb3c2

Remove draft code

8936d78

Remove return types in initializers

1428cc6

Merge pull request #810 from safe-global/feat/rename-method-create-to…

3532f54

…-init

dasanra mentioned this pull request May 10, 2024

chore(deps): bump es5-ext from 0.10.62 to 0.10.63 #718

Closed

leonardotc reviewed May 13, 2024

View reviewed changes

dasanra and others added 12 commits May 15, 2024 13:39

chore: add CONTRIBUTING and SUPPORT files (#815)

907fe87

* remove API reference from api-kit and protocol-kit * chore: update relay-kit information to refer ERC-4337 --------- Co-authored-by: Yago Pérez Vázquez <yago@safe.global>

Merge branch 'development' into Abitype-1_3_0-safe-contract

ef1a610

chore: fix parameter name

f7d4e50

Test api-kit with an alternative RPC

1b09a06

Change RPC

3b6bc0f

fix: remove unused util

3f78bbc

fix: use EMPTY_DATA constant value

c96755d

Add tests for externalProvider and externalSigner

70eb7d4

Update sepolia rpc as the ankr one is not working

781de86

Merge branch 'development' into Abitype-1_3_0-safe-contract

df0dfc6

Merge branch 'Abitype-1_3_0-safe-contract' of https://github.com/safe…

9d585f5

…-global/safe-core-sdk into Abitype-1_3_0-safe-contract # Conflicts: # packages/safe-core-sdk-types/package.json

dasanra approved these changes May 16, 2024

View reviewed changes

dasanra merged commit 12dccb6 into development May 16, 2024
19 checks passed

github-actions bot locked and limited conversation to collaborators May 16, 2024

dasanra deleted the Abitype-1_3_0-safe-contract branch May 16, 2024 12:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(protocol-kit): Add Abitype for contract types and use EIP-1193 #604

feat(protocol-kit): Add Abitype for contract types and use EIP-1193 #604

DaniSomoza commented Nov 24, 2023 •

edited by dasanra

coveralls commented Nov 24, 2023

coveralls commented Nov 24, 2023 •

edited

feat(protocol-kit): Add Abitype for contract types and use EIP-1193 #604

feat(protocol-kit): Add Abitype for contract types and use EIP-1193 #604

Conversation

DaniSomoza commented Nov 24, 2023 • edited by dasanra

What it solves

Contracts Implemented

How this PR fixes it

Classes And Types Implemented

Guides

Add a v1.4.1 Safe Contract For Ethers.js (Easy)

Add Web3.js for v1.3.0 Safe Contract (Medium)

Add another contract like safeProxyFactory v1.3.0 contract for Ethers (Hard):

coveralls commented Nov 24, 2023

Pull Request Test Coverage Report for Build 6979367114

💛 - Coveralls

coveralls commented Nov 24, 2023 • edited

Pull Request Test Coverage Report for Build 8452514007

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

DaniSomoza commented Nov 24, 2023 •

edited by dasanra

Add a `v1.4.1` Safe Contract For `Ethers.js` (Easy)

Add `Web3.js` for `v1.3.0` Safe Contract (Medium)

Add another contract like `safeProxyFactory` `v1.3.0` contract for Ethers (Hard):

coveralls commented Nov 24, 2023 •

edited