Add artifacts folder and organize subfolders and files inside it (#184

)

* Add artifacts folder and organize subfolders and files inside

* Fix merge issue

.gitignore

@@ -15,4 +15,4 @@ broadcast/
 slither-results.json
 
 # Devnet deployment files
-deployment/devnet/
+deployment/artifacts/contracts/devnet/

script/1_deployTokenContracts.sh

@@ -12,19 +12,19 @@ echo "Setting environment variables..."
 source .env
 echo "Done."
 
-echo "Creating $NETWORK directory inside deployment directory..."
+echo "Creating $NETWORK directory inside deployment/artifacts/contracts directory..."
 if [ -z "$NETWORK" ]
 then
       echo "NETWORK variable inside .env file is not set. Please set NETWORK environment variable."
       exit 1
 else
-      if [ -d "deployment/$NETWORK" ]
+      if [ -d "deployment/artifacts/contracts/$NETWORK" ]
       then
-            echo "Directory deployment/$NETWORK already exists."
-            echo "Removing files inside deployment/$NETWORK directory..."
-            rm -rf deployment/$NETWORK/*
+            echo "Directory deployment/artifacts/contracts/$NETWORK already exists."
+            echo "Removing files inside deployment/artifacts/contracts/$NETWORK directory..."
+            rm -rf deployment/artifacts/contracts/$NETWORK/*
       else
-            mkdir deployment/$NETWORK
+            mkdir deployment/artifacts/contracts/$NETWORK
       fi
 fi
 echo "Done."

script/2_deployStakingAndGovernance.sh

@@ -12,17 +12,17 @@ echo "Setting environment variables..."
 source .env
 echo "Done."
 
-echo "Creating $NETWORK directory inside deployment directory..."
+echo "Creating $NETWORK directory inside deployment/artifacts/contracts directory..."
 if [ -z "$NETWORK" ]
 then
       echo "NETWORK variable inside .env file is not set. Please set NETWORK environment variable."
       exit 1
 else
-      if [ -d "deployment/$NETWORK" ]
+      if [ -d "deployment/artifacts/contracts/$NETWORK" ]
       then
-            echo "Directory deployment/$NETWORK already exists."
+            echo "Directory deployment/artifacts/contracts/$NETWORK already exists."
       else
-            mkdir deployment/$NETWORK
+            mkdir deployment/artifacts/contracts/$NETWORK
       fi
 fi
 echo "Done."

script/3_deployVestingWallets.sh

@@ -12,17 +12,17 @@ echo "Setting environment variables..."
 source .env
 echo "Done."
 
-echo "Creating $NETWORK directory inside deployment directory..."
+echo "Creating $NETWORK directory inside deployment/artifacts/contracts directory..."
 if [ -z "$NETWORK" ]
 then
       echo "NETWORK variable inside .env file is not set. Please set NETWORK environment variable."
       exit 1
 else
-      if [ -d "deployment/$NETWORK" ]
+      if [ -d "deployment/artifacts/contracts/$NETWORK" ]
       then
-            echo "Directory deployment/$NETWORK already exists."
+            echo "Directory deployment/artifacts/contracts/$NETWORK already exists."
       else
-            mkdir deployment/$NETWORK
+            mkdir deployment/artifacts/contracts/$NETWORK
       fi
 fi
 echo "Done."

script/4_deployClaimContract.sh

@@ -12,17 +12,17 @@ echo "Setting environment variables..."
 source .env
 echo "Done."
 
-echo "Creating $NETWORK directory inside deployment directory..."
+echo "Creating $NETWORK directory inside deployment/artifacts/contracts directory..."
 if [ -z "$NETWORK" ]
 then
       echo "NETWORK variable inside .env file is not set. Please set NETWORK environment variable."
       exit 1
 else
-      if [ -d "deployment/$NETWORK" ]
+      if [ -d "deployment/artifacts/contracts/$NETWORK" ]
       then
-            echo "Directory deployment/$NETWORK already exists."
+            echo "Directory deployment/artifacts/contracts/$NETWORK already exists."
       else
-            mkdir deployment/$NETWORK
+            mkdir deployment/artifacts/contracts/$NETWORK
       fi
 fi
 echo "Done."

script/5_deployAirdropContract.sh

@@ -12,17 +12,17 @@ echo "Setting environment variables..."
 source .env
 echo "Done."
 
-echo "Creating $NETWORK directory inside deployment directory..."
+echo "Creating $NETWORK directory inside deployment/artifacts/contracts directory..."
 if [ -z "$NETWORK" ]
 then
       echo "NETWORK variable inside .env file is not set. Please set NETWORK environment variable."
       exit 1
 else
-      if [ -d "deployment/$NETWORK" ]
+      if [ -d "deployment/artifacts/contracts/$NETWORK" ]
       then
-            echo "Directory deployment/$NETWORK already exists."
+            echo "Directory deployment/artifacts/contracts/$NETWORK already exists."
       else
-            mkdir deployment/$NETWORK
+            mkdir deployment/artifacts/contracts/$NETWORK
       fi
 fi
 echo "Done."

script/contracts/Utils.sol

@@ -115,7 +115,8 @@ contract Utils is Script {
     function readL1AddressesFile() external view returns (L1AddressesConfig memory) {
         string memory network = getNetworkType();
         string memory root = vm.projectRoot();
-        string memory addressPath = string.concat(root, "/deployment/", network, "/l1addresses.json");
+        string memory addressPath =
+            string.concat(root, "/deployment/artifacts/contracts/", network, "/l1addresses.json");
         string memory addressJson = vm.readFile(addressPath);
 
         L1AddressesConfig memory l1AddressesConfig;
@@ -141,15 +142,16 @@ contract Utils is Script {
         vm.serializeAddress(json, "L1LiskToken", cfg.L1LiskToken);
         string memory finalJson =
             vm.serializeAddress(json, "L1VestingWalletImplementation", cfg.L1VestingWalletImplementation);
-        finalJson.write(string.concat("deployment/", network, "/l1addresses.json"));
+        finalJson.write(string.concat("deployment/artifacts/contracts/", network, "/l1addresses.json"));
     }
 
     /// @notice This function reads L2 addresses from JSON file.
     /// @return L2AddressesConfig struct containing L2 addresses.
     function readL2AddressesFile() external view returns (L2AddressesConfig memory) {
         string memory network = getNetworkType();
         string memory root = vm.projectRoot();
-        string memory addressPath = string.concat(root, "/deployment/", network, "/l2addresses.json");
+        string memory addressPath =
+            string.concat(root, "/deployment/artifacts/contracts/", network, "/l2addresses.json");
         string memory addressJson = vm.readFile(addressPath);
 
         L2AddressesConfig memory l2AddressesConfig;
@@ -250,7 +252,7 @@ contract Utils is Script {
         string memory finalJson =
             vm.serializeAddress(json, "L2VotingPowerImplementation", cfg.L2VotingPowerImplementation);
 
-        finalJson.write(string.concat("deployment/", network, "/l2addresses.json"));
+        finalJson.write(string.concat("deployment/artifacts/contracts/", network, "/l2addresses.json"));
     }
 
     /// @notice This function writes Vesting Wallets to JSON file.
@@ -265,7 +267,11 @@ contract Utils is Script {
             VestingWallet memory vestingWallet = _vestingWallets[i];
             finalJson = vm.serializeAddress(json, vestingWallet.name, vestingWallet.vestingWalletAddress);
         }
-        finalJson.write(string.concat("deployment/", network, string.concat("/vestingWallets_", _layer, ".json")));
+        finalJson.write(
+            string.concat(
+                "deployment/artifacts/contracts/", network, string.concat("/vestingWallets_", _layer, ".json")
+            )
+        );
     }
 
     /// @notice This function reads MerkleRoot from JSON file.
@@ -341,8 +347,9 @@ contract Utils is Script {
     {
         string memory network = getNetworkType();
         string memory root = vm.projectRoot();
-        string memory vestingWalletsPath =
-            string.concat(root, "/deployment/", network, string.concat("/vestingWallets_", _layer, ".json"));
+        string memory vestingWalletsPath = string.concat(
+            root, "/deployment/artifacts/contracts/", network, string.concat("/vestingWallets_", _layer, ".json")
+        );
         string memory vestingWalletsJson = vm.readFile(vestingWalletsPath);
         return vm.parseJsonAddress(vestingWalletsJson, string.concat(".['", _vestingWalletName, "']"));
     }

script/example/demoClaim.sh

@@ -20,12 +20,12 @@ then
     exit
 fi
 
-echo "Removing files inside deployment directory if they exists..."
-rm -rf deployment/devnet
+echo "Removing files inside deployment/artifacts/contracts directory if they exists..."
+rm -rf deployment/artifacts/contracts/devnet
 echo "Done."
 
-echo "Creating devnet directory inside deployment directory..."
-mkdir deployment/devnet
+echo "Creating devnet directory inside deployment/artifacts/contracts directory..."
+mkdir deployment/artifacts/contracts/devnet
 echo "Done."
 
 echo "Deploying Demo L2LiskToken smart contract..."