ibc-core-handler 0.57.0

Maintained by `ibc-rs`, exposes IBC handler entry points for an integrated IBC core modules. These entry points are responsible for processing incoming IBC messages, performing validation, and execution logic by invoking the appropriate module handler.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

use ibc_core_channel::handler::{
    acknowledgement_packet_execute, acknowledgement_packet_validate, chan_close_confirm_execute,
    chan_close_confirm_validate, chan_close_init_execute, chan_close_init_validate,
    chan_open_ack_execute, chan_open_ack_validate, chan_open_confirm_execute,
    chan_open_confirm_validate, chan_open_init_execute, chan_open_init_validate,
    chan_open_try_execute, chan_open_try_validate, recv_packet_execute, recv_packet_validate,
    timeout_packet_execute, timeout_packet_validate, TimeoutMsgType,
};
use ibc_core_channel::types::msgs::{
    channel_msg_to_port_id, packet_msg_to_port_id, ChannelMsg, PacketMsg,
};
use ibc_core_client::context::{ClientExecutionContext, ClientValidationContext};
use ibc_core_client::handler::{create_client, update_client, upgrade_client};
use ibc_core_client::types::error::ClientError;
use ibc_core_client::types::msgs::{ClientMsg, MsgUpdateOrMisbehaviour};
use ibc_core_connection::handler::{
    conn_open_ack, conn_open_confirm, conn_open_init, conn_open_try,
};
use ibc_core_connection::types::msgs::ConnectionMsg;
use ibc_core_handler_types::error::HandlerError;
use ibc_core_handler_types::msgs::MsgEnvelope;
use ibc_core_host::types::error::HostError;
use ibc_core_host::{ExecutionContext, ValidationContext};
use ibc_core_router::router::Router;
use ibc_core_router::types::error::RouterError;
use ibc_primitives::prelude::*;
use ibc_primitives::proto::Any;

/// Entrypoint which performs both validation and message execution
pub fn dispatch<Ctx>(
    ctx: &mut Ctx,
    router: &mut impl Router,
    msg: MsgEnvelope,
) -> Result<(), HandlerError>
where
    Ctx: ExecutionContext,
    <<Ctx::V as ClientValidationContext>::ClientStateRef as TryFrom<Any>>::Error: Into<ClientError>,
    <<Ctx::E as ClientExecutionContext>::ClientStateMut as TryFrom<Any>>::Error: Into<ClientError>,
    <Ctx::HostClientState as TryFrom<Any>>::Error: Into<ClientError>,
{
    validate(ctx, router, msg.clone())?;
    execute(ctx, router, msg)
}

/// Entrypoint which only performs message validation
///
/// If a transaction contains `n` messages `m_1` ... `m_n`, then
/// they MUST be processed as follows:
///     validate(m_1), execute(m_1), ..., validate(m_n), execute(m_n)
/// That is, the state transition of message `i` must be applied before
/// message `i+1` is validated. This is equivalent to calling
/// `dispatch()` on each successively.
pub fn validate<Ctx>(ctx: &Ctx, router: &impl Router, msg: MsgEnvelope) -> Result<(), HandlerError>
where
    Ctx: ValidationContext,
    <<Ctx::V as ClientValidationContext>::ClientStateRef as TryFrom<Any>>::Error: Into<ClientError>,
    <Ctx::HostClientState as TryFrom<Any>>::Error: Into<ClientError>,
{
    match msg {
        MsgEnvelope::Client(msg) => match msg {
            ClientMsg::CreateClient(msg) => create_client::validate(ctx, msg)?,
            ClientMsg::UpdateClient(msg) => {
                update_client::validate(ctx, MsgUpdateOrMisbehaviour::UpdateClient(msg))?
            }
            ClientMsg::Misbehaviour(msg) => {
                update_client::validate(ctx, MsgUpdateOrMisbehaviour::Misbehaviour(msg))?
            }
            ClientMsg::UpgradeClient(msg) => upgrade_client::validate(ctx, msg)?,
            ClientMsg::RecoverClient(_msg) => {
                // Recover client messages are not dispatched by ibc-rs as they can only be
                // authorized via a passing governance proposal
            }
        },
        MsgEnvelope::Connection(msg) => match msg {
            ConnectionMsg::OpenInit(msg) => conn_open_init::validate(ctx, msg)?,
            ConnectionMsg::OpenTry(msg) => conn_open_try::validate(ctx, msg)?,
            ConnectionMsg::OpenAck(msg) => conn_open_ack::validate(ctx, msg)?,
            ConnectionMsg::OpenConfirm(msg) => conn_open_confirm::validate(ctx, &msg)?,
        },
        MsgEnvelope::Channel(msg) => {
            let port_id = channel_msg_to_port_id(&msg);
            let module_id = router.lookup_module(port_id).ok_or(RouterError::Host(
                HostError::missing_state(format!("missing module ID for port {}", port_id.clone())),
            ))?;
            let module = router
                .get_route(&module_id)
                .ok_or(RouterError::MissingModule)?;

            match msg {
                ChannelMsg::OpenInit(msg) => chan_open_init_validate(ctx, module, msg)?,
                ChannelMsg::OpenTry(msg) => chan_open_try_validate(ctx, module, msg)?,
                ChannelMsg::OpenAck(msg) => chan_open_ack_validate(ctx, module, msg)?,
                ChannelMsg::OpenConfirm(msg) => chan_open_confirm_validate(ctx, module, msg)?,
                ChannelMsg::CloseInit(msg) => chan_close_init_validate(ctx, module, msg)?,
                ChannelMsg::CloseConfirm(msg) => chan_close_confirm_validate(ctx, module, msg)?,
            }
        }
        MsgEnvelope::Packet(msg) => {
            let port_id = packet_msg_to_port_id(&msg);
            let module_id = router.lookup_module(port_id).ok_or(RouterError::Host(
                HostError::missing_state(format!("missing module ID for port {}", port_id.clone())),
            ))?;
            let module = router
                .get_route(&module_id)
                .ok_or(RouterError::MissingModule)?;

            match msg {
                PacketMsg::Recv(msg) => recv_packet_validate(ctx, msg)?,
                PacketMsg::Ack(msg) => acknowledgement_packet_validate(ctx, module, msg)?,
                PacketMsg::Timeout(msg) => {
                    timeout_packet_validate(ctx, module, TimeoutMsgType::Timeout(msg))?
                }
                PacketMsg::TimeoutOnClose(msg) => {
                    timeout_packet_validate(ctx, module, TimeoutMsgType::TimeoutOnClose(msg))?
                }
            }
        }
    };

    Ok(())
}

