Struct WalletConfigConsensus

pub struct WalletConfigConsensus {
    pub network: Network,
    pub peg_in_descriptor: Descriptor<CompressedPublicKey>,
    pub peer_peg_in_keys: BTreeMap<PeerId, CompressedPublicKey>,
    pub finality_delay: u32,
    pub default_fee: Feerate,
    pub fee_consensus: FeeConsensus,
    pub client_default_bitcoin_rpc: BitcoinRpcConfig,
}

Fields

network: Network

Bitcoin network (e.g. testnet, bitcoin)

peg_in_descriptor: Descriptor<CompressedPublicKey>

The federations public peg-in-descriptor

peer_peg_in_keys: BTreeMap<PeerId, CompressedPublicKey>

The public keys for the bitcoin multisig

finality_delay: u32

How many bitcoin blocks to wait before considering a transaction confirmed

default_fee: Feerate

If we cannot determine the feerate from our bitcoin node, default to this

fee_consensus: FeeConsensus

Fees for bitcoin transactions

client_default_bitcoin_rpc: BitcoinRpcConfig

Points to a Bitcoin API that the client can use to interact with the Bitcoin blockchain (mostly for deposits). Eventually the backend should become configurable locally and this should merely be a suggested default by the federation.

This is only used by the client, the RPC used by the server is defined in WalletConfigLocal.

Trait Implementations

impl Clone for WalletConfigConsensus

fn clone(&self) -> WalletConfigConsensus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WalletConfigConsensus

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

Formats the value using the given formatter.

impl Decodable for WalletConfigConsensus

fn consensus_decode_from_finite_reader<D>( d: &mut D, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<WalletConfigConsensus, DecodeError>

where D: Read,

Decode Self from a size-limited reader.

fn consensus_decode<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl<'de> Deserialize<'de> for WalletConfigConsensus

fn deserialize<__D>( __deserializer: __D, ) -> Result<WalletConfigConsensus, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for WalletConfigConsensus

fn consensus_encode<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl Serialize for WalletConfigConsensus

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypedServerModuleConsensusConfig for WalletConfigConsensus

fn kind(&self) -> ModuleKind

fn version(&self) -> ModuleConsensusVersion

fn from_erased(erased: &ServerModuleConsensusConfig) -> Result<Self, Error>