IBC Primitives

这个库提供了在实现各种IBC模块时普遍使用的基本类型、特质和实用工具，包括核心功能、客户端和应用。

安装

在项目目录中运行以下Cargo命令：

cargo add ibc-primitives

或者在你的Cargo.toml中添加以下行：

ibc-primitives = "0.57.0"

使用示例

以下是使用ibc-primitives实现跨链通信基本功能的示例：

use ibc_primitives::{
    ClientId, ConnectionId, ChannelId, PortId, 
    Height, Timestamp, Sequence,
    ClientType, ConnectionEnd, ChannelEnd,
    ConsensusState, ClientState
};

// 创建客户端标识
let client_id = ClientId::new("07-tendermint".parse().unwrap(), 0).unwrap();

// 创建连接标识
let connection_id = ConnectionId::new(1);

// 创建通道标识
let channel_id = ChannelId::new(0);

// 创建端口标识
let port_id = PortId::transfer();

// 创建高度(区块高度)
let height = Height::new(0, 1).unwrap();

// 创建时间戳
let timestamp = Timestamp::now();

// 创建序列号
let sequence = Sequence::from(1);

// 定义客户端类型
let client_type = ClientType::new("07-tendermint".to_string());

// 创建连接端
let connection_end = ConnectionEnd::new(
    ibc::core::ics03_connection::connection::State::Open,
    client_id.clone(),
    ConnectionId::new(1),
    Counterparty::new(
        client_id.clone(),
        Some(ConnectionId::new(1)),
        Some(PortId::transfer()),
    ),
    Version::default(),
    ZERO_DURATION,
);

// 创建通道端
let channel_end = ChannelEnd::new(
    ibc::core::ics04_channel::channel::State::Open,
    *channel_id.order(),
    PortId::transfer(),
    Counterparty::new(PortId::transfer(), Some(ChannelId::new(0))),
    vec![ConnectionId::new(1)],
    Version::default(),
);

// 定义共识状态
let consensus_state = ConsensusState::new(
    vec![0; 32].into(),
    Timestamp::now(),
    vec![0; 32].into(),
    Height::new(0, 1).unwrap(),
);

// 定义客户端状态
let client_state = ClientState::new(
    client_type,
    Height::new(0, 1).unwrap(),
    Duration::new(60, 0),
    Duration::new(120, 0),
    Duration::new(10, 0),
    Height::new(0, 1).unwrap(),
    vec![0; 32].into(),
    vec![String::from("cosmos")],
    true,
);

完整示例demo

下面是一个完整的IBC Primitives使用示例，展示了如何创建客户端、连接和通道：

use ibc_primitives::{
    ClientId, ConnectionId, ChannelId, PortId,
    Height, Timestamp, Sequence,
    ClientType, ConnectionEnd, ChannelEnd,
    ConsensusState, ClientState,
    Counterparty, Version
};
use std::time::Duration;

fn main() {
    // 1. 创建客户端相关数据
    let client_type_str = "07-tendermint";
    let client_type = ClientType::new(client_type_str.to_string());
    let client_id = ClientId::new(client_type_str.parse().unwrap(), 0).unwrap();
    
    // 2. 创建共识状态
    let consensus_height = Height::new(0, 1).unwrap();
    let consensus_state = ConsensusState::new(
        vec![0; 32].into(),  // 根哈希
        Timestamp::now(),    // 时间戳
        vec![0; 32].into(),  // 下一个验证人集合哈希
        consensus_height     // 高度
    );
    
    // 3. 创建客户端状态
    let client_state = ClientState::new(
        client_type.clone(),
        Height::new(0, 1).unwrap(),
        Duration::new(60, 0),   // 信任期
        Duration::new(120, 0),  // 解冻期
        Duration::new(10, 0),   // 升级期
        Height::new(0, 1).unwrap(),
        vec![0; 32].into(),     // 最新高度证明
        vec![String::from("cosmos")],  // 允许的升级路径
        true                   // 是否允许更新
    );
    
    // 4. 创建连接端
    let connection_id = ConnectionId::new(1);
    let connection_end = ConnectionEnd::new(
        ibc::core::ics03_connection::connection::State::Open,
        client_id.clone(),
        connection_id.clone(),
        Counterparty::new(
            client_id.clone(),
            Some(ConnectionId::new(1)),
            Some(PortId::transfer()),
        ),
        Version::default(),
        Duration::ZERO,
    );
    
    // 5. 创建通道端
    let channel_id = ChannelId::new(0);
    let channel_end = ChannelEnd::new(
        ibc::core::ics04_channel::channel::State::Open,
        *channel_id.order(),
        PortId::transfer(),
        Counterparty::new(
            PortId::transfer(), 
            Some(ChannelId::new(0))
        ),
        vec![connection_id],
        Version::default(),
    );
    
    println!("成功创建IBC基本组件:");
    println!("- 客户端ID: {}", client_id);
    println!("- 连接ID: {}", connection_id);
    println!("- 通道ID: {}", channel_id);
    println!("- 客户端状态: {:?}", client_state);
    println!("- 共识状态: {:?}", consensus_state);
}

核心数据结构

ibc-primitives提供了以下主要数据结构：

1. 标识符类型:

   • ClientId - 客户端唯一标识符
   • ConnectionId - 连接唯一标识符
   • ChannelId - 通道唯一标识符
   • PortId - 端口标识符

2. 基本类型:

   • Height - 表示区块链高度(epoch和版本号)
   • Timestamp - 时间戳
   • Sequence - 序列号用于排序

3. 状态类型:

   • ClientState - 客户端状态
   • ConsensusState - 共识状态
   • ConnectionEnd - 连接端状态
   • ChannelEnd - 通道端状态

文档

更多详细使用说明请参考官方文档。