Skip to content

Commit

Permalink
shielded-pool: emit events on ICS20 transfers
Browse files Browse the repository at this point in the history
  • Loading branch information
@cronokirby
cronokirby committed Oct 1, 2024
1 parent e4b12a0 commit d682205
Show file tree
Hide file tree
Showing 2 changed files with 131 additions and 12 deletions.
104 changes: 96 additions & 8 deletions crates/core/component/shielded-pool/src/component/transfer.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use std::str::FromStr;

use crate::{
component::{AssetRegistry, NoteManager},
Ics20Withdrawal,
event, Ics20Withdrawal,
};
use anyhow::{Context, Result};
use async_trait::async_trait;
Expand All @@ -21,9 +21,11 @@ use ibc_types::{
transfer::acknowledgement::TokenTransferAcknowledgement,
};
use penumbra_asset::{asset, asset::Metadata, Value};
use penumbra_ibc::component::ChannelStateReadExt;
use penumbra_keys::Address;
use penumbra_num::Amount;
use penumbra_proto::{
core::component::shielded_pool::v1::FungibleTokenTransferPacketMetadata,
penumbra::core::component::ibc::v1::FungibleTokenPacketData, StateReadProto, StateWriteProto,
};
use penumbra_sct::CommitmentSource;
Expand Down Expand Up @@ -116,6 +118,23 @@ pub trait Ics20TransferWriteExt: StateWrite {
),
new_value_balance,
);
self.record_proto(event::outbound_fungible_token_transfer(
Value {
amount: withdrawal.amount,
asset_id: withdrawal.denom.id(),
},
&withdrawal.return_address,
withdrawal.destination_chain_address.clone(),
FungibleTokenTransferPacketMetadata {
channel: withdrawal.source_channel.0.clone(),
sequence: self
.get_send_sequence(
&withdrawal.source_channel,
&checked_packet.source_port(),
)
.await?,
},
));
} else {
// receiver is the source, burn utxos

Expand Down Expand Up @@ -149,6 +168,23 @@ pub trait Ics20TransferWriteExt: StateWrite {
),
new_value_balance,
);
self.record_proto(event::outbound_fungible_token_transfer(
Value {
amount: withdrawal.amount,
asset_id: withdrawal.denom.id(),
},
&withdrawal.return_address,
withdrawal.destination_chain_address.clone(),
FungibleTokenTransferPacketMetadata {
channel: withdrawal.source_channel.0.clone(),
sequence: self
.get_send_sequence(
&withdrawal.source_channel,
&checked_packet.source_port(),
)
.await?,
},
));
}

self.send_packet_execute(checked_packet).await;
Expand Down Expand Up @@ -352,6 +388,15 @@ async fn recv_transfer_packet_inner<S: StateWrite>(
state_key::ics20_value_balance::by_asset_id(&msg.packet.chan_on_b, &denom.id()),
new_value_balance,
);
state.record_proto(event::inbound_fungible_token_transfer(
value,
packet_data.sender.clone(),
&receiver_address,
FungibleTokenTransferPacketMetadata {
channel: msg.packet.chan_on_a.0.clone(),
sequence: msg.packet.sequence.0,
},
));
} else {
// create new denom:
//
Expand Down Expand Up @@ -403,13 +448,26 @@ async fn recv_transfer_packet_inner<S: StateWrite>(
state_key::ics20_value_balance::by_asset_id(&msg.packet.chan_on_b, &denom.id()),
new_value_balance,
);
state.record_proto(event::inbound_fungible_token_transfer(
value,
packet_data.sender.clone(),
&receiver_address,
FungibleTokenTransferPacketMetadata {
channel: msg.packet.chan_on_a.0.clone(),
sequence: msg.packet.sequence.0,
},
));
}

Ok(())
}

