Struct Meta

pub struct Meta {
    pub cfg: MetaConfig,
    pub our_peer_id: PeerId,
    pub num_peers: NumPeers,
}

Meta module

Fields

cfg: MetaConfig

our_peer_id: PeerId

num_peers: NumPeers

Implementations

impl Meta

pub(crate) async fn get_desired( dbtx: &mut DatabaseTransaction<'_>, ) -> Vec<(MetaKey, MetaDesiredValue)>

pub(crate) async fn get_submission( dbtx: &mut DatabaseTransaction<'_>, key: MetaKey, peer_id: PeerId, ) -> Option<MetaSubmissionValue>

pub(crate) async fn get_consensus( dbtx: &mut DatabaseTransaction<'_>, key: MetaKey, ) -> Option<MetaValue>

pub(crate) async fn change_consensus( dbtx: &mut DatabaseTransaction<'_, NonCommittable>, key: MetaKey, value: MetaValue, matching_submissions: Vec<PeerId>, )

impl Meta

pub(crate) async fn handle_submit_request( &self, dbtx: &mut DatabaseTransaction<'_, Committable>, _auth: &ApiAuth, req: &SubmitRequest, ) -> Result<(), ApiError>

pub(crate) async fn handle_get_consensus_request( &self, dbtx: &mut DatabaseTransaction<'_, NonCommittable>, req: &GetConsensusRequest, ) -> Result<Option<MetaConsensusValue>, ApiError>

pub(crate) async fn handle_get_consensus_revision_request( &self, dbtx: &mut DatabaseTransaction<'_, NonCommittable>, req: &GetConsensusRequest, ) -> Result<Option<u64>, ApiError>

pub(crate) async fn handle_get_submissions_request( &self, dbtx: &mut DatabaseTransaction<'_, NonCommittable>, _auth: &ApiAuth, req: &GetSubmissionsRequest, ) -> Result<BTreeMap<PeerId, MetaValue>, ApiError>

Trait Implementations

impl Debug for Meta

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ServerModule for Meta

Implementation of consensus for the server module

type Common = MetaModuleTypes

Define the consensus types

fn consensus_proposal<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, dbtx: &'life1 mut DatabaseTransaction<'life2>, ) -> Pin<Box<dyn Future<Output = Vec<MetaConsensusItem>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Check the difference between what’s desired vs submitted and consensus.

Returns: Items to submit as our proposal.

fn process_consensus_item<'a, 'b, 'life0, 'async_trait>( &'a self, dbtx: &'life0 mut DatabaseTransaction<'b>, __arg2: MetaConsensusItem, peer_id: PeerId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'b: 'async_trait, 'life0: 'async_trait,

BUG: This implementation fails to return an Err on redundant consensus items. If you are using this code as a template, make sure to read the ServerModule::process_consensus_item documentation,

type Init = MetaInit

fn process_input<'a, 'b, 'c, 'life0, 'async_trait>( &'a self, _dbtx: &'life0 mut DatabaseTransaction<'c>, _input: &'b MetaInput, ) -> Pin<Box<dyn Future<Output = Result<InputMeta, MetaInputError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'b: 'async_trait, 'c: 'async_trait, 'life0: 'async_trait,

Try to spend a transaction input. On success all necessary updates will be part of the database transaction. On failure (e.g. double spend) the database transaction is rolled back and the operation will take no effect.

fn process_output<'a, 'b, 'life0, 'async_trait>( &'a self, _dbtx: &'life0 mut DatabaseTransaction<'b>, _output: &'a MetaOutput, _out_point: OutPoint, ) -> Pin<Box<dyn Future<Output = Result<TransactionItemAmount, MetaOutputError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'b: 'async_trait, 'life0: 'async_trait,

Try to create an output (e.g. issue notes, peg-out BTC, …). On success all necessary updates to the database will be part of the database transaction. On failure (e.g. double spend) the database transaction is rolled back and the operation will take no effect.

fn output_status<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, _out_point: OutPoint, ) -> Pin<Box<dyn Future<Output = Option<MetaOutputOutcome>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Retrieve the current status of the output. Depending on the module this might contain data needed by the client to access funds or give an estimate of when funds will be available. Returns None if the output is unknown, NOT if it is just not ready yet.

fn audit<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, _audit: &'life3 mut Audit, _module_instance_id: ModuleInstanceId, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Queries the database and returns all assets and liabilities of the module.

fn api_endpoints(&self) -> Vec<ApiEndpoint<Self>>

Returns a list of custom API endpoints defined by the module. These are made available both to users as well as to other modules. They thus should be deterministic, only dependant on their input and the current epoch.

fn module_kind() -> ModuleKind

fn decoder() -> Decoder

Returns a decoder for the following associated types of this module:

fn verify_input( &self, _input: &<Self::Common as ModuleCommon>::Input, ) -> Result<(), <Self::Common as ModuleCommon>::InputError>