Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update aep setup script readme #231

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions examples/setup-aep-fee-router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The script performs the following operations:

1. Obtain all chain contracts (needed to execute the next steps)
2. Obtain the current fee collectors of the chain: Orbit base fee collector, Orbit surplus fee collector, Parent chain surplus fee collector
3. Deploy the ChildToParentRouter contract, configured to send the amounts received to the appropriate Arbitrum Foundation or Arbitrum DAO controlled address on the parent chain
3. Deploy the ChildToParentRouter contract, configured to send the amounts received to the appropriate address on the parent chain controlled by the Arbitrum Foundation
4. Deploy a RewardDistributor contract for each different fee collector account, configured to distribute 90% of the amounts received to the current fee collector, and 10% to the ChildToParentRouter contract
5. Set each of the fee collectors to the RewardDistributor contracts

Expand All @@ -18,18 +18,20 @@ Note that if all three fee types are collected by the same address, only one Rew

- ROLLUP_ADDRESS: address of the Rollup contract
- CHAIN_OWNER_PRIVATE_KEY: private key of the account with executor privileges in the UpgradeExecutor admin contract for the chain
- ORBIT_CHAIN_ID: chainId of the Orbit chain
- ORBIT_CHAIN_ID: chain id of the Orbit chain
- ORBIT_CHAIN_RPC: RPC of the Orbit chain
- PARENT_CHAIN_ID: chainId of the parent chain (should be a non-Arbitrum chain, including Ethereum)
- PARENT_CHAIN_ID: chain id of the parent chain (should be a non-Arbitrum chain)
- PARENT_CHAIN_TARGET_ADDRESS: address on the parent chain where 10% of the revenue will be sent to (more information below)

### What PARENT_CHAIN_TARGET_ADDRESS to use

When executing this script, the RewardDistributor contract will be configured to send 10% of the funds received (10% of the revenue of the chain) to the address specified in PARENT_CHAIN_TARGET_ADDRESS, in the parent chain.

The PARENT_CHAIN_TARGET_ADDRESS should be an address controlled by the Arbitrum Foundation or the Arbitrum DAO. For L2 Orbit chains settling to Ethereum that use ETH as the native gas token, this variable should be `0x40Cd7D713D7ae463f95cE5d342Ea6E7F5cF7C999`, which is a ParentToChildRewardRouter contract that sends its balance in ETH to the Arbitrum Foundation Treasury Timelock contract on Arbitrum One.
For L2 Orbit chains settling to Ethereum, this variable should be the `ParentToChildRewardRouter` contract that lives on Ethereum, which routes its funds to the Arbitrum DAO Treasury Timelock contract on Arbitrum One.

If your chain is an L2 Orbit chain that uses a different native gas token, or if it is an L3 Orbit chain that settles to a non-Arbitrum chain, you should set PARENT_CHAIN_TARGET_ADDRESS to a different address. Please reach out to the Arbitrum Foundation to get the appropriate address.
L3 chains (or further layers) might need to specify a different target address on the parent chain depending on the gas token of the chain. If the chain uses ETH as the gas token, and a `ChildToParentRouter` contract is deployed in the parent chain, they can route their funds to that contract. If the chain uses a different gas token, please contact the Arbitrum Foundation to confirm the target address to withdraw the AEP fees to.

Routing contracts owned by the Arbitrum Foundation can be seen in the [AEP documentation](https://docs.arbitrum.io/launch-orbit-chain/how-tos/set-up-aep-fee-router#canonical-contracts).

## Setup

Expand Down
Loading