[WIP] UMIP-179: Updates #602
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
pxrl
commented
Apr 22, 2024
•
pxrl
commented
- Truncate LP fee precision to 8 (tbd) decimals.
- Remove deprecated legacy v3 events.
- Add link to OZ audit reports.
- Specify proposer action on invalid FilledV3Relay repaymentChainId. - Clarify proposer action on un-executable RelayerRefundLeaf. - Add link to OZ audit for Across V3.
pxrl
commented
Apr 22, 2024
UMIPs/umip-179.md
Outdated
Comment on lines
260
to
263
| If a validated `FilledV3Relay` event specifies an invalid `repaymentChainId`, the proposer shall issue repayment on the fill destination chain. | ||
| Reasons for the `repaymentChainId` to be considered invalid are: | ||
| - `repaymentChainId` is not supported by Across. | ||
| - `inputToken` is not supported as a repayment token on `repaymentChainId`. |
There was a problem hiding this comment.
I think forcing repayment on the destination chain is the only safe approach here, since if the relayer fills via a contract on zkSync and the proposer proposes repayment on some other chain then the relayer will never receive their repayment.
There was a problem hiding this comment.
Yeah, good point. I think that's right.
pxrl
commented
Apr 22, 2024
UMIPs/umip-179.md
Outdated
| - The LP fee is typically referenced as a multiplier of the `V3FundsDeposited` `inputAmount`, named `realizedLpFeePct` elsewhere in this document. | ||
| - The LP fee as a multiplier of `inputAmount` (typically named `realizedLpFeePct` elsewhere in this document) shall be: | ||
| - Promoted to 18 decimals, where 1e18 represents 100%, and | ||
| - Truncated (zeroed) between 0 and 1e10, providing 8 decimals of effective precision. |
There was a problem hiding this comment.
Would appreciate feedback on the wording here.
There was a problem hiding this comment.
Do you think it's easier to understand if you show the math?
The LP fee is truncated via the following formula: output = input / 1e10 * 1e10
There was a problem hiding this comment.
Maybe:
- Available precision to 8 decimals. Truncated via [output = input / 1e10 * 1e10]
mrice32
reviewed
May 6, 2024
UMIPs/umip-179.md
Outdated
| - The LP fee is typically referenced as a multiplier of the `V3FundsDeposited` `inputAmount`, named `realizedLpFeePct` elsewhere in this document. | ||
| - The LP fee as a multiplier of `inputAmount` (typically named `realizedLpFeePct` elsewhere in this document) shall be: | ||
| - Promoted to 18 decimals, where 1e18 represents 100%, and | ||
| - Truncated (zeroed) between 0 and 1e10, providing 8 decimals of effective precision. |
There was a problem hiding this comment.
Do you think it's easier to understand if you show the math?
The LP fee is truncated via the following formula: output = input / 1e10 * 1e10
UMIPs/umip-179.md
Outdated
|
|
||
| ### Computing Bundle LP Fees | ||
| The bundle LP fee for a target block range on a SpokePool and token pair shall be determined by summing the applicable LP fees for each of the following validated events: | ||
| - `FilledV3Relay` | ||
|
|
||
| ### Computing Relayer Repayments | ||
| For a validated `FilledV3Relay` event, the relayer repayment amount shall be computed as follows: | ||
| - `(inputAmount * (1 - realizedLpFeePct)) / 1e18`, where `realizedLpFeePct` is computed over the set of HubPool `l1Token`, `originChainId` and `repaymentChainId` at the HubPool block number corresponding to the relevant `V3FundsDeposited` `quoteTimestamp`. | ||
| - `(inputAmount * (1e18 - realizedLpFeePct)) / 1e18`, where `realizedLpFeePct` is computed over the set of HubPool `l1Token`, `originChainId` and `repaymentChainId` at the HubPool block number corresponding to the relevant `V3FundsDeposited` `quoteTimestamp`. |
UMIPs/umip-179.md
Outdated
Comment on lines
260
to
263
| If a validated `FilledV3Relay` event specifies an invalid `repaymentChainId`, the proposer shall issue repayment on the fill destination chain. | ||
| Reasons for the `repaymentChainId` to be considered invalid are: | ||
| - `repaymentChainId` is not supported by Across. | ||
| - `inputToken` is not supported as a repayment token on `repaymentChainId`. |
There was a problem hiding this comment.
Yeah, good point. I think that's right.
UMIPs/umip-179.md
Outdated
| - The LP fee is typically referenced as a multiplier of the `V3FundsDeposited` `inputAmount`, named `realizedLpFeePct` elsewhere in this document. | ||
| - The LP fee as a multiplier of `inputAmount` (typically named `realizedLpFeePct` elsewhere in this document) shall be: | ||
| - Promoted to 18 decimals, where 1e18 represents 100%, and | ||
| - Truncated (zeroed) between 0 and 1e10, providing 8 decimals of effective precision. |
There was a problem hiding this comment.
Maybe:
- Available precision to 8 decimals. Truncated via [output = input / 1e10 * 1e10]
UMIPs/umip-179.md
Outdated
|
|
||
| Note: | ||
| - If a particular relayer refund is known to be unexecutable, it can be removed from the bundle by the proposer if a sufficient public justification is made before the proposal. This is intended to deal with unlikely situations, such as ag centralized token issuer blacklisting an address that is due a refund. If this leaf were to remain unaltered, this blacklisted address could block other addresses from recieving refunds. | ||
| Across v3 has been [audited by OpenZeppelin](https://blog.openzeppelin.com/across-v3-incremental-audit). |
There was a problem hiding this comment.
Suggested change
| Across v3 has been [audited by OpenZeppelin](https://blog.openzeppelin.com/across-v3-incremental-audit). | |
| Across v3 has been audited by OpenZeppelin, shared [here](https://blog.openzeppelin.com/across-v3-incremental-audit) and [here](https://blog.openzeppelin.com/across-v3-and-oval-incremental-audit). |
There was a problem hiding this comment.
Good call. It looks like OZ haven't posted about their most recent audit yet. @mrice32 are we able to prompt on that?
pxrl
commented
Mar 6, 2025
nicholaspai
reviewed
Mar 6, 2025
| @@ -407,18 +360,19 @@ Each valid `Fill` is subject to an LP fee. The procedure for computing LP fees i | |||
| - The `HubPool` `liquidityUtilizationCurrent()` and `liquidityUtilizationPostRelay()` functions shall be used instead of the `BridgePool` variant. | |||
| - The event `inputToken` shall be mapped from the SpokePool address to a HubPool `l1Token` address by following the matching procedure outlined above. | |||
| - The LP fee is computed between the `originChainId` specified by the `Deposit` and `repaymentChainId` specified by the relayer, where the `relayExecutionInfo.FillType != SlowFill` and the Fill `destinationChainId` otherwise. | |||
| - The LP fee as a multiplier of `inputAmount` (typically named `realizedLpFeePct` elsewhere in this document) shall be: | |||
| - Promoted to 18 decimals, where 1e18 represents 100%, and | |||
| - Truncated to 8 decimals of effective precision, as follows: lpFee = (inputAmount / 1e10) * 1e10 | |||
There was a problem hiding this comment.
Why 8? why not 6? Just curious how you selected 8, as I imagine the fewest # of precision decimals we can use -- the better UX
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.