Struct forest_filecoin::message_pool::msgpool::msg_pool::MessagePool
source · pub struct MessagePool<T> {Show 13 fields
local_addrs: Arc<RwLock<Vec<Address>>>,
pub pending: Arc<RwLock<HashMap<Address, MsgSet>>>,
pub cur_tipset: Arc<Mutex<Arc<Tipset>>>,
pub api: Arc<T>,
pub network_name: String,
pub network_sender: Sender<NetworkMessage>,
pub bls_sig_cache: Arc<Mutex<LruCache<Cid, Signature>>>,
pub sig_val_cache: Arc<Mutex<LruCache<Cid, ()>>>,
pub republished: Arc<RwLock<HashSet<Cid>>>,
pub repub_trigger: Sender<()>,
local_msgs: Arc<RwLock<HashSet<SignedMessage>>>,
pub config: MpoolConfig,
pub chain_config: Arc<ChainConfig>,
}
Expand description
This contains all necessary information needed for the message pool. Keeps track of messages to apply, as well as context needed for verifying transactions.
Fields§
§local_addrs: Arc<RwLock<Vec<Address>>>
The local address of the client
pending: Arc<RwLock<HashMap<Address, MsgSet>>>
A map of pending messages where the key is the address
cur_tipset: Arc<Mutex<Arc<Tipset>>>
The current tipset (a set of blocks)
api: Arc<T>
The underlying provider
network_name: String
§network_sender: Sender<NetworkMessage>
Sender half to send messages to other components
bls_sig_cache: Arc<Mutex<LruCache<Cid, Signature>>>
A cache for BLS signature keyed by Cid
sig_val_cache: Arc<Mutex<LruCache<Cid, ()>>>
A cache for BLS signature keyed by Cid
republished: Arc<RwLock<HashSet<Cid>>>
A set of republished messages identified by their Cid
repub_trigger: Sender<()>
Acts as a signal to republish messages from the republished set of messages
local_msgs: Arc<RwLock<HashSet<SignedMessage>>>
§config: MpoolConfig
Configurable parameters of the message pool
chain_config: Arc<ChainConfig>
Chain configuration
Implementations§
source§impl<T> MessagePool<T>where
T: Provider,
impl<T> MessagePool<T>where
T: Provider,
sourcefn add_local(&self, m: SignedMessage) -> Result<(), Error>
fn add_local(&self, m: SignedMessage) -> Result<(), Error>
Add a signed message to the pool and its address.
sourcepub async fn push(&self, msg: SignedMessage) -> Result<Cid, Error>
pub async fn push(&self, msg: SignedMessage) -> Result<Cid, Error>
Push a signed message to the MessagePool
. Additionally performs basic
checks on the validity of a message.
fn check_message(&self, msg: &SignedMessage) -> Result<(), Error>
sourcepub fn add(&self, msg: SignedMessage) -> Result<(), Error>
pub fn add(&self, msg: SignedMessage) -> Result<(), Error>
This is a helper to push that will help to make sure that the message
fits the parameters to be pushed to the MessagePool
.
sourcefn verify_msg_sig(&self, msg: &SignedMessage) -> Result<(), Error>
fn verify_msg_sig(&self, msg: &SignedMessage) -> Result<(), Error>
Verify the message signature. first check if it has already been verified and put into cache. If it has not, then manually verify it then put it into cache for future use.
sourcefn add_tipset(
&self,
msg: SignedMessage,
cur_ts: &Tipset,
local: bool,
) -> Result<bool, Error>
fn add_tipset( &self, msg: SignedMessage, cur_ts: &Tipset, local: bool, ) -> Result<bool, Error>
Verify the state_sequence
and balance for the sender of the message
given then call add_locked
to finish adding the signed_message
to pending.
sourcefn add_helper(&self, msg: SignedMessage) -> Result<(), Error>
fn add_helper(&self, msg: SignedMessage) -> Result<(), Error>
Finish verifying signed message before adding it to the pending mset
hash-map. If an entry in the hash-map does not yet exist, create a
new mset
that will correspond to the from message and push it to
the pending hash-map.
sourcepub fn get_sequence(&self, addr: &Address) -> Result<u64, Error>
pub fn get_sequence(&self, addr: &Address) -> Result<u64, Error>
Get the sequence for a given address, return Error if there is a failure to retrieve the respective sequence.
sourcefn get_state_sequence(
&self,
addr: &Address,
cur_ts: &Tipset,
) -> Result<u64, Error>
fn get_state_sequence( &self, addr: &Address, cur_ts: &Tipset, ) -> Result<u64, Error>
Get the state of the sequence for a given address in cur_ts
.
sourcefn get_state_balance(
&self,
addr: &Address,
ts: &Tipset,
) -> Result<TokenAmount, Error>
fn get_state_balance( &self, addr: &Address, ts: &Tipset, ) -> Result<TokenAmount, Error>
Get the state balance for the actor that corresponds to the supplied address and tipset, if this actor does not exist, return an error.
sourcepub fn pending(&self) -> Result<(Vec<SignedMessage>, Arc<Tipset>), Error>
pub fn pending(&self) -> Result<(Vec<SignedMessage>, Arc<Tipset>), Error>
Return a tuple that contains a vector of all signed messages and the current tipset for self.
sourcepub fn pending_for(&self, a: &Address) -> Option<Vec<SignedMessage>>
pub fn pending_for(&self, a: &Address) -> Option<Vec<SignedMessage>>
Return a Vector of signed messages for a given from address. This vector
will be sorted by each messsage
’s sequence. If no corresponding
messages found, return None result type.
sourcepub fn messages_for_blocks<'a>(
&self,
blks: impl Iterator<Item = &'a CachingBlockHeader>,
) -> Result<Vec<SignedMessage>, Error>
pub fn messages_for_blocks<'a>( &self, blks: impl Iterator<Item = &'a CachingBlockHeader>, ) -> Result<Vec<SignedMessage>, Error>
Return Vector of signed messages given a block header for self.
sourcepub fn load_local(&mut self) -> Result<(), Error>
pub fn load_local(&mut self) -> Result<(), Error>
Loads local messages to the message pool to be applied.
source§impl<T> MessagePool<T>
impl<T> MessagePool<T>
sourcepub fn new(
api: T,
network_name: String,
network_sender: Sender<NetworkMessage>,
config: MpoolConfig,
chain_config: Arc<ChainConfig>,
services: &mut JoinSet<Result<()>>,
) -> Result<MessagePool<T>, Error>where
T: Provider,
pub fn new(
api: T,
network_name: String,
network_sender: Sender<NetworkMessage>,
config: MpoolConfig,
chain_config: Arc<ChainConfig>,
services: &mut JoinSet<Result<()>>,
) -> Result<MessagePool<T>, Error>where
T: Provider,
Creates a new MessagePool
instance.
source§impl<T> MessagePool<T>where
T: Provider,
impl<T> MessagePool<T>where
T: Provider,
sourcepub fn select_messages(
&self,
ts: &Tipset,
tq: f64,
) -> Result<Vec<SignedMessage>, Error>
pub fn select_messages( &self, ts: &Tipset, tq: f64, ) -> Result<Vec<SignedMessage>, Error>
Forest employs a sophisticated algorithm for selecting messages for inclusion from the pool, given the ticket quality of a miner. This method selects messages for including in a block.
fn select_messages_greedy( &self, cur_ts: &Tipset, ts: &Tipset, ) -> Result<Vec<SignedMessage>, Error>
fn select_messages_optimal( &self, cur_ts: &Tipset, target_tipset: &Tipset, ticket_quality: f64, ) -> Result<Vec<SignedMessage>, Error>
fn get_pending_messages( &self, cur_ts: &Tipset, ts: &Tipset, ) -> Result<HashMap<Address, HashMap<u64, SignedMessage>>, Error>
fn select_priority_messages( &self, pending: &mut HashMap<Address, HashMap<u64, SignedMessage>>, base_fee: &TokenAmount, ts: &Tipset, ) -> Result<(Vec<SignedMessage>, u64), Error>
Auto Trait Implementations§
impl<T> Freeze for MessagePool<T>
impl<T> !RefUnwindSafe for MessagePool<T>
impl<T> Send for MessagePool<T>
impl<T> Sync for MessagePool<T>
impl<T> Unpin for MessagePool<T>
impl<T> !UnwindSafe for MessagePool<T>
Blanket Implementations§
source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> References<RawCodec> for T
impl<T> References<RawCodec> for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.