evm: Adds Transceiver Payload V1 (#316)

Author: solanoepalacio

ci_tests/package-lock.json

@@ -182,16 +182,9 @@ contract WormholeTransceiver is
         TransceiverStructs.TransceiverInstruction memory instruction,
         bytes memory nttManagerMessage
     ) internal override {
-        (
-            TransceiverStructs.TransceiverMessage memory transceiverMessage,
-            bytes memory encodedTransceiverPayload
-        ) = TransceiverStructs.buildAndEncodeTransceiverMessage(
-            WH_TRANSCEIVER_PAYLOAD_PREFIX,
-            toWormholeFormat(caller),
-            recipientNttManagerAddress,
-            nttManagerMessage,
-            new bytes(0)
-        );
+        TransceiverStructs.TransceiverMessage memory transceiverMessage;
+        bytes memory encodedTransceiverPayload;
+        bytes32 wormholeFormattedCaller = toWormholeFormat(caller);
 
         WormholeTransceiverInstruction memory weIns =
             parseWormholeTransceiverInstruction(instruction.payload);
@@ -200,6 +193,15 @@ contract WormholeTransceiver is
             // NOTE: standard relaying supports refunds. The amount to be refunded will be sent
             // to a refundAddress specified by the client on the destination chain.
 
+            (transceiverMessage, encodedTransceiverPayload) = TransceiverStructs
+                .buildAndEncodeTransceiverMessage(
+                WH_TRANSCEIVER_PAYLOAD_PREFIX,
+                wormholeFormattedCaller,
+                recipientNttManagerAddress,
+                nttManagerMessage,
+                new bytes(0)
+            );
+
             // push onto the stack again to avoid stack too deep error
             bytes32 refundRecipient = refundAddress;
             uint16 destinationChain = recipientChain;
@@ -216,18 +218,49 @@ contract WormholeTransceiver is
 
             emit RelayingInfo(uint8(RelayingType.Standard), refundAddress, deliveryPayment);
         } else if (!weIns.shouldSkipRelayerSend && isSpecialRelayingEnabled(recipientChain)) {
+            // This transceiver payload is used to signal whether the message should be
+            // picked up by the special relayer or not:
+            //  - It only affects the off-chain special relayer.
+            //  - It is not used by the target NTT Manager contract.
+            // Transceiver payload is prefixed with 1 byte representing the version of
+            // the payload. The rest of the bytes are the -actual- payload data. In payload
+            // v1, the payload data is a boolean representing whether the message should
+            // be picked up by the special relayer or not.
+            bytes memory transceiverPayload = abi.encodePacked(uint8(1), true);
+            (transceiverMessage, encodedTransceiverPayload) = TransceiverStructs
+                .buildAndEncodeTransceiverMessage(
+                WH_TRANSCEIVER_PAYLOAD_PREFIX,
+                wormholeFormattedCaller,
+                recipientNttManagerAddress,
+                nttManagerMessage,
+                transceiverPayload
+            );
+
+            // push onto the stack again to avoid stack too deep error
+            uint256 deliveryFee = deliveryPayment;
+            uint16 destinationChain = recipientChain;
+
             uint256 wormholeFee = wormhole.messageFee();
             uint64 sequence = wormhole.publishMessage{value: wormholeFee}(
                 0, encodedTransceiverPayload, consistencyLevel
             );
-            specialRelayer.requestDelivery{value: deliveryPayment - wormholeFee}(
-                getNttManagerToken(), recipientChain, 0, sequence
+            specialRelayer.requestDelivery{value: deliveryFee - wormholeFee}(
+                getNttManagerToken(), destinationChain, 0, sequence
             );
 
             // NOTE: specialized relaying does not currently support refunds. The zero address
             // is used as a placeholder for the refund address until support is added.
-            emit RelayingInfo(uint8(RelayingType.Special), bytes32(0), deliveryPayment);
+            emit RelayingInfo(uint8(RelayingType.Special), bytes32(0), deliveryFee);
         } else {
+            (transceiverMessage, encodedTransceiverPayload) = TransceiverStructs
+                .buildAndEncodeTransceiverMessage(
+                WH_TRANSCEIVER_PAYLOAD_PREFIX,
+                wormholeFormattedCaller,
+                recipientNttManagerAddress,
+                nttManagerMessage,
+                new bytes(0)
+            );
+
             wormhole.publishMessage{value: deliveryPayment}(
                 0, encodedTransceiverPayload, consistencyLevel
             );

evm/src/Transceiver/WormholeTransceiver/WormholeTransceiver.sol

@@ -94,7 +94,7 @@ contract TestTransceiverStructs is Test {
             sourceNttManagerAddress: hex"042942FAFABE",
             recipientNttManagerAddress: hex"042942FABABE",
             nttManagerPayload: TransceiverStructs.encodeNttManagerMessage(mm),
-            transceiverPayload: new bytes(0)
+            transceiverPayload: hex"0101"
         });
 
         bytes memory encodedTransceiverMessage =

evm/test/TransceiverStructs.t.sol

@@ -1 +1 @@
-9945ff10042942fafabe0000000000000000000000000000000000000000000000000000042942fababe00000000000000000000000000000000000000000000000000000091128434bafe23430000000000000000000000000000000000ce00aa00000000004667921341234300000000000000000000000000000000000000000000000000004f994e545407000000000012d687beefface00000000000000000000000000000000000000000000000000000000feebcafe0000000000000000000000000000000000000000000000000000000000110000
+9945ff10042942fafabe0000000000000000000000000000000000000000000000000000042942fababe00000000000000000000000000000000000000000000000000000091128434bafe23430000000000000000000000000000000000ce00aa00000000004667921341234300000000000000000000000000000000000000000000000000004f994e545407000000000012d687beefface00000000000000000000000000000000000000000000000000000000feebcafe00000000000000000000000000000000000000000000000000000000001100020101

evm/test/payloads/transceiver_message_1.txt

@@ -232,7 +232,7 @@ mod test {
                     },
                 },
             },
-            transceiver_payload: vec![],
+            transceiver_payload: vec![0x01, 0x01],
         };
         assert_eq!(message, expected);
         assert_eq!(vec.len(), 0);