Fix library reference substitution and regular expression matching for both contracts and libraries

[juliopavila]

Description:

This PR addresses two related issues in the zodiac-core package.

1. Library Reference Replacement in Bytecode:
   There was a critical issue where the OZGovernor contract, which depends on the MultisendEncoder library, would fail to deploy because the contract bytecode saved a reference to the library but not its address. This caused deployment failures since the library's placeholder in the bytecode was not being correctly replaced by the actual deployed address.

2. Regular Expression Mismatch in sourcePathFromSourceCode:
   Additionally, the sourcePathFromSourceCode function was returning null when attempting to resolve the MultisendEncoder contract. Upon investigation, it was discovered that MultisendEncoder is actually defined as a library, not a contract, and the function's regular expression was only matching contract definitions. This mismatch caused the function to fail when looking for libraries.

Solutions:

1. Library Reference Replacement:

   • Added the replaceLibraryReferences function to handle replacing placeholders in the contract bytecode with the actual deployed addresses of libraries.
   • Ensured that library addresses are properly validated (formatted as 40-character hexadecimal strings) and padded if necessary before replacement.
   • This solution ensures that the OZGovernor contract can now correctly link to the MultisendEncoder library during deployment.

2. Regular Expression Update in sourcePathFromSourceCode:

   • Modified the regular expression in the sourcePathFromSourceCode function to match both contract and library definitions. This change allows the function to successfully resolve libraries as well as contracts.

   Old RegExp:

   const contractPattern = new RegExp(`contract\\s+${contractName}\\s+`, "g");

   New RegExp:

   const contractPattern = new RegExp(`(contract|library)\\s+${contractName}\\s+`, "g");

Changes Introduced:

1. New replaceLibraryReferences Function:

   • Introduced a function to replace library references in the bytecode with the actual deployed addresses. The function ensures proper formatting and validation of the library addresses and replaces any placeholders in the bytecode with these addresses.

2. Integration into getBuildArtifact:

   • The replaceLibraryReferences function was integrated into getBuildArtifact to ensure that any contract bytecode with library references is correctly resolved and linked before deployment.

3. Regular Expression Fix:

   • Updated the regular expression in sourcePathFromSourceCode to match both contract and library keywords, ensuring libraries like MultisendEncoder are properly detected in the source code.

4. Library Address Resolution:

   • Utilized getCreate2Address to calculate and retrieve the deployed address for libraries, ensuring that the OZGovernor contract now correctly links with MultisendEncoder.

Testing:

• Verified the deployment of the OZGovernor contract using the updated bytecode, ensuring library references were correctly replaced and the contract no longer fails during deployment.
• Confirmed that the sourcePathFromSourceCode function now resolves both contracts and libraries.

[coveralls]

Pull Request Test Coverage Report for Build 10773316312

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 99.512%

---

Totals
Change from base Build 10621322757:	0.0%
Covered Lines:	122
Relevant Lines:	123

---

💛 - Coveralls