Struct WalletClientConfig

pub struct WalletClientConfig {
    pub peg_in_descriptor: Descriptor<CompressedPublicKey>,
    pub network: Network,
    pub finality_delay: u32,
    pub fee_consensus: FeeConsensus,
    pub default_bitcoin_rpc: BitcoinRpcConfig,
}

Fields

peg_in_descriptor: Descriptor<CompressedPublicKey>

The federations public peg-in-descriptor

network: Network

The bitcoin network the client will use

finality_delay: u32

Confirmations required for a peg in to be accepted by federation

fee_consensus: FeeConsensus

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.

Implementations

impl WalletClientConfig

pub fn new( peg_in_descriptor: Descriptor<CompressedPublicKey>, network: Network, finality_delay: u32, default_bitcoin_rpc: BitcoinRpcConfig, ) -> WalletClientConfig

Trait Implementations

impl Clone for WalletClientConfig

fn clone(&self) -> WalletClientConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalletClientConfig

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

Formats the value using the given formatter.

impl Decodable for WalletClientConfig

fn consensus_decode_from_finite_reader<D>( d: &mut D, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<WalletClientConfig, 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 WalletClientConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WalletClientConfig

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

Formats the value using the given formatter.

impl Encodable for WalletClientConfig

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 Hash for WalletClientConfig

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoDynInstance for WalletClientConfig

type DynType = DynClientConfig

The type erased version of the type implementing this trait

fn into_dyn( self, instance_id: u16, ) -> <WalletClientConfig as IntoDynInstance>::DynType

Convert self into its type-erased equivalent

impl PartialEq for WalletClientConfig

fn eq(&self, other: &WalletClientConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WalletClientConfig

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 ClientConfig for WalletClientConfig

impl Eq for WalletClientConfig

impl StructuralPartialEq for WalletClientConfig