Finishing touches (#91)

* minor improvements and unification

* add missing message fee value when attesting a token

* revert message fee docs in interface and fix handling in demo integration

Author: nonergodic

README.md

@@ -48,7 +48,7 @@ This SDK largely follows [the Solidity style guide](https://docs.soliditylang.or
 * indentation uses 2 instead of 4 spaces
 * maximum line length where feasible is 100 characters (urls in comments are an exception)
 * [order of functions](https://docs.soliditylang.org/en/latest/style-guide.html) is roughly followed but more important functions might be sorted to the top.
-* additional whitespace are at times added to create more compelling visual blocks (e.g. for a block of related assignments)
+* additional whitespace is at times added to create more compelling visual blocks (e.g. for a block of related assignments)
 * function modifiers do not get a separate line each once line length is exceeded
 * NatSpec is avoided because it favors a "box-checking" approach towards documentation rather than focusing on essentials and rationales
 

gen/utils.ts

@@ -1,8 +1,6 @@
+const LOWER_TO_UPPER = /([a-z])([A-Z])/g;
+
 export function toCapsSnakeCase(identifier: string) {
-  return identifier.split('').map((char, index) =>
-    (  char === char.toUpperCase() //insert underscore before uppercase letters
-    && char !== char.toLowerCase() //don't insert underscore before numbers
-    && index !== 0                 //don't insert underscore at the beginning
-    ) ? '_' + char : char.toUpperCase()
-  ).join('');
+  //insert underscore between lowercase and uppercase letters and then capitalize all
+  return identifier.replace(LOWER_TO_UPPER, '$1_$2').toUpperCase();
 }

src/RawDispatcher.sol

@@ -1,5 +1,4 @@
 // SPDX-License-Identifier: Apache 2
-
 pragma solidity ^0.8.0;
 
 //TL;DR:

src/constants/Chains.sol

@@ -7,16 +7,11 @@ pragma solidity ^0.8.0;
 uint16 constant CHAIN_ID_UNSET = 0;
 uint16 constant CHAIN_ID_SOLANA = 1;
 uint16 constant CHAIN_ID_ETHEREUM = 2;
-uint16 constant CHAIN_ID_TERRA = 3;
 uint16 constant CHAIN_ID_BSC = 4;
 uint16 constant CHAIN_ID_POLYGON = 5;
 uint16 constant CHAIN_ID_AVALANCHE = 6;
-uint16 constant CHAIN_ID_OASIS = 7;
 uint16 constant CHAIN_ID_ALGORAND = 8;
-uint16 constant CHAIN_ID_AURORA = 9;
 uint16 constant CHAIN_ID_FANTOM = 10;
-uint16 constant CHAIN_ID_KARURA = 11;
-uint16 constant CHAIN_ID_ACALA = 12;
 uint16 constant CHAIN_ID_KLAYTN = 13;
 uint16 constant CHAIN_ID_CELO = 14;
 uint16 constant CHAIN_ID_NEAR = 15;
@@ -31,7 +26,6 @@ uint16 constant CHAIN_ID_ARBITRUM = 23;
 uint16 constant CHAIN_ID_OPTIMISM = 24;
 uint16 constant CHAIN_ID_GNOSIS = 25;
 uint16 constant CHAIN_ID_PYTHNET = 26;
-uint16 constant CHAIN_ID_XPLA = 28;
 uint16 constant CHAIN_ID_BTC = 29;
 uint16 constant CHAIN_ID_BASE = 30;
 uint16 constant CHAIN_ID_SEI = 32;
@@ -46,7 +40,7 @@ uint16 constant CHAIN_ID_SNAXCHAIN = 43;
 uint16 constant CHAIN_ID_UNICHAIN = 44;
 uint16 constant CHAIN_ID_WORLDCHAIN = 45;
 uint16 constant CHAIN_ID_INK = 46;
-uint16 constant CHAIN_ID_HYPER_E_V_M = 47;
+uint16 constant CHAIN_ID_HYPER_EVM = 47;
 uint16 constant CHAIN_ID_MONAD = 48;
 uint16 constant CHAIN_ID_MEZO = 50;
 uint16 constant CHAIN_ID_SONIC = 52;

src/constants/Common.sol

@@ -14,4 +14,4 @@ uint256 constant WORD_SIZE_PLUS_ONE = 33;
 uint256 constant SCRATCH_SPACE_PTR = 0x00;
 uint256 constant SCRATCH_SPACE_SIZE = 64;
 
-uint256 constant FREE_MEMORY_PTR = 0x40;
+uint256 constant FREE_MEMORY_PTR = 0x40;

src/interfaces/IDeliveryProvider.sol

@@ -1,5 +1,4 @@
 // SPDX-License-Identifier: Apache 2
-
 pragma solidity ^0.8.0;
 
 interface IDeliveryProvider {

src/interfaces/IWormholeRelayer.sol

@@ -1,6 +1,10 @@
 // SPDX-License-Identifier: Apache 2
 pragma solidity ^0.8.0;
 
+// ╭──────────────────────────────────────────────────────────────╮
+// │ Prefer using WormholeRelayer.sol over the raw interface here │
+// ╰──────────────────────────────────────────────────────────────╯
+
 struct MessageKey {
   uint8 keyType; // 0-127 are reserved for standardized KeyTypes, 128-255 are for custom use
   bytes encodedKey; //all key types except VaaKeys are encoded with a 4 byte length prefix
@@ -44,8 +48,7 @@ interface IWormholeRelayerSend {
    *
    * `targetAddress` must implement the IWormholeReceiver interface
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
-   * `quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit)`
+   * This function must be called with `msg.value` equal to `quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit)`
    *
    * Any refunds (from leftover gas) will be paid to the delivery provider. In order to receive the refunds, use the `sendPayloadToEvm` function
    * with `refundChain` and `refundAddress` as parameters
@@ -73,8 +76,7 @@ interface IWormholeRelayerSend {
    * Any refunds (from leftover gas) will be sent to `refundAddress` on chain `refundChain`
    * `targetAddress` must implement the IWormholeReceiver interface
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
-   * `quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit)`
+   * This function must be called with `msg.value` equal to `quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit)`
    *
    * @param targetChain in Wormhole Chain ID format
    * @param targetAddress address to call on targetChain (that implements IWormholeReceiver)
@@ -103,8 +105,7 @@ interface IWormholeRelayerSend {
    *
    * `targetAddress` must implement the IWormholeReceiver interface
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
-   * `quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit)`
+   * This function must be called with `msg.value` equal to `quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit)`
    *
    * Any refunds (from leftover gas) will be paid to the delivery provider. In order to receive the refunds, use the `sendVaasToEvm` function
    * with `refundChain` and `refundAddress` as parameters
@@ -134,8 +135,7 @@ interface IWormholeRelayerSend {
    * Any refunds (from leftover gas) will be sent to `refundAddress` on chain `refundChain`
    * `targetAddress` must implement the IWormholeReceiver interface
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
-   * `quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit)`
+   * This function must be called with `msg.value` equal to `quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit)`
    *
    * @param targetChain in Wormhole Chain ID format
    * @param targetAddress address to call on targetChain (that implements IWormholeReceiver)
@@ -168,7 +168,7 @@ interface IWormholeRelayerSend {
    * Any refunds (from leftover gas) will be sent to `refundAddress` on chain `refundChain`
    * `targetAddress` must implement the IWormholeReceiver interface
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
+   * This function must be called with `msg.value` equal to
    * quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit, deliveryProviderAddress) + paymentForExtraReceiverValue
    *
    * @param targetChain in Wormhole Chain ID format
@@ -210,7 +210,7 @@ interface IWormholeRelayerSend {
    * Any refunds (from leftover gas) will be sent to `refundAddress` on chain `refundChain`
    * `targetAddress` must implement the IWormholeReceiver interface
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
+   * This function must be called with `msg.value` equal to
    * quoteEVMDeliveryPrice(targetChain, receiverValue, gasLimit, deliveryProviderAddress) + paymentForExtraReceiverValue
    *
    * Note: MessageKeys can specify wormhole messages (VaaKeys) or other types of messages (ex. USDC CCTP attestations). Ensure the selected
@@ -255,7 +255,7 @@ interface IWormholeRelayerSend {
    * Any refunds (from leftover gas) will be sent to `refundAddress` on chain `refundChain`
    * `targetAddress` must implement the IWormholeReceiver interface
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
+   * This function must be called with `msg.value` equal to
    * quoteDeliveryPrice(targetChain, receiverValue, encodedExecutionParameters, deliveryProviderAddress) + paymentForExtraReceiverValue
    *
    * @param targetChain in Wormhole Chain ID format
@@ -297,7 +297,7 @@ interface IWormholeRelayerSend {
    * Any refunds (from leftover gas) will be sent to `refundAddress` on chain `refundChain`
    * `targetAddress` must implement the IWormholeReceiver interface
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
+   * This function must be called with `msg.value` equal to
    * quoteDeliveryPrice(targetChain, receiverValue, encodedExecutionParameters, deliveryProviderAddress) + paymentForExtraReceiverValue
    *
    * Note: MessageKeys can specify wormhole messages (VaaKeys) or other types of messages (ex. USDC CCTP attestations). Ensure the selected
@@ -337,7 +337,7 @@ interface IWormholeRelayerSend {
    * @notice Requests a previously published delivery instruction to be redelivered
    * (e.g. with a different delivery provider)
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
+   * This function must be called with `msg.value` equal to
    * quoteEVMDeliveryPrice(targetChain, newReceiverValue, newGasLimit, newDeliveryProviderAddress)
    *
    *  @notice *** This will only be able to succeed if the following is true **
@@ -370,7 +370,7 @@ interface IWormholeRelayerSend {
    * @notice Requests a previously published delivery instruction to be redelivered
    *
    *
-   * This function must be called with `msg.value` equal to wormholeMessageFee +
+   * This function must be called with `msg.value` equal to
    * quoteDeliveryPrice(targetChain, newReceiverValue, newEncodedExecutionParameters, newDeliveryProviderAddress)
    *
    * @param deliveryVaaKey VaaKey identifying the wormhole message containing the

src/interfaces/token/IERC20.sol

@@ -1,5 +1,4 @@
 // SPDX-License-Identifier: Apache 2
-
 pragma solidity ^0.8.0;
 
 //https://eips.ethereum.org/EIPS/eip-20

src/interfaces/token/IERC20Metadata.sol

@@ -1,5 +1,4 @@
 // SPDX-License-Identifier: Apache 2
-
 pragma solidity ^0.8.0;
 
 import "IERC20/IERC20.sol";

src/interfaces/token/IERC20Permit.sol

@@ -1,5 +1,4 @@
 // SPDX-License-Identifier: Apache 2
-
 pragma solidity ^0.8.0;
 
 import "IERC20/IERC20.sol";