Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add document for launching Ignition node from source and Local network from source #2502

Merged
merged 8 commits into from
Jan 6, 2025
Merged

Add document for launching Ignition node from source and Local network from source #2502

merged 8 commits into from
Jan 6, 2025

Conversation

AurelienFT
Copy link
Contributor

Description

New documentation on README.md that covers more cases to launch nodes on differents cases.

@AurelienFT AurelienFT added the no changelog Skip the CI check of the changelog modification label Dec 16, 2024
@AurelienFT AurelienFT self-assigned this Dec 16, 2024
@AurelienFT AurelienFT requested a review from a team December 16, 2024 12:23
acerone85
acerone85 reviewed Dec 16, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
acerone85
acerone85 reviewed Dec 16, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
acerone85
acerone85 reviewed Dec 16, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
acerone85
acerone85 previously approved these changes Dec 16, 2024
View reviewed changes
Copy link
Contributor

@acerone85 acerone85 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Followed the README to launch a local node, everything works as expected.

xgreenx
xgreenx reviewed Dec 16, 2024
View reviewed changes
Copy link
Collaborator

@xgreenx xgreenx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to put instruction how to build binary image between "Rust setup" and "Compiling".

And we can rework "Compiling" section to specify that it is for local development.

README.md Outdated

Instead of directly placing your personal values on the command we advise you to use, for example, environment variables.

### From source
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the difference with "Running a Local network from source"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The difference is the parameters, here we sue the chain config of ignition we use the realyer address on mainnet, we don't produce blocks, we use the bootstrap peers...

README.md Outdated
Comment on lines 193 to 214
--enable-relayer \
--service-name fuel-ignition-node \
--keypair {KEYGEN_SECRET_KEY} \
--relayer {ETHEREUM_RPC_ENDPOINT} \
--ip=0.0.0.0 \
--port 4000 \
--peering-port 30333 \
--db-path ~/.fuel-ignition \
--snapshot {PATH_TO_CHAIN_CONFIGURATION_FOLDER}/ignition \
--utxo-validation --poa-instant false --enable-p2p \
--utxo-validation \
--poa-instant false \
--enable-p2p \
--bootstrap-nodes /dnsaddr/mainnet.fuel.network \
--sync-header-batch-size 100 \
--relayer-v2-listening-contracts=0xAEB0c00D0125A8a788956ade4f4F12Ead9f65DDf \
--relayer-da-deploy-height=20620434 \
--relayer-log-page-size=100 \
--sync-block-stream-buffer-size 30
--relayer-v2-listening-contracts 0xAEB0c00D0125A8a788956ade4f4F12Ead9f65DDf \
--relayer-da-deploy-height 20620434 \
--relayer-log-page-size 2000 \
--sync-block-stream-buffer-size 30 \
--min-gas-price 1000 \
--starting-gas-price 1000 \
--gas-price-change-percent 10 \
--gas-price-threshold-percent 50
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to provide information which fields to use, for that we have documentation and we can point to it. Maybe we need to rework "Running a Ignition node" and point to the documentation to avoid multiple places.

We just need to describe how to build the production ready binary.

Copy link
Contributor Author

@AurelienFT AurelienFT Dec 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see where is the documentation. It's only the --help ? I think it's valuable to be able to copy-paste a command that is working as expected to connect to Ignition/Launch a local network and then if you need something specific you can just tweak some parameters. We saw in the past weeks that if some parameters are not present the node isn't working as expected so to avoid confusion I find it useful to first set everything correctly (such as a --ignition that we could have) and then play with flags if you want.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.fuel.network/guides/running-a-node/running-a-mainnet-node/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to remove duplicate

README.md Outdated