// see: https://github.com/cosmos/ibc/blob/8326e26e7e1188b95c32481ff00348a705b23700/spec/app/ics-020-fungible-token-transfer/README.md?plain=1#L297
async fn refund_tokens<S: StateWrite>(mut state: S, packet: &Packet) -> Result<()> {
async fn refund_tokens<S: StateWrite>(
mut state: S,
packet: &Packet,
reason: event::FungibleTokenRefundReason,
) -> Result<()> {
let packet_data: FungibleTokenPacketData = serde_json::from_slice(packet.data.as_slice())?;
let denom: asset::Metadata = packet_data // CRITICAL: verify that this denom is validated in upstream timeout handling
.denom
Expand Down Expand Up @@ -469,6 +527,17 @@ async fn refund_tokens<S: StateWrite>(mut state: S, packet: &Packet) -> Result<(
state_key::ics20_value_balance::by_asset_id(&packet.chan_on_a, &denom.id()),
new_value_balance,
);
state.record_proto(event::outbound_fungible_token_refund(
value,
&receiver, // note, this comes from packet_data.sender
packet_data.receiver.clone(),
reason,
// Use the destination channel, i.e. our name for it, to be consistent across events.
FungibleTokenTransferPacketMetadata {
channel: packet.chan_on_b.0.clone(),
sequence: packet.sequence.0,
},
));
} else {
let value_balance: Amount = state
.get(&state_key::ics20_value_balance::by_asset_id(
Expand Down Expand Up @@ -497,6 +566,17 @@ async fn refund_tokens<S: StateWrite>(mut state: S, packet: &Packet) -> Result<(
state_key::ics20_value_balance::by_asset_id(&packet.chan_on_a, &denom.id()),
new_value_balance,
);
// note, order flipped relative to the event.
state.record_proto(event::outbound_fungible_token_refund(
value,
&receiver, // note, this comes from packet_data.sender
packet_data.receiver.clone(),
reason,
FungibleTokenTransferPacketMetadata {
channel: packet.chan_on_b.0.clone(),
sequence: packet.sequence.0,
},
));
}

Ok(())
Expand Down Expand Up @@ -535,9 +615,13 @@ impl AppHandlerExecute for Ics20Transfer {

async fn timeout_packet_execute<S: StateWrite>(mut state: S, msg: &MsgTimeout) -> Result<()> {
// timeouts may fail due to counterparty chains sending transfers of u128-1
refund_tokens(&mut state, &msg.packet)
.await
.context("able to timeout packet")?;
refund_tokens(
&mut state,
&msg.packet,
event::FungibleTokenRefundReason::Timeout,
)
.await
.context("able to timeout packet")?;

Ok(())
}
Expand All @@ -552,9 +636,13 @@ impl AppHandlerExecute for Ics20Transfer {
// in the case where a counterparty chain acknowledges a packet with an error,
// for example due to a middleware processing issue or other behavior,
// the funds should be unescrowed back to the packet sender.
refund_tokens(&mut state, &msg.packet)
.await
.context("unable to refund packet acknowledgement")?;
refund_tokens(
&mut state,
&msg.packet,
event::FungibleTokenRefundReason::Error,
)
.await
.context("unable to refund packet acknowledgement")?;
}

Ok(())
Expand Down
39 changes: 35 additions & 4 deletions crates/core/component/shielded-pool/src/event.rs
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
use penumbra_asset::Value;
use penumbra_keys::Address;
use penumbra_proto::core::component::shielded_pool::v1::{
EventInboundFungibleTokenTransfer, EventOutboundFungibleTokenRefund,
EventOutboundFungibleTokenTransfer, EventOutput, EventSpend,
event_outbound_fungible_token_refund::Reason, EventInboundFungibleTokenTransfer,
EventOutboundFungibleTokenRefund, EventOutboundFungibleTokenTransfer, EventOutput, EventSpend,
FungibleTokenTransferPacketMetadata,
};
use penumbra_sct::Nullifier;

Expand All @@ -25,24 +26,54 @@ pub fn output(note_payload: &NotePayload) -> EventOutput {

pub fn outbound_fungible_token_transfer(
value: Value,
sender: Address,
sender: &Address,
receiver: String,
meta: FungibleTokenTransferPacketMetadata,
) -> EventOutboundFungibleTokenTransfer {
EventOutboundFungibleTokenTransfer {
value: Some(value.into()),
sender: Some(sender.into()),
receiver,
meta: Some(meta),
}
}

#[derive(Clone, Copy, Debug)]
pub enum FungibleTokenRefundReason {
Timeout,
Error,
}

pub fn outbound_fungible_token_refund(
value: Value,
sender: &Address,
receiver: String,
reason: FungibleTokenRefundReason,
meta: FungibleTokenTransferPacketMetadata,
) -> EventOutboundFungibleTokenRefund {
let reason = match reason {
FungibleTokenRefundReason::Timeout => Reason::Timeout,
FungibleTokenRefundReason::Error => Reason::Error,
};
EventOutboundFungibleTokenRefund {
value: Some(value.into()),
sender: Some(sender.into()),
receiver,
reason: reason as i32,
meta: Some(meta),
}
}

pub fn inbound_fungible_token_transfer(
value: Value,
sender: String,
receiver: Address,
receiver: &Address,
meta: FungibleTokenTransferPacketMetadata,
) -> EventInboundFungibleTokenTransfer {
EventInboundFungibleTokenTransfer {
value: Some(value.into()),
sender,
receiver: Some(receiver.into()),
meta: Some(meta),
}
}

0 comments on commit d682205

Please sign in to comment.