Add AnlogTokenV2 [pre|post]upgrade tests (#16)

* add UpgradeV1V2Test: fails

* annotate V2 as an upgrade to V1

* chore: uppercase constants in test

* upgrade v1 v2 fails: InvalidInitialization

* UpgradeV1V2 works

* add test_postUpgrade basic steps

* all AnlogTokenV2 tests also to run after upgrade

* add script/01_Upgrade.V1.V2.s.sol

* neat readme

* better title

Author: agryaznov

.env.anvil

@@ -1,4 +1,5 @@
-export ANVIL_RPC_URL=http://localhost:9545
+export ANVIL_PORT=9545
+export ANVIL_RPC_URL=http://localhost:$ANVIL_PORT
 # well-known (thus key compromised) Anvil default account(0)
 export DEPLOYER=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
 # well-known (thus key compromised) Anvil default account(1)
@@ -9,7 +10,9 @@ export UPGRADER=0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC
 export PAUSER=0x90F79bf6EB2c4f870365E785982E1f101E93b906
 # well-known (thus key compromised) Anvil default account(4)
 export UNPAUSER=0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65
+# Already deployed proxy
+export PROXY=0xF289621eD23Dd4051362FFddC57C237e3c00018D
 # Teleport-specific
-export GATEWAY=0x49877F1e26d523e716d941a424af46B86EcaF09E
+export GATEWAY=0xEb73D0D236DE8F8D09dc6A52916e5849ff1E8dfA
 export TIMECHAIN_ROUTE_ID=1000
 export MINIMAL_TELEPORT_VALUE=1000000000000

README.md

@@ -3,7 +3,7 @@
 > While this upgradeable token smart contract is built using [audited OZ libraries](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/tree/v5.2.0/audits),  
 > **this particular implementation has not yet underwent any security audits. Use at your own risk.**
 
-# $ANLOG ERC20 Token 
+# `$WANLOG`: Wrapped `ANLOG` ERC20 Token 
 
 ## Initial Requirements
 
@@ -49,16 +49,8 @@ This project is built with the [Foundry](https://book.getfoundry.sh/) framework.
 
 ## Testing 
 
-If changed some contract, run this first:
-
-``` sh
-forge fmt && forge clean && forge build
-```
-
-Then run tests: 
-
 ``` sh
-forge test
+forge fmt && forge clean && forge tests
 ```
 
 ## Deployment 
@@ -68,54 +60,37 @@ forge test
 <details>
 <summary>Expand me</summary>
 
-Spin out a default [Anvil](https://book.getfoundry.sh/anvil/) node:
+Load environment variables:
 
 ``` sh
-anvil -p 9545
+source .env.anvil
 ```
 
-Load environment variables and run the deployment script:
+Spin out an [Anvil](https://book.getfoundry.sh/anvil/) fork of Sepolia:
+
+``` sh
+anvil -f $SEPOLIA_RPC_URL -p $ANVIL_PORT 
+```
+
+Run the deployment script:
 
 ``` sh
-source .env.anvil
 forge script script/00_Deploy.V1.s.sol --rpc-url $ANVIL_RPC_URL --broadcast -i 1
 ```
 
 It will ask you to enter the private key. As we're using Anvil's default `account (0)` as the deployer (specified in the [`.env.anvil`](./.env.anvil)), use its (**!well-known!**) key here (can be found in Anvil logs). 
 
 </details>
 
-### To Sepolia testnet 
+### To Sepolia
 
-> [!IMPORTANT]  
-> You need to setup environment first, see [`.env.sepolia.example`](./.env.sepolia.example)
-
-#### Dry-run on Fork 
-
-<details>
-<summary>Expand me</summary>
-
-Spin out an Anvil fork of Sepolia network:
+Load environment variables:
 
 ``` sh
 source .env.sepolia
-anvil -f $SEPOLIA_RPC_URL -p 9545
 ```
 
-Deploy: 
-
-``` sh
-source .env.sepolia
-forge script script/00_Deploy.V1.s.sol --rpc-url $ANVIL_RPC_URL --broadcast -i 1
-```
-
-Make sure to provide the private key of the `DEPLOYER` account upon script's interactive prompt.
-</details>
-
-
-#### Real run on Sepolia 
-
-##### Deploy 
+#### Deploy 
 
 Once steps described above taken and succeed, deploy to Sepolia with:
 
@@ -129,7 +104,7 @@ forge script script/00_Deploy.V1.s.sol --rpc-url $SEPOLIA_RPC_URL --broadcast -i
 > forge script script/00_Deploy.V1.s.sol --rpc-url $ANVIL_RPC_URL --broadcast -l
 > ```
 
-##### Verify 
+#### Verify 
 
 Figure out `solc` version used to compile the contracts: 
 
@@ -153,37 +128,46 @@ forge v --verifier etherscan --compiler-version=<solc_version> \
 src/AnlogTokenV1.sol:AnlogTokenV1
 ```
 
-### Upgrade instructions
+## Upgrade
 
 > [!NOTE]
-> Commands below are given for the setting when you upgrade from `V0` to `V1Upgrade`. See [`Upgrade.V0.V1.t.sol`](test/Upgrade.V0.V1.t.sol) for the reference.
+> Commands below are given for the setting when you upgrade from `V1` to `V2`. 
+> Also see [`Upgrade.V1.V2.t.sol` test](test/Upgrade.V0.V1.t.sol) for the reference.
+
+*Prerequisites*: you have `V1` deployed.
+
+### Locally to Anvil 
+
+<details>
+<summary>Expand me</summary>
 
+Load environment variables:
 
-Let say you have deployed proxy and `V0` implementation contract for it.  
-To upgrade the implementation contract to `V1Upgrade`:
+``` sh
+source .env.anvil
+```
+
+First spin out a local anvil and deploy `V1` to it by following instructions above.
+
+Then set `PROXY` environment variable to the address of the deployed proxy.
 
-1. Deploy `V1Upgrade`:
+Then run `V1.V2` upgrade script:
 
-   ``` sh
-   source .env.sepolia
-   forge create --constructor-args=0x,0x,0x,0x \
-   --rpc-url $SEPOLIA_RPC_URL \
-   --from $DEPLOYER \
-   test/mock/AnlogTokenV1Upgrade.sol:AnlogTokenV1Upgrade -i --broadcast 
-   ```
+``` sh
+forge script script/01_Upgrade.V1.V2.s.sol --rpc-url $ANVIL_RPC_URL --broadcast -i 1
+```
+
+It will ask you to enter the private key. As we're using Anvil's default `account (2)` as the `UPGRADER` (specified in the [`.env.anvil`](./.env.anvil)), use its (**!well-known!**) key here (can be found in Anvil logs). 
+
+</details>
 
-   **NOTE** that we provided `0x,0x,0x,0x` to the constructor args. That is because we don't care on the values of the implementation contract storage. The proxy storage will be updated in the following `initialize()` call right after the upgrade.
 
-2. Prepare `calldata` for `V1Upgrade` initializer:
+### To Sepolia 
 
-   ```sh
-   source .env.sepolia
-   cast cd "initialize(address,address,address,address)()" $MINTER $UPGRADER $PAUSER $UNPAUSER
-   ``` 
-   You should get hex-encoded `calldata` as the result.
+In a live network, most probably a multisig is used for the `UPGRADER` account. Thus for doing an upgrade, 
 
-3. Dispatch the call to  [`upgradeToAndCall(address,bytes)`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/332bcb5f4d9cf0ae0f98fe91c77d9c1fb9951506/contracts/proxy/ERC1967/ERC1967Utils.sol#L67), providing the following args:
+dispatch the call to  [`upgradeToAndCall(address,bytes)`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/332bcb5f4d9cf0ae0f98fe91c77d9c1fb9951506/contracts/proxy/ERC1967/ERC1967Utils.sol#L67), providing the following args:
 
-      - **address**: current (`V0`) implementation contract address;
-      - **bytes**: `calldata` for the `V1Upgrade` implementation contract initializer 
-        (the one you've got on the previous step).
+      - **address**: current (`V1`) implementation contract address;
+      - **bytes**: (empty) (this is `calldata` for the `V2` implementation contract initializer, which we don't need for this upgrade).
+        **note** for the cases when you need it, look at this [commit](https://github.com/Analog-Labs/erc20-token/blob/2c6025e8099966194ed006c25f1a79b5cabfa0df/README.md#upgrade-instructions) for the instructions of how to calculate it.

script/00_Deploy.V1.s.sol

@@ -5,7 +5,7 @@ import {Script, console} from "forge-std/Script.sol";
 import {Upgrades} from "openzeppelin-foundry-upgrades/Upgrades.sol";
 import {AnlogTokenV1} from "../src/AnlogTokenV1.sol";
 
-contract AnlogTokenScript is Script {
+contract AnlogTokenV1DeploymentScript is Script {
     AnlogTokenV1 public token;
 
     function setUp() public {}

script/01_Deploy.V2.s.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import {Script, console} from "forge-std/Script.sol";
+import {Upgrades, Options} from "openzeppelin-foundry-upgrades/Upgrades.sol";
+import {AnlogTokenV1} from "../src/AnlogTokenV1.sol";
+
+contract AnlogTokenV1V2UpgradeScript is Script {
+    AnlogTokenV1 public token;
+
+    function setUp() public {}
+
+    function run() public {
+        address proxy = vm.envAddress("PROXY");
+        address upgrader = vm.envAddress("UPGRADER");
+
+        // Teleport-related
+        address gateway = vm.envAddress("GATEWAY");
+        uint16 timechainId = uint16(vm.envUint("TIMECHAIN_ROUTE_ID"));
+        uint256 minimalTeleport = vm.envUint("MINIMAL_TELEPORT_VALUE");
+
+        // We don't need initializer to be called for this upgrade,
+        // as all the initial V1 token config stays the same.
+        // Thus `data` is empty.
+        bytes memory emptyData;
+
+        Options memory opts;
+        opts.constructorData = abi.encode(gateway, timechainId, minimalTeleport);
+
+        vm.startBroadcast(upgrader);
+        Upgrades.upgradeProxy(proxy, "AnlogTokenV2.sol", emptyData, opts);
+        vm.stopBroadcast();
+
+        console.log("[dry-run] Upgraded to AnlogTokenV2.sol implentation to proxy address: ", proxy);
+        console.log(" TELEPORT SETTINGS:");
+        console.log("   GATEWAY: ", gateway);
+        console.log("   TIMECHAIN_ROUTE_ID: ", timechainId);
+        console.log("   MINIMAL_TELEPORT_VALUE: ", minimalTeleport);
+    }
+}

script/01_Upgrade.V1.V2.s.sol

@@ -14,10 +14,8 @@ import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
 import {IGmpReceiver} from "@analog-gmp/interfaces/IGmpReceiver.sol";
 import {IGateway} from "@analog-gmp/interfaces/IGateway.sol";
 
-/// @notice V1: Roles Model implementation of upgradable ERC20 token.
-/// This to be used as the initial implementation of UUPS proxy.
-/// If an upgrade from V0 to V1 is needed,
-/// AnlogTokenV2Upgrade should be used instead.
+/// @notice V2: Teleportable Wrapped Analog ERC20 token.
+/// @custom:oz-upgrades-from AnlogTokenV1
 contract AnlogTokenV2 is
     Initializable,
     ERC20Upgradeable,