From 3500d06decb234976cb36812b42f80c68d444e0d Mon Sep 17 00:00:00 2001
From: Aditya Sripal <adityasripal@gmail.com>
Date: Mon, 13 Mar 2023 19:32:26 +0100
Subject: [PATCH] documentation
---
.../27-interchain-accounts/types/packet.go | 26 +++++++++++++
modules/apps/transfer/types/packet.go | 37 +++++++++++++++++++
2 files changed, 63 insertions(+)
diff --git a/modules/apps/27-interchain-accounts/types/packet.go b/modules/apps/27-interchain-accounts/types/packet.go
index 25d032a7be5..0fe013ea15c 100644
--- a/modules/apps/27-interchain-accounts/types/packet.go
+++ b/modules/apps/27-interchain-accounts/types/packet.go
@@ -51,6 +51,32 @@ func (iapd InterchainAccountPacketData) GetBytes() []byte {
return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&iapd))
}
+/**
+
+ADR-8 CallbackPacketData implementation
+
+InterchainAccountPacketData implements CallbackPacketDataI interface. This will allow middlewares targetting specific VMs
+to retrieve the desired callback addresses for the ICA packet on the source and destination chains.
+
+The Memo is used to set the desired callback addresses.
+
+The Memo format is defined like so:
+
+```json
+{
+ // ... other memo fields we don't care about
+ "callbacks": {
+ "src_callback_address": {contractAddrOnSrcChain},
+ "dest_callback_address": {contractAddrOnDestChain},
+ "src_callback_msg": {jsonObjectForSrcChainCallback},
+ "dest_callback_msg": {jsonObjectForDestChainCallback},
+ }
+
+}
+```
+
+**/
+
// ADR-8 middleware should callback on the sender address on the source chain
// if the sender address is an IBC Actor (i.e. smart contract that accepts IBC callbacks)
func (iapd InterchainAccountPacketData) GetSrcCallbackAddress() (addr string) {
diff --git a/modules/apps/transfer/types/packet.go b/modules/apps/transfer/types/packet.go
index 0b1fef5775c..76466626190 100644
--- a/modules/apps/transfer/types/packet.go
+++ b/modules/apps/transfer/types/packet.go
@@ -67,8 +67,42 @@ func (ftpd FungibleTokenPacketData) GetBytes() []byte {
return sdk.MustSortJSON(mustProtoMarshalJSON(&ftpd))
}
+/**
+
+ADR-8 CallbackPacketData implementation
+
+FungibleTokenPacketData implements CallbackPacketDataI interface. This will allow middlewares targetting specific VMs
+to retrieve the desired callback addresses for the ICS20 packet on the source and destination chains.
+
+The Memo is used to ensure that the callback is desired by the user. This allows a user to send an ICS20 packet
+to a contract with ADR-8 enabled without automatically triggering the callback logic which may lead to unexpected
+behaviour.
+
+The Memo format is defined like so:
+
+```json
+{
+ // ... other memo fields we don't care about
+ "callbacks": {
+ "src_callback_address": {contractAddrOnSrcChain},
+ "dest_callback_address": {contractAddrOnDestChain},
+ "src_callback_msg": {jsonObjectForSrcChainCallback},
+ "dest_callback_msg": {jsonObjectForDestChainCallback},
+ }
+
+}
+```
+
+For transfer, we will enforce that the src_callback_address is the same as sender and dest_callback_address is the same as receiver.
+However, we may remove this restriction at a later date if it proves useful.
+
+**/
+
// ADR-8 middleware should callback on the sender address on the source chain
// if the sender address is an IBC Actor (i.e. smart contract that accepts IBC callbacks)
+// The desired callback address must be confirmed in the memo under the "callbacks" key.
+// This ensures that the callback is explicitly desired by the user and not just called
+// automatically.
func (ftpd FungibleTokenPacketData) GetSrcCallbackAddress() (addr string) {
if len(ftpd.Memo) == 0 {
return
@@ -94,6 +128,9 @@ func (ftpd FungibleTokenPacketData) GetSrcCallbackAddress() (addr string) {
// ADR-8 middleware should callback on the receiver address on the destination chain
// if the receiver address is an IBC Actor (i.e. smart contract that accepts IBC callbacks)
+// The desired callback address must be confirmed in the memo under the "callbacks" key.
+// This ensures that the callback is explicitly desired by the user and not just called
+// automatically.
func (ftpd FungibleTokenPacketData) GetDestCallbackAddress() (addr string) {
if len(ftpd.Memo) == 0 {
return