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.

mchristopher · 2024-12-02T23:02:20Z

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

+/// Minimum fuel-core version supported.
+pub const MIN_FUEL_CORE_VERSION: &str = "0.40.0";
+
+pub const TESTNET_RESERVED_NODE: &str = "/dns4/p2p-testnet.fuel.network/tcp/30333/p2p/16Uiu2HAmDxoChB7AheKNvCVpD4PHJwuDGn8rifMBEHmEynGHvHrf";


We should use the same setup for testnet that we do for mainnet. Primarily - testnet should use bootstrap nodes the same as mainnet does.

It should also use /dnsaddr/testnet.fuel.network. instead of a specific node like above.

Sounds good to me! Fixing it now, we might want to update the this docs as well as I was following this one: https://docs.fuel.network/guides/running-a-node/running-a-testnet-node/ Will open a PR for that as well

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

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

mchristopher · 2024-12-02T23:30:07Z

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

+        let secret = ask_user_discreetly("Secret:")?;
+        Ok(KeyPair { peer_id, secret })
+    } else {
+        bail!("Please create a keypair with `fuel-core-keygen new --key-type peering`");


Can we generate a keypair instead of requiring the user to manually do this? For the vast majority of users, just taking care of automatically setting up the keypair would be the desired behavior.

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

…re node

zees-dev · 2024-12-12T11:00:27Z

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

+use std::path::PathBuf;
+
+#[derive(Parser, Debug, Clone)]
+pub struct LocalCmd {


Can we also have DB path for local node; it's good to be able to persist local node setup across restarts/runs

This probably implies that in-memory is the default option (you may need to use an enum here so we can override to custom path)

That is a good point! I think we should enable local node with persisting db but that shouldn't be the default. Maybe we can do it with a flag?

Whatever is easiest/maintainable, don't really mind; thought an enum made sense since you'd either have 1 or the other option.
Another option is to use Either type (if we're certain there'd only ever be these 2 options); but an additional flag is fine too!

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

zees-dev · 2024-12-12T11:31:46Z

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

+    let mut handle = match op::run(command).await {
+        Ok(handler) => handler,
+        Err(err) => {
+            forc_result_bail!(err);
+        }
+    };


nit:

Suggested change

let mut handle = match op::run(command).await {

Ok(handler) => handler,

Err(err) => {

forc_result_bail!(err);

}

};

let mut handle = op::run(command).await?;

zees-dev · 2024-12-12T11:39:52Z

Is it possible to make the forc-node a bit more extensible; i.e. user can provide additional CLI args - which would simply be appended onto the underlying fuel-core run command.
I.e. something like forc-node local -- <additional CLI flags> - where everything after the -- would simply be appended to the underlying fuel-core run command.

This way, if a user wants to run the node with some additional/custom CLI args, they could simply append those args (without us having to make a PR for it for the time being).

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

Cargo.toml

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

zees-dev · 2024-12-12T12:03:42Z

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

+    } else {
+        // Spawn the process with proper error handling
+        let handle = fuel_core_command
+            .spawn()
+            .with_context(|| "Failed to spawn fuel-core process:".to_string())?;
+        Ok(Some(handle))
+    }


nit:

Suggested change

} else {

// Spawn the process with proper error handling

let handle = fuel_core_command

.spawn()

.with_context(|| "Failed to spawn fuel-core process:".to_string())?;

Ok(Some(handle))

}

return Ok(None);

}

// Spawn the process with proper error handling

let handle = fuel_core_command

.spawn()

.with_context(|| "Failed to spawn fuel-core process:".to_string())?;

Ok(Some(handle))

zees-dev

Great work; have a few suggestions above^; otherwise looking good! 🚀

sdankel

Great work on this! 🏆

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

sdankel · 2024-12-13T08:22:04Z

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

+use std::{net::IpAddr, path::PathBuf};
+
+#[derive(Parser, Debug, Clone)]
+pub struct IgnitionCmd {


nit: it looks like the options are the same for TestnetCmd, it's just the defaults that differ. We could have a common struct for the options that are the same and use flatten

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

sdankel · 2024-12-13T08:47:01Z

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

+        if update {
+            fetcher.download_config(&ChainConfig::Local).await?;
+        } else {
+            bail!(


For some reason these errors aren't being formatted properly.

sdankel · 2024-12-13T08:50:34Z

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

+
+    #[test]
+    fn test_basic_command() {
+        let mut command = Command::new("fuel-core");


I'm not seeing where fuel-core gets installed for these tests. In CI, do they always run with the latest version of fuel-core?

These do not need fuel-core itself as these tests only tests the pretty printer. Adding integration tests are tricky and only possible for local node case (as others basically needs to sync with rest of the network > 24h to run a single test 😄) I'll try to come-up with the integration tests for happy paths for local shortly

sdankel · 2024-12-13T08:54:50Z

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

+    fuel_core_command.args(params.as_slice());
+
+    if dry_run {
+        println_green(&format!(


It'd be nice to print the command even when it's not a dry run.

Hmm that is an interesting idea! I think we should do it. Adding it.

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

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

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

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

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

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