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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
use cosmwasm_schema::cw_serde;
use cosmwasm_std::{
to_json_binary, Addr, Api, Binary, CosmosMsg, HexBinary, IbcPacketAckMsg, IbcPacketTimeoutMsg,
StdResult, Storage, Uint64, WasmMsg,
};
use cw_storage_plus::Map;
use crate::{
ack::Ack,
ibc::{ExecuteResponsePacket, ExecuteResult},
};
/// A request for a callback.
#[cw_serde]
pub struct CallbackRequest {
pub receiver: String,
pub msg: Binary,
}
/// Executed on the callback receiver upon message completion. When
/// being executed, the message will be tagged with "callback":
///
/// ```json
/// {"callback": {
/// "initiator": ...,
/// "initiator_msg": ...,
/// "result": ...,
/// }}
/// ```
#[cw_serde]
pub struct CallbackMessage {
/// Initaitor on the note chain.
pub initiator: Addr,
/// Message sent by the initaitor. This _must_ be base64 encoded
/// or execution will fail.
pub initiator_msg: Binary,
/// Data from the host chain.
pub result: Callback,
}
#[cw_serde]
pub enum Callback {
/// Result of executing the requested messages, or an error.
///
/// 14/04/23: if a submessage errors the reply handler can see
/// `codespace: wasm, code: 5`, but not the actual error. as a
/// result, we can't return good errors for Execution and this
/// error string will only tell you the error's codespace. for
/// example, an out-of-gas error is code 11 and looks like
/// `codespace: sdk, code: 11`.
Execute(Result<ExecutionResponse, String>),
/// An error occured that could not be recovered from. The only
/// known way that this can occur is message handling running out
/// of gas, in which case the error will be `codespace: sdk, code:
/// 11`.
///
/// This error is not named because it could also occur due to a
/// panic or unhandled error during message processing. We don't
/// expect this to happen and have carefully written the code to
/// avoid it.
FatalError(String),
}
#[cw_serde]
pub struct ExecutionResponse {
/// The address on the remote chain that executed the messages.
pub executed_by: String,
/// Index `i` corresponds to the result of executing the `i`th
/// message.
pub result: Vec<ExecuteResult>,
}
#[cw_serde]
pub struct ErrorResponse {
/// The index of the first message who's execution failed.
pub message_index: Uint64,
/// The error that occured executing the message.
pub error: String,
}
/// Disembiguates between a callback for remote message execution and
/// queries.
#[cw_serde]
pub enum CallbackRequestType {
Execute,
// Query,
}
/// Requests that a callback be returned for the IBC message
/// identified by `(channel_id, sequence_number)`.
pub fn request_callback(
storage: &mut dyn Storage,
api: &dyn Api,
channel_id: String,
sequence_number: u64,
initiator: Addr,
request: Option<CallbackRequest>,
request_type: CallbackRequestType,
) -> StdResult<()> {
if let Some(request) = request {
let receiver = api.addr_validate(&request.receiver)?;
let initiator_msg = request.msg;
CALLBACKS.save(
storage,
(channel_id, sequence_number),
&PendingCallback {
initiator,
initiator_msg,
receiver,
request_type,
},
)?;
}
Ok(())
}
const ACK_SUCCESS: u8 = 0;
#[allow(unused)]
const ACK_FAILURE: u8 = 1;
/// Call on every packet ACK. Returns a callback message to execute,
/// if any, and the address that executed the request on the remote
/// chain (the message initiator's remote account), if any.
///
/// (storage, ack) -> (callback, executed_by)
pub fn on_ack(
storage: &mut dyn Storage,
// TODO: Update with enum response type that supports queries here in future
IbcPacketAckMsg {
acknowledgement,
original_packet,
..
}: &IbcPacketAckMsg,
) -> (Option<CosmosMsg>, Option<String>, Ack) {
let (ack_res, ack_res_data) = acknowledgement.data.split_at(1);
let mut executed_by = None;
let maybe_response = ExecuteResponsePacket::decode_bytes(ack_res_data);
let result: Ack = match maybe_response {
Ok(decoded) => {
executed_by = match &decoded {
ExecuteResponsePacket { executed_by, .. } => Some(executed_by),
}
.cloned();
Ack::Execute(Ok(ExecutionResponse {
// TODO: fix unwrap
executed_by: executed_by.clone().unwrap(),
result: decoded.result,
}))
}
Err(err) => {
if ack_res[0] != ACK_SUCCESS {
Ack::FatalError(HexBinary::from(ack_res_data).to_string())
} else {
Ack::Execute(Err(err.to_string()))
}
}
};
let callback_message = dequeue_callback(
storage,
original_packet.src.channel_id.clone(),
original_packet.sequence,
)
.map(|request| callback_message(request, result.clone()));
(callback_message, executed_by, result)
}
/// Call on every packet timeout. Returns a callback message to execute,
/// if any.
pub fn on_timeout(
storage: &mut dyn Storage,
IbcPacketTimeoutMsg { packet, .. }: &IbcPacketTimeoutMsg,
) -> Option<CosmosMsg> {
let request = dequeue_callback(storage, packet.src.channel_id.clone(), packet.sequence)?;
let timeout = "timeout".to_string();
let result = match request.request_type {
CallbackRequestType::Execute => Callback::Execute(Err(timeout)),
// CallbackRequestType::Query => Callback::Query(Err(ErrorResponse {
// message_index: Uint64::zero(),
// error: timeout,
// })),
};
Some(callback_message(request, result))
}
fn callback_message(request: PendingCallback, result: Callback) -> CosmosMsg {
/// Gives the executed message a "callback" tag:
/// `{ "callback": CallbackMsg }`.
#[cw_serde]
enum C {
Callback(CallbackMessage),
}
WasmMsg::Execute {
contract_addr: request.receiver.into_string(),
msg: to_json_binary(&C::Callback(CallbackMessage {
initiator: request.initiator,
initiator_msg: request.initiator_msg,
result,
}))
.expect("fields are known to be serializable"),
funds: vec![],
}
.into()
}
fn dequeue_callback(
storage: &mut dyn Storage,
channel_id: String,
sequence_number: u64,
) -> Option<PendingCallback> {
let request = CALLBACKS
.may_load(storage, (channel_id.clone(), sequence_number))
.unwrap()?;
CALLBACKS.remove(storage, (channel_id, sequence_number));
Some(request)
}
#[cw_serde]
struct PendingCallback {
initiator: Addr,
initiator_msg: Binary,
/// The address that will receive the callback on completion.
receiver: Addr,
/// Used to return the appropriate callback type during timeouts.
request_type: CallbackRequestType,
}
/// (channel_id, sequence_number) -> callback
const CALLBACKS: Map<(String, u64), PendingCallback> = Map::new("polytone-callbacks");