feat(protocol-kit): Refactor and improve contract classes for Abitype #758
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* change the abstraction order: abstract at adapter level before abstracting at contract-level * this allows to move the getAddress function into the abstract adapter-level classes instead of defining it for each contract individually * introduce BaseContract class for appropriate ABI and the address from contract deployments
Move simulate and encode functions into higher class abstraction levels instead of defining it for every contract version individually
Move encode, estimateGas + getAddress functions into abstract parent classes.
Move encode, estimateGas + getAddress functions into abstract parent classes.
Move encode + getAddress functions into abstract parent classes.
Move encode + getAddress functions into abstract parent classes.
Use the new type in EncodeFunction, EstimateGasFunction + ContractFunction types
…for SimulateTxAccessor contract
Move encode, estimateGas + getAddress functions into abstract parent classes.
Move encode, estimateGas + getAddress functions into abstract parent classes.
…once web3 dependency is removed
dasanra
approved these changes
Apr 5, 2024
dasanra
merged commit f33a4d0
into
Abitype-CompatibilityFallbackHandler-contract
12 of 14 checks passed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it solves
Various code improvements to reduce duplicate code:
getAddressestimateGasencodeContractFunctiontype in all contract implementationsHow this PR fixes it
Changing the abstraction order of the contract classes: abstract at adapter level before abstracting at contract-level. This allows to move the
getAddress,encode+estimateGasfunctions into the abstract adapter-level classes (e.g.BaseContractEthers) instead of defining them for each contract individually.Introducing the
BaseContractclass to handle the logic of selecting the appropriate ABI and the address from contract deployments. This new class replaces all the contract-specific base classes, such asSafeBaseContract.