Struct GlobalClientConfig

pub struct GlobalClientConfig {
    pub api_endpoints: BTreeMap<PeerId, PeerUrl>,
    pub broadcast_public_keys: Option<BTreeMap<PeerId, PublicKey>>,
    pub consensus_version: CoreConsensusVersion,
    pub meta: BTreeMap<String, String>,
}

Federation-wide client config

Fields

api_endpoints: BTreeMap<PeerId, PeerUrl>

API endpoints for each federation member

broadcast_public_keys: Option<BTreeMap<PeerId, PublicKey>>

Signing session keys for each federation member Optional for 0.3.x backwards compatibility

consensus_version: CoreConsensusVersion

Core consensus version

meta: BTreeMap<String, String>

Additional config the federation wants to transmit to the clients

Implementations

impl GlobalClientConfig

pub fn calculate_federation_id(&self) -> FederationId

0.4.0 and later uses a hash of broadcast public keys to calculate the federation id. 0.3.x and earlier use a hash of api endpoints

pub fn federation_name(&self) -> Option<&str>

Federation name from config metadata (if set)

Trait Implementations

impl Clone for GlobalClientConfig

fn clone(&self) -> GlobalClientConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalClientConfig

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

Formats the value using the given formatter.

impl Decodable for GlobalClientConfig

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object with a well-defined format.

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

Decode an object from hex

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

impl<'de> Deserialize<'de> for GlobalClientConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for GlobalClientConfig

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

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::Engine: Write,

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

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl PartialEq for GlobalClientConfig

fn eq(&self, other: &GlobalClientConfig) -> 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 GlobalClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GlobalClientConfig

impl StructuralPartialEq for GlobalClientConfig