Struct ConsumerInitializationParameters

pub struct ConsumerInitializationParameters {
    pub initial_height: Option<Height>,
    pub genesis_hash: Vec<u8>,
    pub binary_hash: Vec<u8>,
    pub spawn_time: Option<Timestamp>,
    pub unbonding_period: Option<Duration>,
    pub ccv_timeout_period: Option<Duration>,
    pub transfer_timeout_period: Option<Duration>,
    pub consumer_redistribution_fraction: String,
    pub blocks_per_distribution_transmission: i64,
    pub historical_entries: i64,
    pub distribution_transmission_channel: String,
}

ConsumerInitializationParameters are the parameters needed to launch a chain

---

Following fields are used when the consumer chain launches and are not needed by the provider afterwards.

---

Fields

initial_height: Option<Height>

the proposed initial height of new consumer chain. For a completely new chain, this will be {0,1}. However, it may be different if this is a chain that is converting to a consumer chain.

genesis_hash: Vec<u8>

The hash of the consumer chain genesis state without the consumer CCV module genesis params. It is used for off-chain confirmation of genesis.json validity by validators and other parties.

binary_hash: Vec<u8>

The hash of the consumer chain binary that should be run by validators on chain initialization. It is used for off-chain confirmation of binary validity by validators and other parties.

spawn_time: Option<Timestamp>

spawn time is the time on the provider chain at which the consumer chain genesis is finalized and all validators will be responsible for starting their consumer chain validator node.

unbonding_period: Option<Duration>

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

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%.

blocks_per_distribution_transmission: i64

BlocksPerDistributionTransmission is the number of blocks between ibc-token-transfers from the consumer chain to the provider chain. On sending transmission event, consumer_redistribution_fraction of the accumulated tokens are sent to the consumer redistribution address.

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.

distribution_transmission_channel: String

The ID of a token transfer channel used for the Reward Distribution sub-protocol. If DistributionTransmissionChannel == “”, a new transfer channel is created on top of the same connection as the CCV channel. Note that transfer_channel_id is the ID of the channel end on the consumer chain. it is most relevant for chains performing a sovereign to consumer changeover in order to maintain the existing ibc transfer channel

Trait Implementations

impl Clone for ConsumerInitializationParameters

fn clone(&self) -> ConsumerInitializationParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConsumerInitializationParameters

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

Formats the value using the given formatter.

impl Default for ConsumerInitializationParameters

fn default() -> Self

Returns the “default value” for a type.

impl Message for ConsumerInitializationParameters

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

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

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

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

impl Name for ConsumerInitializationParameters

const NAME: &'static str = "ConsumerInitializationParameters"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "interchain_security.ccv.provider.v1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for ConsumerInitializationParameters

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