cosmwasm-std 3.0.1

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::{Addr, Binary, IbcAcknowledgement, Timestamp};

/// Payload value should be encoded in a format defined by the channel version,
/// and the module on the other side should know how to parse this.
#[non_exhaustive]
#[derive(
    Serialize, Deserialize, Clone, Debug, PartialEq, Eq, cw_schema::Schemaifier, JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub struct Ibc2Payload {
    /// The port id on the chain where the packet is sent from.
    pub source_port: String,
    /// The port id on the chain where the packet is sent to.
    pub destination_port: String,
    /// Version of the receiving contract.
    pub version: String,
    /// Encoding used to serialize the [Ibc2Payload::value].
    pub encoding: String,
    /// Encoded payload data.
    pub value: Binary,
}

impl Ibc2Payload {
    pub fn new(
        source_port: String,
        destination_port: String,
        version: String,
        encoding: String,
        value: Binary,
    ) -> Self {
        Self {
            source_port,
            destination_port,
            version,
            encoding,
            value,
        }
    }
}

/// These are messages in the IBC lifecycle using the new Ibc2 approach.
/// Only usable by Ibc2-enabled contracts
#[non_exhaustive]
#[derive(
    Serialize, Deserialize, Clone, Debug, PartialEq, Eq, cw_schema::Schemaifier, JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub enum Ibc2Msg {
    /// Sends an Ibc2 packet with given payloads over the existing channel.
    SendPacket {
        source_client: String,
        timeout: Timestamp,
        payloads: Vec<Ibc2Payload>,
    },
    /// Acknowledges a packet that this contract received over IBC.
    /// This allows acknowledging a packet that was not acknowledged yet in the `ibc2_packet_receive` call.
    WriteAcknowledgement {
        /// Existing channel where the packet was received
        source_client: String,
        /// Sequence number of the packet that was received
        packet_sequence: u64,
        /// The acknowledgement to send back
        ack: IbcAcknowledgement,
    },
}

/// IBC2PacketReceiveMsg represents a message received via the IBC2 protocol.
/// The message that is passed into `ibc2_packet_receive`.
/// It contains the payload data along with metadata about the source and relayer.
#[derive(
    Serialize, Deserialize, Clone, Debug, PartialEq, Eq, cw_schema::Schemaifier, JsonSchema,
)]
#[non_exhaustive]
pub struct Ibc2PacketReceiveMsg {
    /// The actual data being transmitted via IBC2.
    pub payload: Ibc2Payload,
    /// The address of the entity that relayed the packet.
    pub relayer: Addr,
    /// The identifier of the source IBC client.
    pub source_client: String,
    /// The unique sequence number of the received packet.
    pub packet_sequence: u64,
}

impl Ibc2PacketReceiveMsg {
    pub fn new(
        payload: Ibc2Payload,
        relayer: Addr,
        source_client: String,
        packet_sequence: u64,
    ) -> Self {
        Self {
            payload,
            relayer,
            source_client,
            packet_sequence,
        }
    }
}

/// IBC2PacketTimeoutMsg represents a timeout event for a packet that was not
/// successfully delivered within the expected timeframe in the IBC2 protocol.
/// It includes details about the source and destination clients, and the sequence
/// number of the timed-out packet.
#[derive(
    Serialize, Deserialize, Clone, Debug, PartialEq, Eq, cw_schema::Schemaifier, JsonSchema,
)]
#[non_exhaustive]
pub struct Ibc2PacketTimeoutMsg {
    /// The data associated with the timed-out packet.
    pub payload: Ibc2Payload,
    /// The identifier of the client that originally sent the packet.
    pub source_client: String,
    /// The identifier of the client that was the intended recipient.
    pub destination_client: String,
    /// The sequence number of the timed-out packet.
    pub packet_sequence: u64,
    /// The address of the relayer responsible for the packet.
    pub relayer: Addr,
}

impl Ibc2PacketTimeoutMsg {
    pub fn new(
        payload: Ibc2Payload,
        source_client: String,
        destination_client: String,
        packet_sequence: u64,
        relayer: Addr,
    ) -> Self {
        Self {
            payload,
            source_client,
            destination_client,
            packet_sequence,
            relayer,
        }
    }
}

/// Message sent to the IBCv2 app upon receiving an acknowledgement packet
#[derive(
    Serialize, Deserialize, Clone, Debug, PartialEq, Eq, cw_schema::Schemaifier, JsonSchema,
)]
#[non_exhaustive]
pub struct Ibc2PacketAckMsg {
    pub source_client: String,
    pub destination_client: String,
    pub data: Ibc2Payload,
    pub acknowledgement: Binary,
    pub relayer: Addr,
}

impl Ibc2PacketAckMsg {
    pub fn new(
        source_client: String,
        destination_client: String,
        data: Ibc2Payload,
        acknowledgement: Binary,
        relayer: Addr,
    ) -> Self {
        Self {
            source_client,
            destination_client,
            data,
            acknowledgement,
            relayer,
        }
    }
}

/// Ibc2PacketSendMsg represents a payload sent event in the IBC2 protocol.
/// Since sending IBCv2 packet is permissionless, the IBC protocol introduces
/// an extra entry point, in which the application can verify the message sent from
/// a port ID belonging to the contract.
///
/// It includes details about the source and destination clients, the sequence
/// number of the packet and the signer that sent the message.
#[derive(
    Serialize, Deserialize, Clone, Debug, PartialEq, Eq, cw_schema::Schemaifier, JsonSchema,
)]
#[non_exhaustive]
pub struct Ibc2PacketSendMsg {
    /// The payload to be sent.
    pub payload: Ibc2Payload,
    /// The identifier of the client that originally sent the packet.
    pub source_client: String,
    /// The identifier of the client that was the intended recipient.
    pub destination_client: String,
    /// The sequence number of the sent packet.
    pub packet_sequence: u64,
    /// The address of the signer that sent the packet.
    pub signer: Addr,
}

impl Ibc2PacketSendMsg {
    pub fn new(
        payload: Ibc2Payload,
        source_client: String,
        destination_client: String,
        packet_sequence: u64,
        signer: Addr,
    ) -> Self {
        Self {
            payload,
            source_client,
            destination_client,
            packet_sequence,
            signer,
        }
    }
}

#[cfg(test)]
mod tests {
    use serde_json::to_string;

    use crate::Ibc2Payload;

    #[test]
    fn ibc2_payload_serialize() {
        let packet = Ibc2Payload {
            source_port: "sending-contractr-port".to_string(),
            destination_port: "receiving-contract-port".to_string(),
            version: "v1".to_string(),
            encoding: "json".to_string(),
            value: b"foo".into(),
        };
        let expected = r#"{"source_port":"sending-contractr-port","destination_port":"receiving-contract-port","version":"v1","encoding":"json","value":"Zm9v"}"#;
        assert_eq!(to_string(&packet).unwrap(), expected);
    }
}