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 196 197 198 199 200 201 202 203 204 205 206 207 208 209
//! Defines the main channel, port and packet error types
use displaydoc::Display;
use ibc_core_client_types::{error as client_error, Height};
use ibc_core_connection_types::error as connection_error;
use ibc_core_host_types::error::IdentifierError;
use ibc_core_host_types::identifiers::{ChannelId, ConnectionId, PortId, Sequence};
use ibc_primitives::prelude::*;
use ibc_primitives::{ParseTimestampError, Timestamp};
use super::channel::Counterparty;
use super::timeout::TimeoutHeight;
use crate::channel::State;
use crate::Version;
#[derive(Debug, Display)]
pub enum ChannelError {
/// invalid channel end: `{channel_end}`
InvalidChannelEnd { channel_end: String },
/// invalid channel id: expected `{expected}`, actual `{actual}`
InvalidChannelId { expected: String, actual: String },
/// invalid channel state: expected `{expected}`, actual `{actual}`
InvalidState { expected: String, actual: String },
/// invalid channel order type: expected `{expected}`, actual `{actual}`
InvalidOrderType { expected: String, actual: String },
/// invalid connection hops length: expected `{expected}`; actual `{actual}`
InvalidConnectionHopsLength { expected: u64, actual: u64 },
/// invalid signer error: `{reason}`
InvalidSigner { reason: String },
/// invalid proof: missing height
MissingHeight,
/// packet data bytes must be valid UTF-8 (this restriction will be lifted in the future)
NonUtf8PacketData,
/// missing counterparty
MissingCounterparty,
/// version not supported: expected `{expected}`, actual `{actual}`
VersionNotSupported { expected: Version, actual: Version },
/// missing channel end
MissingChannel,
/// the channel end (`{port_id}`, `{channel_id}`) does not exist
ChannelNotFound {
port_id: PortId,
channel_id: ChannelId,
},
/// Verification fails for the packet with the sequence number `{sequence}`, error: `{client_error}`
PacketVerificationFailed {
sequence: Sequence,
client_error: client_error::ClientError,
},
/// Error verifying channel state error: `{0}`
VerifyChannelFailed(client_error::ClientError),
/// String `{value}` cannot be converted to packet sequence, error: `{error}`
InvalidStringAsSequence {
value: String,
error: core::num::ParseIntError,
},
/// invalid channel counterparty: expected `{expected}`, actual `{actual}`
InvalidCounterparty {
expected: Counterparty,
actual: Counterparty,
},
/// application module error: `{description}`
AppModule { description: String },
/// Undefined counterparty connection for `{connection_id}`
UndefinedConnectionCounterparty { connection_id: ConnectionId },
/// invalid proof: empty proof
InvalidProof,
/// identifier error: `{0}`
InvalidIdentifier(IdentifierError),
/// channel counter overflow error
CounterOverflow,
/// other error: `{description}`
Other { description: String },
}
#[derive(Debug, Display)]
pub enum PacketError {
/// connection error: `{0}`
Connection(connection_error::ConnectionError),
/// channel error: `{0}`
Channel(ChannelError),
/// Receiving chain block height `{chain_height}` >= packet timeout height `{timeout_height}`
LowPacketHeight {
chain_height: Height,
timeout_height: TimeoutHeight,
},
/// Receiving chain block timestamp >= packet timeout timestamp
LowPacketTimestamp,
/// Invalid packet sequence `{given_sequence}` ≠ next send sequence `{next_sequence}`
InvalidPacketSequence {
given_sequence: Sequence,
next_sequence: Sequence,
},
/// Channel `{channel_id}` should not be state `{state}`
InvalidChannelState { channel_id: ChannelId, state: State },
/// the associated connection `{connection_id}` is not OPEN
ConnectionNotOpen { connection_id: ConnectionId },
/// Receipt for the packet `{sequence}` not found
PacketReceiptNotFound { sequence: Sequence },
/// The stored commitment of the packet `{sequence}` is incorrect
IncorrectPacketCommitment { sequence: Sequence },
/// implementation specific error
ImplementationSpecific,
/// Undefined counterparty connection for `{connection_id}`
UndefinedConnectionCounterparty { connection_id: ConnectionId },
/// invalid proof: empty proof
InvalidProof,
/// Packet timeout height `{timeout_height}` > chain height `{chain_height} and timeout timestamp `{timeout_timestamp}` > chain timestamp `{chain_timestamp}`
PacketTimeoutNotReached {
timeout_height: TimeoutHeight,
chain_height: Height,
timeout_timestamp: Timestamp,
chain_timestamp: Timestamp,
},
/// Packet acknowledgement exists for the packet with the sequence `{sequence}`
AcknowledgementExists { sequence: Sequence },
/// Acknowledgment cannot be empty
InvalidAcknowledgement,
/// Acknowledgment status cannot be empty
EmptyAcknowledgementStatus,
/// Acknowledgment for the packet `{sequence}` not found
PacketAcknowledgementNotFound { sequence: Sequence },
/// invalid proof: missing height
MissingHeight,
/// there is no packet in this message
MissingPacket,
/// invalid signer error: `{reason}`
InvalidSigner { reason: String },
/// application module error: `{description}`
AppModule { description: String },
/// route not found
RouteNotFound,
/// packet sequence cannot be 0
ZeroPacketSequence,
/// packet data bytes cannot be empty
ZeroPacketData,
/// invalid timeout height for the packet
InvalidTimeoutHeight,
/// Invalid packet timeout timestamp value error: `{0}`
InvalidPacketTimestamp(ParseTimestampError),
/// missing timeout
MissingTimeout,
/// invalid identifier error: `{0}`
InvalidIdentifier(IdentifierError),
/// Missing sequence number for sending packets on port `{port_id}` and channel `{channel_id}`
MissingNextSendSeq {
port_id: PortId,
channel_id: ChannelId,
},
/// the channel end (`{port_id}`, `{channel_id}`) does not exist
ChannelNotFound {
port_id: PortId,
channel_id: ChannelId,
},
/// Commitment for the packet `{sequence}` not found
PacketCommitmentNotFound { sequence: Sequence },
/// Missing sequence number for receiving packets on port `{port_id}` and channel `{channel_id}`
MissingNextRecvSeq {
port_id: PortId,
channel_id: ChannelId,
},
/// Missing sequence number for ack packets on port `{port_id}` and channel `{channel_id}`
MissingNextAckSeq {
port_id: PortId,
channel_id: ChannelId,
},
/// Cannot encode sequence `{sequence}`
CannotEncodeSequence { sequence: Sequence },
/// other error: `{description}`
Other { description: String },
}
impl From<IdentifierError> for ChannelError {
fn from(err: IdentifierError) -> Self {
Self::InvalidIdentifier(err)
}
}
impl From<IdentifierError> for PacketError {
fn from(err: IdentifierError) -> Self {
Self::InvalidIdentifier(err)
}
}
#[cfg(feature = "std")]
impl std::error::Error for PacketError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match &self {
Self::Connection(e) => Some(e),
Self::Channel(e) => Some(e),
Self::InvalidIdentifier(e) => Some(e),
_ => None,
}
}
}
#[cfg(feature = "std")]
impl std::error::Error for ChannelError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match &self {
Self::InvalidIdentifier(e) => Some(e),
Self::PacketVerificationFailed {
client_error: e, ..
} => Some(e),
Self::InvalidStringAsSequence { error: e, .. } => Some(e),
_ => None,
}
}
}