Skip to content

feat(network): custom network profiles with deployment-file import#362

Merged
MuncleUscles merged 4 commits into
v0.40-devfrom
feat/custom-network-profiles
Jul 8, 2026
Merged

feat(network): custom network profiles with deployment-file import#362
MuncleUscles merged 4 commits into
v0.40-devfrom
feat/custom-network-profiles

Conversation

@MuncleUscles

Copy link
Copy Markdown
Member

Summary

Adds first-class support for pointing the CLI at a non-standard network — an existing chain with a different consensus deployment (the Clarke-on-Bradbury test-run scenario). New genlayer network add <alias> builds a custom profile from a built-in base chain plus overrides, including importing all contract addresses straight from a consensus deployments.json:

genlayer network add clarke --base testnet-bradbury --deployment deployments.json [--rpc <node-rpc>] [--chain-id <n>]
genlayer network set clarke     # every command now targets the new deployment

Depends-On: genlayerlabs/genlayer-consensus#1162

Changes

  • network add: --base <built-in>, --deployment <json> (walks the consensus deployments shape; maps ConsensusMain/ConsensusData/GenStaking/FeeManager/Rounds/Appeals; --deployment-key selects a sub-object; surfaces ConsensusMainWithFees ambiguity), per-contract flags (--consensus-main, --consensus-data, --staking, --fee-manager, --rounds-storage, --appeals), --rpc, --chain-id. Flags override the file; the base chain fills the rest.
  • Persistence: profiles store base alias + address overrides only — resolveNetwork loads the base fresh from genlayer-js and applies overrides, so ABIs never go stale (unlike the legacy full-JSON config path).
  • network set/list/info/remove understand custom profiles; --network <custom-alias> works in staking/vesting commands (StakingAction.getNetwork updated).
  • prepare script added so npm install -g github:genlayerlabs/genlayer-cli#<ref> builds dist/ — enables install-from-git instructions without clone+link.
  • genlayer-js bumped to v2-dev tip: the locked SHA predated the vesting client actions, so vesting validator create was broken (client.vestingValidatorJoin is not a function).
  • Help-text fix: --network options now say "built-in or custom network alias" instead of the stale "(localnet, testnet-asimov)".

Verification

  • 576/576 vitest tests (52 files), incl. new coverage: add/precedence/validation/ambiguity/--deployment-key, custom resolution with fresh ABIs, set/list/info/remove, StakingAction custom alias.
  • Live integration against consensus #1162: deployed that branch (107 contracts, epoch-0 initialized, VestingFactory schedule) to a fresh anvil; then via this CLI: network add from the real deployments file → staking epoch-info (min stake read) → staking validator-join --amount 42000gen (validator wallet created) → vesting validator create from a 100000-GEN vesting contract (validator created, visible in staking validators as [mine]).

Known cosmetic issue (pre-existing, not this PR): vesting validator create prints validatorWallet: undefined — the wallet is created on-chain but the event decode misses it.

Notes

  • e2e intentionally NOT triggered yet — waiting on the consensus #1162 dependency plan.

genlayer network add <alias> --base <built-in> [--deployment <json>]
[--rpc <url>] [--consensus-main|--consensus-data|--staking|--fee-manager
|--rounds-storage|--appeals <addr>] [--chain-id <n>] [--deployment-key <path>]

Profiles persist as base + address overrides only; resolveNetwork loads
the base chain fresh from genlayer-js and applies overrides, so ABIs
never go stale. network set/list/info/remove and StakingAction --network
accept custom aliases. The consensus deployments.json shape is parsed by
walking the tree for ContractName->address leaves (ConsensusMain,
ConsensusData, GenStaking/Staking, FeeManager, Rounds/RoundsStorage,
Appeals); flags take precedence over the file. Adds a prepare script so
npm install from a git ref builds dist. Verified: 576 vitest tests, full
manual smoke (add/list/set/info/remove with a deployment file).
The locked v2-dev SHA (28e99fbc) predates the vesting client actions;
vestingValidatorJoin and friends land at 666d1156. Verified live:
vesting validator create succeeds against a #1162-branch consensus
deployment.
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bd74ac6a-a657-4af6-bac9-665c3feab427

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/custom-network-profiles

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@MuncleUscles

Copy link
Copy Markdown
Member Author

/run-e2e

