sync master <> dev

[0xalpharush]

Summary by CodeRabbit

• Chores

  • Updated CI workflow dependencies for improved automation and security.
  • Updated publishing workflow to utilize a newer version of the PyPI publishing action for enhanced reliability.

• New Features

  • Introduced the ability to specify a custom working directory for compilation processes, enhancing flexibility in build environments.
  • Added a new test for Etherscan compilation, ensuring higher reliability and correctness of contract compilations.

• Refactor

  • Improved configuration handling for Ethereum Smart Contract compilation, allowing for more precise control over compilation parameters.

[coderabbitai]

Walkthrough

The recent updates streamline development workflows and enhance compilation capabilities. The GitHub actions for Continuous Integration (CI) and publishing to PyPI have been upgraded for better efficiency. Additionally, enhancements in the crytic_compile tool improve flexibility by allowing a custom working directory and introducing a new JSON configuration for Solc in Etherscan compilations. A new test script further bolsters the robustness of Etherscan integration, ensuring smoother development processes.

Changes

File Path	Change Summary
.github/workflows/ci.yml	Updated cachix/install-nix-action to v25 and cachix/cachix-action to v14.
.github/workflows/publish.yml	Updated pypa/gh-action-pypi-publish to 1.8.14.
crytic_compile/crytic_compile.py	Added custom cwd support in __init__ method.
crytic_compile/platform/etherscan.py	Introduced metadata_config JSON for Solc configurations in compile method.
scripts/ci_test_etherscan.sh	Added a new Etherscan test involving contract compilation.

Poem

🐇💻
In the world of code, a rabbit hopped,
Bringing updates, where bugs are stopped.
With actions polished, and tests anew,
Through etherscan's mist, a clearer view.
🚀✨
"To better builds," the rabbit cheered,
As through the digital fields, it veered.
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c0ad9f5 and de160c4.

Files selected for processing (5)

• .github/workflows/ci.yml (1 hunks)
• .github/workflows/publish.yml (1 hunks)
• crytic_compile/crytic_compile.py (2 hunks)
• crytic_compile/platform/etherscan.py (1 hunks)
• scripts/ci_test_etherscan.sh (1 hunks)

Additional comments: 4

.github/workflows/publish.yml (1)

• 48-48: The update to pypa/[email protected] looks good. It's always a good practice to check the changelog for the action to ensure there are no breaking changes that could affect your workflow.

.github/workflows/ci.yml (2)

• 66-66: The update to cachix/install-nix-action@v25 looks good. It's always beneficial to check the changelog for the action to ensure there are no breaking changes that could affect your workflow.
• 69-69: The update to cachix/cachix-action@v14 looks good. As with any action update, reviewing the changelog for potential breaking changes or new features is recommended.

crytic_compile/crytic_compile.py (1)

• 148-152: The implementation for specifying a custom working directory (cwd) in the __init__ method is correctly handled. It allows for greater flexibility in specifying the compilation context.

[coderabbitai]

The addition of the Etherscan #8 test case is a good enhancement for testing coverage. However, the style of checking exit codes can be improved for better readability. Instead of checking $? after each command, you can directly check the command's success, like so:

- if [ $? -ne 0 ]
+ if ! crytic-compile 0x9AB6b21cDF116f611110b048987E58894786C244 --etherscan-apikey "$GITHUB_ETHERSCAN"; then

This change can be applied to all instances where exit codes are checked in this script.

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	# From crytic/crytic-compile#544
	echo "::group::Etherscan #8"
	crytic-compile 0x9AB6b21cDF116f611110b048987E58894786C244 --etherscan-apikey "$GITHUB_ETHERSCAN"
	if [ $? -ne 0 ]
	then
	echo "Etherscan #8 test failed"
	exit 255
	fi
	dir_name=$(find crytic-export/etherscan-contracts/ -type d -name "*0x9AB6b21cDF116f611110b048987E58894786C244*" -print -quit)
	cd "$dir_name" || { echo "Failed to change directory"; exit 255; }
	if [ ! -f crytic_compile.config.json ]; then
	echo "crytic_compile.config.json does not exist"
	exit 255
	fi
	# TODO: Globbing at crytic_compile.py:720 to run with '.'
	crytic-compile 'contracts/InterestRates/InterestRatePositionManager.f.sol' --config-file crytic_compile.config.json
	if [ $? -ne 0 ]
	then
	echo "crytic-compile command failed"
	exit 255
	fi
	cd ../../../
	echo "::endgroup::"
	# From crytic/crytic-compile#544
	echo "::group::Etherscan #8"
	if ! crytic-compile 0x9AB6b21cDF116f611110b048987E58894786C244 --etherscan-apikey "$GITHUB_ETHERSCAN"; then
	echo "Etherscan #8 test failed"
	exit 255
	fi
	dir_name=$(find crytic-export/etherscan-contracts/ -type d -name "*0x9AB6b21cDF116f611110b048987E58894786C244*" -print -quit)
	cd "$dir_name" || { echo "Failed to change directory"; exit 255; }
	if [ ! -f crytic_compile.config.json ]; then
	echo "crytic_compile.config.json does not exist"
	exit 255
	fi
	# TODO: Globbing at crytic_compile.py:720 to run with '.'
	if ! crytic-compile 'contracts/InterestRates/InterestRatePositionManager.f.sol' --config-file crytic_compile.config.json; then
	echo "crytic-compile command failed"
	exit 255
	fi
	cd ../../../
	echo "::endgroup::"

[coderabbitai]

The addition of the metadata_config dictionary and its export to a JSON file is a valuable enhancement for customizable compilation processes. However, for clarity and consistency, consider renaming the dictionary keys to match common naming conventions in Solc configurations:

{
-   "solc_remaps": remappings if remappings else {},
+   "solcRemappings": remappings if remappings else {},
-   "solc_solcs_select": compiler_version,
+   "solcVersion": compiler_version,
-   "solc_args": " ".join(
+   "solcArgs": " ".join(

This change would make the keys more intuitive and consistent with Solc's naming conventions.

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	metadata_config = {
	"solc_remaps": remappings if remappings else {},
	"solc_solcs_select": compiler_version,
	"solc_args": " ".join(
	filter(
	None,
	[
	"--via-ir" if via_ir_enabled else "",
	"--optimize --optimize-runs " + str(optimize_runs) if optimize_runs else "",
	"--evm-version " + evm_version if evm_version else "",
	],
	)
	),
	}
	with open(
	os.path.join(working_dir if working_dir else export_dir, "crytic_compile.config.json"),
	"w",
	encoding="utf-8",
	) as f:
	json.dump(metadata_config, f)
	metadata_config = {
	"solcRemappings": remappings if remappings else {},
	"solcVersion": compiler_version,
	"solcArgs": " ".join(
	filter(
	None,
	[
	"--via-ir" if via_ir_enabled else "",
	"--optimize --optimize-runs " + str(optimize_runs) if optimize_runs else "",
	"--evm-version " + evm_version if evm_version else "",
	],
	)
	),
	}
	with open(
	os.path.join(working_dir if working_dir else export_dir, "crytic_compile.config.json"),
	"w",
	encoding="utf-8",
	) as f:
	json.dump(metadata_config, f)