build: add mainnet, testnet, dev migrations

[rndquu]

Resolves #827

This PR adds and modifies 2 commands:

1. yarn deploy:mainnet: deploys the Diamond and Dollar contracts to ethereum mainet
2. yarn deploy:development: deploys Diamond, Dollar, UbiquityAlgorithmicDollarManager and UbiquityGovernance contracts to local anvil instance or testnet (depending on the RPC_URL env variable)

There is no any difference between migrations to a local anvil instance and testnet so there is no separate command for testnet (i.e. there is no yarn deploy:testnet).

The only difference between yarn deploy:mainnet and yarn deploy:development is that yarn deploy:mainnet uses already deployed UbiquityAlgorithmicDollarManager and UbiquityGovernance contracts while yarn deploy:development deploys them from scratch.

The deploy diamond migration deploys not all of the facets because chances are that we're not gonna need them + it's better to deploy exactly what we're gonna use without unnecessary "dead" contracts.

Other remarks:

• old deploy scripts are removed
• there is the new old folder which contains contracts for UbiquityAlgorithmicDollarManager and UbiquityGovernance contracts (used in dev migrations + useful should we want to include them for auditing)

P.S. "Audit & Fix" workflow is failing but it is not related to the current PR, already fixed here

[ubiquibot]

c950b0a

b050bb9

b4791ff

261eabe

c4feaa9

1274354

e54be58

628aee4

d3e0288

39962c5

[gitcoindev]

Hi @rndquu is this still a draft or review can start?

[rndquu]

Hi @rndquu is this still a draft or review can start?

Hey, the PR is draft

[gitcoindev]

Hi @rndquu I started the review, checked out clean pull request, built from scratch and executed deployment on Anvil testnet.

Step 1 cp .env.example to .env, install & build

$ yarn install
$ yarn workspace @ubiquity/contracts build

1. Started Anvil on development branch - deployment fails (correct behavior)
2. Started Anvil on pr branch - deployment successful (correct behavior)

I used the command from readme

$ yarn workspace @ubiquity/contracts deploy:development

Therefore, the 'smoke test' passed.

I noticed that the deployment folders in broadcast folder is reported as untracked, you may want to add it to .gitignore

{feat/827} ~/work/pullrequest/ubiquity-dollar$ git status
On branch feat/827
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        packages/contracts/broadcast/Deploy001_Diamond_Dollar.s.sol/
        packages/contracts/broadcast/Deploy002_Governance.s.sol/

with my current content:

packages/contracts/broadcast/
├── 05_StakingShare.s.sol
│   └── 31337
│       └── run-latest.json
├── Deploy001_Diamond_Dollar.s.sol
│   └── 31337
│       ├── run-1700834661.json
│       ├── run-1700835041.json
│       └── run-latest.json
└── Deploy002_Governance.s.sol
    └── 31337
        ├── run-1700834669.json
        ├── run-1700835046.json
        └── run-latest.json

I will now go through the commits and changes.

[gitcoindev]

The deploy diamond migration deploys not all of the facets because chances are that we're not gonna need them + it's better to deploy exactly what we're gonna use without unnecessary "dead" contracts.

I agree. Would still be useful to see the full list of skipped facets in a commit message, stating why the given facet may not be needed. Perhaps also such information would help auditors.

[gitcoindev]

I went through all changes and in general I have minor findings. After those will be addressed / answered I will approve from my side.

[rndquu]

@gitcoindev

I noticed that the deployment folders in broadcast folder is reported as untracked, you may want to add it to .gitignore

From my point of view .gitignore is set fine:

• we save latest transactions from a local anvil instance (because we need them in the frontend)
• we save all mainnet and testnet transactions (in order to see a full migration history and relevant contract addresses)

[gitcoindev]

@gitcoindev

I noticed that the deployment folders in broadcast folder is reported as untracked, you may want to add it to .gitignore

From my point of view .gitignore is set fine:

• we save latest transactions from a local anvil instance (because we need them in the frontend)
• we save all mainnet and testnet transactions (in order to see a full migration history and relevant contract addresses)

all right, makes sense

[molecula451]

I'm performing last testing before pass @rndquu

[molecula451]

I'm deploying to actual testnet (not forked) while it does deploy the contracts after another run, it fails on the first run:

but then the script re-run compilation:

but then deploys:

