L-02 No Ability to Specify the Initial _minTeleporterVersion (#268)

ava-labs · Aug 30, 2024 · 9298626 · 9298626
2 parents 4955f22 + 684f3cb
commit 9298626
Show file tree

Hide file tree

Showing 27 changed files with 207 additions and 133 deletions.
diff --git a/abi-bindings/go/TokenHome/ERC20TokenHome/ERC20TokenHome.go b/abi-bindings/go/TokenHome/ERC20TokenHome/ERC20TokenHome.go
diff --git a/abi-bindings/go/TokenHome/ERC20TokenHomeUpgradeable/ERC20TokenHomeUpgradeable.go b/abi-bindings/go/TokenHome/ERC20TokenHomeUpgradeable/ERC20TokenHomeUpgradeable.go
diff --git a/abi-bindings/go/TokenHome/NativeTokenHome/NativeTokenHome.go b/abi-bindings/go/TokenHome/NativeTokenHome/NativeTokenHome.go
diff --git a/abi-bindings/go/TokenHome/NativeTokenHomeUpgradeable/NativeTokenHomeUpgradeable.go b/abi-bindings/go/TokenHome/NativeTokenHomeUpgradeable/NativeTokenHomeUpgradeable.go
diff --git a/abi-bindings/go/TokenRemote/ERC20TokenRemote/ERC20TokenRemote.go b/abi-bindings/go/TokenRemote/ERC20TokenRemote/ERC20TokenRemote.go
diff --git a/abi-bindings/go/TokenRemote/ERC20TokenRemoteUpgradeable/ERC20TokenRemoteUpgradeable.go b/abi-bindings/go/TokenRemote/ERC20TokenRemoteUpgradeable/ERC20TokenRemoteUpgradeable.go
diff --git a/abi-bindings/go/TokenRemote/NativeTokenRemote/NativeTokenRemote.go b/abi-bindings/go/TokenRemote/NativeTokenRemote/NativeTokenRemote.go
diff --git a/abi-bindings/go/TokenRemote/NativeTokenRemoteUpgradeable/NativeTokenRemoteUpgradeable.go b/abi-bindings/go/TokenRemote/NativeTokenRemoteUpgradeable/NativeTokenRemoteUpgradeable.go
diff --git a/contracts/lib/teleporter b/contracts/lib/teleporter
diff --git a/contracts/src/TokenHome/ERC20TokenHome.sol b/contracts/src/TokenHome/ERC20TokenHome.sol
@@ -17,9 +17,16 @@ contract ERC20TokenHome is ERC20TokenHomeUpgradeable {
     constructor(
         address teleporterRegistryAddress,
         address teleporterManager,
+        uint256 minTeleporterVersion,
         address tokenAddress,
         uint8 tokenDecimals
     ) ERC20TokenHomeUpgradeable(ICTTInitializable.Allowed) {
-        initialize(teleporterRegistryAddress, teleporterManager, tokenAddress, tokenDecimals);
+        initialize(
+            teleporterRegistryAddress,
+            teleporterManager,
+            minTeleporterVersion,
+            tokenAddress,
+            tokenDecimals
+        );
     }
 }
diff --git a/contracts/src/TokenHome/ERC20TokenHomeUpgradeable.sol b/contracts/src/TokenHome/ERC20TokenHomeUpgradeable.sol
@@ -68,28 +68,41 @@ contract ERC20TokenHomeUpgradeable is IERC20TokenHome, TokenHome {
      * address. See here for details: https://github.com/ava-labs/teleporter/tree/main/contracts/teleporter/registry
      * @param teleporterManager Address that manages this contract's integration with the
      * Teleporter registry and Teleporter versions.
+     * @param minTeleporterVersion Minimum Teleporter version supported by this contract.
      * @param tokenAddress The ERC20 token contract address to be transferred by the home.
      * @param tokenDecimals The number of decimals for the ERC20 token
      */
     function initialize(
         address teleporterRegistryAddress,
         address teleporterManager,
+        uint256 minTeleporterVersion,
         address tokenAddress,
         uint8 tokenDecimals
     ) public initializer {
         __ERC20TokenHome_init(
-            teleporterRegistryAddress, teleporterManager, tokenAddress, tokenDecimals
+            teleporterRegistryAddress,
+            teleporterManager,
+            minTeleporterVersion,
+            tokenAddress,
+            tokenDecimals
         );
     }
 
     // solhint-disable-next-line func-name-mixedcase
     function __ERC20TokenHome_init(
         address teleporterRegistryAddress,
         address teleporterManager,
+        uint256 minTeleporterVersion,
         address tokenAddress,
         uint8 tokenDecimals
     ) internal onlyInitializing {
-        __TokenHome_init(teleporterRegistryAddress, teleporterManager, tokenAddress, tokenDecimals);
+        __TokenHome_init(
+            teleporterRegistryAddress,
+            teleporterManager,
+            minTeleporterVersion,
+            tokenAddress,
+            tokenDecimals
+        );
         __ERC20TokenHome_init_unchained(tokenAddress);
     }
 

diff --git a/contracts/src/TokenHome/NativeTokenHome.sol b/contracts/src/TokenHome/NativeTokenHome.sol
@@ -17,8 +17,11 @@ contract NativeTokenHome is NativeTokenHomeUpgradeable {
     constructor(
         address teleporterRegistryAddress,
         address teleporterManager,
+        uint256 minTeleporterVersion,
         address wrappedTokenAddress
     ) NativeTokenHomeUpgradeable(ICTTInitializable.Allowed) {
-        initialize(teleporterRegistryAddress, teleporterManager, wrappedTokenAddress);
+        initialize(
+            teleporterRegistryAddress, teleporterManager, minTeleporterVersion, wrappedTokenAddress
+        );
     }
 }
diff --git a/contracts/src/TokenHome/NativeTokenHomeUpgradeable.sol b/contracts/src/TokenHome/NativeTokenHomeUpgradeable.sol
@@ -71,24 +71,35 @@ contract NativeTokenHomeUpgradeable is INativeTokenHome, TokenHome {
      * address. See here for details: https://github.com/ava-labs/teleporter/tree/main/contracts/teleporter/registry
      * @param teleporterManager Address that manages this contract's integration with the
      * Teleporter registry and Teleporter versions.
+     * @param minTeleporterVersion Minimum Teleporter version supported by this contract.
      * @param wrappedTokenAddress The wrapped native token contract address of the native asset
      * to be transferred to TokenRemote instances.
      */
     function initialize(
         address teleporterRegistryAddress,
         address teleporterManager,
+        uint256 minTeleporterVersion,
         address wrappedTokenAddress
     ) public initializer {
-        __NativeTokenHome_init(teleporterRegistryAddress, teleporterManager, wrappedTokenAddress);
+        __NativeTokenHome_init(
+            teleporterRegistryAddress, teleporterManager, minTeleporterVersion, wrappedTokenAddress
+        );
     }
 
     // solhint-disable-next-line func-name-mixedcase
     function __NativeTokenHome_init(
         address teleporterRegistryAddress,
         address teleporterManager,
+        uint256 minTeleporterVersion,
         address wrappedTokenAddress
     ) internal onlyInitializing {
-        __TokenHome_init(teleporterRegistryAddress, teleporterManager, wrappedTokenAddress, 18);
+        __TokenHome_init(
+            teleporterRegistryAddress,
+            teleporterManager,
+            minTeleporterVersion,
+            wrappedTokenAddress,
+            18
+        );
         __NativeTokenHome_init_unchained(wrappedTokenAddress);
     }
 

diff --git a/contracts/src/TokenHome/TokenHome.sol b/contracts/src/TokenHome/TokenHome.sol
@@ -104,17 +104,21 @@ abstract contract TokenHome is
      * @param teleporterRegistryAddress The address of the TeleporterRegistry contract.
      * @param teleporterManager Address that manages this contract's integration with the
      * Teleporter registry and Teleporter versions.
+     * @param minTeleporterVersion Minimum Teleporter version supported by this contract.
      * @param tokenAddress The token contract address to be transferredd by the home instance.
      * @param tokenDecimals The number of decimals for the token being transferred.
      */
     // solhint-disable-next-line func-name-mixedcase
     function __TokenHome_init(
         address teleporterRegistryAddress,
         address teleporterManager,
+        uint256 minTeleporterVersion,
         address tokenAddress,
         uint8 tokenDecimals
     ) internal virtual onlyInitializing {
-        __TeleporterRegistryOwnableApp_init(teleporterRegistryAddress, teleporterManager);
+        __TeleporterRegistryOwnableApp_init(
+            teleporterRegistryAddress, teleporterManager, minTeleporterVersion
+        );
         __SendReentrancyGuard_init();
         __TokenHome_init_unchained(tokenAddress, tokenDecimals);
     }

diff --git a/contracts/src/TokenRemote/TokenRemote.sol b/contracts/src/TokenRemote/TokenRemote.sol
@@ -154,7 +154,9 @@ abstract contract TokenRemote is
         uint8 tokenDecimals
     ) internal onlyInitializing {
         __TeleporterRegistryOwnableApp_init(
-            settings.teleporterRegistryAddress, settings.teleporterManager
+            settings.teleporterRegistryAddress,
+            settings.teleporterManager,
+            settings.minTeleporterVersion
         );
         __SendReentrancyGuard_init();
         __TokenRemote_init_unchained(settings, initialReserveImbalance_, tokenDecimals);

diff --git a/contracts/src/TokenRemote/interfaces/ITokenRemote.sol b/contracts/src/TokenRemote/interfaces/ITokenRemote.sol
@@ -14,13 +14,15 @@ import {TeleporterFeeInfo} from "@teleporter/ITeleporterMessenger.sol";
  * address. See here for details: https://github.com/ava-labs/teleporter/tree/main/contracts/teleporter/registry.
  * @param teleporterManager Address that manages this contract's integration with the
  * Teleporter registry and Teleporter versions.
+ * @param minTeleporterVersion Minimum Teleporter version supported by this contract.
  * @param tokenHomeBlockchainID The blockchain ID of the associated TokenHome instance.
  * @param tokenHomeAddress The address of the associated token home contract.
  * @param tokenHomeDecimals The number of decimal places used by the token home's token.
  */
 struct TokenRemoteSettings {
     address teleporterRegistryAddress;
     address teleporterManager;
+    uint256 minTeleporterVersion;
     bytes32 tokenHomeBlockchainID;
     address tokenHomeAddress;
     uint8 tokenHomeDecimals;

diff --git a/contracts/test/ERC20TokenHomeTests.t.sol b/contracts/test/ERC20TokenHomeTests.t.sol
@@ -36,6 +36,7 @@ contract ERC20TokenHomeTest is ERC20TokenTransferrerTest, TokenHomeTest {
         app.initialize(
             MOCK_TELEPORTER_REGISTRY_ADDRESS,
             MOCK_TELEPORTER_MESSENGER_ADDRESS,
+            1,
             address(mockERC20),
             tokenHomeDecimals
         );
@@ -51,7 +52,7 @@ contract ERC20TokenHomeTest is ERC20TokenTransferrerTest, TokenHomeTest {
      */
     function testNonUpgradeableInitialization() public {
         app = new ERC20TokenHome(
-            MOCK_TELEPORTER_REGISTRY_ADDRESS, address(this), address(mockERC20), tokenHomeDecimals
+            MOCK_TELEPORTER_REGISTRY_ADDRESS, address(this), 1, address(mockERC20), tokenHomeDecimals
         );
         assertEq(app.getBlockchainID(), DEFAULT_TOKEN_HOME_BLOCKCHAIN_ID);
     }
@@ -60,7 +61,7 @@ contract ERC20TokenHomeTest is ERC20TokenTransferrerTest, TokenHomeTest {
         app = new ERC20TokenHomeUpgradeable(ICTTInitializable.Disallowed);
         vm.expectRevert(abi.encodeWithSelector(Initializable.InvalidInitialization.selector));
         app.initialize(
-            MOCK_TELEPORTER_REGISTRY_ADDRESS, address(this), address(mockERC20), tokenHomeDecimals
+            MOCK_TELEPORTER_REGISTRY_ADDRESS, address(this), 1, address(mockERC20), tokenHomeDecimals
         );
     }
 
@@ -70,7 +71,7 @@ contract ERC20TokenHomeTest is ERC20TokenTransferrerTest, TokenHomeTest {
             address(this),
             address(mockERC20),
             tokenHomeDecimals,
-            "TeleporterRegistryApp: zero teleporter registry address"
+            "TeleporterRegistryApp: zero Teleporter registry address"
         );
     }
 
@@ -303,7 +304,7 @@ contract ERC20TokenHomeTest is ERC20TokenTransferrerTest, TokenHomeTest {
         app = new ERC20TokenHomeUpgradeable(ICTTInitializable.Allowed);
         vm.expectRevert(expectedErrorMessage);
         app.initialize(
-            teleporterRegistryAddress, teleporterManagerAddress, feeTokenAddress, tokenDecimals
+            teleporterRegistryAddress, teleporterManagerAddress, 1, feeTokenAddress, tokenDecimals
         );
     }
 }
diff --git a/contracts/test/ERC20TokenRemoteTests.t.sol b/contracts/test/ERC20TokenRemoteTests.t.sol
@@ -58,6 +58,7 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
             TokenRemoteSettings({
                 teleporterRegistryAddress: MOCK_TELEPORTER_REGISTRY_ADDRESS,
                 teleporterManager: address(this),
+                minTeleporterVersion: 1,
                 tokenHomeBlockchainID: DEFAULT_TOKEN_HOME_BLOCKCHAIN_ID,
                 tokenHomeAddress: DEFAULT_TOKEN_HOME_ADDRESS,
                 tokenHomeDecimals: tokenHomeDecimals
@@ -76,6 +77,7 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
             TokenRemoteSettings({
                 teleporterRegistryAddress: MOCK_TELEPORTER_REGISTRY_ADDRESS,
                 teleporterManager: address(this),
+                minTeleporterVersion: 1,
                 tokenHomeBlockchainID: DEFAULT_TOKEN_HOME_BLOCKCHAIN_ID,
                 tokenHomeAddress: DEFAULT_TOKEN_HOME_ADDRESS,
                 tokenHomeDecimals: tokenHomeDecimals
@@ -91,14 +93,15 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
             TokenRemoteSettings({
                 teleporterRegistryAddress: address(0),
                 teleporterManager: address(this),
+                minTeleporterVersion: 1,
                 tokenHomeBlockchainID: DEFAULT_TOKEN_HOME_BLOCKCHAIN_ID,
                 tokenHomeAddress: DEFAULT_TOKEN_HOME_ADDRESS,
                 tokenHomeDecimals: tokenHomeDecimals
             }),
             MOCK_TOKEN_NAME,
             MOCK_TOKEN_SYMBOL,
             tokenDecimals,
-            "TeleporterRegistryApp: zero teleporter registry address"
+            "TeleporterRegistryApp: zero Teleporter registry address"
         );
     }
 
@@ -107,6 +110,7 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
             TokenRemoteSettings({
                 teleporterRegistryAddress: MOCK_TELEPORTER_REGISTRY_ADDRESS,
                 teleporterManager: address(0),
+                minTeleporterVersion: 1,
                 tokenHomeBlockchainID: DEFAULT_TOKEN_HOME_BLOCKCHAIN_ID,
                 tokenHomeAddress: DEFAULT_TOKEN_HOME_ADDRESS,
                 tokenHomeDecimals: tokenHomeDecimals
@@ -123,6 +127,7 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
             TokenRemoteSettings({
                 teleporterRegistryAddress: MOCK_TELEPORTER_REGISTRY_ADDRESS,
                 teleporterManager: address(this),
+                minTeleporterVersion: 1,
                 tokenHomeBlockchainID: bytes32(0),
                 tokenHomeAddress: DEFAULT_TOKEN_HOME_ADDRESS,
                 tokenHomeDecimals: tokenHomeDecimals
@@ -139,6 +144,7 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
             TokenRemoteSettings({
                 teleporterRegistryAddress: MOCK_TELEPORTER_REGISTRY_ADDRESS,
                 teleporterManager: address(this),
+                minTeleporterVersion: 1,
                 tokenHomeBlockchainID: DEFAULT_TOKEN_REMOTE_BLOCKCHAIN_ID,
                 tokenHomeAddress: DEFAULT_TOKEN_HOME_ADDRESS,
                 tokenHomeDecimals: tokenHomeDecimals
@@ -155,6 +161,7 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
             TokenRemoteSettings({
                 teleporterRegistryAddress: MOCK_TELEPORTER_REGISTRY_ADDRESS,
                 teleporterManager: address(this),
+                minTeleporterVersion: 1,
                 tokenHomeBlockchainID: DEFAULT_TOKEN_HOME_BLOCKCHAIN_ID,
                 tokenHomeAddress: address(0),
                 tokenHomeDecimals: 18
@@ -166,11 +173,6 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
         );
     }
 
-    function testDecimals() public {
-        uint8 res = app.decimals();
-        assertEq(tokenDecimals, res);
-    }
-
     function testSendWithSeparateFeeAsset() public {
         uint256 amount = 200_000;
         uint256 feeAmount = 100;
@@ -197,13 +199,19 @@ contract ERC20TokenRemoteTest is ERC20TokenTransferrerTest, TokenRemoteTest {
         _send(input, amount);
     }
 
+    function testDecimals() public view {
+        uint8 res = app.decimals();
+        assertEq(tokenDecimals, res);
+    }
+
     function _createNewRemoteInstance() internal override returns (TokenRemote) {
         ERC20TokenRemoteUpgradeable instance =
             new ERC20TokenRemoteUpgradeable(ICTTInitializable.Allowed);
         instance.initialize(
             TokenRemoteSettings({
                 teleporterRegistryAddress: MOCK_TELEPORTER_REGISTRY_ADDRESS,
                 teleporterManager: address(this),
+                minTeleporterVersion: 1,
                 tokenHomeBlockchainID: DEFAULT_TOKEN_HOME_BLOCKCHAIN_ID,
                 tokenHomeAddress: DEFAULT_TOKEN_HOME_ADDRESS,
                 tokenHomeDecimals: tokenHomeDecimals

diff --git a/contracts/test/ExampleERC20DecimalsTests.t.sol b/contracts/test/ExampleERC20DecimalsTests.t.sol
@@ -16,7 +16,7 @@ contract ExampleERC20DecimalsTest is Test {
         exampleERC20 = new ExampleERC20Decimals(MOCK_DECIMALS);
     }
 
-    function testDecimals() public {
+    function testDecimals() public view {
         assertEq(exampleERC20.decimals(), MOCK_DECIMALS);
     }
 }
diff --git a/contracts/test/NativeTokenHomeTests.t.sol b/contracts/test/NativeTokenHomeTests.t.sol
@@ -34,7 +34,7 @@ contract NativeTokenHomeTest is NativeTokenTransferrerTest, TokenHomeTest {
         wavax = new WrappedNativeToken("AVAX");
         app = new NativeTokenHomeUpgradeable(ICTTInitializable.Allowed);
         app.initialize(
-            MOCK_TELEPORTER_REGISTRY_ADDRESS, MOCK_TELEPORTER_MESSENGER_ADDRESS, address(wavax)
+            MOCK_TELEPORTER_REGISTRY_ADDRESS, MOCK_TELEPORTER_MESSENGER_ADDRESS, 1, address(wavax)
         );
         tokenHome = app;
         nativeTokenTransferrer = app;
@@ -47,22 +47,22 @@ contract NativeTokenHomeTest is NativeTokenTransferrerTest, TokenHomeTest {
      * Initialization unit tests
      */
     function testNonUpgradeableInitialization() public {
-        app = new NativeTokenHome(MOCK_TELEPORTER_REGISTRY_ADDRESS, address(this), address(wavax));
+        app = new NativeTokenHome(MOCK_TELEPORTER_REGISTRY_ADDRESS, address(this), 1, address(wavax));
         assertEq(app.getBlockchainID(), DEFAULT_TOKEN_HOME_BLOCKCHAIN_ID);
     }
 
     function testDisableInitialization() public {
         app = new NativeTokenHomeUpgradeable(ICTTInitializable.Disallowed);
         vm.expectRevert(abi.encodeWithSelector(Initializable.InvalidInitialization.selector));
-        app.initialize(MOCK_TELEPORTER_REGISTRY_ADDRESS, address(this), address(wavax));
+        app.initialize(MOCK_TELEPORTER_REGISTRY_ADDRESS, address(this), 1, address(wavax));
     }
 
     function testZeroTeleporterRegistryAddress() public {
         _invalidInitialization(
             address(0),
             address(this),
             address(wavax),
-            "TeleporterRegistryApp: zero teleporter registry address"
+            "TeleporterRegistryApp: zero Teleporter registry address"
         );
     }
 
@@ -173,6 +173,6 @@ contract NativeTokenHomeTest is NativeTokenTransferrerTest, TokenHomeTest {
     ) private {
         app = new NativeTokenHomeUpgradeable(ICTTInitializable.Allowed);
         vm.expectRevert(expectedErrorMessage);
-        app.initialize(teleporterRegistryAddress, teleporterManagerAddress, wrappedTokenAddress);
+        app.initialize(teleporterRegistryAddress, teleporterManagerAddress, 1, wrappedTokenAddress);
     }
 }