Merge pull request #1560 from thesandboxgame/feat/network-enums-and-tags

Network enums and tags

packages/deploy/README.md

@@ -44,6 +44,161 @@ where:
   executed ( see:[hardhat-deploy](https://github.com/wighawag/hardhat-deploy)
   configuration)
 
+## Deployment Tags Documentation
+
+This sections aims to clarify the use of deployment tags within our deploy
+package. The configured enum `DEPLOY_TAGS` helps us manage deployment files
+effectively, allowing us to easier identify which scripts are meant to run on
+specific networks.
+
+### DEPLOY_TAGS Enum
+
+```typescript
+export enum DEPLOY_TAGS {
+  L1 = 'L1', // Layer one networks like Ethereum mainnet, Sepolia
+  L1_PROD = 'L1-prod', // Layer one production networks like Ethereum mainnet
+  L1_TEST = 'L1-test', // Layer one test networks like Goerli
+  L2 = 'L2', // Layer two networks like Polygon, Mumbai
+  L2_PROD = 'L2-prod', // Layer two production networks like Polygon
+  L2_TEST = 'L2-test', // Layer two test networks like Mumbai
+}
+```
+
+These tags help distinguish which scripts are written for L1 or L2 networks and
+which should only run on test networks because they are mocks or supplementary
+scripts.
+
+### Networks Configuration
+
+Here is an example configuration of networks within our Hardhat project that
+uses these tags:
+
+```typescript
+const networks = {
+  [DEPLOY_NETWORKS.ETH_GOERLI]: {
+    tags: [DEPLOY_TAGS.L1, DEPLOY_TAGS.L1_TEST],
+    companionNetworks: {
+      [DEPLOY_NETWORKS.MUMBAI]: DEPLOY_NETWORKS.MUMBAI,
+    },
+  },
+  [DEPLOY_NETWORKS.ETH_SEPOLIA]: {
+    tags: [DEPLOY_TAGS.L1, DEPLOY_TAGS.L1_PROD],
+    companionNetworks: {
+      [DEPLOY_NETWORKS.AMOY]: DEPLOY_NETWORKS.AMOY,
+      [DEPLOY_NETWORKS.BASE_SEPOLIA]: DEPLOY_NETWORKS.BASE_SEPOLIA,
+      [DEPLOY_NETWORKS.BSC_TESTNET]: DEPLOY_NETWORKS.BSC_TESTNET,
+    },
+  },
+  // other network configurations...
+};
+```
+
+## Usage Guidelines
+
+### When to Add Tags
+
+1. **L1 Networks (Layer 1)**
+
+   - **L1**: General tag for scripts intended to run on any Layer 1 network.
+   - **L1_PROD**: Use for scripts meant only for Layer 1 production networks
+     (e.g., Ethereum mainnet).
+   - **L1_TEST**: Tag scripts intended for Layer 1 test networks (e.g., Goerli,
+     Sepolia).
+
+2. **L2 Networks (Layer 2)**
+
+   - **L2**: General tag for scripts intended to run on any Layer 2 network.
+   - **L2_PROD**: Use for scripts meant only for Layer 2 production networks
+     (e.g., Polygon).
+   - **L2_TEST**: Tag scripts intended for Layer 2 test networks (e.g., Mumbai).
+
+### Example Scenarios
+
+1. **Deploying a Mock Contract on Amoy**
+
+   - If you have a mock contract that should only be deployed on test networks
+     for testing purposes, tag the script with `L2` and `L2_TEST`.
+   - Use the `DEPLOY_NETWORKS` enum to specify to which network the script was
+     ran on.
+   - Example:
+
+     ```typescript
+     // deploy_mocks/deployMockContract.ts
+     const func: DeployFunction = async function (
+       hre: HardhatRuntimeEnvironment
+     ) {
+       const {deployments, getNamedAccounts} = hre;
+       const {deploy} = deployments;
+
+       await deploy('MockContract', {
+         from: deployer,
+         log: true,
+       });
+     };
+
+     func.tags = [DEPLOY_TAGS.L2, DEPLOY_TAGS.L2_TEST];
+     ```
+
+2. **Deploying a Mainnet-Only Script**
+
+   - If you have a script that should only run on the Ethereum mainnet, tag it
+     with `L1` and `L1_PROD` along with the `ETH_MAINNET` network tag.
+   - Example:
+
+     ```typescript
+     // deploy/deployMainnetOnlyContract.ts
+     const func: DeployFunction = async function (
+       hre: HardhatRuntimeEnvironment
+     ) {
+       const {deployments, getNamedAccounts} = hre;
+       const {deploy} = deployments;
+
+       await deploy('MainnetOnlyContract', {
+         from: deployer,
+         log: true,
+       });
+     };
+
+     func.tags = [DEPLOY_TAGS.L1, DEPLOY_TAGS.L1_PROD];
+     ```
+
+3. **Deploying to Both L1 and L2 Networks**
+
+   - If you have a script that should deploy to both Layer 1 and Layer 2
+     networks, use the general tags `L1` and `L2`.
+   - Example:
+
+     ```typescript
+     // deploy/deployUniversalContract.ts
+     const func: DeployFunction = async function (
+       hre: HardhatRuntimeEnvironment
+     ) {
+       const {deployments, getNamedAccounts} = hre;
+       const {deploy} = deployments;
+
+       await deploy('UniversalContract', {
+         from: deployer,
+         log: true,
+       });
+     };
+
+     func.tags = [
+       DEPLOY_TAGS.L1,
+       DEPLOY_TAGS.L2,
+       DEPLOY_TAGS.L1_PROD,
+       DEPLOY_TAGS.L2_PROD,
+       DEPLOY_TAGS.L1_TEST,
+       DEPLOY_TAGS.L2_TEST,
+     ];
+     ```
+
+## Conclusion
+
+By following these guidelines and using the appropriate tags, you can ensure
+that our deployment scripts are managed correctly and deployed in the intended
+environments. This not only helps maintain the clarity of deployment processes
+but also prevents accidental deployments to unintended networks.
+
 ## Upgrades
 
 1. Modify smart contracts, add tests, and update documentation in the respective

packages/deploy/deploy/000_core/001_deploy_polygon_sand.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts} = hre;
@@ -25,5 +26,11 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   });
 };
 export default func;