https://sepolia.etherscan.io/tx/0x603a56a6aa1ff3b59f80516e264f8431ab79a4aae9df3a69d2ac7cbbc4511637
https://sepolia.etherscan.io/tx/0xaaab85aa032374313bdb099b6f4314b675b43813aee0279a6ec3a42353489ea7

I have matched bytecode and the above can be find at run-latest.json

It's the script failing expected?? @rndquu

more debug needed it?

[rndquu]

@molecula451

I'm deploying to actual testnet (not forked) while it does deploy the contracts after another run, it fails on the first run

Did you check the failing tx on etherscan? There must be some clue of why it failed

[molecula451]

Did you check the failing tx on etherscan? There must be some clue of why it failed

please check the screenshots, the revert it's when the script it's running, not when the contracts are getting deployed, so no etherscan, but yeah, would need to debug, also this happen continuously, when you run the script

[rndquu]

Did you check the failing tx on etherscan? There must be some clue of why it failed

please check the screenshots, the revert it's when the script it's running, not when the contracts are deployed, so no etherscan, but yeah, need to debug

There is failing tx on addCollateralToken() in the screenshot so the tx must be on sepolia's etherscan, tx hash can be found in your local broadcast logs

[molecula451]

There is failing tx on addCollateralToken() in the screenshot so the tx must be on sepolia's etherscan, tx hash can be found in your local broadcast logs

that revert it's not getting shipped, it's locally happening but not getting shipped you can check the account

https://sepolia.etherscan.io/address/0x940c5d8a6ac44ba0583162d32b05c079950b1ef3

the 2 transactions are the after the second re-run, it fails on the first run, then the script goes on, and deploys

[rndquu]

@molecula451 Do both owner and admin accounts have enough ether?

[molecula451]

@molecula451 Do both owner and admin accounts have enough ether?

yes, more than enough I'd say, 5 sepoliaETH, and it only cost less than them those 2 deployments

[molecula451]

can you reproduce it? @rndquu, indeed doesn't seem to happen on anvil fork

[molecula451]

the revert it's happening from here https://github.com/ubiquity/ubiquity-dollar/pull/842/files#diff-4c325704f2117271b3d06b56268d88bd646de602e36926d84e28f2dba7d8968cR276

@rndquu

[rndquu]

can you reproduce it? @rndquu, indeed doesn't seem to happen on anvil fork

yes, that's because LUSD is not actually deployed on sepolia testnet, I'll fix the error, thank you

[rndquu]

@molecula451 @gitcoindev

Notice that I moved the collateral token address to .env file.

LUSD token (used as collateral in UbiquityPoolFacet) is not deployed to sepolia testnet so for testnet we should use some other token. I've checked the migration to testnet with DAI as collateral token and the migration executed fine.

[molecula451]

so the bug was LUSD was not deployed

[rndquu]

so the bug was LUSD was not deployed

yes

[molecula451]

Hi @rndquu I started the review, checked out clean pull request, built from scratch and executed deployment on Anvil testnet.

$ yarn install
$ yarn workspace @ubiquity/contracts build

1. Started Anvil on development branch - deployment fails (correct behavior)
2. Started Anvil on pr branch - deployment successful (correct behavior)

I used the command from readme

$ yarn workspace @ubiquity/contracts deploy:development

Therefore, the 'smoke test' passed.

for your info you do not have to run all these commands, that's why we are updating the readme #843
@gitcoindev

check yarn deploy:development just do

yarn.mp4

[molecula451]

aaaaaaaaaaaaaaaaaaaaaaaaaand!! @rndquu

Successfully set Dollar

rndqnuu just updated the contracts

[molecula451]

⚠️ This list is bound to change at this PR it's still getting testing ⚠️ ⚠️

This PR:

• Successfully grant expected roles according to the scripts, it grants a manager role to msg.sender set at .env
• Set Dollar Token at initial run
• Deploys 9 facets including Diamond
• The deployment match addresses on run-latest.json an any compatible EVM explorer (etherscan for e.g)
• The deployment match diamond bytecode
• Diamond facet returns correct set dollar token deployed at run
  
  can be seen at https://sepolia.etherscan.io/address/0x6b16e6b2bb75d63a90a8557cc11b3832c0642629

[molecula451]

Basically all the debug happened on this PR. This PR is more than ready to be merge

[molecula451]

I'm merging this one. Please leave your Review @gitcoindev

[gitcoindev]

All right! I went through all the changes and comments again and approving. Good job @rndquu . We will also test this pr in future development.

[molecula451]

what a great PR and great review and feedback happened here, congrats everyone, here this appealing, and is demanding excellent