refactor: Solana changes #140

MaxMustermann2 · 2025-01-17T12:44:41Z

commit 75c84b1
Author: MaxMustermann2 [email protected]
Date: Fri Jan 17 12:38:52 2025 +0000

refactor(lzsend): use correct solana values

commit 52fde80
Author: MaxMustermann2 [email protected]
Date: Fri Jan 17 12:34:50 2025 +0000

refactor: change msg format (reorder parts)

Fixes #136

Summary by CodeRabbit

Changes
- Reordered parameter packing in multiple contracts to change how payload data is processed.
- Added Solana-specific gas limit and message value constants.
- Updated test cases to reflect new payload structure.
- Specified a more precise version for the Foundry toolchain in CI workflows.
Technical Notes
- Changes primarily affect internal data handling.
- No functional changes to core contract logic detected.

Fixes ExocoreNetwork#136

coderabbitai · 2025-01-17T12:44:49Z

Walkthrough

The pull request introduces systematic changes across multiple contracts and test files, focusing on reordering parameters in byte array packing and payload construction. The modifications primarily affect how data is encoded and extracted in delegation, deposit, and transfer operations, with a consistent pattern of moving the sender or staker address to the first position, followed by amount, and then the token or validator identifier. These changes aim to standardize message formats across different contract interactions while maintaining the existing functional logic.

Changes

File	Change Summary
`src/core/BaseRestakingController.sol`	Reordered parameters in `delegateTo` and `undelegateFrom` functions when packing `actionArgs`.
`src/core/ExocoreGateway.sol`	Modified parameter extraction order in multiple handler functions like `handleLSTTransfer`, `handleNSTTransfer`, etc.
`src/core/LSTRestakingController.sol`	Altered parameter order in `deposit`, `claimPrincipalFromExocore`, and `depositThenDelegateTo` functions.
`src/storage/ExocoreGatewayStorage.sol`	Added constants for Solana-specific gas limits and message values.
`test/foundry/*.t.sol` files	Updated payload construction in various test functions to match new parameter ordering.
`test/mocks/ExocoreGatewayMock.sol`	Reordered payload parsing and added `_buildOptions` function.
`foundry.toml`	Added `optimizer` and `solc` version parameters.
`.github/workflows/*.yml` files	Updated `foundry-version` from `nightly` to a specific commit hash.

Assessment against linked issues

Objective	Addressed	Explanation
Uniform message format for DepositLST and DepositNST	✅

Possibly related PRs

feat: register whitelist tokens to Exocore from client chain contract #23: The changes in the BaseRestakingController contract regarding the delegateTo and undelegateFrom functions are related to the modifications in the ExocoreGateway contract, which also involves reordering parameters in similar functions, indicating a connection in how these contracts handle action arguments.
chore: downgrade openzeppelin-contracts-upgradeable from v5 to v4 #45: The changes in the BaseRestakingController contract and the LSTRestakingController contract both involve modifications to the order of parameters in their respective functions, which aligns with the changes made in the ExocoreGateway contract, suggesting a broader refactoring of how these contracts manage their parameters.
update executor options for solana client controller #120: The updates to the ExocoreGateway for handling Solana client chains and the associated message structures are relevant to the changes in the BaseRestakingController and LSTRestakingController, as they all involve managing different types of tokens and their interactions.

Suggested reviewers

cloud8little
magj2006
adu-web3
bwhour

Poem

🐰 Bytes dancing, order rearranged,
Parameters shuffled, logic unchanged.
From token to sender, a subtle shift,
Code's rhythm flows with a rabbit's gift!
Interchain messages now align,
Uniformity's the design divine! 🌈

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8bd6e2 and a89fda6.

📒 Files selected for processing (2)

.github/workflows/compare-layouts.yml (1 hunks)
.github/workflows/forge-ci.yml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

.github/workflows/forge-ci.yml

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: setup / install

🔇 Additional comments (2)

.github/workflows/compare-layouts.yml (2)

Line range hint 1-276: Well-structured workflow with robust error handling!

