forest/message_pool/msgpool/
provider.rs

1// Copyright 2019-2026 ChainSafe Systems
2// SPDX-License-Identifier: Apache-2.0, MIT
3
4use std::sync::Arc;
5
6use crate::blocks::{CachingBlockHeader, Tipset, TipsetKey};
7use crate::chain::HeadChange;
8use crate::message::{ChainMessage, SignedMessage};
9use crate::message_pool::msg_pool::{
10    MAX_ACTOR_PENDING_MESSAGES, MAX_UNTRUSTED_ACTOR_PENDING_MESSAGES,
11};
12use crate::networks::Height;
13use crate::shim::{
14    address::Address,
15    econ::TokenAmount,
16    message::Message,
17    state_tree::{ActorState, StateTree},
18};
19use crate::state_manager::StateManager;
20use crate::utils::db::CborStoreExt;
21use async_trait::async_trait;
22use cid::Cid;
23use fvm_ipld_blockstore::Blockstore;
24use tokio::sync::broadcast::{Receiver as Subscriber, Sender as Publisher};
25
26use crate::message_pool::errors::Error;
27
28/// Provider Trait. This trait will be used by the message pool to interact with
29/// some medium in order to do the operations that are listed below that are
30/// required for the message pool.
31#[async_trait]
32pub trait Provider {
33    /// Update `Mpool`'s `cur_tipset` whenever there is a change to the provider
34    fn subscribe_head_changes(&self) -> Subscriber<HeadChange>;
35    /// Get the heaviest Tipset in the provider
36    fn get_heaviest_tipset(&self) -> Tipset;
37    /// Add a message to the `MpoolProvider`, return either Cid or Error
38    /// depending on successful put
39    fn put_message(&self, msg: &ChainMessage) -> Result<Cid, Error>;
40    /// Return state actor for given address given the tipset that the a temp
41    /// `StateTree` will be rooted at. Return `ActorState` or Error
42    /// depending on whether or not `ActorState` is found
43    fn get_actor_after(&self, addr: &Address, ts: &Tipset) -> Result<ActorState, Error>;
44    /// Return the signed messages for given block header
45    fn messages_for_block(
46        &self,
47        h: &CachingBlockHeader,
48    ) -> Result<(Vec<Message>, Vec<SignedMessage>), Error>;
49    /// Return a tipset given the tipset keys from the `ChainStore`
50    fn load_tipset(&self, tsk: &TipsetKey) -> Result<Tipset, Error>;
51    /// Computes the base fee
52    fn chain_compute_base_fee(&self, ts: &Tipset) -> Result<TokenAmount, Error>;
53    // Get max number of messages per actor in the pool
54    fn max_actor_pending_messages(&self) -> u64 {
55        MAX_ACTOR_PENDING_MESSAGES
56    }
57    // Get max number of messages per actor in the pool for untrusted sources
58    fn max_untrusted_actor_pending_messages(&self) -> u64 {
59        MAX_UNTRUSTED_ACTOR_PENDING_MESSAGES
60    }
61}
62
63/// This is the default Provider implementation that will be used for the
64/// `mpool` RPC.
65#[derive(derive_more::Constructor)]
66pub struct MpoolRpcProvider<DB> {
67    subscriber: Publisher<HeadChange>,
68    sm: Arc<StateManager<DB>>,
69}
70
71#[async_trait]
72impl<DB> Provider for MpoolRpcProvider<DB>
73where
74    DB: Blockstore + Sync + Send + 'static,
75{
76    fn subscribe_head_changes(&self) -> Subscriber<HeadChange> {
77        self.subscriber.subscribe()
78    }
79
80    fn get_heaviest_tipset(&self) -> Tipset {
81        self.sm.chain_store().heaviest_tipset()
82    }
83
84    fn put_message(&self, msg: &ChainMessage) -> Result<Cid, Error> {
85        let cid = self
86            .sm
87            .blockstore()
88            .put_cbor_default(msg)
89            .map_err(|err| Error::Other(err.to_string()))?;
90        Ok(cid)
91    }
92
93    fn get_actor_after(&self, addr: &Address, ts: &Tipset) -> Result<ActorState, Error> {
94        let state = StateTree::new_from_root(self.sm.blockstore_owned(), ts.parent_state())
95            .map_err(|e| Error::Other(e.to_string()))?;
96        Ok(state.get_required_actor(addr)?)
97    }
98
99    fn messages_for_block(
100        &self,
101        h: &CachingBlockHeader,
102    ) -> Result<(Vec<Message>, Vec<SignedMessage>), Error> {
103        crate::chain::block_messages(self.sm.blockstore(), h).map_err(|err| err.into())
104    }
105
106    fn load_tipset(&self, tsk: &TipsetKey) -> Result<Tipset, Error> {
107        Ok(self
108            .sm
109            .chain_store()
110            .chain_index()
111            .load_required_tipset(tsk)?)
112    }
113
114    fn chain_compute_base_fee(&self, ts: &Tipset) -> Result<TokenAmount, Error> {
115        let smoke_height = self.sm.chain_config().epoch(Height::Smoke);
116        crate::chain::compute_base_fee(self.sm.blockstore(), ts, smoke_height)
117            .map_err(|err| err.into())
118    }
119}
forest/message_pool/msgpool/provider.rs

forest/message_pool/msgpool/
provider.rs