The docs generator's option regex only matched <word> placeholders, so
flags with dots or hyphens in the value name (--base <built-in-alias>,
--deployment <path.json>, --deployment-key <dot.path>) were silently
dropped from the options tables. Widen to <[^>]+> and regenerate: adds
the network add/remove pages and the previously undocumented vesting
command section (validator create/deposit/exit/claim, operator-transfer,
set-identity, delegate/undelegate/claim/withdraw/list).
The join receipt does not carry the new wallet address, so the output
printed validatorWallet: undefined. Read getValidatorWallets from the
vesting contract after the join and report the newest entry. Verified
live against a #1162-branch deployment.
@MuncleUscles MuncleUscles merged commit 185d22b into v0.40-dev Jul 8, 2026
9 of 10 checks passed
MuncleUscles added a commit that referenced this pull request Jul 8, 2026
* fix(system): propagate command-check and version parse fixes to v0.40-dev (#350)

Propagates #349 to v0.40-dev.

* docs: add branching guide (#353)

* docs: add branching guide

* ci: harden testnet smoke timeout

* feat: support fee profiles in contract commands (#355)

* feat: support fee profiles in contract commands

* test: make fee profile deploy test portable

* feat: staking validators discovery (#357)

* feat: add staking validators discovery

* feat: epoch-aware validator listing with below-min indicator

* fix(staking): account-less client for read-only staking queries

getReadOnlyStakingClient threw 'Account not found' on fresh installs;
listings and other reads don't need a local account.

* feat: vesting commands (#358)

* feat: add vesting commands

* feat(vesting): validator subcommands — create/join, deposit, exit, claim, operator-transfer, set-identity, list/status

Drives the CON-607 Vesting.sol validator leg through the SDK's named
vestingValidator* actions; list/status enumerate getValidatorWallets
with per-wallet deposited principal.

* chore(deps): update dependency uuid to v11.1.1 [security] (#320)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(init): use backend provider id "google" for Gemini (#359)

Selecting Gemini during `genlayer init` failed with:
  Requested providers '{'geminiai'}' do not match any stored providers.

The selected provider id is forwarded verbatim to
sim_createRandomValidators, but the backend's llm_provider table stores
Gemini as "google". Rename the provider id geminiai -> google so it
matches. Display name ("Gemini") and env var (GEMINI_API_KEY) are
unchanged.

Since "geminiai" never resolved to a valid provider, no working
configuration relied on it.

Fixes #271

Co-authored-by: Edgars Nemše <edgars@genlayerlabs.com>

* fix(docs-sync): stop overwriting the generated root _meta.json (#352)

The sync-docs workflow rsynced the generated category-based
docs/api-references/_meta.json into genlayer-docs and then immediately
overwrote it with a hardcoded heredoc containing the pre-grouping flat
command list (init, up, deploy, ...). Those keys no longer match the
directory layout, so the genlayer-docs sidebar rendered broken entries
on every sync (fixed manually in genlayer-docs#426; this removes the
cause).

Also make the generated root meta complete:
- add "index": "Overview" for the generated index.mdx
- append ungrouped top-level commands (estimate-fees, finalize,
  finalize-batch) so they get explicit nav entries instead of relying
  on Nextra's implicit append

Snapshot under docs/api-references regenerated against current main
(picks up the new estimate-fees command and latest help text).

Co-authored-by: Albert Castellana <albert@genlayer.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Edgars <edgars@entropicsolutions.io>

* fix: drop getSlashingAddress from validator-history (#361)

getSlashingAddress() was removed from the genlayer-js SDK (v0.39+/v2-dev),
causing `genlayer staking validator-history` to crash with
`client.getSlashingAddress is not a function` before any history is fetched.

Resolve the idleness (slashing) contract address dynamically via viem
readContract against consensusMainContract.getIdlenessAddress(), falling
back to the staking contract address if resolution fails so reward events
still display.

Port of #344 (by @ygd58) from the dead v0.39 line to v0.40-dev.
Supersedes #344.

Fixes #341

Co-authored-by: Edgars <edgars@entropicsolutions.io>

* feat(network): custom network profiles with deployment-file import (#362)

* feat(network): custom network profiles with deployment-file import

genlayer network add <alias> --base <built-in> [--deployment <json>]
[--rpc <url>] [--consensus-main|--consensus-data|--staking|--fee-manager
|--rounds-storage|--appeals <addr>] [--chain-id <n>] [--deployment-key <path>]

Profiles persist as base + address overrides only; resolveNetwork loads
the base chain fresh from genlayer-js and applies overrides, so ABIs
never go stale. network set/list/info/remove and StakingAction --network
accept custom aliases. The consensus deployments.json shape is parsed by
walking the tree for ContractName->address leaves (ConsensusMain,
ConsensusData, GenStaking/Staking, FeeManager, Rounds/RoundsStorage,
Appeals); flags take precedence over the file. Adds a prepare script so
npm install from a git ref builds dist. Verified: 576 vitest tests, full
manual smoke (add/list/set/info/remove with a deployment file).

* chore(deps): bump genlayer-js to v2-dev tip for vesting actions

The locked v2-dev SHA (28e99fbc) predates the vesting client actions;
vestingValidatorJoin and friends land at 666d1156. Verified live:
vesting validator create succeeds against a #1162-branch consensus
deployment.

* docs(cli): regenerate API references; fix option placeholder regex

The docs generator's option regex only matched <word> placeholders, so
flags with dots or hyphens in the value name (--base <built-in-alias>,
--deployment <path.json>, --deployment-key <dot.path>) were silently
dropped from the options tables. Widen to <[^>]+> and regenerate: adds
the network add/remove pages and the previously undocumented vesting
command section (validator create/deposit/exit/claim, operator-transfer,
set-identity, delegate/undelegate/claim/withdraw/list).

* fix(vesting): resolve validator wallet address in create output

The join receipt does not carry the new wallet address, so the output
printed validatorWallet: undefined. Read getValidatorWallets from the
vesting contract after the join and report the newest entry. Verified
live against a #1162-branch deployment.

* fix: make git install build lifecycle robust (#363)

* fix: make git install build script self contained

* chore: refresh genlayer-js lockfile

* fix: make keychain dependency optional

* fix: restore git prepare build

* fix: include build dependency for git installs

* chore: keep esbuild as dev dependency

* ci: publish prereleases to npm dist tags (#364)

* ci: add clarke cli tarball release

* ci: publish prereleases to npm dist tags

* Release v0.40.0-rc1 [skip ci]

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Tobu <36818942+Tobu8888@users.noreply.github.com>
Co-authored-by: Albert Castellana <acastellana@users.noreply.github.com>
Co-authored-by: Albert Castellana <albert@genlayer.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Edgars <edgars@entropicsolutions.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant