feat: add forc-node command for easily bootstrapping a node #6473

kayagokalp · 2024-08-28T05:58:46Z

Description

WIP at the moment, I have couple of code duplications to remove but we can start playing with this.

Forc Node

Forc node is a new plugin for easily bootstrapping fuel-core instances with sensible defaults. We currently support:

Ignition
Testnet
Local

Ignition

This configuration automatically syncs with ignition network, basically run forc node ignition and the created node instance will start syncing.

The defaults are taken from: https://docs.fuel.network/guides/running-a-node/running-a-mainnet-node/

> ./target/debug/forc-node ignition
✔ Do you have a keypair in hand? · yes
✔ Peer Id: · 16Uiu2HAm6U2QNh35FAoob8LNS9zA6tz4BSrsyCmJxgpEzmYRNgrk
✔ Secret: · ********
? Ethereum RPC (Sepolia) Endpoint: › https://eth-mainnet.g.alchemy.com/v2/....
2024-11-28T06:06:36.369956Z  INFO fuel_core_bin::cli::run: 315: `[Importer, P2P, Producer, TxPool, GraphQL]` metrics are enabled
2024-11-28T06:06:36.370965Z  INFO fuel_core_bin::cli::run: 345: Block production disabled
2024-11-28T06:06:36.370973Z  WARN fuel_core_bin::cli::run: 405: The coinbase recipient `ContractId` is not set!
2024-11-28T06:06:36.370981Z  INFO fuel_core_bin::cli::run: 608: Fuel Core version v0.40.0
...

Testnet

This is for connecting to the latest testnet. Similar to mainnet only thing required is to run forc node testnet to start a node created for syncing with testnet.

The defaults are taken from: https://docs.fuel.network/guides/running-a-node/running-a-testnet-node/

> ./target/debug/forc-node testnet
✔ Do you have a keypair in hand? · yes
✔ Peer Id: · 16Uiu2HAm6U2QNh35FAoob8LNS9zA6tz4BSrsyCmJxgpEzmYRNgrk
✔ Secret: · ********
? Ethereum RPC (Sepolia) Endpoint: › https://eth-sepolia.g.alchemy.com/v2/....
2024-11-28T06:06:36.369956Z  INFO fuel_core_bin::cli::run: 315: `[Importer, P2P, Producer, TxPool, GraphQL]` metrics are enabled
2024-11-28T06:06:36.370965Z  INFO fuel_core_bin::cli::run: 345: Block production disabled
2024-11-28T06:06:36.370973Z  WARN fuel_core_bin::cli::run: 405: The coinbase recipient `ContractId` is not set!
2024-11-28T06:06:36.370981Z  INFO fuel_core_bin::cli::run: 608: Fuel Core version v0.40.0
...

Local

This is a in-memory instance mostly suited for local developments with instant block production and debug mode enabled in the fuel-core level.

> ./target/debug/forc-node local
2024-11-28T06:04:44.654891Z  INFO fuel_core_bin::cli::run: 315: `[Importer, P2P, Producer, TxPool, GraphQL]` metrics are enabled
2024-11-28T06:04:44.655762Z  INFO fuel_core_bin::cli::run::relayer: 56: Relayer service disabled
2024-11-28T06:04:44.655769Z  INFO fuel_core_bin::cli::run::p2p: 259: P2P service disabled
2024-11-28T06:04:44.655797Z  INFO fuel_core_bin::cli::run: 343: Block production mode: Instant
...

Dry run

It is possible that users of this new plugin might not want to run the node without seeing the parameters send to it. So forc-node has a dry run mode that can be enabled forc-node --dry-run <ignition|testnet|local> which will instead of running the node print the command that would achieve the same result:

> ./target/debug/forc-node --dry-run local
fuel-core run --debug --snapshot /Users/kayagokalp/.forc/chainspecs/local --db-type in-memory --poa-instant true

TODO

[] Add docs to sway book plugins section
[] Add CI check to compare cargo fuel-core version with min supported

mchristopher

Small comments.

Also, can we remove the wasm bytecodes & benchmark JSON files? Those are not needed at runtime (it will pull updates from the live network if needed), and I don't like committing or shipping binary blobs in this repo if we can avoid it.

forc-plugins/forc-node/src/consts.rs

forc-plugins/forc-node/src/chain_config.rs

forc-plugins/forc-node/src/util.rs

forc-plugins/forc-node/src/chain_config.rs

…re node

forc-plugins/forc-node/src/local/cmd.rs

zees-dev · 2024-12-12T11:11:14Z

opinion: I've seen dry-run mostly used for making transactions or some state-changing/persisting action; I personally think that the default command run when starting up the node should be printed in the --help output instead.
Alternatively, if we still want to continue using dry-run for this; then it should adapt with the CLI flags; for example when running:

cargo run -p forc-node -- --dry-run local --port 8090

It prints the following (port is missing):

fuel-core run --debug --snapshot /Users/z/.forc/chainspecs/local --db-type in-memory --poa-instant true

forc-plugins/forc-node/src/run_opts.rs

forc-plugins/forc-node/src/util.rs

sdankel

Great work on this! 🏆

forc-plugins/forc-node/src/cmd.rs

forc-plugins/forc-node/src/ignition/cmd.rs

forc-plugins/forc-node/src/consts.rs

sdankel · 2024-12-13T08:25:35Z

forc-plugins/forc-node/src/chain_config.rs

+
+    fn build_api_endpoint(&self, folder_name: &str) -> String {
+        format!(
+            "{}/repos/FuelLabs/{}/contents/{}",


If we're always fetching from master, would this mean forc-node might be using a newer version of the chain config than what's actually deployed?

forc-plugins/forc-node/src/run_opts.rs

forc-plugins/forc-node/src/chain_config.rs

forc-plugins/forc-node/src/util.rs

forc-plugins/forc-node/src/local/op.rs

forc-plugins/forc-node/src/testnet/cmd.rs

forc-plugins/forc-node/src/ignition/cmd.rs

Co-authored-by: Sophie Dankel <[email protected]>

kayagokalp · 2025-01-17T01:35:09Z

I'll move forc-node tests to a sepearate step because it needs fuel-core installed. That's why test workspace stuff is failing but the code itself is ready to be reviewed! @FuelLabs/tooling

forc-plugins/forc-node/src/cmd.rs

kayagokalp force-pushed the kayagokalp/forc-node-local branch from bd90b81 to 4cab4db Compare November 28, 2024 05:47

mchristopher reviewed Dec 2, 2024

View reviewed changes

forc-plugins/forc-node/src/consts.rs Outdated Show resolved Hide resolved

forc-plugins/forc-node/src/consts.rs Outdated Show resolved Hide resolved

kayagokalp force-pushed the kayagokalp/forc-node-local branch from 4cab4db to 2db09cc Compare December 2, 2024 23:16

kayagokalp self-assigned this Dec 2, 2024

mchristopher reviewed Dec 2, 2024

View reviewed changes

forc-plugins/forc-node/src/chain_config.rs Outdated Show resolved Hide resolved

mchristopher reviewed Dec 2, 2024

View reviewed changes

forc-plugins/forc-node/src/util.rs Outdated Show resolved Hide resolved

kayagokalp added enhancement New feature or request forc labels Dec 4, 2024

JoshuaBatty reviewed Dec 12, 2024

View reviewed changes

forc-plugins/forc-node/src/chain_config.rs Show resolved Hide resolved

JoshuaBatty reviewed Dec 12, 2024

View reviewed changes

forc-plugins/forc-node/src/chain_config.rs Outdated Show resolved Hide resolved

kayagokalp force-pushed the kayagokalp/forc-node-local branch from 5873fab to fadc4ee Compare December 12, 2024 07:01

kayagokalp added 11 commits December 11, 2024 23:06

feat: implement a forc-node plugin for easily bootstrapping a fuel-co…

c8aea71

…re node

refactor: remove duplicated code-paths

417bfc7

chore: remove wasm bytecodes and benchmarks

2ba0c6a

feat: config fetcher implemented

c4ed2ec

feat: finalize downloader

2b5d8af

chore: remove chain configs

caf0e0d

chore: spellcheck

f605b99

chore: add doc comments

440a3da

apply code review

afe7a25

chore: fmt cargo.toml

5704de3

chore: lint

91b8e10

kayagokalp marked this pull request as ready for review December 12, 2024 07:06

kayagokalp requested review from a team as code owners December 12, 2024 07:06

kayagokalp force-pushed the kayagokalp/forc-node-local branch from 5e2f71c to 91b8e10 Compare December 12, 2024 07:06

zees-dev reviewed Dec 12, 2024

View reviewed changes

forc-plugins/forc-node/src/local/cmd.rs Show resolved Hide resolved

zees-dev reviewed Dec 12, 2024

View reviewed changes

forc-plugins/forc-node/src/run_opts.rs Show resolved Hide resolved

zees-dev reviewed Dec 12, 2024

View reviewed changes

forc-plugins/forc-node/src/util.rs Show resolved Hide resolved

chore: review suggestions

b0ca40b

sdankel reviewed Dec 13, 2024

View reviewed changes

forc-plugins/forc-node/src/local/op.rs Outdated Show resolved Hide resolved

sdankel reviewed Dec 13, 2024

View reviewed changes

forc-plugins/forc-node/src/testnet/cmd.rs Outdated Show resolved Hide resolved

sdankel reviewed Dec 13, 2024

View reviewed changes

forc-plugins/forc-node/src/ignition/cmd.rs Outdated Show resolved Hide resolved

kayagokalp and others added 11 commits December 17, 2024 05:15

Apply suggestions from code review

c4b94c8

Co-authored-by: Sophie Dankel <[email protected]>

Apply suggestions from code review

2eed5fe

Co-authored-by: Sophie Dankel <[email protected]>

Merge branch 'master' into kayagokalp/forc-node-local

ca4cc9d

feat: local with persistent db support

8ad7354

chore: apply remaining comments

b542926

feat: print command always

9b4f914

test: add health integration test

9e2b660

change test name

bb1bd3f

fix: error formating

c962157

feat: generate keygen if user does not have one

e54c0e3

feat: remove unused deps and format the toml file

7872a7f

JoshuaBatty reviewed Jan 19, 2025

View reviewed changes

forc-plugins/forc-node/src/cmd.rs Outdated Show resolved Hide resolved

chore: fix ci

f59a38b

kayagokalp force-pushed the kayagokalp/forc-node-local branch from db7a38f to f59a38b Compare January 21, 2025 20:27

kayagokalp and others added 5 commits January 21, 2025 12:36

Merge branch 'master' into kayagokalp/forc-node-local

7fac0b6

fix: merging conflicts

1da68e4

toml and spell check

3b33b99

fix ordering

093c977

docs: add forc-node auto doc page

72fd6b0

kayagokalp requested review from a team as code owners January 23, 2025 22:04

Merge branch 'master' into kayagokalp/forc-node-local

0794447

sdankel temporarily deployed to fuel-sway-bot January 24, 2025 03:57 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add forc-node command for easily bootstrapping a node #6473

feat: add forc-node command for easily bootstrapping a node #6473

kayagokalp commented Aug 28, 2024 •

edited

Loading

mchristopher left a comment

zees-dev commented Dec 12, 2024 •

edited

Loading

sdankel left a comment

sdankel Dec 13, 2024

kayagokalp commented Jan 17, 2025 •

edited

Loading

feat: add forc-node command for easily bootstrapping a node #6473

Are you sure you want to change the base?

feat: add forc-node command for easily bootstrapping a node #6473

Conversation

kayagokalp commented Aug 28, 2024 • edited Loading

Description

Forc Node

Ignition

Testnet

Local

Dry run

TODO

mchristopher left a comment

Choose a reason for hiding this comment

zees-dev commented Dec 12, 2024 • edited Loading

sdankel left a comment

Choose a reason for hiding this comment

sdankel Dec 13, 2024

Choose a reason for hiding this comment

kayagokalp commented Jan 17, 2025 • edited Loading

kayagokalp commented Aug 28, 2024 •

edited

Loading

zees-dev commented Dec 12, 2024 •

edited

Loading

kayagokalp commented Jan 17, 2025 •

edited

Loading