Managing Your Router
Routers have three distinct roles for management:
- 1.Router Signer - The address associated with the private key that is available to the router at runtime to sign payloads which authorize liquidity to be used to facilitate cross-chain transfers. The Router Signer also has the ability to remove the router’s liquidity to the designated recipient.⚠️ The *Router Signer* key is effectively a hot wallet that must be accessible by an internet-connected router at all times, making it the least secure key in the system. It is important to understand the ramifications of a key compromise and configure the other roles appropriately to mitigate risks.
- 2.Recipient - The address that will receive funds when liquidity is removed. Example secure options are: a DAO treasury, a secure multisig, a custodial centralized exchange account which you trust. Since this is only a receiver address, it is not required to be able to sign and send transactions (i.e. in the custodial case).ℹ️ There is an option to *not set* the recipient by setting it to `address(0)`. This will allow the `removeRouterLiquidity` functions to specify a recipient of their choice. This is a security risk and **not recommended** unless you are fully aware of the risks and have specific needs to do this.
- 3.Router Owner - The address that is able to set and change the Recipient address, as well as change itself to a different Router Owner address. The Router Owner can also remove the router’s liquidity to the designated recipient. This address should be a secure multisig, since it needs to be able to sign transactions to carry out the functionality.ℹ️ Router Ownership can be *burned* (set to `address(0)`). This is of course the most secure way to manage a router, but the implications are you can never change the designated recipient.
Use this section if the router has never been initialized.
- 1.Use the Connext repo to find the deployments for the chain you want to set up the router on:
- 1.Find the
Connext.jsondeployment for that chain and copy the address.
- 3.Scroll to the
RoutersFacetsection and select the option for
WRITEand connect with the Router Signer account.
- 4.Select the method
initializeRouterand fill in the details for
_recipientand execute the transaction.
- 5.Notify the Connext team to allowlist your router (this is still a permissioned role!).
ℹ️ Note: This is the easiest way to call the contract function but since it is an onchain function it can be called from any mechanism to send the correct function with the appropriate arguments.
Use these instructions to modify a router that has already been initialized.
- 2.Use the functions
RoutersFacetto modify the params as necessary.
- 1.Navigate to the ‘Router’ tab on Connextscan 2.0 and click your router ID
- 2.Click ‘Manage Router, and remove funds using our ’Remove Liquidity’ UI feature
- 2.Find the canonical
TokenIdby calling the
adoptedToCanonicalfunction on the
TokenFacetand filling in the
_adoptedwith the address of the token contract of the “adopted asset” (i.e. USDC).
- 3.With this information, call the