The workflow demonstrates excellent practices:

Clear job dependencies and progression

Efficient use of caching and artifacts

Graceful handling of parent workflow failures

Appropriate timeout limits

94-94: Good practice pinning Foundry to a specific version!

Pinning to a specific nightly build (nightly-70cd140131cd49875c6f31626bdfae08eba35386) instead of using the generic nightly tag improves reproducibility and prevents unexpected behavior from newer nightly builds.

Let's verify this specific nightly build:

✅ Verification successful

✅ Verified: Foundry version is valid and recent

The specified nightly build (70cd140131cd49875c6f31626bdfae08eba35386) is a valid and recent version from January 8, 2025, containing only minor dependency updates.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the Foundry version exists and check its age
# Note: Using GitHub API to check the commit in foundry-rs/foundry repository

gh api \
  -H "Accept: application/vnd.github+json" \
  /repos/foundry-rs/foundry/commits/70cd140131cd49875c6f31626bdfae08eba35386
Length of output: 5530

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

🪧 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>, please review it.
- Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
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/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-01-17T12:44:57Z

✅ The Solhint workflow has completed successfully. Check the workflow run for details. (a89fda6)

github-actions · 2025-01-17T12:44:58Z

✅ The Slither Analysis workflow has completed successfully. Check the workflow run for details. (a89fda6)

github-actions · 2025-01-17T12:44:58Z

✅ The Forge CI workflow has completed successfully. Check the workflow run for details. (a89fda6)

github-actions · 2025-01-17T12:48:20Z

✅ The Compare Storage Layouts workflow has completed successfully. Check the workflow run for details. (a89fda6)

See foundry-rs/foundry#9657

Pin the foundry version so that it runs even on the base branch. Later, in a separate PR, once this one is merged, it will be reverted to the nightly version.

MaxMustermann2 · 2025-01-17T14:24:01Z

.github/workflows/compare-layouts.yml

@@ -91,7 +91,7 @@ jobs:
      # The below line does not accept environment variables,
      # so it becomes the single source of truth for the version, within this workflow.
      # Any `pinning` of the version should be done here and in forge-ci.yml.
-      foundry-version: nightly
+      foundry-version: nightly-70cd140131cd49875c6f31626bdfae08eba35386


This change is necessary to make the CI pass. It will be changed back to nightly in the next PR.

MaxMustermann2 added 3 commits January 17, 2025 12:41

refactor: change msg format (reorder parts)

52fde80

Fixes ExocoreNetwork#136

refactor(lzsend): use correct solana values

75c84b1

test: restore delegation test asserts

91dcb65

MaxMustermann2 requested review from magj2006, bwhour, adu-web3 and cloud8little January 17, 2025 12:45

MaxMustermann2 added 4 commits January 17, 2025 13:26

fix(config): explicitly enable the optimizer

666bc99

See foundry-rs/foundry#9657

feat(config): pin solc version

0fe744f

fix(ci): pin Foundry version

d8bd6e2

Pin the foundry version so that it runs even on the base branch. Later, in a separate PR, once this one is merged, it will be reverted to the nightly version.

fix(ci): add the word nightly in the version

a89fda6

MaxMustermann2 commented Jan 17, 2025

View reviewed changes

magj2006 approved these changes Jan 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Solana changes #140

refactor: Solana changes #140

MaxMustermann2 commented Jan 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 17, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

MaxMustermann2 Jan 17, 2025

refactor: Solana changes #140

Are you sure you want to change the base?

refactor: Solana changes #140

Conversation

MaxMustermann2 commented Jan 17, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jan 17, 2025 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Jan 17, 2025 • edited Loading

github-actions bot commented Jan 17, 2025 • edited Loading

github-actions bot commented Jan 17, 2025 • edited Loading

github-actions bot commented Jan 17, 2025 • edited Loading

MaxMustermann2 Jan 17, 2025

Choose a reason for hiding this comment

MaxMustermann2 commented Jan 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 17, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading