Skip to content

[WIP] Crosschain Configuration docs #148

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[WIP] Crosschain Configuration docs #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions pages/protocol/crosschain/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"overview": "Overview",
"addresses": "Addresses",
"configuration": "Configuration",
"code": "Code"
}
42 changes: 42 additions & 0 deletions pages/protocol/crosschain/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Configuration
lang: en-US
---

## Crosschain Configuration

Frax OFTs and lockboxes require multiple settings to be configured for proper crosschain functionality. These settings include:

### SendLibrary

Frax utilizes the LZ-provided SendLibrary for sending messages crosschain. If LayerZero changes their default SendLibrary, Frax will maintain the previous version until manually set by the Frax team.

### ReceiveLibrary

Frax utilizes the LZ-provided ReceiveLibrary for receiving messages crosschain. If LayerZero changes their default ReceiveLibrary, Frax will maintain the previous version until manually set by the Frax team.

### Executor

Frax utilizes the LZ-provided Executor for executing messages crosschain. If LayerZero changes their default Executor, Frax will automatically update to the latest version.

### Max Message Size

Frax utilizes the LZ-provided Max Message Size setting to limit the maximum size of data in a message sent crosschain. In general, this value is the same across EVM chains and varies per non-EVM chain. If LayerZero changes their Max Message Size, Frax will automatically update to the latest setting.

### Confirmations

Frax utilizes the LZ-provided Confirmations setting to determine how many block confirmations are required before a message can be executed on the destination chain. This value varies per chain based on the average block time and finality of each chain. If LayerZero changes their Confirmations setting, Frax will automatically update to the latest setting.

### Enforced Options

Frax configures a default Enforced Option to require a minimum amount of gas to be forwarded to each destination chain executor. This ensures that messages have sufficient gas to be executed on the destination chain. Enforced Options are solely managed by the Frax team.

### Delegate

The delegate is a permissioned address that can configure the aforementioned settings on the OFT and lockbox contracts. The Frax team operates as the delegate through a 3/6 multisig on each respective chain, found within the #Addresses section of the crosschain docs.

### DVN

Frax utilizes a 3 of 3 DVN stack required to approve every crosschain transaction. The DVNs are operated by LayerZero, Horizen, and Frax. In particular, the Frax DVN details are as follows:

TODO