fuel-core 0.48.0

Fuel client library is aggregation of all fuels service. It contains the all business logic of the fuel protocol.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
#![allow(clippy::let_unit_value)]

use super::{
    DbType,
    adapters::{
        FuelBlockSigner,
        P2PAdapter,
        TxStatusManagerAdapter,
        compression_adapters::{
            CompressionBlockDBAdapter,
            CompressionServiceAdapter,
        },
    },
    config::DaCompressionMode,
    genesis::create_genesis_block,
};
#[cfg(feature = "rpc")]
use crate::database::database_description::on_chain::OnChain;
#[cfg(feature = "relayer")]
use crate::relayer::Config as RelayerConfig;
#[cfg(feature = "p2p")]
use crate::service::adapters::consensus_module::poa::pre_confirmation_signature::{
    key_generator::Ed25519KeyGenerator,
    trigger::TimeBasedTrigger,
    tx_receiver::PreconfirmationsReceiver,
};
use crate::{
    combined_database::CombinedDatabase,
    database::Database,
    fuel_core_graphql_api::{
        self,
        Config as GraphQLConfig,
    },
    graphql_api::worker_service::{
        self,
    },
    schema::build_schema,
    service::{
        Config,
        SharedState,
        SubServices,
        adapters::{
            BlockImporterAdapter,
            BlockProducerAdapter,
            ChainStateInfoProvider,
            ExecutorAdapter,
            MaybeRelayerAdapter,
            PoAAdapter,
            PreconfirmationSender,
            SharedMemoryPool,
            SystemTime,
            TxPoolAdapter,
            UniversalGasPriceProvider,
            VerifierAdapter,
            block_importer::BlockReconciliationWriteAdapter,
            chain_state_info_provider,
            consensus_module::poa::{
                InDirectoryPredefinedBlocks,
                NoopReconciliationAdapter,
                ReconciliationAdapter,
                RedisLeaderLeaseAdapter,
            },
            fuel_gas_price_provider::FuelGasPriceProvider,
            graphql_api::GraphQLBlockImporter,
            import_result_provider::ImportResultProvider,
            ready_signal::ReadySignal,
            tx_status_manager::ConsensusConfigProtocolPublicKey,
        },
    },
};
use fuel_core_compression_service::service::new_service as new_compression_service;
use fuel_core_gas_price_service::v1::{
    algorithm::AlgorithmV1,
    da_source_service::block_committer_costs::{
        BlockCommitterDaBlockCosts,
        BlockCommitterHttpApi,
    },
    metadata::V1AlgorithmConfig,
    service::SharedData,
    uninitialized_task::new_gas_price_service_v1,
};
use fuel_core_poa::Trigger;
use fuel_core_storage::{
    self,
    transactional::AtomicView,
};
#[cfg(feature = "relayer")]
use fuel_core_types::blockchain::primitives::DaBlockHeight;
use fuel_core_types::signer::SignMode;
#[cfg(feature = "rpc")]
use rpc::*;
use std::sync::Arc;
use tokio::sync::Mutex;

#[cfg(feature = "rpc")]
mod rpc {
    pub use crate::{
        database::database_description::block_aggregator::BlockAggregatorDatabase,
        service::adapters::rpc::ReceiptSource,
    };
    pub use fuel_core_block_aggregator_api::{
        blocks::old_block_source::{
            OldBlocksSource,
            convertor_adapter::ProtobufBlockConverter,
        },
        service::UninitializedTask,
    };
    pub use fuel_core_services::ServiceRunner;
    pub use fuel_core_types::fuel_types::BlockHeight;
}

pub type PoAService = fuel_core_poa::Service<
    BlockProducerAdapter,
    BlockImporterAdapter,
    SignMode,
    InDirectoryPredefinedBlocks,
    SystemTime,
    ReadySignal,
    ReconciliationAdapter,
>;
#[cfg(feature = "p2p")]
pub type P2PService = fuel_core_p2p::service::Service<Database, TxPoolAdapter>;
pub type TxPoolSharedState = fuel_core_txpool::SharedState;
pub type BlockProducerService = fuel_core_producer::block_producer::Producer<
    Database,
    TxPoolAdapter,
    ExecutorAdapter,
    FuelGasPriceProvider<AlgorithmV1, u32, u64>,
    ChainStateInfoProvider,
>;
pub type GraphQL = fuel_core_graphql_api::api_service::Service;

