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.

Sign up for GitHub

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

Add aep addresses #1915

Merged
merged 5 commits into from
Dec 17, 2024
Merged

Add aep addresses #1915

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4cdd703
Add AEP fee routing addresses back
TucksonDev Dec 17, 2024
90bf876
Include new routers
TucksonDev Dec 17, 2024
2bcd523
Merge branch 'master' into add-aep-addresses
TucksonDev Dec 17, 2024
5607d41
Smol change to trigger deployment
TucksonDev Dec 17, 2024
460687a
Merge branch 'master' into add-aep-addresses
TucksonDev Dec 17, 2024
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
18 changes: 7 additions & 11 deletions arbitrum-docs/launch-orbit-chain/how-tos/set-up-aep-fee-router.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 'How to set up an AEP fee router'
sidebar_label: 'Set up an AEP fee router'
description: 'Learn how to implement AEP fee router.'
author: Midroni
sme: Midroni
description: 'Learn how to setup an AEP fee router.'
author: Midroni, TucksonDev
sme: Midroni, TucksonDev
user_story: As a current Orbit chain owner, I need to learn how to set up an AEP fee router.
content_type: how-to
---
Expand All @@ -12,15 +12,13 @@ content_type: how-to

You can adopt the AEP Fee Router by using the [AEP Router deployment scripts](https://github.com/OffchainLabs/arbitrum-orbit-sdk/tree/main/examples/setup-aep-fee-router) provided in the [Orbit SDK](https://github.com/OffchainLabs/arbitrum-orbit-sdk/tree/main)

<!--
### Canonical contracts

| Network | Contract | Address | Configured for |
| ------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------- |
| Ethereum | `Arbitrum Foundation's multisig wallet` | [0x1Afa41C006dA1605846271E7bdae942F2787f941](https://etherscan.io/address/0x1Afa41C006dA1605846271E7bdae942F2787f941) | `ETH`, `ERC-20` |
| Arbitrum Nova | `Child2ParentRouter` | [0x36D0170D92F66e8949eB276C3AC4FEA64f83704d](https://nova.arbiscan.io/address/0x36D0170D92F66e8949eB276C3AC4FEA64f83704d) | `ETH` |
| Base | `Child2ParentRouter` | [0x1015c1ae166c4c39d18a1151b7029bac1530c9aa](https://basescan.org/address/0x1015c1ae166c4c39d18a1151b7029bac1530c9aa) | `ETH` |
-->
| Arbitrum Nova | `Child2ParentRouter` | [0xd27cb0fe2a696ebaa80d606ce0edf55aabaeab84](https://nova.arbiscan.io/address/0xd27cb0fe2a696ebaa80d606ce0edf55aabaeab84) | `ETH` |
| Base | `Child2ParentRouter` | [0xd9a2e0e5d7509f0bf1b2d33884f8c1b4d4490879](https://basescan.org/address/0xd9a2e0e5d7509f0bf1b2d33884f8c1b4d4490879) | `ETH` |

## The AEP fee router contract system

Expand Down Expand Up @@ -49,7 +47,7 @@ This includes:
- Another `ChildToParentRouter` configured to the same gas token and configured to send funds to a successive parent chain (this is the case for a Layer-3 network or higher)
- Deploying a `RewardDistributor` contract configured to forward 10% of fees to the `ChildToParentRouter` and 90% to the chain owner’s preferred reward-receiving address.

In the event that a `ChildToParentRouter` does not connect to the address controlled by the Arbitrum Foundation on Ethereum, an Orbit chain must deploy successive `ChildToParentRouter` contracts until a connection to such address is established. <!-- Additional `ChildToParentRouter` contracts configured to route ETH have been deployed in certain networks and can be leveraged by chains created on top of these networks. You can see which networks have a router deployed [here](#canonical-contracts). -->
In the event that a `ChildToParentRouter` does not connect to the address controlled by the Arbitrum Foundation on Ethereum, an Orbit chain must deploy successive `ChildToParentRouter` contracts until a connection to such address is established. Additional `ChildToParentRouter` contracts configured to route ETH have been deployed in certain networks and can be leveraged by chains created on top of these networks. You can see which networks have a router deployed [here](#canonical-contracts).

Optionally, an Orbit chain can decide to deduct assertion costs by following the instructions in the [Deducting Assertion Costs](/launch-orbit-chain/how-tos/calculate-aep-fees#assertion-costs) section:

Expand All @@ -64,15 +62,13 @@ In the absence of these, please send `ETH` through the AEP Fee Router to fulfill

The Orbit SDK provides a [configurable script](https://github.com/OffchainLabs/arbitrum-orbit-sdk/tree/main/examples/setup-aep-fee-router) that allows a chain operator to deploy quickly and set up the AEP fee router contracts.

<!--
::::info Note for L3 chains with custom gas tokens

The standard script deploys and sets up the AEP fee router contracts to route funds to the parent chain.
L2 chains are expected to route funds to the [multisig wallet owned by the Arbitrum Foundation](#canonical-contracts) living on Ethereum.
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](#canonical-contracts) 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.

::::
-->

The script performs the following operations:

Expand All @@ -95,7 +91,7 @@ To configure the script, you need to specify the following [environment variable
- `ORBIT_CHAIN_ID`: chain id of the Orbit chain
- `ORBIT_CHAIN_RPC`: RPC of the Orbit chain
- `PARENT_CHAIN_ID`: chain id of the parent chain, which shouldn't be an Arbitrum chain
- `PARENT_CHAIN_TARGET_ADDRESS`: address on the parent chain where 10% of the revenue will be sent to. Please, contact the Arbitrum Foundation to obtain the specific target address for your chain. <!-- You can find the potential target addresses in the [canonical contracts](#canonical-contracts) section of this document. If the parent chain is not on that list, or if your chain uses a gas token different than the one the router is configured for, contact the Arbitrum Foundation to obtain a specific target address for your chain. -->
- `PARENT_CHAIN_TARGET_ADDRESS`: address on the parent chain where 10% of the revenue will be sent to. You can find the potential target addresses in this document's [canonical contracts](#canonical-contracts) section. If the parent chain is not on that list, or if your chain uses a gas token different than the one the router is configured for, contact the Arbitrum Foundation to obtain a specific target address for your chain.

Finally, follow these steps to execute the script (from the `examples/setup-aep-fee-router` folder):

Expand Down
Loading