feat: receive admin address at launch #136

beer-1 · 2025-02-23T07:33:18Z

Description

Closes: #XXXX

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct type prefix in the PR title, you can find examples of the prefixes below:

confirmed ! in the type prefix if API or client breaking change
targeted the correct branch
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

New Features
- Introduced a new admin configuration option that automatically sets up a dedicated admin account when not explicitly provided.
- Updated the genesis setup to incorporate the admin account, with an adjusted fee exemption list reflecting this addition.
Documentation
- Enhanced configuration examples to include the new admin setting for improved clarity and usage guidance.

coderabbitai · 2025-02-23T07:33:25Z

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce an "admin" configuration option into the system. In the JSON configuration example, an "admin" key with an associated L2 address is added. In the Go code, a new Admin field is incorporated into the SystemKeys struct and is automatically initialized to the validator’s values if not provided. Finally, the genesis process is updated to include the admin’s L2 address in the fee whitelist and as the genesis admin address.

Changes

File(s)	Change Summary
`contrib/launchtools/README.md`	Added a new `"admin"` key with an `"l2_address"` field in the JSON configuration, positioned before the `"validator"` key.
`contrib/launchtools/config.go`	Introduced a new field `Admin *SystemAccount` in the `SystemKeys` struct. Updated the `Finalize` method to initialize the Admin account (defaulting to validator if nil) and validate its `L2Address`.
`contrib/launchtools/steps/genesis.go`	Modified the genesis initialization to increase the fee whitelist from 3 to 4 addresses, now including the admin's `L2Address` instead of the validator's.

Sequence Diagram(s)

sequenceDiagram
    participant ConfigLoader as Config Loader
    participant SystemKeys as SystemKeys.Finalize
    participant Genesis as Genesis Initializer
    participant Validator as Validator Account

    ConfigLoader->>SystemKeys: Load configuration
    SystemKeys-->>SystemKeys: Check if Admin is set
    alt Admin not initialized
        SystemKeys->>Validator: Retrieve Validator L2Address & Mnemonic
        SystemKeys->>SystemKeys: Initialize Admin from Validator
    end
    SystemKeys->>Genesis: Pass finalized SystemKeys
    Genesis->>Genesis: Update fee whitelist with Admin L2Address
    Genesis->>Genesis: Set Admin as genesis admin address

Poem

I'm a rabbit with a joyful hop,
Admin's here to make the configs pop!
With a dash of code and a clever tweak,
Validator aids when admin's meek.
Genesis now sings a fresh, clear beat!
Hop along and relish the neat feat!
🐰✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint (1.62.2)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package injective: could not load export data: no export data for "github.com/cosmos/relayer/v2/relayer/codecs/injective""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package injective: could not load export data: no export data for "github.com/cosmos/relayer/v2/relayer/codecs/injective""

📜 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 7bb2292 and f1028ea.

📒 Files selected for processing (3)

contrib/launchtools/README.md (1 hunks)
contrib/launchtools/config.go (2 hunks)
contrib/launchtools/steps/genesis.go (2 hunks)

✨ Finishing Touches

📝 Generate Docstrings (Beta)

🪧 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 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.

codecov · 2025-02-23T07:39:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.38%. Comparing base (7bb2292) to head (f1028ea).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #136   +/-   ##
=======================================
  Coverage   49.38%   49.38%           
=======================================
  Files          57       57           
  Lines        4275     4275           
=======================================
  Hits         2111     2111           
  Misses       1726     1726           
  Partials      438      438

receive admin address at launch

34f8a40

beer-1 requested a review from a team as a code owner February 23, 2025 07:33

comment

f1028ea

beer-1 merged commit 89d1bf8 into main Feb 23, 2025
5 checks passed

beer-1 deleted the feat/receive-admin-address branch February 23, 2025 07:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: receive admin address at launch #136

feat: receive admin address at launch #136

beer-1 commented Feb 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 23, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Feb 23, 2025

feat: receive admin address at launch #136

feat: receive admin address at launch #136

Conversation

beer-1 commented Feb 23, 2025 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Feb 23, 2025 • edited Loading

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Feb 23, 2025

Codecov Report

beer-1 commented Feb 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)