Voyager timeouts (#4217)

Author: aeryz

Cargo.lock

@@ -188,6 +188,7 @@ members = [
 
   "voyager/plugins/packet-filter",
   "voyager/plugins/transaction-batch",
+  "voyager/plugins/packet-timeout",
 
   "drip",
 

Cargo.toml

@@ -3,6 +3,7 @@ use cosmwasm_schema::cw_serde;
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{wasm_execute, DepsMut, Env, MessageInfo, Response, StdError};
 use ibc_union_msg::{module::IbcUnionMsg, msg::MsgWriteAcknowledgement};
+use ibc_union_spec::Timestamp;
 
 use crate::{
     msg::{ExecuteMsg, InitMsg, UCS00PingPong},
@@ -33,7 +34,11 @@ pub fn execute(
     match msg {
         ExecuteMsg::Initiate { channel_id, packet } => {
             let config = CONFIG.load(deps.storage)?;
-            let msg = packet.reverse(&config, env.block.time.nanos(), channel_id);
+            let msg = packet.reverse(
+                &config,
+                Timestamp::from_nanos(env.block.time.nanos()),
+                channel_id,
+            );
 
             Ok(Response::default().add_message(wasm_execute(config.ibc_host, &msg, vec![])?))
         }
@@ -54,7 +59,7 @@ pub fn execute(
             let config = CONFIG.load(deps.storage)?;
             let msg = ping_packet.reverse(
                 &config,
-                env.block.time.nanos(),
+                Timestamp::from_nanos(env.block.time.nanos()),
                 packet.destination_channel_id,
             );
 

cosmwasm/ibc-union/app/ucs00-pingpong/src/contract.rs

@@ -1,7 +1,7 @@
 use cosmwasm_schema::cw_serde;
 use ethabi::{ParamType, Token};
 use ibc_union_msg::msg::MsgSendPacket;
-use ibc_union_spec::ChannelId;
+use ibc_union_spec::{ChannelId, Timestamp};
 
 use crate::{state::Config, ContractError};
 
@@ -37,7 +37,7 @@ impl UCS00PingPong {
     pub fn reverse(
         &self,
         config: &Config,
-        current_timestamp: u64,
+        current_timestamp: Timestamp,
         source_channel: ChannelId,
     ) -> ibc_union_msg::msg::ExecuteMsg {
         let counterparty_packet = UCS00PingPong {
@@ -47,7 +47,8 @@ impl UCS00PingPong {
         ibc_union_msg::msg::ExecuteMsg::PacketSend(MsgSendPacket {
             source_channel_id: source_channel,
             timeout_height: 0,
-            timeout_timestamp: current_timestamp + config.seconds_before_timeout * 1_000_000_000,
+            timeout_timestamp: current_timestamp
+                + Timestamp::from_secs(config.seconds_before_timeout),
             data: counterparty_packet.encode().into(),
         })
     }

cosmwasm/ibc-union/app/ucs00-pingpong/src/msg.rs

@@ -29,6 +29,7 @@ ibc-union-msg               = { workspace = true }
 ibc-union-spec              = { workspace = true, features = ["serde", "ethabi"] }
 serde                       = { workspace = true, features = ["derive"] }
 serde-json-wasm             = "1.0"
+serde-utils.workspace       = true
 thiserror                   = { workspace = true }
 token-factory-api           = { workspace = true }
 ucs03-zkgm-token-minter-api = { workspace = true }

cosmwasm/ibc-union/app/ucs03-zkgm/Cargo.toml

@@ -13,7 +13,7 @@ use ibc_union_msg::{
     module::IbcUnionMsg,
     msg::{MsgSendPacket, MsgWriteAcknowledgement},
 };
-use ibc_union_spec::{path::BatchPacketsPath, ChannelId, Packet};
+use ibc_union_spec::{path::BatchPacketsPath, ChannelId, Packet, Timestamp};
 use ucs03_zkgm_token_minter_api::{LocalTokenMsg, Metadata, MetadataResponse, WrappedTokenMsg};
 use unionlabs::{
     ethereum::keccak256,
@@ -228,7 +228,7 @@ pub fn execute(
             info,
             channel_id,
             timeout_height.u64(),
-            timeout_timestamp.u64(),
+            timeout_timestamp,
             salt,
             Instruction::abi_decode_params(&instruction, true)?,
         ),
@@ -1008,7 +1008,7 @@ fn execute_forward(
     let next_packet = MsgSendPacket {
         source_channel_id: next_source_channel_id,
         timeout_height: forward.timeout_height,
-        timeout_timestamp: forward.timeout_timestamp,
+        timeout_timestamp: Timestamp::from_nanos(forward.timeout_timestamp),
         data: ZkgmPacket {
             salt: derive_forward_salt(salt).into(),
             path: next_path,
@@ -1856,7 +1856,7 @@ pub fn send(
     info: MessageInfo,
     channel_id: ChannelId,
     timeout_height: u64,
-    timeout_timestamp: u64,
+    timeout_timestamp: Timestamp,
     salt: H256,
     instruction: Instruction,
 ) -> Result<Response, ContractError> {

cosmwasm/ibc-union/app/ucs03-zkgm/src/contract.rs

@@ -1,5 +1,5 @@
 use cosmwasm_std::{Addr, CosmosMsg, Uint256, Uint64};
-use ibc_union_spec::{ChannelId, Packet};
+use ibc_union_spec::{ChannelId, Packet, Timestamp};
 use serde::{Deserialize, Serialize};
 use unionlabs::primitives::{Bytes, H256};
 
@@ -64,7 +64,8 @@ pub enum ExecuteMsg {
     Send {
         channel_id: ChannelId,
         timeout_height: Uint64,
-        timeout_timestamp: Uint64,
+        #[serde(with = "serde_utils::string")]
+        timeout_timestamp: Timestamp,
         salt: H256,
         instruction: Bytes,
     },
@@ -142,7 +143,7 @@ mod tests {
             ExecuteMsg::Send {
                 channel_id: ChannelId!(9),
                 timeout_height: Uint64::new(0),
-                timeout_timestamp: Uint64::new(1744248392563000000),
+                timeout_timestamp: Timestamp::from_nanos(1744248392563000000),
                 salt: hex!("fd0ff5488c14b15c03d8958b25261c22a42b049894aeb1f33926a1f7ccadaf98").into(),
                 instruction: "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000003e00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000300000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000300000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000001a000000000000000000000000000000000000000000000000000000000000001e0000000000000000000000000000000000000000000000000000000000012d450000000000000000000000000000000000000000000000000000000000000024000000000000000000000000000000000000000000000000000000000000002800000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002c0000000000000000000000000000000000000000000000000000000000012d450000000000000000000000000000000000000000000000000000000000000002a307832633664373366343061636535313263343330343032646362646339343839343134333035303438000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000014bd1b743615f903a630393f78234b4500fbe5691a000000000000000000000000000000000000000000000000000000000000000000000000000000000000003e62626e316e7a6e6c377372676d7478396a7565766e72617372327372736c717a7a6533303833673330773875673936663936726a7065757167386636757700000000000000000000000000000000000000000000000000000000000000000007756e6942544364000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006756e6942544300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000014717dA936440d811EbBF98515EB4a8Db2443BeFf5000000000000000000000000".parse().unwrap()
             }

cosmwasm/ibc-union/app/ucs03-zkgm/src/msg.rs

@@ -1,4 +1,4 @@
-use ibc_union_spec::{Channel, ChannelId, ClientId, ConnectionId, Packet};
+use ibc_union_spec::{Channel, ChannelId, ClientId, ConnectionId, Packet, Timestamp};
 use serde::{Deserialize, Serialize};
 use unionlabs_primitives::Bytes;
 
@@ -225,6 +225,6 @@ pub struct MsgWriteAcknowledgement {
 pub struct MsgSendPacket {
     pub source_channel_id: ChannelId,
     pub timeout_height: u64,
-    pub timeout_timestamp: u64,
+    pub timeout_timestamp: Timestamp,
     pub data: Bytes,
 }

cosmwasm/ibc-union/core/msg/src/msg.rs

@@ -31,6 +31,7 @@ use ibc_union_spec::{
         ConnectionPath, ConsensusStatePath, COMMITMENT_MAGIC, COMMITMENT_MAGIC_ACK,
     },
     Channel, ChannelId, ChannelState, ClientId, Connection, ConnectionId, ConnectionState, Packet,
+    Timestamp,
 };
 use serde::{de::DeserializeOwned, Deserialize, Serialize};
 use unionlabs::{
@@ -666,7 +667,7 @@ fn timeout_packet(
 
     let proof_timestamp =
         get_timestamp_at_height(deps.as_ref(), connection.client_id, proof_height)?;
-    if proof_timestamp == 0 {
+    if proof_timestamp.is_zero() {
         return Err(ContractError::TimeoutProofTimestampNotFound);
     }
 
@@ -685,15 +686,15 @@ fn timeout_packet(
     )?;
     mark_packet_as_acknowledged(deps.branch(), &packet)?;
 
-    if packet.timeout_timestamp == 0 && packet.timeout_height == 0 {
+    if packet.timeout_timestamp.is_zero() && packet.timeout_height == 0 {
         return Err(ContractError::TimeoutMustBeSet);
     }
 
-    if packet.timeout_timestamp > 0 && packet.timeout_timestamp > proof_timestamp {
+    if !packet.timeout_timestamp.is_zero() && packet.timeout_timestamp > proof_timestamp {
         return Err(ContractError::TimeoutTimestampNotReached);
     }
 
-    if packet.timeout_height > 0 && packet.timeout_height > proof_height {
+    if !packet.timeout_timestamp.is_zero() && packet.timeout_height > proof_height {
         return Err(ContractError::TimeoutHeightNotReached);
     }
 
@@ -1636,8 +1637,8 @@ fn process_receive(
             });
         }
 
-        let current_timestamp = env.block.time.nanos();
-        if packet.timeout_timestamp != 0 && (current_timestamp >= packet.timeout_timestamp) {
+        let current_timestamp = Timestamp::from_nanos(env.block.time.nanos());
+        if !packet.timeout_timestamp.is_zero() && (current_timestamp >= packet.timeout_timestamp) {
             return Err(ContractError::ReceivedTimedOutPacketTimestamp {
                 timeout_timestamp: packet.timeout_timestamp,
                 current_timestamp,
@@ -1750,10 +1751,10 @@ fn send_packet(
     sender: Addr,
     source_channel_id: ChannelId,
     timeout_height: u64,
-    timeout_timestamp: u64,
+    timeout_timestamp: Timestamp,
     data: Vec<u8>,
 ) -> ContractResult {
-    if timeout_timestamp == 0 && timeout_height == 0 {
+    if timeout_timestamp.is_zero() && timeout_height == 0 {
         return Err(ContractError::TimeoutMustBeSet);
     }
 
@@ -1975,7 +1976,7 @@ fn get_timestamp_at_height(
     deps: Deps,
     client_id: ClientId,
     height: u64,
-) -> Result<u64, ContractError> {
+) -> Result<Timestamp, ContractError> {
     let client_impl = client_impl(deps, client_id)?;
     let timestamp = query_light_client(
         deps,

cosmwasm/ibc-union/core/src/contract.rs

@@ -9,7 +9,7 @@ mod tests;
 use cosmwasm_std::{Addr, StdError};
 use frissitheto::UpgradeError;
 use ibc_union_msg::lightclient::Status;
-use ibc_union_spec::{ChannelId, ChannelState, ClientId, ConnectionState};
+use ibc_union_spec::{ChannelId, ChannelState, ClientId, ConnectionState, Timestamp};
 use thiserror::Error;
 use unionlabs::primitives::Bytes;
 
@@ -72,8 +72,8 @@ pub enum ContractError {
         ContractErrorKind::from(self)
     )]
     ReceivedTimedOutPacketTimestamp {
-        timeout_timestamp: u64,
-        current_timestamp: u64,
+        timeout_timestamp: Timestamp,
+        current_timestamp: Timestamp,
     },
     #[error(
         "{} caller ({caller}) is not the owner ({owner}) of the channel ({channel_id})",

cosmwasm/ibc-union/core/src/lib.rs

@@ -3,7 +3,7 @@
 #![warn(clippy::pedantic, missing_docs, clippy::missing_const_for_fn)]
 #![cfg_attr(not(feature = "std"), no_std)]
 
-use core::fmt;
+use core::{fmt, ops::Add, str::FromStr};
 
 /// Represents a timestamp, normalized to nanoseconds.
 ///
@@ -19,7 +19,7 @@ use core::fmt;
 /// This type can represent timestamps between **January 1, 1970 12:00:00 AM** and **July 21, 2554
 /// 11:34:33.709 PM** (about 529 years from the time of writing this). If this code is still in use
 /// at this time, good luck.
-#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Default, Hash)]
 #[cfg_attr(
     feature = "serde",
     derive(serde::Serialize, serde::Deserialize),
@@ -30,6 +30,9 @@ use core::fmt;
 pub struct Timestamp(u64);
 
 impl Timestamp {
+    /// Zero timestamp.
+    pub const ZERO: Self = Timestamp(0);
+
     /// Construct a [`Timestamp`] from the given ***nanoseconds*** value.
     ///
     /// ```rust
@@ -73,10 +76,42 @@ impl Timestamp {
     pub const fn as_secs(&self) -> u64 {
         self.0 / 1_000_000_000
     }
+
+    /// Check if the timestamp is zero.
+    ///
+    /// Note that this checks against the ***nanos***. If the value is sub-second, this will return *false*, whereas [`Timestamp::as_secs()`] will return 0:
+    ///
+    /// ```rust
+    /// # use consensus_primitives::Timestamp;
+    /// let ts = Timestamp::from_nanos(123);
+    /// assert_eq!(ts.as_secs(), 0);
+    /// assert!(!ts.is_zero());
+    /// ```
+    #[must_use = "accessing the inner value has no effect"]
+    pub const fn is_zero(&self) -> bool {
+        self.0 == 0
+    }
+}
+
+impl FromStr for Timestamp {
+    type Err = <u64 as FromStr>::Err;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        s.parse().map(Self)
+    }
 }
 
 impl fmt::Display for Timestamp {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         write!(f, "{}", self.0)
     }
 }
+
+impl Add for Timestamp {
+    type Output = Self;
+
+    #[track_caller]
+    fn add(self, rhs: Self) -> Self::Output {
+        Self(self.0 + rhs.0)
+    }
+}

lib/consensus-primitives/src/lib.rs

@@ -32,7 +32,7 @@ ibc-union-spec = { workspace = true, features = ["ethabi", "schemars", "serde",
 [features]
 default = []
 
-bincode             = ["dep:bincode", "unionlabs/bincode"]
+bincode             = ["dep:bincode", "voyager-primitives/bincode", "unionlabs/bincode"]
 ethabi              = ["dep:alloy-sol-types", "unionlabs/ethabi"]
 ibc-solidity-compat = ["dep:ibc-solidity"]
 schemars            = ["dep:schemars", "voyager-primitives/schemars", "unionlabs/schemars"]

lib/ibc-union-spec/Cargo.toml

@@ -275,7 +275,12 @@ pub struct MsgPacketAcknowledgement {
     derive(serde::Serialize, serde::Deserialize),
     serde(rename_all = "snake_case", deny_unknown_fields)
 )]
-pub struct MsgPacketTimeout {}
+pub struct MsgPacketTimeout {
+    pub packet: Packet,
+    /// TODO: Should this be proof_unreceived?
+    pub proof: Bytes,
+    pub proof_height: u64,
+}
 
 #[derive(Debug, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]

lib/ibc-union-spec/src/datagram.rs

@@ -1,6 +1,6 @@
 use enumorph::Enumorph;
 use unionlabs::primitives::Bytes;
-use voyager_primitives::ClientType;
+use voyager_primitives::{ClientType, Timestamp};
 
 use crate::{
     types::{ChannelId, ClientId, ConnectionId},
@@ -389,7 +389,7 @@ pub struct PacketMetadata {
     pub destination_channel: ChannelMetadata,
 
     pub timeout_height: u64,
-    pub timeout_timestamp: u64,
+    pub timeout_timestamp: Timestamp,
 }
 
 /// All metadata associated with a Channel.