wip

Author: patricios-space

contracts/contracts/ccip/ccipsend_executor/contract.tolk

@@ -1,3 +1,5 @@
+import "@stdlib/gas-payments"
+
 import "types"
 import "messages"
 import "storage"
@@ -7,10 +9,8 @@ import "../onramp/messages"
 import "../../lib/utils"
 import "../router/messages"
 import "../fee_quoter/types"
-import "@stdlib/gas-payments"
-import "../common/types"
 import "../token_registry/messages"
-import "../pools/messages"
+import "../lib/token_pool/messages"
 
 tolk 1.4.1
 

contracts/contracts/ccip/ccipsend_executor/messages.tolk

@@ -2,7 +2,7 @@ import "types"
 import "../onramp/messages"
 import "../fee_quoter/messages"
 import "../token_registry/messages"
-import "../pools/messages"
+import "../lib/token_pool/messages"
 
 type CCIPSendExecutor_InMessage =
     | CCIPSendExecutor_Execute

contracts/contracts/ccip/lib/token_pool/messages.tolk

@@ -0,0 +1,24 @@
+import "../../common/types"
+
+type TokenPool_InMessage =
+    | TokenPool_LockOrBurn
+    | TokenPool_ReleaseOrMint
+    ;
+
+/// Incoming messages
+
+struct (0x7dd8f942) TokenPool_LockOrBurn {
+	tokenAmount: TokenAmount, // TODO LockOrBurn doesn't need to know the token address
+	notify: address,
+}
+
+struct (0x351f77e3) TokenPool_ReleaseOrMint {
+	amount: coins,
+	notify: address,
+}
+
+/// Outgoing messages
+
+struct (0x4c700579) TokenPool_NotifySuccessfulLockOrBurn {}
+
+struct (0xd001f083) TokenPool_NotifySuccessfulReleaseOrMint {}

contracts/contracts/ccip/offramp/contract.tolk

@@ -800,6 +800,8 @@ fun onExecuteValidated(st: Storage, msg: OffRamp_ExecuteValidated, sender: addre
 
     val executorAddress: AutoDeployAddress = getReceiverExecutorDeployAddress(st, execId);
 
+    val tokenAdminRegistry = getTokenAdminRegistry(st, message.tokenAmounts);
+
     // Check if this is the first time the exec flow is running given that in that case we need to
     // initialize the executor
     if (msg.executionState == ExecutionState.Untouched) {
@@ -815,6 +817,7 @@ fun onExecuteValidated(st: Storage, msg: OffRamp_ExecuteValidated, sender: addre
                         message: message.toCell(),
                         root: sender,
                         execId,
+                        tokenAdminRegistry,
                     }.toCell(),
                 }
             },
@@ -838,6 +841,32 @@ fun onExecuteValidated(st: Storage, msg: OffRamp_ExecuteValidated, sender: addre
     initExecMsg.send(SEND_MODE_PAY_FEES_SEPARATELY);
 }
 
