Struct ibc_proto::interchain_security::ccv::v1::ConsumerParams

pub struct ConsumerParams {
    pub enabled: bool,
    pub blocks_per_distribution_transmission: i64,
    pub distribution_transmission_channel: String,
    pub provider_fee_pool_addr_str: String,
    pub ccv_timeout_period: Option<Duration>,
    pub transfer_timeout_period: Option<Duration>,
    pub consumer_redistribution_fraction: String,
    pub historical_entries: i64,
    pub unbonding_period: Option<Duration>,
    pub soft_opt_out_threshold: String,
    pub reward_denoms: Vec<String>,
    pub provider_reward_denoms: Vec<String>,
}

ConsumerParams defines the parameters for CCV consumer module.

Note this type is referenced in both the consumer and provider CCV modules, and persisted on the provider, see MakeConsumerGenesis and SetConsumerGenesis.

Fields

enabled: bool

TODO: Remove enabled flag and find a better way to setup integration tests See: https://github.com/cosmos/interchain-security/issues/339

blocks_per_distribution_transmission: i64

///////////////////// Distribution Params Number of blocks between ibc-token-transfers from the consumer chain to the provider chain. Note that at this transmission event a fraction of the accumulated tokens are divided and sent consumer redistribution address.

distribution_transmission_channel: String

Channel, and provider-chain receiving address to send distribution token transfers over. These parameters is auto-set during the consumer <-> provider handshake procedure.

provider_fee_pool_addr_str: String

ccv_timeout_period: Option<Duration>

Sent CCV related IBC packets will timeout after this duration

transfer_timeout_period: Option<Duration>

Sent transfer related IBC packets will timeout after this duration

consumer_redistribution_fraction: String

The fraction of tokens allocated to the consumer redistribution address during distribution events. The fraction is a string representing a decimal number. For example “0.75” would represent 75%.

historical_entries: i64

The number of historical info entries to persist in store. This param is a part of the cosmos sdk staking module. In the case of a ccv enabled consumer chain, the ccv module acts as the staking module.

unbonding_period: Option<Duration>

Unbonding period for the consumer, which should be smaller than that of the provider in general.

soft_opt_out_threshold: String

The threshold for the percentage of validators at the bottom of the set who can opt out of running the consumer chain without being punished. For example, a value of 0.05 means that the validators in the bottom 5% of the set can opt out

reward_denoms: Vec<String>

Reward denoms. These are the denominations which are allowed to be sent to the provider as rewards.

provider_reward_denoms: Vec<String>

Provider-originated reward denoms. These are denoms coming from the provider which are allowed to be used as rewards. e.g. “uatom”

Trait Implementations

impl Clone for ConsumerParams

fn clone(&self) -> ConsumerParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConsumerParams

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

Formats the value using the given formatter.

impl Default for ConsumerParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for ConsumerParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ConsumerParams

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ConsumerParams