/// Entrypoint which only performs message execution
pub fn execute<Ctx>(
    ctx: &mut Ctx,
    router: &mut impl Router,
    msg: MsgEnvelope,
) -> Result<(), HandlerError>
where
    Ctx: ExecutionContext,
    <<Ctx::E as ClientExecutionContext>::ClientStateMut as TryFrom<Any>>::Error: Into<ClientError>,
{
    match msg {
        MsgEnvelope::Client(msg) => match msg {
            ClientMsg::CreateClient(msg) => create_client::execute(ctx, msg)?,
            ClientMsg::UpdateClient(msg) => {
                update_client::execute(ctx, MsgUpdateOrMisbehaviour::UpdateClient(msg))?
            }
            ClientMsg::Misbehaviour(msg) => {
                update_client::execute(ctx, MsgUpdateOrMisbehaviour::Misbehaviour(msg))?
            }
            ClientMsg::UpgradeClient(msg) => upgrade_client::execute(ctx, msg)?,
            ClientMsg::RecoverClient(_msg) => {
                // Recover client messages are not dispatched by ibc-rs as they can only be
                // authorized via a passing governance proposal
            }
        },
        MsgEnvelope::Connection(msg) => match msg {
            ConnectionMsg::OpenInit(msg) => conn_open_init::execute(ctx, msg)?,
            ConnectionMsg::OpenTry(msg) => conn_open_try::execute(ctx, msg)?,
            ConnectionMsg::OpenAck(msg) => conn_open_ack::execute(ctx, msg)?,
            ConnectionMsg::OpenConfirm(msg) => conn_open_confirm::execute(ctx, &msg)?,
        },
        MsgEnvelope::Channel(msg) => {
            let port_id = channel_msg_to_port_id(&msg);
            let module_id = router.lookup_module(port_id).ok_or(RouterError::Host(
                HostError::missing_state(format!("missing module ID for port {}", port_id.clone())),
            ))?;
            let module = router
                .get_route_mut(&module_id)
                .ok_or(RouterError::MissingModule)?;

            match msg {
                ChannelMsg::OpenInit(msg) => chan_open_init_execute(ctx, module, msg)?,
                ChannelMsg::OpenTry(msg) => chan_open_try_execute(ctx, module, msg)?,
                ChannelMsg::OpenAck(msg) => chan_open_ack_execute(ctx, module, msg)?,
                ChannelMsg::OpenConfirm(msg) => chan_open_confirm_execute(ctx, module, msg)?,
                ChannelMsg::CloseInit(msg) => chan_close_init_execute(ctx, module, msg)?,
                ChannelMsg::CloseConfirm(msg) => chan_close_confirm_execute(ctx, module, msg)?,
            }
        }
        MsgEnvelope::Packet(msg) => {
            let port_id = packet_msg_to_port_id(&msg);
            let module_id = router.lookup_module(port_id).ok_or(RouterError::Host(
                HostError::missing_state(format!("missing module ID for port {}", port_id.clone())),
            ))?;
            let module = router
                .get_route_mut(&module_id)
                .ok_or(RouterError::MissingModule)?;

            match msg {
                PacketMsg::Recv(msg) => recv_packet_execute(ctx, module, msg)?,
                PacketMsg::Ack(msg) => acknowledgement_packet_execute(ctx, module, msg)?,
                PacketMsg::Timeout(msg) => {
                    timeout_packet_execute(ctx, module, TimeoutMsgType::Timeout(msg))?
                }
                PacketMsg::TimeoutOnClose(msg) => {
                    timeout_packet_execute(ctx, module, TimeoutMsgType::TimeoutOnClose(msg))?
                }
            }
        }
    }

    Ok(())
}