Project Setup -

Run locally follow these instructions - Needs Node v18.x.x and npm

Follow this link to get context of HardHat

Compile and run tests -

npx hardhat compile
npx hardhat test

---

Deploy existing contracts on testnet using gitHub actions

Tests run before deploying the contract on testnet.

Normal contract

1. Go to GitHub action page
2. Run this workflow Deploy a contract to testnet using dispatch with input parameters contract name and type e.g. contract name = factory and contract type = Logic. Both name and type are case sensitive.
3. Monitor the Deploy a contract to testnet using dispatch workflow.

Proxy contract

1. Go to GitHub action page
2. Run this workflow Deploy a contract to testnet using dispatch with input parameters contract name and type e.g. contract name = factory and contract type = Proxy. Both name and type are case sensitive.
3. Monitor the Deploy a contract to testnet using dispatch workflow.

Upgrade implementation contract

1. Go to GitHub action page
2. Run this workflow Deploy a contract to testnet using dispatch with input parameters contract name and type e.g. contract name = factory and contract type = Upgrade. Both name and type are case sensitive.
3. Monitor the Deploy a contract to testnet using dispatch workflow.

---

Deploy contracts on testnet using command line

New contract (one time setup needed)

1. Go to ./deployment/deploy.ts
2. Add new contract name in SUPPORTED_CONTRACTS_FOR_DEPLOYMENT
3. Run npx hardhat run deployment/deploy.ts

Existing contract

Run npx hardhat run deployment/deploy.ts

Once above command executes, a prompt in terminal displays options to deploy contracts

1. create - Deploys a new logic contract
2. upgrade - Upgrades the existing proxy with new implementation

---

Contract Upgrade Strategy

---

Linter set up -

• All *.sol files should be formatted with - NomicFoundation.hardhat-solidity
• Pls verify the default formatter is below under /Users/<USER>/Library/Application\ Support/Code/User/settings.json
• Please enable format on save settings in VS code - Code -> Preferences -> Settings -> Text Editor -> Formatting -> Format On Save

"[solidity]": {
        "editor.defaultFormatter": "NomicFoundation.hardhat-solidity"
    }