+fun getTokenAdminRegistry(st: Storage, tokenAmounts: SnakedCell<Any2TVMTokenTransfer>?): Cell<address>? {
+    if (tokenAmounts == null) {
+        return null;
+    }
+    val tokenTransfer = tokenAmounts.getTokenTransfer(Error.UnsupportedNumberOfTokens);
+    val registryAddress = getTokenRegistryDeployAddress(st, tokenTransfer.token).calculateAddress();
+    return registryAddress.toCell();
+}
+
+// TODO duplicated from Router
+/*
+Derives the token registry contract address from the token address
+*/
+fun getTokenRegistryDeployAddress(st: Storage, tokenAddress: address): AutoDeployAddress {
+    return {
+        stateInit: {
+            code: st.deployables.load().deployer,
+            data: NamespacedDeployableData({
+                namespace: DeployableNamespace_TokenRegistry,
+                owner: contract.getAddress(),
+                id: tokenAddress,
+            }),
+        }
+    }
+}
+
 /*
 Retrieves the Router address associated with a given sourceChainSelector.
 Throws an error if the source chain is not enabled in the stored configs.

contracts/contracts/ccip/offramp/errors.tolk

@@ -20,4 +20,5 @@ enum Error {
     OnRampAddressMismatch
     EmptyCommitReport
     MerkleRootCannotBeZero
+    UnsupportedNumberOfTokens
 }

contracts/contracts/ccip/offramp/types.tolk

@@ -66,6 +66,15 @@ struct Any2TVMRampMessage {
     // maybe mark these amounts as slice remaining then parse them by hand to avoid requiring this to be a map<> at send time?
 }
 
+// Helper to extract the single token transfer from the message, and assert that there is only one token transfer
+fun SnakedCell<Any2TVMTokenTransfer>.getTokenTransfer(self, error: int): Any2TVMTokenTransfer {
+    var it = self.iter();
+    assert (!it.empty(), error);
+    val token = it.next();
+    assert (it.empty(), error);
+    return token
+}
+
 fun Any2TVMRampMessage.generateMessageId(self, metadataHash: uint256): uint256 {
     // Loosely based on https://github.com/smartcontractkit/chainlink-ccip/blob/2d2ce6abb3f7626dbd3008e4232da4faa839feff/chains/evm/contracts/libraries/Internal.sol#L113-L134
     return beginCell()
@@ -99,10 +108,10 @@ struct MerkleRoot {
 
 struct Any2TVMTokenTransfer {
     sourcePoolAddress: Cell<CrossChainAddress>;
-    destPoolAddress: address;
-    destGasAmount: uint32;
+    token: address;
+    destGasAmount: uint32; // TBD: This field was removed in CCIP 2.0 and it's purpose/utility in TON is unclear.
     extraData: cell;
-    amount: uint256;
+    amount: coins; // TBD: Does this change break any message ID we set in the past? It would but we didn't support token transfers then
 }
 
 struct OffRamp_Deployables {

contracts/contracts/ccip/pools/messages.tolk

@@ -6,14 +6,16 @@ import "types"
 import "errors"
 import "../offramp/messages"
 import "../../lib/utils"
+import "../lib/token_pool/messages"
+import "../token_registry/messages"
 
 tolk 1.4.1
 
-const CONTRACT_VERSION = "1.6.2".literalSlice();
+const CONTRACT_VERSION = "1.7.0".literalSlice();
 
 contract ReceiveExecutor {
     author: "SmartContract Chainlink Limited SEZC"
-    version: "1.6.2"
+    version: "1.7.0"
     description: "link.chain.ton.ccip.ReceiveExecutor"
 
     storage: ReceiveExecutor_Storage
@@ -37,6 +39,16 @@ fun onInternalMessage(in: InMessage) {
             onCCIPReceiveConfirm(mutate st, msg);
             st.store();
         }
+        // Sender must be the TokenAdminRegistry
+        TokenRegistry_ReturnTokenInfo => {
+            var st = ReceiveExecutor_Storage.load();
+            assert(st.tokenAdminRegistry != null, Error.Unauthorized);
+            val tokenAdminRegistry = st.tokenAdminRegistry.load();
+            assert(in.senderAddress == tokenAdminRegistry, Error.Unauthorized);
+            assert(st.state == ReceiveExecutor_MessageState.TokenAdminRegistryQuery, Error.TokenAdminRegistryUnexpectedResponse);
+            onTokenAdminRegistryResponse(mutate st, msg);
+            st.store();
+        }
         // Sender must be the owner (OffRamp)
         ReceiveExecutor_Bounced => {
             var st = ReceiveExecutor_Storage.load();
@@ -52,11 +64,49 @@ fun onInternalMessage(in: InMessage) {
 }
 
 fun onInitExecute(mutate st: ReceiveExecutor_Storage, msg: ReceiveExecutor_InitExecute) {
-    st.lastExecutionTimestamp = blockchain.now();
+    if (st.tokenAdminRegistry != null) {
+        return queryTokenAdminRegistry(mutate st, st.tokenAdminRegistry!.load());
+    }
     execute(mutate st, msg.gasOverride);
 }
 
+fun queryTokenAdminRegistry(mutate st: ReceiveExecutor_Storage, tokenAdminRegistry: address) {
+    st.state = ReceiveExecutor_MessageState.TokenAdminRegistryQuery;
+    createMessage(
+        {
+            bounce: true,
+            value: 0,
+            dest: tokenAdminRegistry,
+            body: TokenRegistry_GetTokenInfo {
+            }
+        }
+    ).send(SEND_MODE_CARRY_ALL_REMAINING_MESSAGE_VALUE);
+}
+
+fun onTokenAdminRegistryResponse(mutate st: ReceiveExecutor_Storage, msg: TokenRegistry_ReturnTokenInfo) {
+    val rampMsg = lazy st.message.load();
+    assert (rampMsg.tokenAmounts != null) throw Error.NoTokenAmountsInMessage;
+    val token = rampMsg.tokenAmounts.getTokenTransfer(Error.UnsupportedNumberOfTokens);
+    releaseOrMint(mutate st, token);
+}
+
+fun releaseOrMint(mutate st: ReceiveExecutor_Storage, tokenAmount: Any2TVMTokenTransfer) {
+    st.state = ReceiveExecutor_MessageState.TokenTransfer;
+    createMessage(
+        {
+            bounce: true,
+            value: 0, // TBD should we be using tokenAmoun.destGasAmount instead? It's not clear what this field is for in TON, and it was removed in CCIP 2.0
+            dest: tokenAmount.token,
+            body: TokenPool_ReleaseOrMint {
+                amount: tokenAmount.amount,    
+                notify: contract.getAddress(),
+            }
+        }
+    ).send(SEND_MODE_CARRY_ALL_REMAINING_MESSAGE_VALUE);
+}
+
 fun execute(mutate st: ReceiveExecutor_Storage, gasOverride: coins?) {
+    st.lastExecutionTimestamp = blockchain.now();
     st.state = ReceiveExecutor_MessageState.Execute;
     createMessage(
         {

contracts/contracts/ccip/receive_executor/contract.tolk

@@ -6,4 +6,7 @@ enum Error {
     UpdatingStateOfNonExecutedMessage
     NotificationFromInvalidReceiver
     Unauthorized
+    UnsupportedNumberOfTokens
+    NoTokenAmountsInMessage
+    TokenAdminRegistryUnexpectedResponse
 }

contracts/contracts/ccip/receive_executor/errors.tolk

@@ -1,10 +1,13 @@
 // SPDX-License-Identifier: BUSL-1.1
 import "../offramp/messages"
+import "../token_registry/messages"
 
 type ReceiveExecutor_InMessage =
     | ReceiveExecutor_InitExecute
     | ReceiveExecutor_Bounced
-    | ReceiveExecutor_Confirm;
+    | ReceiveExecutor_Confirm
+    | TokenRegistry_ReturnTokenInfo
+    ;
 
 struct (0x64cd2fd2) ReceiveExecutor_InitExecute {
     gasOverride: coins? = null;