// TODO: Add to consensus params https://github.com/FuelLabs/fuel-vm/issues/888
pub const DEFAULT_GAS_PRICE_CHANGE_PERCENT: u16 = 10;

pub fn init_sub_services(
    config: &Config,
    database: CombinedDatabase,
    block_production_ready_signal: ReadySignal,
) -> anyhow::Result<(SubServices, SharedState)> {
    let chain_config = config.snapshot_reader.chain_config();
    let chain_id = chain_config.consensus_parameters.chain_id();
    let chain_name = chain_config.chain_name.clone();
    let on_chain_view = database.on_chain().latest_view()?;
    let (new_txs_updater, new_txs_watcher) = tokio::sync::watch::channel(());
    #[cfg(feature = "p2p")]
    let (preconfirmation_sender, preconfirmation_receiver) =
        tokio::sync::mpsc::channel(1024);
    #[cfg(not(feature = "p2p"))]
    let (preconfirmation_sender, _) = tokio::sync::mpsc::channel(1024);

    let genesis_block = on_chain_view
        .genesis_block()?
        .unwrap_or(create_genesis_block(config).compress(&chain_id));
    let last_block_header = on_chain_view
        .get_current_block()?
        .map(|block| block.header().clone())
        .unwrap_or(genesis_block.header().clone());

    let last_height = *last_block_header.height();

    if config.historical_execution
        && config.combined_db_config.database_type != DbType::RocksDb
    {
        return Err(anyhow::anyhow!(
            "Historical execution is only supported with RocksDB"
        ));
    }

    #[cfg(feature = "p2p")]
    let p2p_externals = config
        .p2p
        .clone()
        .map(fuel_core_p2p::service::build_shared_state);

    #[cfg(feature = "p2p")]
    let p2p_adapter = {
        use crate::service::adapters::PeerReportConfig;

        // Hardcoded for now, but left here to be configurable in the future.
        // TODO: https://github.com/FuelLabs/fuel-core/issues/1340
        let peer_report_config = PeerReportConfig {
            successful_block_import: 5.,
            missing_block_headers: -100.,
            bad_block_header: -100.,
            missing_transactions: -100.,
            invalid_transactions: -100.,
        };
        P2PAdapter::new(
            p2p_externals.as_ref().map(|ext| ext.0.clone()),
            peer_report_config,
        )
    };

    #[cfg(not(feature = "p2p"))]
    let p2p_adapter = P2PAdapter::new();

    let protocol_pubkey =
        ConsensusConfigProtocolPublicKey::new(chain_config.consensus.clone());

    let tx_status_manager = fuel_core_tx_status_manager::new_service(
        p2p_adapter.clone(),
        config.tx_status_manager.clone(),
        protocol_pubkey,
    );
    let tx_status_manager_adapter =
        TxStatusManagerAdapter::new(tx_status_manager.shared.clone());
    let preconfirmation_sender = PreconfirmationSender::new(
        preconfirmation_sender,
        tx_status_manager_adapter.clone(),
    );

    let upgradable_executor_config = fuel_core_upgradable_executor::config::Config {
        forbid_fake_coins_default: config.utxo_validation,
        allow_syscall: config.allow_syscall,
        native_executor_version: config.native_executor_version,
        allow_historical_execution: config.historical_execution,
    };
    let executor = ExecutorAdapter::new(
        database.on_chain().clone(),
        database.relayer().clone(),
        upgradable_executor_config,
        new_txs_watcher,
        preconfirmation_sender.clone(),
    );
    let import_result_provider =
        ImportResultProvider::new(database.on_chain().clone(), executor.clone());

    let verifier = VerifierAdapter::new(
        &genesis_block,
        chain_config.consensus.clone(),
        database.on_chain().clone(),
    );

    let redis_reconciliation_adapter = config
        .leader_lock
        .as_ref()
        .map(|leader_lock| {
            RedisLeaderLeaseAdapter::new(
                leader_lock.redis_urls.clone(),
                leader_lock.lease_key.clone(),
                leader_lock.lease_ttl,
                leader_lock.node_timeout,
                leader_lock.retry_delay,
                leader_lock.max_retry_delay_offset,
                leader_lock.max_attempts,
                leader_lock.stream_max_len,
            )
            .map(|adapter| {
                adapter
                    .with_quorum_disruption_budget(leader_lock.quorum_disruption_budget)
            })
        })
        .transpose()?;

    let importer_adapter = BlockImporterAdapter::new(
        chain_id,
        config.block_importer.clone(),
        database.on_chain().clone(),
        executor.clone(),
        verifier.clone(),
        redis_reconciliation_adapter
            .as_ref()
            .cloned()
            .map(BlockReconciliationWriteAdapter::Redis)
            .unwrap_or_else(|| BlockReconciliationWriteAdapter::Noop(Default::default())),
    );

    let chain_state_info_provider_service = chain_state_info_provider::new_service(
        database.on_chain().clone(),
        &importer_adapter,
    );
    let chain_state_info_provider =
        ChainStateInfoProvider::new(chain_state_info_provider_service.shared.clone());

    #[cfg(feature = "relayer")]
    let relayer_service = if let Some(config) = &config.relayer {
        Some(fuel_core_relayer::new_service(
            database.relayer().clone(),
            config.clone(),
        )?)
    } else {
        None
    };

    let relayer_adapter = MaybeRelayerAdapter {
        #[cfg(feature = "relayer")]
        relayer_synced: relayer_service.as_ref().map(|r| r.shared.clone()),
        #[cfg(feature = "relayer")]
        relayer_database: database.relayer().clone(),
        #[cfg(feature = "relayer")]
        da_deploy_height: config.relayer.as_ref().map_or(
            DaBlockHeight(RelayerConfig::DEFAULT_DA_DEPLOY_HEIGHT),
            |config| config.da_deploy_height,
        ),
    };

    let genesis_block_height = *genesis_block.header().height();
    let settings = chain_state_info_provider.clone();
    let block_stream = importer_adapter.events_shared_result();

    let committer_api =
        BlockCommitterHttpApi::new(config.gas_price_config.da_committer_url.clone());
    let da_source = BlockCommitterDaBlockCosts::new(committer_api);
    let v1_config = V1AlgorithmConfig::from(config.clone());

    let gas_price_service_v1 = new_gas_price_service_v1(
        v1_config,
        genesis_block_height,
        settings,
        block_stream,
        database.gas_price().clone(),
        da_source,
        database.on_chain().clone(),
    )?;
    let SharedData {
        gas_price_algo,
        latest_gas_price,
        ..
    } = gas_price_service_v1.shared.clone();
    let universal_gas_price_provider = UniversalGasPriceProvider::new_from_inner(
        latest_gas_price,
        DEFAULT_GAS_PRICE_CHANGE_PERCENT,
    );

    let producer_gas_price_provider = FuelGasPriceProvider::new(
        gas_price_algo.clone(),
        universal_gas_price_provider.clone(),
    );

    let txpool = fuel_core_txpool::new_service(
        chain_id,
        config.txpool.clone(),
        p2p_adapter.clone(),
        importer_adapter.clone(),
        database.on_chain().clone(),
        chain_state_info_provider.clone(),
        last_height,
        universal_gas_price_provider.clone(),
        executor.clone(),
        new_txs_updater,
        preconfirmation_sender,
    );
    let tx_pool_adapter = TxPoolAdapter::new(txpool.shared.clone());

    #[cfg(feature = "p2p")]
    let mut network = config.p2p.clone().zip(p2p_externals).map(
        |(p2p_config, (shared_state, request_receiver))| {
            fuel_core_p2p::service::new_service(
                chain_id,
                last_height,
                p2p_config,
                shared_state,
                request_receiver,
                database.on_chain().clone(),
                importer_adapter.clone(),
                tx_pool_adapter.clone(),
            )
        },
    );

    let block_producer = fuel_core_producer::Producer {
        config: config.block_producer.clone(),
        view_provider: database.on_chain().clone(),
        txpool: tx_pool_adapter.clone(),
        executor: Arc::new(executor.clone()),
        relayer: Box::new(relayer_adapter.clone()),
        lock: Mutex::new(()),
        gas_price_provider: producer_gas_price_provider.clone(),
        chain_state_info_provider: chain_state_info_provider.clone(),
    };
    let producer_adapter = BlockProducerAdapter::new(block_producer);

    let poa_config: fuel_core_poa::Config = config.into();
    let mut production_enabled = !matches!(poa_config.trigger, Trigger::Never);

    if !production_enabled
        && config.debug
        && !matches!(poa_config.signer, SignMode::Unavailable)
    {
        production_enabled = true;
        tracing::info!("Enabled manual block production because of `debug` flag");
    }

    let signer = FuelBlockSigner::new(config.consensus_signer.clone());

    #[cfg(feature = "shared-sequencer")]
    let shared_sequencer = {
        let config = config.shared_sequencer.clone();

        fuel_core_shared_sequencer::service::new_service(
            importer_adapter.clone(),
            config,
            Arc::new(signer.clone()),
        )?
    };

    let predefined_blocks =
        InDirectoryPredefinedBlocks::new(config.predefined_blocks_path.clone());

    #[cfg(feature = "p2p")]
    let config_preconfirmation: fuel_core_poa::pre_confirmation_signature_service::config::Config =
        config.into();

    #[cfg(feature = "p2p")]
    let pre_confirmation_service = production_enabled
        .then(|| {
            fuel_core_poa::pre_confirmation_signature_service::new_service(
                config_preconfirmation.clone(),
                PreconfirmationsReceiver::new(preconfirmation_receiver),
                p2p_adapter.clone(),
                signer.clone(),
                Ed25519KeyGenerator,
                TimeBasedTrigger::new(
                    SystemTime,
                    config_preconfirmation.key_rotation_interval,
                    config_preconfirmation.key_expiration_interval,
                ),
            )
        })
        .transpose()?;

    let poa = production_enabled
        .then(|| -> anyhow::Result<_> {
            let reconciliation_port = redis_reconciliation_adapter
                .as_ref()
                .cloned()
                .map(ReconciliationAdapter::Redis)
                .unwrap_or_else(|| {
                    ReconciliationAdapter::Noop(NoopReconciliationAdapter)
                });

            Ok(fuel_core_poa::new_service(
                &last_block_header,
                poa_config,
                tx_pool_adapter.clone(),
                producer_adapter.clone(),
                importer_adapter.clone(),
                p2p_adapter.clone(),
                Arc::new(signer),
                predefined_blocks,
                SystemTime,
                block_production_ready_signal,
                reconciliation_port,
            ))
        })
        .transpose()?;
    let poa_adapter = PoAAdapter::new(poa.as_ref().map(|service| service.shared.clone()));

    #[cfg(feature = "p2p")]
    let sync = fuel_core_sync::service::new_service(
        last_height,
        p2p_adapter.clone(),
        importer_adapter.clone(),
        super::adapters::ConsensusAdapter::new(
            verifier.clone(),
            config.relayer_consensus_config.clone(),
            relayer_adapter,
        ),
        config.sync,
    )?;

    // we allow the consumers of the database access even
    // when the compression service is disabled
    let compression_service_adapter =
        CompressionServiceAdapter::new(database.compression().clone());

    let compression_importer_adapter = CompressionBlockDBAdapter::new(
        importer_adapter.clone(),
        database.on_chain().clone(),
    );

    let compression_service = match &config.da_compression {
        DaCompressionMode::Disabled => None,
        DaCompressionMode::Enabled(cfg) => Some(
            new_compression_service(
                compression_importer_adapter,
                database.compression().clone(),
                cfg.clone(),
                database.on_chain().clone(),
                chain_id,
            )
            .map_err(|e| anyhow::anyhow!(e))?,
        ),
    };

    let schema = crate::schema::dap::init(build_schema(), config.debug)
        .data(database.on_chain().clone());

    let graphql_block_importer =
        GraphQLBlockImporter::new(importer_adapter.clone(), import_result_provider);
    let graphql_worker_context = worker_service::Context {
        tx_status_manager: tx_status_manager_adapter.clone(),
        block_importer: graphql_block_importer,
        on_chain_database: database.on_chain().clone(),
        off_chain_database: database.off_chain().clone(),
        continue_on_error: config.continue_on_error,
        block_subscriptions_queue: config.graphql_config.block_subscriptions_queue,
        consensus_parameters: &chain_config.consensus_parameters,
    };
    let graphql_worker =
        fuel_core_graphql_api::worker_service::new_service(graphql_worker_context)?;

    let graphql_block_height_subscription_handle = graphql_worker.shared.clone();

    let graphql_config = GraphQLConfig {
        config: config.graphql_config.clone(),
        utxo_validation: config.utxo_validation,
        debug: config.debug,
        historical_execution: config.historical_execution,
        allow_syscall: config.allow_syscall,
        expensive_subscriptions: config.expensive_subscriptions,
        max_tx: config.txpool.pool_limits.max_txs,
        max_gas: config.txpool.pool_limits.max_gas,
        max_size: config.txpool.pool_limits.max_bytes_size,
        max_txpool_dependency_chain_length: config.txpool.max_txs_chain_count,
        chain_name,
    };

    #[cfg(feature = "rpc")]
    let block_aggregator_rpc = if let Some(config) = config.rpc_config.as_ref() {
        Some(init_rpc_server(
            config,
            &database,
            &importer_adapter,
            genesis_block_height,
        )?)
    } else {
        None
    };

    let graph_ql = fuel_core_graphql_api::api_service::new_service(
        *genesis_block.header().height(),
        graphql_config,
        schema,
        database.on_chain().clone(),
        database.off_chain().clone(),
        Box::new(tx_pool_adapter),
        Box::new(tx_status_manager_adapter.clone()),
        Box::new(producer_adapter),
        Box::new(poa_adapter.clone()),
        Box::new(p2p_adapter),
        Box::new(universal_gas_price_provider),
        Box::new(chain_state_info_provider),
        SharedMemoryPool::new(config.memory_pool_size),
        graphql_block_height_subscription_handle,
        Box::new(compression_service_adapter),
    )?;

    let shared = SharedState {
        poa_adapter,
        txpool_shared_state: txpool.shared.clone(),
        #[cfg(feature = "p2p")]
        network: network.as_ref().map(|n| n.shared.clone()),
        #[cfg(feature = "relayer")]
        relayer: relayer_service.as_ref().map(|r| r.shared.clone()),
        graph_ql: graph_ql.shared.clone(),
        database,
        block_importer: importer_adapter,
        executor,
        config: config.clone(),
        tx_status_manager: tx_status_manager_adapter,
        compression: compression_service.as_ref().map(|c| c.shared.clone()),
        gas_price_service: gas_price_service_v1.shared.clone(),
        #[cfg(feature = "rpc")]
        block_aggregator_rpc: block_aggregator_rpc.as_ref().map(|s| s.shared.clone()),
    };

    #[allow(unused_mut)]
    // `FuelService` starts and shutdowns all sub-services in the `services` order
    let mut services: SubServices = vec![
        Box::new(gas_price_service_v1),
        Box::new(txpool),
        Box::new(chain_state_info_provider_service),
    ];

    #[cfg(feature = "relayer")]
    if let Some(relayer) = relayer_service {
        services.push(Box::new(relayer));
    }

    #[cfg(feature = "p2p")]
    {
        if let Some(network) = network.take() {
            services.push(Box::new(network));
            services.push(Box::new(sync));
            if let Some(pre_confirmation_service) = pre_confirmation_service {
                services.push(Box::new(pre_confirmation_service));
            }
        }
    }
    #[cfg(feature = "shared-sequencer")]
    services.push(Box::new(shared_sequencer));

    services.push(Box::new(graph_ql));
    services.push(Box::new(graphql_worker));
    services.push(Box::new(tx_status_manager));
    #[cfg(feature = "rpc")]
    if let Some(block_aggregator_rpc) = block_aggregator_rpc {
        services.push(Box::new(block_aggregator_rpc));
    }

    if let Some(compression_service) = compression_service {
        services.push(Box::new(compression_service));
    }

    // always make sure that the block producer is inserted last
    if let Some(poa) = poa {
        services.push(Box::new(poa));
    }

    Ok((services, shared))
}

#[allow(clippy::type_complexity)]
#[cfg(feature = "rpc")]
fn init_rpc_server(
    config: &fuel_core_block_aggregator_api::service::Config,
    database: &CombinedDatabase,
    importer_adapter: &BlockImporterAdapter,
    genesis_height: BlockHeight,
) -> anyhow::Result<
    ServiceRunner<
        UninitializedTask<
            OldBlocksSource<ProtobufBlockConverter, Database<OnChain>, ReceiptSource>,
            Database<BlockAggregatorDatabase>,
            Database<BlockAggregatorDatabase>,
        >,
    >,
> {
    let receipts = ReceiptSource::new(database.off_chain().clone());
    let serializer = ProtobufBlockConverter;
    let onchain_db = database.on_chain().clone();
    let importer = importer_adapter.events_shared_result();
    fuel_core_block_aggregator_api::service::new_service(
        database.block_aggregation_storage().clone(),
        serializer,
        onchain_db,
        receipts,
        importer,
        config.clone(),
        genesis_height,
    )
}