Add FeeCurrencyDirectory to Anvil migrations #10992

arthurgousset · 2024-05-13T16:07:54Z

Description

Adds the new FeeCurrencyDirectory contract to the Anvil migration script.

Changes

deploys and proxies the FeeCurrencyDirectory contract
registers FeeCurrencyDirectory in the Registry
adds three existing cStables (cUSD, cEUR, and cREAL) to the FeeCurrencyDirectory

Other changes

adds is IOracle to the class definition in SortedOracles
removes a duplicate import in Migrations.s.sol

Tested

Yes, tested locally:

get the FeeCurrencyDirectory address from the Registry
get registered currencies from the FeeCurrencyDirectory contract
get the exchange rate for a currency from the FeeCurrencyDirectory contract

Steps to reproduce tests locally

Requirement:

Have foundry installed
Be in the packages/protocol directory

Tests:

Run migration script (in a different Terminal)

$ ./migrations_sol/create_and_migrate_anvil_devchain.sh

Check that Anvil is running

$ nc -z localhost 8546
Connection to localhost port 8546 [tcp/*] succeeded!

Source: start_anvil.sh

Anvil is running ✅

get the FeeCurrencyDirectory address from the Registry:

export REGISTRY_ADDRESS="0x000000000000000000000000000000000000ce10"
export ANVIL_PORT=8546
cast call \
$REGISTRY_ADDRESS \
"getAddressForStringOrDie(string calldata identifier)" \
"FeeCurrencyDirectory" \
--rpc-url=http://127.0.0.1:$ANVIL_PORT

0x00000000000000000000000042fe5a2a61ed9705eb2f08a04a58ceb606d22f6a

cast abi-decode \
"getAddressForStringOrDie(string calldata identifier)(address)" \
"0x00000000000000000000000042fe5a2a61ed9705eb2f08a04a58ceb606d22f6a"

0x42Fe5a2A61ed9705eb2F08a04A58CEB606D22f6a

FeeCurrencyDirectory is registered in the Registry ✅

get registered currencies from the FeeCurrencyDirectory contract

export FEECURRENCYDIRECTORY_PROXY_ADDRESS=0x42Fe5a2A61ed9705eb2F08a04A58CEB606D22f6a
export ANVIL_PORT=8546

cast call \
$FEECURRENCYDIRECTORY_PROXY_ADDRESS \
"getCurrencies()" \
--rpc-url=http://127.0.0.1:$ANVIL_PORT

0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000e6774be4e5f97db10cafb4c00c74cfbdcdc434d9000000000000000000000000b7a33b4ad2b1f6b0a944232f5c71798d27ad92720000000000000000000000002a3733dbc31980f02b12135c809b5da33bf3a1e9

cast abi-decode \
"getCurrencies()(address[] memory)" \
"0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000e6774be4e5f97db10cafb4c00c74cfbdcdc434d9000000000000000000000000b7a33b4ad2b1f6b0a944232f5c71798d27ad92720000000000000000000000002a3733dbc31980f02b12135c809b5da33bf3a1e9"

[0xe6774BE4E5f97dB10cAFB4c00C74cFbdCDc434D9, 0xb7a33b4ad2B1f6b0a944232F5c71798d27Ad9272, 0x2A3733dBc31980f02b12135C809b5da33BF3a1e9]

3 currencies are registered in the FeeCurrencyDirectory ✅ As expected, the registered currencies are:

cUSD ✅

cast call \
0xe6774BE4E5f97dB10cAFB4c00C74cFbdCDc434D9 \
"name()" \
--rpc-url=http://127.0.0.1:8546
0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000b43656c6f20446f6c6c6172000000000000000000000000000000000000000000

cast abi-decode \
"name()(string memory)" \
"0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000b43656c6f20446f6c6c6172000000000000000000000000000000000000000000"
"Celo Dollar"

cEUR ✅

cast call \
0xb7a33b4ad2B1f6b0a944232F5c71798d27Ad9272 \
"name()" \
--rpc-url=http://127.0.0.1:8546
0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000943656c6f204575726f0000000000000000000000000000000000000000000000

cast abi-decode \
"name()(string memory)" \
"0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000943656c6f204575726f0000000000000000000000000000000000000000000000"
"Celo Euro"

cREAL ✅

cast call \
0x2A3733dBc31980f02b12135C809b5da33BF3a1e9 \
"name()" \
--rpc-url=http://127.0.0.1:8546
0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001343656c6f204272617a696c69616e205265616c00000000000000000000000000

cast abi-decode \
"name()(string memory)" \
"0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001343656c6f204272617a696c69616e205265616c00000000000000000000000000"
"Celo Brazilian Real"

Get exchange rate for a currency:

$ cast call \
0x42Fe5a2A61ed9705eb2F08a04A58CEB606D22f6a \
"getExchangeRate(address)(uint256, uint256)" \
0xb7a33b4ad2B1f6b0a944232F5c71798d27Ad9272 \
--rpc-url=http://127.0.0.1:8546
1000000000000000000000000 [1e24]
1000000000000000000000000 [1e24]

Calling the getExchangeRate function on a registered currency returns an exchange rate ✅

Terminate Anvil:

$ kill $(lsof -i tcp:8546 | tail -n 1 | awk '{print $2}')

Source: start_anvil.sh

Related issues

Fixes Add FeeCurrencyDirectory to Anvil migrations #10991

Backwards compatibility

Yes, only adds to the migration script, doesn't alter existing expectations and behaviour.

Documentation

No docs changes

Not checked that the current changes are sufficient and working.

arthurgousset · 2024-05-13T16:10:18Z

Notes-to-self

create_and_migrate_anvil_devchain.sh
Source: packages/protocol/migrations_sol/create_and_migrate_anvil_devchain.sh

Entry point of workflow
Starts anvil with start_anvil.sh script
Deploys precompiles with deploy_precompiles.sh script
Sets registry contract at specified addresses using registry bytecode

start_anvil.sh
Source: packages/protocol/migrations_sol/start_anvil.sh

Start anvil instance at specified port and console logs when anvil is running

deploy_precompiles.sh
Source: packages/protocol/migrations_sol/deploy_precompiles.sh

Gets bytecodes from build artifacts, chooses precompile addresses, and sets bytecode at specified addresses on anvil

Migration.s.sol
Source: packages/protocol/migrations_sol/Migration.s.sol

run() function is the main entry point of the script

migrationsConfig.json
Source: packages/protocol/migrations_sol/migrationsConfig.json

Contains contract initialisation data and configs

FeeCurrencyDirectory.sol
Source: packages/protocol/contracts-0.8/common/FeeCurrencyDirectory.sol

Set a currency config

/**
   * @notice Sets the currency configuration for a token.
   * @dev This action can only be performed by the contract owner.
   * @param token The token address.
   * @param oracle The oracle address for price fetching.
   * @param intrinsicGas The intrinsic gas value for transactions.
   */
  function setCurrencyConfig(
    address token,
    address oracle,
    uint256 intrinsicGas
  )

IFeeCurrencyDirectory.sol
Source: packages/protocol/contracts-0.8/common/interfaces/IFeeCurrencyDirectory.sol

Specifies interface including CurrencyConfig struct

run_integration_tests_in_anvil.sh
Source: packages/protocol/migrations_sol/run_integration_tests_in_anvil.sh

Generates devchain and runs simple integration test defined in Integration.t.sol

integration_tests.sh
Source: packages/protocol/migrations_sol/integration_tests.sh

Uses forge to run test defined in Integration.t.sol script

Integration.t.sol
Source: packages/protocol/test-sol/integration/Integration.t.sol

High-level test file that defines account1, account2, and registry address
Currently doesn't test anything specific to other contracts as far as I can tell

FeeCurrencyDirectory.t.sol
Source: packages/protocol/test-sol/common/FeeCurrencyDirectory.t.sol

Foundry tests for FeeCurrencyDirectory

protocol_tests.yml
Source: .github/workflows/protocol_tests.yml

Workflow that runs Foundry-based tests
Runs migration test defined in run_integration_tests_in_anvil.sh script

celo-monorepo.yml
Source: .github/workflows/celo-monorepo.yml

Not relevant to this PR, because it uses the devchain, which is currently Ganache-based.

arthurgousset · 2024-05-13T16:13:42Z

Test migration locally

Requirement:

Have foundry installed
Be in the packages/protocol directory

Steps to reproduce:

Compile contracts
```
$ forge --version && forge compile
```

Run migration test

$ ./migrations_sol/run_integration_tests_in_anvil.sh

Test `FeeCurrencyDirectory` migration locally

Possible (short-term) solutions:

Manually run migration and run the devchain locally
Manually call getCurrencyConfig(stabletoken) on the local devchain

Possible (longer-term) solutions:

Add FeeCurrencyDirectory-related test to IntegrationTest (in Integration.t.sol), run integration test
Run FeeCurrencyDirectory tests (in FeeCurrencyDirectory.t.sol) using forge, if they run against the devchain. I don’t think that’s the case, but let’s see.

…y-to-Anvil-migrations

1. adds test oracle address 2. adds test intrinsic gas value

…y-to-Anvil-migrations

packages/protocol/migrations_sol/Migration.s.sol

arthurgousset · 2024-05-17T09:38:35Z

(note-to-self)
Useful related PRs:

…interface I was calling `initialize()`, but that function is defined in `FeeCurrencyDirectory` not `IFeeCurrencyDirectory`. Also updates string length, which was previously forgotten. At this point the compilation succeeds as expected, and the migration transactions are successful.

arthurgousset · 2024-05-17T09:45:41Z

At this point the compilation succeeds as expected, and the migration transactions are successful.

Next, I'll run a local Anvil instance (with all the migrations), and I'll interact with the deployed FeeCurrencyDirectory via cast to assert the FeeCurrencyDirectory contract works as expected:

get FeeCurrencyDirectory contract from the Registry
get the CurrencyConfig for the registered mock token

packages/protocol/migrations_sol/Migration.s.sol

arthurgousset · 2024-05-17T10:06:05Z

(note-to-self)

Check that Anvil is running

$ export ANVIL_PORT=8546
$ nc -z localhost $ANVIL_PORT
Connection to localhost port 8546 [tcp/*] succeeded!

Source: start_anvil.sh

Terminate Anvil:

$ export ANVIL_PORT=8546
$ kill $(lsof -i tcp:$ANVIL_PORT | tail -n 1 | awk '{print $2}')

Source: start_anvil.sh

arthurgousset · 2024-05-17T16:45:07Z

At this point (a36eae5), the local tests pass.

Local test

We can:

get the FeeCurrencyDirectory address from the Registry:

export REGISTRY_ADDRESS="0x000000000000000000000000000000000000ce10"
export ANVIL_PORT=8546 
cast call \
$REGISTRY_ADDRESS \
"getAddressForStringOrDie(string calldata identifier)" \
"FeeCurrencyDirectory" \
--rpc-url=http://127.0.0.1:$ANVIL_PORT

0x00000000000000000000000042fe5a2a61ed9705eb2f08a04a58ceb606d22f6a

cast abi-decode \
"getAddressForStringOrDie(string calldata identifier)(address)" \
"0x00000000000000000000000042fe5a2a61ed9705eb2f08a04a58ceb606d22f6a"

0x42Fe5a2A61ed9705eb2F08a04A58CEB606D22f6a

get registered currencies from the FeeCurrencyDirectory contract

export FEECURRENCYDIRECTORY_PROXY_ADDRESS=0x42Fe5a2A61ed9705eb2F08a04A58CEB606D22f6a
export ANVIL_PORT=8546
export MOCKTOKEN_ADDRESS=0xefB84935239dAcdecF7c5bA76d8dE40b077B7b33

cast call \
$FEECURRENCYDIRECTORY_PROXY_ADDRESS \
"getCurrencies()" \
--rpc-url=http://127.0.0.1:$ANVIL_PORT

0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000e6774be4e5f97db10cafb4c00c74cfbdcdc434d9000000000000000000000000b7a33b4ad2b1f6b0a944232f5c71798d27ad92720000000000000000000000002a3733dbc31980f02b12135c809b5da33bf3a1e9

cast abi-decode \
"getCurrencies()(address[] memory)" \
"0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000e6774be4e5f97db10cafb4c00c74cfbdcdc434d9000000000000000000000000b7a33b4ad2b1f6b0a944232f5c71798d27ad92720000000000000000000000002a3733dbc31980f02b12135c809b5da33bf3a1e9"

[0xe6774BE4E5f97dB10cAFB4c00C74cFbdCDc434D9, 0xb7a33b4ad2B1f6b0a944232F5c71798d27Ad9272, 0x2A3733dBc31980f02b12135C809b5da33BF3a1e9]

As expected, the registered currencies are

cUSD:

cast call \
0xe6774BE4E5f97dB10cAFB4c00C74cFbdCDc434D9 \
"name()" \
--rpc-url=http://127.0.0.1:8546
0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000b43656c6f20446f6c6c6172000000000000000000000000000000000000000000

cast abi-decode \
"name()(string memory)" \
"0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000b43656c6f20446f6c6c6172000000000000000000000000000000000000000000"
"Celo Dollar"

cEUR:

cast call \
0xb7a33b4ad2B1f6b0a944232F5c71798d27Ad9272 \
"name()" \
--rpc-url=http://127.0.0.1:8546
0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000943656c6f204575726f0000000000000000000000000000000000000000000000

cast abi-decode \
"name()(string memory)" \
"0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000943656c6f204575726f0000000000000000000000000000000000000000000000"
"Celo Euro"

cREAL:

cast call \
0x2A3733dBc31980f02b12135C809b5da33BF3a1e9 \
"name()" \
--rpc-url=http://127.0.0.1:8546
0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001343656c6f204272617a696c69616e205265616c00000000000000000000000000

cast abi-decode \
"name()(string memory)" \
"0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001343656c6f204272617a696c69616e205265616c00000000000000000000000000"
"Celo Brazilian Real"

This means, all currencies registered in the `FeeCurrencyDirectory` now support the `getExchangeRate` function, which uses the MockOracle contract under the hood.

arthurgousset · 2024-05-20T11:06:19Z

As of 8b910b7, the migration script sets the oracle in CurrencyConfig to a MockOracle.sol contract (which implements IOracle.sol), and sets an arbitrary exchange rate of $\frac{10}{5}$.

This works as expected ✅

Calling the getExchangeRate function on a registered currency returns the arbitrary exchange rate

$ cast call \
0x42Fe5a2A61ed9705eb2F08a04A58CEB606D22f6a \
"getExchangeRate(address)(uint256, uint256)" \
0xb7a33b4ad2B1f6b0a944232F5c71798d27Ad9272 \
--rpc-url=http://127.0.0.1:8546/
10
5

…y-to-Anvil-migrations

packages/protocol/migrations_sol/Migration.s.sol

…grations' of github.com:celo-org/celo-monorepo into arthurgousset/feat/add-FeeCurrencyDirectory-to-Anvil-migrations

The `SortedOracles.sol` contract already implements the `IOracle.sol` interface. This commit only adds it to the contract definition for ease of reference.

…cles` The latest `SortedOracles.sol` implementation implements the `IOracle.sol` interface. That means it implements the required `getExchangeRate()` function. That means the `MockOracle.sol` contract is not required in the migrations.

arthurgousset · 2024-05-20T13:40:32Z

As of 1c04e8b, the migration script sets the oracle in CurrencyConfig to the SortedOracles.sol contract (which implements IOracle.sol).

This works as expected ✅

Calling the getExchangeRate function on a registered currency returns an exchange rate:

$ cast call \
0x42Fe5a2A61ed9705eb2F08a04A58CEB606D22f6a \
"getExchangeRate(address)(uint256, uint256)" \
0xb7a33b4ad2B1f6b0a944232F5c71798d27Ad9272 \
--rpc-url=http://127.0.0.1:8546
1000000000000000000000000 [1e24]
1000000000000000000000000 [1e24]

Now matches error message defined in `isL2Check.sol` Source: https://github.com/celo-org/celo-monorepo/blob/668a4050f7ee067948498c333da3feec85fa03fe/packages/protocol/contracts-0.8/common/IsL2Check.sol#L32-L33

arthurgousset added 6 commits May 13, 2024 14:58

refactor(migrations/start_anvil): renames variable to fix typo

3952655

docs(protocol/create_and_migrate): adds comment for context

044b505

docs(protocol/migrations): adds TODOs and comments for context

d4dda9c

chore(protocol/migrations): adds TODO comment

0cb4453

feat(protocol/migrations): adds FeeCurrencyDirectory migration

6d3d407

Not checked that the current changes are sufficient and working.

feat(protocol/migrations): sets CurrencyConfig for stabletoken

2cec07d

arthurgousset mentioned this pull request May 13, 2024

Add FeeCurrencyDirectory to Anvil migrations #10991

Closed

arthurgousset added 3 commits May 15, 2024 22:19

Merge branch 'master' into arthurgousset/feat/add-FeeCurrencyDirector…

fe8f66e

…y-to-Anvil-migrations

feat(protocol/migrations_sol): sets example CurrencyConfig

99b59af

1. adds test oracle address 2. adds test intrinsic gas value

Merge branch 'master' into arthurgousset/feat/add-FeeCurrencyDirector…

35258dc

…y-to-Anvil-migrations

arthurgousset commented May 16, 2024

View reviewed changes

packages/protocol/migrations_sol/Migration.s.sol Show resolved Hide resolved

arthurgousset commented May 17, 2024

View reviewed changes

packages/protocol/migrations_sol/Migration.s.sol Show resolved Hide resolved

chore(protocol/migrations_sol): adds MockOracle to CurrencyConfigs

8b910b7

This means, all currencies registered in the `FeeCurrencyDirectory` now support the `getExchangeRate` function, which uses the MockOracle contract under the hood.

Merge branch 'master' into arthurgousset/feat/add-FeeCurrencyDirector…

3873e76

…y-to-Anvil-migrations

arthurgousset marked this pull request as ready for review May 20, 2024 11:10

arthurgousset requested a review from a team as a code owner May 20, 2024 11:10

pahor167 reviewed May 20, 2024

View reviewed changes

packages/protocol/migrations_sol/Migration.s.sol Outdated Show resolved Hide resolved

packages/protocol/migrations_sol/Migration.s.sol Outdated Show resolved Hide resolved

packages/protocol/migrations_sol/Migration.s.sol Outdated Show resolved Hide resolved

arthurgousset added 4 commits May 20, 2024 12:35

chore(protocol/migrations_sol): removes TODO comments

18eb163

Merge branch 'arthurgousset/feat/add-FeeCurrencyDirectory-to-Anvil-mi…

ed539fd

…grations' of github.com:celo-org/celo-monorepo into arthurgousset/feat/add-FeeCurrencyDirectory-to-Anvil-migrations

chore(protocol:SortedOracles.sol): Adds IOracle to contract definition

78e6cf2

The `SortedOracles.sol` contract already implements the `IOracle.sol` interface. This commit only adds it to the contract definition for ease of reference.

arthurgousset added 3 commits May 20, 2024 14:52

chore(protocol/migrations_sol): removes unused and duplicate imports

dfedba8

style(protocol/migrations_sol): linting

668a405

test(protocol/test-sol/Validators): updates L2 error messages

adccdf5

Now matches error message defined in `isL2Check.sol` Source: https://github.com/celo-org/celo-monorepo/blob/668a4050f7ee067948498c333da3feec85fa03fe/packages/protocol/contracts-0.8/common/IsL2Check.sol#L32-L33

pahor167 approved these changes May 20, 2024

View reviewed changes

arthurgousset merged commit eded310 into master May 20, 2024
24 checks passed

arthurgousset deleted the arthurgousset/feat/add-FeeCurrencyDirectory-to-Anvil-migrations branch May 20, 2024 16:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add FeeCurrencyDirectory to Anvil migrations #10992

Add FeeCurrencyDirectory to Anvil migrations #10992

arthurgousset commented May 13, 2024 •

edited

arthurgousset commented May 13, 2024

arthurgousset commented May 13, 2024 •

edited

arthurgousset commented May 17, 2024

arthurgousset commented May 17, 2024 •

edited

arthurgousset commented May 17, 2024 •

edited

arthurgousset commented May 17, 2024 •

edited

arthurgousset commented May 20, 2024 •

edited

arthurgousset commented May 20, 2024

Add FeeCurrencyDirectory to Anvil migrations #10992

Add FeeCurrencyDirectory to Anvil migrations #10992

Conversation

arthurgousset commented May 13, 2024 • edited

Description

Changes

Other changes

Tested

Related issues

Backwards compatibility

Documentation

arthurgousset commented May 13, 2024

arthurgousset commented May 13, 2024 • edited

Test migration locally

Test FeeCurrencyDirectory migration locally

arthurgousset commented May 17, 2024

arthurgousset commented May 17, 2024 • edited

arthurgousset commented May 17, 2024 • edited

arthurgousset commented May 17, 2024 • edited

Local test

arthurgousset commented May 20, 2024 • edited

arthurgousset commented May 20, 2024

arthurgousset commented May 13, 2024 •

edited

arthurgousset commented May 13, 2024 •

edited

Test `FeeCurrencyDirectory` migration locally

arthurgousset commented May 17, 2024 •

edited

arthurgousset commented May 17, 2024 •

edited

arthurgousset commented May 17, 2024 •

edited

arthurgousset commented May 20, 2024 •

edited