-func.tags = ['PolygonSand', 'PolygonSand_deploy', 'L2'];
+func.tags = [
+  'PolygonSand',
+  'PolygonSand_deploy',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
+];
 func.dependencies = ['CHILD_CHAIN_MANAGER', 'TRUSTED_FORWARDER_V2'];

packages/deploy/deploy/100_claim/100_multi_claim.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (
   hre: HardhatRuntimeEnvironment
@@ -26,5 +27,11 @@ const func: DeployFunction = async function (
 };
 
 export default func;
-func.tags = ['SignedMultiGiveaway', 'SignedMultiGiveaway_deploy', 'L2'];
+func.tags = [
+  'SignedMultiGiveaway',
+  'SignedMultiGiveaway_deploy',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
+];
 func.dependencies = ['TRUSTED_FORWARDER_V2'];

packages/deploy/deploy/100_claim/200_multi_claim_role_setup.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (
   hre: HardhatRuntimeEnvironment
@@ -29,5 +30,11 @@ const func: DeployFunction = async function (
 };
 
 export default func;
-func.tags = ['SignedMultiGiveaway', 'SignedMultiGiveaway_role_setup', 'L2'];
+func.tags = [
+  'SignedMultiGiveaway',
+  'SignedMultiGiveaway_role_setup',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
+];
 func.dependencies = ['SignedMultiGiveaway_deploy'];

packages/deploy/deploy/17_raffle_care_bears/010_deploy_raffle_care_bears.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts} = hre;
@@ -41,5 +42,11 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
 };
 
 export default func;
-func.tags = ['RaffleCareBears', 'RaffleCareBears_deploy'];
+func.tags = [
+  'RaffleCareBears',
+  'RaffleCareBears_deploy',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
+];
 func.dependencies = ['TRUSTED_FORWARDER_V2'];

packages/deploy/deploy/17_raffle_care_bears/011_setup_raffle_care_bears_minter.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments} = hre;
@@ -32,6 +33,9 @@ func.tags = [
   'RaffleCareBears',
   'RaffleCareBears_setup',
   'RaffleCareBears_setup_minter',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
 ];
 // func.dependencies = ['PolygonSand_deploy', 'RaffleCareBears_deploy'];
 func.dependencies = ['RaffleCareBears_deploy'];

