ibc-relayer-types 0.21.0

Implementation of the Inter-Blockchain Communication Protocol (IBC). This crate comprises the main data structures and on-chain logic.
Documentation
use ibc_proto::google::protobuf::Any;
use prost::{EncodeError, Message};

use crate::core::ics24_host::error::ValidationError;
use crate::prelude::*;

pub trait Msg: Clone {
    type ValidationError;
    type Raw: From<Self> + Message;

    // TODO: Clarify what is this function supposed to do & its connection to ICS26 routing mod.
    fn route(&self) -> String;

    /// Unique type identifier for this message, to support encoding to/from `prost_types::Any`.
    fn type_url(&self) -> String;

    #[allow(clippy::wrong_self_convention)]
    fn to_any(self) -> Any {
        Any {
            type_url: self.type_url(),
            value: self.get_sign_bytes(),
        }
    }

    fn get_sign_bytes(self) -> Vec<u8> {
        let raw_msg: Self::Raw = self.into();
        encode_message(&raw_msg).unwrap_or_else(|e| {
            // Severe error that cannot be recovered.
            panic!(
                "Cannot encode the proto message {:?} into a buffer due to underlying error: {}",
                raw_msg, e
            )
        })
    }

    fn validate_basic(&self) -> Result<(), ValidationError> {
        Ok(())
    }
}

pub fn encode_message<M: Message>(message: &M) -> Result<Vec<u8>, EncodeError> {
    let mut buf = Vec::new();
    Message::encode(message, &mut buf)?;
    Ok(buf)
}