refactor: Consolidate relayer fillRelay method #967
Merged
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
No change in behaviour, but a but less code duplication between the normal and sped-up fillRelay code paths. This is a precursor to supporting messaging.
pxrl
requested review from
mrice32,
nicholaspai and
james-a-morris
as code owners
pxrl
commented
Oct 4, 2023
Comment on lines
+318
to
+319
| ? `Filled deposit ${messageModifier}🚀` | ||
| : `Partially filled deposit ${messageModifier}📫"`; |
There was a problem hiding this comment.
Just want to call this out specifically, since the wording of the log message is changed by this PR.
Before: Relay instantly sent & Instantly completed relay
After: Filled deposit & Partially filled deposit
The rationale for this is that I always found Instantly completed relay to be confusing - it indicates a partial fill, but the only real indicator of this is the postbox emoji (📫). RE Relay instantly sent, this can also occur on a deposit that is hours or days old, so instantly is pretty subjective.
mrice32
approved these changes
Oct 4, 2023
| this.logger.debug({ at: "Relayer", message: "Filling deposit", deposit, repaymentChainId }); | ||
|
|
james-a-morris
approved these changes
Oct 5, 2023
Comment on lines
+690
to
+700
| const srcChain = getNetworkName(deposit.originChainId); | ||
| const dstChain = getNetworkName(deposit.destinationChainId); | ||
| const amount = createFormatFunction(2, 4, false, decimals)(deposit.amount.toString()); | ||
| const depositor = blockExplorerLink(deposit.depositor, deposit.originChainId); | ||
| const _fillAmount = createFormatFunction(2, 4, false, decimals)(fillAmount.toString()); | ||
| const relayerFeePct = formatFeePct(deposit.relayerFeePct); | ||
| const realizedLpFeePct = formatFeePct(deposit.realizedLpFeePct); | ||
| return ( | ||
| `Relayed depositId ${deposit.depositId} from ${getNetworkName(deposit.originChainId)} ` + | ||
| `to ${getNetworkName(deposit.destinationChainId)} of ` + | ||
| `${createFormatFunction(2, 4, false, decimals)(deposit.amount.toString())} ${symbol}. ` + | ||
| `with depositor ${blockExplorerLink(deposit.depositor, deposit.originChainId)}. ` + | ||
| `Fill amount of ${createFormatFunction(2, 4, false, decimals)(fillAmount.toString())} ${symbol} with ` + | ||
| `relayerFee ${formatFeePct(deposit.relayerFeePct)}% & ` + | ||
| `realizedLpFee ${formatFeePct(deposit.realizedLpFeePct)}%. ` | ||
| `Relayed depositId ${deposit.depositId} from ${srcChain} to ${dstChain} of ${amount} ${symbol},` + | ||
| ` with depositor ${depositor}. Fill amount of ${_fillAmount} ${symbol} with` + | ||
| ` relayerFee ${relayerFeePct}% & realizedLpFee ${realizedLpFeePct}%.` |
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.
No change in behaviour, but a but less code duplication between the normal and sped-up fillRelay code paths.
This is a precursor to supporting messaging.