packages/deploy/deploy/17_raffle_care_bears/013_setup_raffle_care_bears_wave_0.ts

@@ -1,5 +1,6 @@
-import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments} = hre;
@@ -35,5 +36,8 @@ func.tags = [
   'RaffleCareBears',
   'RaffleCareBears_setup',
   'RaffleCareBears_setup_wave',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
 ];
 func.dependencies = ['RaffleCareBears_deploy'];

packages/deploy/deploy/17_raffle_care_bears/014_setup_raffle_care_bears_signer.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts} = hre;
@@ -25,5 +26,8 @@ func.tags = [
   'RaffleCareBears',
   'RaffleCareBears_setup',
   'RaffleCareBears_setup_signer',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
 ];
 func.dependencies = ['RaffleCareBears_deploy'];

packages/deploy/deploy/17_raffle_care_bears/015_change_owner_care_bears.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts} = hre;
@@ -21,5 +22,11 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
 };
 
 export default func;
-func.tags = ['RaffleCareBears', 'RaffleCareBears_change_admin'];
+func.tags = [
+  'RaffleCareBears',
+  'RaffleCareBears_change_admin',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
+];
 func.dependencies = ['RaffleCareBears_deploy'];

packages/deploy/deploy/18_raffle_playboy_party_people/010_deploy_raffle_playboy_party_people.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts} = hre;
@@ -42,5 +43,11 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
 };
 
 export default func;
-func.tags = ['RafflePlayboyPartyPeople', 'RafflePlayboyPartyPeople_deploy'];
+func.tags = [
+  'RafflePlayboyPartyPeople',
+  'RafflePlayboyPartyPeople_deploy',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
+];
 func.dependencies = ['TRUSTED_FORWARDER_V2'];

packages/deploy/deploy/18_raffle_playboy_party_people/011_setup_raffle_playboy_party_people_minter.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments} = hre;
@@ -33,6 +34,9 @@ func.tags = [
   'RafflePlayboyPartyPeople',
   'RafflePlayboyPartyPeople_setup',
   'RafflePlayboyPartyPeople_setup_minter',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
 ];
 // func.dependencies = ['PolygonSand_deploy', 'RafflePlayboyPartyPeople_deploy'];
 func.dependencies = ['RafflePlayboyPartyPeople_deploy'];

packages/deploy/deploy/18_raffle_playboy_party_people/013_setup_raffle_playboy_party_people_wave_0.ts

@@ -1,5 +1,6 @@
-import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments} = hre;
@@ -38,5 +39,8 @@ func.tags = [
   'RafflePlayboyPartyPeople',
   'RafflePlayboyPartyPeople_setup',
   'RafflePlayboyPartyPeople_setup_wave',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
 ];
 func.dependencies = ['RafflePlayboyPartyPeople_deploy'];

packages/deploy/deploy/18_raffle_playboy_party_people/014_setup_raffle_playboy_party_people_signer.ts

@@ -1,5 +1,6 @@
 import {DeployFunction} from 'hardhat-deploy/types';
 import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts} = hre;
@@ -25,5 +26,8 @@ func.tags = [
   'RafflePlayboyPartyPeople',
   'RafflePlayboyPartyPeople_setup',
   'RafflePlayboyPartyPeople_setup_signer',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
 ];
 func.dependencies = ['RafflePlayboyPartyPeople_deploy'];

packages/deploy/deploy/18_raffle_playboy_party_people/015_change_owner_playboy_party_people.ts

@@ -1,5 +1,6 @@
-import {HardhatRuntimeEnvironment} from 'hardhat/types';
 import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DEPLOY_TAGS} from '../../hardhat.config';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const {deployments, getNamedAccounts} = hre;
@@ -24,5 +25,8 @@ export default func;
 func.tags = [
   'RafflePlayboyPartyPeople',
   'RafflePlayboyPartyPeople_change_admin',
+  DEPLOY_TAGS.L2,
+  DEPLOY_TAGS.L2_PROD,
+  DEPLOY_TAGS.L2_TEST,
 ];
 func.dependencies = ['RafflePlayboyPartyPeople_deploy'];