Run your node (change all variable with {} to your own personal variables):
```bash
cargo run --release --bin fuel-core -- run \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are missing "production" feature. The command should looks like cargo build --release -p fuel-core-bin --no-default-features --features production.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@AurelienFT
Copy link
Contributor Author

@xgreenx I moved the section after the Rust setup. I think it's valuable to have a section for node runners with pre made commands etc and have the general commands for people that wants to contribute to the node. I made two distinct sections and moved the node running one to the top.

@AurelienFT AurelienFT requested a review from xgreenx December 17, 2024 11:22
@AurelienFT AurelienFT marked this pull request as draft January 2, 2025 17:53
@AurelienFT AurelienFT marked this pull request as ready for review January 3, 2025 10:11
@AurelienFT AurelienFT requested a review from acerone85 January 3, 2025 10:11
@AurelienFT AurelienFT merged commit d591eb5 into master Jan 6, 2025
31 checks passed
@AurelienFT AurelienFT deleted the update_readme_command branch January 6, 2025 08:38
rymnc pushed a commit that referenced this pull request Jan 6, 2025
@AurelienFT @acerone85 @rymnc
Add document for launching Ignition node from source and Local networ…
2210194 
…k from source (#2502)

## Description

New documentation on README.md that covers more cases to launch nodes on
differents cases.

---------

Co-authored-by: Andrea Cerone <[email protected]>
@xgreenx xgreenx mentioned this pull request Jan 15, 2025
Merged
xgreenx added a commit that referenced this pull request Jan 15, 2025
@xgreenx
Release v0.41.0 (#2565)
2287292 
## Version v0.41.0

### Added
- [2547](#2547): Replace the
old Graphql gas price provider adapter with the ArcGasPriceEstimate.
- [2445](#2445): Added GQL
endpoint for querying asset details.
- [2442](#2442): Add
uninitialized task for V1 gas price service
- [2154](#2154): Added
`Unknown` variant to `ConsensusParameters` graphql queries
- [2154](#2154): Added
`Unknown` variant to `Block` graphql queries
- [2154](#2154): Added
`TransactionType` type in `fuel-client`
- [2321](#2321): New metrics
for the TxPool:
    - The size of transactions in the txpool (`txpool_tx_size`)
- The time spent by a transaction in the txpool in seconds
(`txpool_tx_time_in_txpool_seconds`)
- The number of transactions in the txpool
(`txpool_number_of_transactions`)
- The number of transactions pending verification before entering the
txpool (`txpool_number_of_transactions_pending_verification`)
- The number of executable transactions in the txpool
(`txpool_number_of_executable_transactions`)
- The time it took to select transactions for inclusion in a block in
microseconds (`txpool_select_transactions_time_microseconds`)
- The time it took to insert a transaction in the txpool in microseconds
(`transaction_insertion_time_in_thread_pool_microseconds`)
- [2385](#2385): Added new
histogram buckets for some of the TxPool metrics, optimize the way they
are collected.
- [2347](#2364): Add activity
concept in order to protect against infinitely increasing DA gas price
scenarios
- [2362](#2362): Added a new
request_response protocol version `/fuel/req_res/0.0.2`. In comparison
with `/fuel/req/0.0.1`, which returns an empty response when a request
cannot be fulfilled, this version returns more meaningful error codes.
Nodes still support the version `0.0.1` of the protocol to guarantee
backward compatibility with fuel-core nodes. Empty responses received
from nodes using the old protocol `/fuel/req/0.0.1` are automatically
converted into an error `ProtocolV1EmptyResponse` with error code 0,
which is also the only error code implemented. More specific error codes
will be added in the future.
- [2386](#2386): Add a flag to
define the maximum number of file descriptors that RocksDB can use. By
default it's half of the OS limit.
- [2376](#2376): Add a way to
fetch transactions in P2P without specifying a peer.
- [2361](#2361): Add caches to
the sync service to not reask for data it already fetched from the
network.
- [2327](#2327): Add more
services tests and more checks of the pool. Also add an high level
documentation for users of the pool and contributors.
- [2416](#2416): Define the
`GasPriceServiceV1` task.
- [2447](#2447): Use new
`expiration` policy in the transaction pool. Add a mechanism to prune
the transactions when they expired.
- [1922](#1922): Added support
for posting blocks to the shared sequencer.
- [2033](#2033): Remove
`Option<BlockHeight>` in favor of `BlockHeightQuery` where applicable.
- [2490](#2490): Added
pagination support for the `balances` GraphQL query, available only when
'balances indexation' is enabled.
- [2439](#2439): Add gas costs
for the two new zk opcodes `ecop` and `eadd` and the benches that allow
to calibrate them.
- [2472](#2472): Added the
`amountU128` field to the `Balance` GraphQL schema, providing the total
balance as a `U128`. The existing `amount` field clamps any balance
exceeding `U64` to `u64::MAX`.
- [2526](#2526): Add
possibility to not have any cache set for RocksDB. Add an option to
either load the RocksDB columns families on creation of the database or
when the column is used.
- [2532](#2532): Getters for
inner rocksdb database handles.
- [2524](#2524): Adds a new
lock type which is optimized for certain workloads to the txpool and p2p
services.
- [2535](#2535): Expose
`backup` and `restore` APIs on the `CombinedDatabase` struct to create
portable backups and restore from them.
- [2550](#2550): Add
statistics and more limits infos about txpool on the node_info endpoint

### Fixed
- [2560](#2560): Fix flaky
test by increasing timeout
- [2558](#2558): Rename `cost`
and `reward` to remove `excess` wording
- [2469](#2469): Improved the
logic for syncing the gas price database with on_chain database
- [2365](#2365): Fixed the
error during dry run in the case of race condition.
- [2366](#2366): The
`importer_gas_price_for_block` metric is properly collected.
- [2369](#2369): The
`transaction_insertion_time_in_thread_pool_milliseconds` metric is
properly collected.
- [2413](#2413): block
production immediately errors if unable to lock the mutex.
- [2389](#2389): Fix
construction of reverse iterator in RocksDB.
- [2479](#2479): Fix an error
on the last iteration of the read and write sequential opcodes on
contract storage.
- [2478](#2478): Fix proof
created by `message_receipts_proof` function by ignoring the receipts
from failed transactions to match `message_outbox_root`.
- [2485](#2485): Hardcode the
timestamp of the genesis block and version of `tai64` to avoid breaking
changes for us.
- [2511](#2511): Fix backward
compatibility of V0Metadata in gas price db.

### Changed
- [2469](#2469): Updated
adapter for querying costs from DA Block committer API
- [2469](#2469): Use the gas
price from the latest block to estimate future gas prices
- [2501](#2501): Use gas price
from block for estimating future gas prices
- [2468](#2468): Abstract
unrecorded blocks concept for V1 algorithm, create new storage impl.
Introduce `TransactionableStorage` trait to allow atomic changes to the
storage.
- [2295](#2295):
`CombinedDb::from_config` now respects `state_rewind_policy` with tmp
RocksDB.
- [2378](#2378): Use cached
hash of the topic instead of calculating it on each publishing gossip
message.
- [2438](#2438): Refactored
service to use new implementation of `StorageRead::read` that takes an
offset in input.
- [2429](#2429): Introduce
custom enum for representing result of running service tasks
- [2377](#2377): Add more
errors that can be returned as responses when using protocol
`/fuel/req_res/0.0.2`. The errors supported are
`ProtocolV1EmptyResponse` (status code `0`) for converting empty
responses sent via protocol `/fuel/req_res/0.0.1`,
`RequestedRangeTooLarge`(status code `1`) if the client requests a range
of objects such as sealed block headers or transactions too large,
`Timeout` (status code `2`) if the remote peer takes too long to fulfill
a request, or `SyncProcessorOutOfCapacity` if the remote peer is
fulfilling too many requests concurrently.
- [2233](#2233): Introduce a
new column `modification_history_v2` for storing the modification
history in the historical rocksDB. Keys in this column are stored in big
endian order. Changed the behaviour of the historical rocksDB to write
changes for new block heights to the new column, and to perform lookup
of values from the `modification_history_v2` table first, and then from
the `modification_history` table, performing a migration upon access if
necessary.
- [2383](#2383): The `balance`
and `balances` GraphQL query handlers now use index to provide the
response in a more performant way. As the index is not created
retroactively, the client must be initialized with an empty database and
synced from the genesis block to utilize it. Otherwise, the legacy way
of retrieving data will be used.
- [2463](#2463): The
`coinsToSpend` GraphQL query handler now uses index to provide the
response in a more performant way. As the index is not created
retroactively, the client must be initialized with an empty database and
synced from the genesis block to utilize it. Otherwise, the legacy way
of retrieving data will be used.
- [2556](#2556): Ensure that
the `last_recorded_height` is set for the DA gas price source.

#### Breaking
- [2469](#2469): Move from
`GasPriceServicev0` to `GasPriceServiceV1`. Include new config values.
- [2438](#2438): The
`fuel-core-client` can only work with new version of the `fuel-core`.
The `0.40` and all older versions are not supported.
- [2438](#2438): Updated
`fuel-vm` to `0.59.1` release. Check [release
notes](https://github.com/FuelLabs/fuel-vm/releases/tag/v0.59.0) for
more details.
- [2389](#2258): Updated the
`messageProof` GraphQL schema to return a non-nullable `MessageProof`.
- [2154](#2154): Transaction
graphql endpoints use `TransactionType` instead of
`fuel_tx::Transaction`.
- [2446](#2446): Use graphiql
instead of graphql-playground due to known vulnerability and stale
development.
- [2379](#2379): Change
`kv_store::Value` to be `Arc<[u8]>` instead of `Arc<Vec<u8>>`.
- [2490](#2490): Updated
GraphQL complexity calculation for `balances` query to account for
pagination (`first`/`last`) and nested field complexity
(`child_complexity`). Queries with large pagination values or deeply
nested fields may have higher complexity costs.
- [2463](#2463):
'CoinsQueryError::MaxCoinsReached` variant has been removed. The
`InsufficientCoins` variant has been renamed to
`InsufficientCoinsForTheMax` and it now contains the additional `max`
field
- [2463](#2463): The number of
excluded ids in the `coinsToSpend` GraphQL query is now limited to the
maximum number of inputs allowed in transaction.
- [2463](#2463): The
`coinsToSpend` GraphQL query may now return different coins, depending
whether the indexation is enabled or not. However, regardless of the
differences, the returned coins will accurately reflect the current
state of the database within the context of the query.
- [2526](#2526): By default
the cache of RocksDB is now disabled instead of being `1024 * 1024 *
1024`.

## What's Changed
* Add metrics to TxPool by @acerone85 in
#2321
* Fix collection of gas price metric by @rafal-ch in
#2366
* Add documentation to run a ignition node in readme by @AurelienFT in
#2363
* Fix collection of tx pool insertion time metric by @rafal-ch in
#2369
* Add versioning to request response protocols by @acerone85 in
#2362
* Return reason of why proof cant be generated by @rafal-ch in
#2258
* p2p: use precalculated topic hash by @yaziciahmet in
#2378
* Remove ignore RUSTSEC-2024-0336 by @AurelienFT in
#2384
* Deal with negative feed back loop in DA gas price by @MitchTurner in
#2364
* Add new flag for maximum file descriptors in rocksdb. by @AurelienFT
in #2386
* Add codeowners for gas price algorithm crate by @rafal-ch in
#2404
* Weekly `cargo update` by @github-actions in
#2373
* chore(gas_price_service): initialize v1 metadata by @rymnc in
#2288
* chore(gas_price_service_v0): remove unused trait impl by @rymnc in
#2410
* Update tai64 to fix the wrong time offset by @AurelienFT in
#2409
* fix(block_producer): immediately return error if lock cannot be
acquired during production by @rymnc in
#2413
* Add a way to fetch transactions in P2P without specifying a peer by
@AurelienFT in #2376
* Add a new code owner for tx pool by @AurelienFT in
#2417
* Satisfy clippy in `gas-price-analysis` by @rafal-ch in
#2418
* Txpool metrics update by @rafal-ch in
#2385
* Improve TxPool tests and documentation by @AurelienFT in
#2327
* feat(gas_price_service_v1): define RunnableTask for GasPriceServiceV1
by @rymnc in #2416
* Return reason of why proof cant be generated (api change) by @rafal-ch
in #2389
* Fuel/Request_Response v0.0.2: More meaningful error messages by
@acerone85 in #2377
* Fix reverse iterator in RocksDB by @AurelienFT in
#2398
* Add test node herself in reserved nodes. by @AurelienFT in
#2390
* Weekly `cargo update` by @github-actions in
#2424
* Weekly `cargo update` by @github-actions in
#2440
* Resolve some falky tests and improve CI times by @AurelienFT in
#2401
* feat: handle `Unknown` transactions, blocks and consensus parameters
by @hal3e in #2154
* fix(p2p): cache responses to serve without roundtrip to db by @rymnc
in #2352
* Replace task `run()` return result with custom enum by @MitchTurner in
#2429
* Fix codeowners by @AurelienFT in
#2444
* fix(graphql_playground): use graphiql instead by @rymnc in
#2446
* Weekly `cargo update` by @github-actions in
#2453
* refactor: remove `Option<BlockHeight>` and use new enum where
applicable by @matt-user in
#2033
* Fixed the error during dry run by @xgreenx in
#2365
* Add decompression traits and a test case by @Dentosal in
#2295
* Versioned Storage for Modifications History by @acerone85 in
#2233
* Allow DA recorded blocks to come out-of-order by @MitchTurner in
#2415
* feat: Change `kv_store::Value` to be Arc<[u8]> instead of Arc<Vec<u8>>
by @netrome in #2411
* Optimize balance-related queries with a cache by @rafal-ch in
#2383
* fix: Add missing features to `fuel-core-tests` by @netrome in
#2467
* Keep data in fails cases in sync service by @AurelienFT in
#2361
* Weekly `cargo update` by @github-actions in
#2470
* Revert balances amount to `U64` and introduce new `amountU128` getter
by @rafal-ch in #2472
* Create uninitialized task for v1 gas price service by @MitchTurner in
#2442
* Port the 0.40.2 fix of TAI on master by @AurelienFT in
#2485
* Ignore RUSTSEC-2024-0421 by @AurelienFT in
#2489
* Ignore receipts from failed transactions in `message_receipts_proof`
by @AurelienFT in #2478
* Add unrecorded blocks abstraction to gas price algo by @MitchTurner in
#2468
* Fix last iteration in sequential opcode by @AurelienFT in
#2479
* fix(gas_price_service_v0): bring back removed fields, causing UB when
trying to access by @rymnc in
#2511
* Refactor fuel-core to use version of StorageRead::read with offset
(Full update to 0.59.1) by @acerone85 in
#2438
* Sync the version of the `fuel-core` with minor hot fixes by @xgreenx
in #2516
* fix(docs): typo preventing ci checks from passing by @rymnc in
#2525
* Integration test for balances and (non)retryable messages by @rafal-ch
in #2505
* Add document for launching Ignition node from source and Local network
from source by @AurelienFT in
#2502
* Make the rocksdb cache optional in config and add policy for column
opening by @AurelienFT in
#2526
* Weekly `cargo update` by @github-actions in
#2530
* chore(rocksdb): getter for inner database handle by @rymnc in
#2532
* Use gas prices from actual blocks to calculate estimate gas prices by
@MitchTurner in #2501
* chore(codeowners): gas price service codeowners by @rymnc in
#2534
* Add zk opcodes by @AurelienFT in
#2439
* Gas price simulation data retriever by @acerone85 in
#2533
* Shared sequencer integration by @Dentosal in
#1922
* Use expiration policy by @AurelienFT in
#2447
* Fixed TPS benchmark to work with latest changes by @xgreenx in
#2515
* Use indexation cache to satisfy "coins to spend" queries by @rafal-ch
in #2463
* feat(txpool|p2p): use seqlock instead of small copy-able RwLocks by
@rymnc in #2524
* Create new index for tracking Asset metadata by @maschad in
#2445
* feat(rocksdb): remove getters for internal rocksdb handles, expose
`backup` instead by @rymnc in
#2535
* Integrate with V1 algo for tests by @MitchTurner in
#2469
* Lock-free `latest_l2_height` in gas price service by @rafal-ch in
#2546
* chore(gas_price_service_v1): strictly ensure last_recorded_height is
set, to avoid initial poll of da source by @rymnc in
#2556
* Replace old Graphql Gas Price adapter with new latest gas price struct
by @MitchTurner in #2547
* Rename cost and rewards without 'excess' by @MitchTurner in
#2558
* Add current pool gas to the node info endpoint by @AurelienFT in
#2550
* Pagination queries for `balances` endpoint by @rafal-ch in
#2490
* 2559 Increase timeout for test by @MitchTurner in
#2560
* Add test expiration policy in executor by @AurelienFT in
#2563

## New Contributors
* @yaziciahmet made their first contribution in
#2378

**Full Changelog**:
v0.40.0...v0.41.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rymnc rymnc rymnc approved these changes

@xgreenx xgreenx xgreenx approved these changes

@Dentosal Dentosal Awaiting requested review from Dentosal Dentosal is a code owner

@MitchTurner MitchTurner Awaiting requested review from MitchTurner MitchTurner is a code owner

@acerone85 acerone85 Awaiting requested review from acerone85

Assignees

@AurelienFT AurelienFT

Labels
no changelog Skip the CI check of the changelog modification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@AurelienFT @xgreenx @acerone85 @rymnc