Merge branch 'main' into backlinks

Author: JoeHowarth

README.md

@@ -28,3 +28,4 @@ forge install wormhole-foundation/wormhole-solidity-sdk
     Look at [test/Fork.t.sol](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/test/Fork.t.sol#L16) for an example usage of Base
 - Included are also the ‘[TokenSender](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/src/WormholeRelayerSDK.sol#L79)’ and ‘[TokenReceiver](https://github.com/wormhole-foundation/wormhole-solidity-sdk/blob/main/src/WormholeRelayerSDK.sol#L186)’ base classes with helpers for smart contracts that wish to send and receive tokens using Wormhole’s TokenBridge. See ‘[HelloToken](https://github.com/wormhole-foundation/hello-token)’ for example usage.
 - Included are helpers that help set up a local forge testing environment. See ‘[HelloWormhole](https://github.com/wormhole-foundation/hello-wormhole)’ for example usage.
+**Note: This code is meant to be used as starter / reference code. Feel free to modify for use in your contracts, and also make sure to audit any code used from here as part of your contracts before deploying to mainnet.**

src/WormholeRelayerSDK.sol

@@ -163,24 +163,6 @@ abstract contract TokenSender is TokenBase {
             targetChain, targetAddress, payload, receiverValue, gasLimit, vaaKeys, refundChain, refundAddress
         );
     }
-
-    function forwardTokenWithPayloadToEvm(
-        uint16 targetChain,
-        address targetAddress,
-        bytes memory payload,
-        uint256 receiverValue,
-        uint256 gasLimit,
-        uint256 forwardMsgValue,
-        address token,
-        uint256 amount
-    ) internal {
-        VaaKey[] memory vaaKeys = new VaaKey[](1);
-        vaaKeys[0] = transferTokens(token, amount, targetChain, targetAddress);
-
-        wormholeRelayer.forwardVaasToEvm{value: forwardMsgValue}(
-            targetChain, targetAddress, payload, receiverValue, gasLimit, vaaKeys
-        );
-    }
 }
 
 abstract contract TokenReceiver is TokenBase {

src/interfaces/IWormholeReceiver.sol

@@ -17,7 +17,7 @@ interface IWormholeReceiver {
      *       on every call, checks that deliveryHash has not already been stored in the
      *       map (This is to prevent other users maliciously trying to relay the same message)
      *   - Checks that `sourceChain` and `sourceAddress` are indeed who
-     *       you expect to have requested the calling of `send` or `forward` on the source chain
+     *       you expect to have requested the calling of `send` on the source chain
      *
      * The invocation of this function corresponding to the `send` request will have msg.value equal
      *   to the receiverValue specified in the send request.

src/interfaces/IWormholeRelayer.sol

@@ -238,182 +238,6 @@ interface IWormholeRelayerSend is IWormholeRelayerBase {
         uint8 consistencyLevel
     ) external payable returns (uint64 sequence);
 
-    /**
-     * @notice Performs the same function as a `send`, except:
-     * 1)  Can only be used during a delivery (i.e. in execution of `receiveWormholeMessages`)
-     * 2)  Is paid for (along with any other calls to forward) by (any msg.value passed in) + (refund leftover from current delivery)
-     * 3)  Only executes after `receiveWormholeMessages` is completed (and thus does not return a sequence number)
-     *
-     * The refund from the delivery currently in progress will not be sent to the user; it will instead
-     * be paid to the delivery provider to perform the instruction specified here
-     *
-     * Publishes an instruction for the same delivery provider (or default, if the same one doesn't support the new target chain)
-     * to relay a payload to the address `targetAddress` on chain `targetChain`
-     * with gas limit `gasLimit` and with `msg.value` equal to `receiverValue`
-     *
-     * The following equation must be satisfied (sum_f indicates summing over all forwards requested in `receiveWormholeMessages`):
-     * (refund amount from current execution of receiveWormholeMessages) + sum_f [msg.value_f]
-     * >= sum_f [quoteEVMDeliveryPrice(targetChain_f, receiverValue_f, gasLimit_f)]
-     *
-     * The difference between the two sides of the above inequality will be added to `paymentForExtraReceiverValue` of the first forward requested
-     *
-     * Any refunds (from leftover gas) from this forward will be paid to the same refundChain and refundAddress specified for the current delivery.
-     *
-     * @param targetChain in Wormhole Chain ID format
-     * @param targetAddress address to call on targetChain (that implements IWormholeReceiver), in Wormhole bytes32 format
-     * @param payload arbitrary bytes to pass in as parameter in call to `targetAddress`
-     * @param receiverValue msg.value that delivery provider should pass in for call to `targetAddress` (in targetChain currency units)
-     * @param gasLimit gas limit with which to call `targetAddress`.
-     */
-    function forwardPayloadToEvm(
-        uint16 targetChain,
-        address targetAddress,
-        bytes memory payload,
-        uint256 receiverValue,
-        uint256 gasLimit
-    ) external payable;
-
-    /**
-     * @notice Performs the same function as a `send`, except:
-     * 1)  Can only be used during a delivery (i.e. in execution of `receiveWormholeMessages`)
-     * 2)  Is paid for (along with any other calls to forward) by (any msg.value passed in) + (refund leftover from current delivery)
-     * 3)  Only executes after `receiveWormholeMessages` is completed (and thus does not return a sequence number)
-     *
-     * The refund from the delivery currently in progress will not be sent to the user; it will instead
-     * be paid to the delivery provider to perform the instruction specified here
-     *
-     * Publishes an instruction for the same delivery provider (or default, if the same one doesn't support the new target chain)
-     * to relay a payload and VAAs specified by `vaaKeys` to the address `targetAddress` on chain `targetChain`
-     * with gas limit `gasLimit` and with `msg.value` equal to `receiverValue`
-     *
-     * The following equation must be satisfied (sum_f indicates summing over all forwards requested in `receiveWormholeMessages`):
-     * (refund amount from current execution of receiveWormholeMessages) + sum_f [msg.value_f]
-     * >= sum_f [quoteEVMDeliveryPrice(targetChain_f, receiverValue_f, gasLimit_f)]
-     *
-     * The difference between the two sides of the above inequality will be added to `paymentForExtraReceiverValue` of the first forward requested
-     *
-     * Any refunds (from leftover gas) from this forward will be paid to the same refundChain and refundAddress specified for the current delivery.
-     *
-     * @param targetChain in Wormhole Chain ID format
-     * @param targetAddress address to call on targetChain (that implements IWormholeReceiver), in Wormhole bytes32 format
-     * @param payload arbitrary bytes to pass in as parameter in call to `targetAddress`
-     * @param receiverValue msg.value that delivery provider should pass in for call to `targetAddress` (in targetChain currency units)
-     * @param gasLimit gas limit with which to call `targetAddress`.
-     * @param vaaKeys Additional VAAs to pass in as parameter in call to `targetAddress`
-     */
-    function forwardVaasToEvm(
-        uint16 targetChain,
-        address targetAddress,
-        bytes memory payload,
-        uint256 receiverValue,
-        uint256 gasLimit,
-        VaaKey[] memory vaaKeys
-    ) external payable;
-
-    /**
-     * @notice Performs the same function as a `send`, except:
-     * 1)  Can only be used during a delivery (i.e. in execution of `receiveWormholeMessages`)
-     * 2)  Is paid for (along with any other calls to forward) by (any msg.value passed in) + (refund leftover from current delivery)
-     * 3)  Only executes after `receiveWormholeMessages` is completed (and thus does not return a sequence number)
-     *
-     * The refund from the delivery currently in progress will not be sent to the user; it will instead
-     * be paid to the delivery provider to perform the instruction specified here
-     *
-     * Publishes an instruction for the delivery provider at `deliveryProviderAddress`
-     * to relay a payload and VAAs specified by `vaaKeys` to the address `targetAddress` on chain `targetChain`
-     * with gas limit `gasLimit` and with `msg.value` equal to
-     * receiverValue + (arbitrary amount that is paid for by paymentForExtraReceiverValue of this chain's wei) in targetChain wei.
-     *
-     * Any refunds (from leftover gas) will be sent to `refundAddress` on chain `refundChain`
-     * `targetAddress` must implement the IWormholeReceiver interface
-     *
-     * The following equation must be satisfied (sum_f indicates summing over all forwards requested in `receiveWormholeMessages`):
-     * (refund amount from current execution of receiveWormholeMessages) + sum_f [msg.value_f]
-     * >= sum_f [quoteEVMDeliveryPrice(targetChain_f, receiverValue_f, gasLimit_f, deliveryProviderAddress_f) + paymentForExtraReceiverValue_f]
-     *
-     * The difference between the two sides of the above inequality will be added to `paymentForExtraReceiverValue` of the first forward requested
-     *
-     * @param targetChain in Wormhole Chain ID format
-     * @param targetAddress address to call on targetChain (that implements IWormholeReceiver), in Wormhole bytes32 format
-     * @param payload arbitrary bytes to pass in as parameter in call to `targetAddress`
-     * @param receiverValue msg.value that delivery provider should pass in for call to `targetAddress` (in targetChain currency units)
-     * @param paymentForExtraReceiverValue amount (in current chain currency units) to spend on extra receiverValue
-     *        (in addition to the `receiverValue` specified)
-     * @param gasLimit gas limit with which to call `targetAddress`. Any units of gas unused will be refunded according to the
-     *        `targetChainRefundPerGasUnused` rate quoted by the delivery provider
-     * @param refundChain The chain to deliver any refund to, in Wormhole Chain ID format
-     * @param refundAddress The address on `refundChain` to deliver any refund to, in Wormhole bytes32 format
-     * @param deliveryProviderAddress The address of the desired delivery provider's implementation of IDeliveryProvider
-     * @param vaaKeys Additional VAAs to pass in as parameter in call to `targetAddress`
-     * @param consistencyLevel Consistency level with which to publish the delivery instructions - see
-     *        https://book.wormhole.com/wormhole/3_coreLayerContracts.html?highlight=consistency#consistency-levels
-     */
-    function forwardToEvm(
-        uint16 targetChain,
-        address targetAddress,
-        bytes memory payload,
-        uint256 receiverValue,
-        uint256 paymentForExtraReceiverValue,
-        uint256 gasLimit,
-        uint16 refundChain,
-        address refundAddress,
-        address deliveryProviderAddress,
-        VaaKey[] memory vaaKeys,
-        uint8 consistencyLevel
-    ) external payable;
-
-    /**
-     * @notice Performs the same function as a `send`, except:
-     * 1)  Can only be used during a delivery (i.e. in execution of `receiveWormholeMessages`)
-     * 2)  Is paid for (along with any other calls to forward) by (any msg.value passed in) + (refund leftover from current delivery)
-     * 3)  Only executes after `receiveWormholeMessages` is completed (and thus does not return a sequence number)
-     *
-     * The refund from the delivery currently in progress will not be sent to the user; it will instead
-     * be paid to the delivery provider to perform the instruction specified here
-     *
-     * Publishes an instruction for the delivery provider at `deliveryProviderAddress`
-     * to relay a payload and VAAs specified by `vaaKeys` to the address `targetAddress` on chain `targetChain`
-     * with `msg.value` equal to
-     * receiverValue + (arbitrary amount that is paid for by paymentForExtraReceiverValue of this chain's wei) in targetChain wei.
-     *
-     * Any refunds (from leftover gas) will be sent to `refundAddress` on chain `refundChain`
-     * `targetAddress` must implement the IWormholeReceiver interface
-     *
-     * The following equation must be satisfied (sum_f indicates summing over all forwards requested in `receiveWormholeMessages`):
-     * (refund amount from current execution of receiveWormholeMessages) + sum_f [msg.value_f]
-     * >= sum_f [quoteDeliveryPrice(targetChain_f, receiverValue_f, encodedExecutionParameters_f, deliveryProviderAddress_f) + paymentForExtraReceiverValue_f]
-     *
-     * The difference between the two sides of the above inequality will be added to `paymentForExtraReceiverValue` of the first forward requested
-     *
-     * @param targetChain in Wormhole Chain ID format
-     * @param targetAddress address to call on targetChain (that implements IWormholeReceiver), in Wormhole bytes32 format
-     * @param payload arbitrary bytes to pass in as parameter in call to `targetAddress`
-     * @param receiverValue msg.value that delivery provider should pass in for call to `targetAddress` (in targetChain currency units)
-     * @param paymentForExtraReceiverValue amount (in current chain currency units) to spend on extra receiverValue
-     *        (in addition to the `receiverValue` specified)
-     * @param encodedExecutionParameters encoded information on how to execute delivery that may impact pricing
-     *        e.g. for version EVM_V1, this is a struct that encodes the `gasLimit` with which to call `targetAddress`
-     * @param refundChain The chain to deliver any refund to, in Wormhole Chain ID format
-     * @param refundAddress The address on `refundChain` to deliver any refund to, in Wormhole bytes32 format
-     * @param deliveryProviderAddress The address of the desired delivery provider's implementation of IDeliveryProvider
-     * @param vaaKeys Additional VAAs to pass in as parameter in call to `targetAddress`
-     * @param consistencyLevel Consistency level with which to publish the delivery instructions - see
-     *        https://book.wormhole.com/wormhole/3_coreLayerContracts.html?highlight=consistency#consistency-levels
-     */
-    function forward(
-        uint16 targetChain,
-        bytes32 targetAddress,
-        bytes memory payload,
-        uint256 receiverValue,
-        uint256 paymentForExtraReceiverValue,
-        bytes memory encodedExecutionParameters,
-        uint16 refundChain,
-        bytes32 refundAddress,
-        address deliveryProviderAddress,
-        VaaKey[] memory vaaKeys,
-        uint8 consistencyLevel
-    ) external payable;
-
     /**
      * @notice Requests a previously published delivery instruction to be redelivered
      * (e.g. with a different delivery provider)
@@ -561,9 +385,7 @@ interface IWormholeRelayerSend is IWormholeRelayerBase {
 interface IWormholeRelayerDelivery is IWormholeRelayerBase {
     enum DeliveryStatus {
         SUCCESS,
-        RECEIVER_FAILURE,
-        FORWARD_REQUEST_FAILURE,
-        FORWARD_REQUEST_SUCCESS
+        RECEIVER_FAILURE
     }
 
     enum RefundStatus {
@@ -585,16 +407,11 @@ interface IWormholeRelayerDelivery is IWormholeRelayerBase {
      * @custom:member gasUsed - The amount of gas that was used to call your target contract
      * @custom:member status:
      *   - RECEIVER_FAILURE, if the target contract reverts
-     *   - SUCCESS, if the target contract doesn't revert and no forwards were requested
-     *   - FORWARD_REQUEST_FAILURE, if the target contract doesn't revert, forwards were requested,
-     *       but provided/leftover funds were not sufficient to cover them all
-     *   - FORWARD_REQUEST_SUCCESS, if the target contract doesn't revert and all forwards are covered
+     *   - SUCCESS, if the target contract doesn't revert 
      * @custom:member additionalStatusInfo:
-     *   - If status is SUCCESS or FORWARD_REQUEST_SUCCESS, then this is empty.
+     *   - If status is SUCCESS, then this is empty.
      *   - If status is RECEIVER_FAILURE, this is `RETURNDATA_TRUNCATION_THRESHOLD` bytes of the
      *       return data (i.e. potentially truncated revert reason information).
-     *   - If status is FORWARD_REQUEST_FAILURE, this is also the revert data - the reason the forward failed.
-     *     This will be either an encoded Cancelled, DeliveryProviderReverted, or DeliveryProviderPaymentFailed error
      * @custom:member refundStatus - Result of the refund. REFUND_SUCCESS or REFUND_FAIL are for
      *     refunds where targetChain=refundChain; the others are for targetChain!=refundChain,
      *     where a cross chain refund is necessary
@@ -663,13 +480,8 @@ error RequestedGasLimitTooLow();
 error DeliveryProviderDoesNotSupportTargetChain(address relayer, uint16 chainId);
 error DeliveryProviderCannotReceivePayment();
 
-//When calling `forward()` on the WormholeRelayer if no delivery is in progress
-error NoDeliveryInProgress();
 //When calling `delivery()` a second time even though a delivery is already in progress
 error ReentrantDelivery(address msgSender, address lockedBy);
-//When any other contract but the delivery target calls `forward()` on the WormholeRelayer while a
-//  delivery is in progress
-error ForwardRequestFromWrongAddress(address msgSender, address deliveryTarget);
 
 error InvalidPayloadId(uint8 parsed, uint8 expected);
 error InvalidPayloadLength(uint256 received, uint256 expected);
@@ -687,7 +499,6 @@ error RequesterNotWormholeRelayer();
 
 //When trying to relay a `DeliveryInstruction` to any other chain but the one it was specified for
 error TargetChainIsNotThisChain(uint16 targetChain);
-error ForwardNotSufficientlyFunded(uint256 amountOfFunds, uint256 amountOfFundsNeeded);
 //When a `DeliveryOverride` contains a gas limit that's less than the original
 error InvalidOverrideGasLimit();
 //When a `DeliveryOverride` contains a receiver value that's less than the original

src/testing/WormholeRelayerTest.sol

@@ -309,7 +309,7 @@ abstract contract WormholeRelayerTest is Test {
         chainInfosMainnet[24] = ChainInfo({
             chainId: 24,
             name: "optimism",
-            url: "https://rpc.ankr.com/arbitrum",
+            url: "https://rpc.ankr.com/optimism",
             relayer: IWormholeRelayer(0x27428DD2d3DD32A4D7f7C497eAaa23130d894911),
             tokenBridge: ITokenBridge(0x1D68124e65faFC907325e3EDbF8c4d84499DAa8b),
             wormhole: IWormhole(0xEe91C335eab126dF5fDB3797EA9d6aD93aeC9722)