docs: payee registration and fee distribution for relayer operators #1577
Conversation
damiannolan
requested review from
colin-axner,
AdityaSripal,
crodriguezvega,
seantking,
charleenfei and
chatton
as code owners
|
|
||
| Packet fees are divided into 3 distinct amounts in order to compensate relayer operators for packet relaying on fee enabled IBC channels. | ||
|
|
||
| - `RecvFee`: The sum of all packet receive fees distributed to a payee for successful execution of `MsgRecvPacket`. |
There was a problem hiding this comment.
Seeing as we're saying the sum of all packet receive fees it might be worth noting above that a packet fee can be 'topped up' multiple times. wdyt?
There was a problem hiding this comment.
Maybe that could be added to the section Escrowing and paying out fees of @charleenfei's PR.
There was a problem hiding this comment.
Yeah, possibly adding to @charleenfei's PR would be a nice idea and segway into linking to this docs page.
There was a problem hiding this comment.
Yea, though the fact that the fees are stored as separate structs is an implementation detail imo. I think it makes sense to say that RecvFee here is the fee that will be distributed to the payee for a successful execution of RecvPacket
And in the escrowing section we can document that the recvFee along with other fees can be topped up multiple times. wdyt?
|
|
||
| Packet fees are divided into 3 distinct amounts in order to compensate relayer operators for packet relaying on fee enabled IBC channels. | ||
|
|
||
| - `RecvFee`: The sum of all packet receive fees distributed to a payee for successful execution of `MsgRecvPacket`. |
There was a problem hiding this comment.
Maybe that could be added to the section Escrowing and paying out fees of @charleenfei's PR.
Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: Sean King <seantking@users.noreply.github.com>
|
|
||
| # Fee distribution | ||
|
|
||
| Learn about payee registration for the distribution of packet fees. The following document is intended for relayer operators. {synopsis} |
There was a problem hiding this comment.
Nice. This is a meta-level comment but perhaps we can have who the document is intended for as its own seperate section at the top?
|
|
||
| Packet fees are divided into 3 distinct amounts in order to compensate relayer operators for packet relaying on fee enabled IBC channels. | ||
|
|
||
| - `RecvFee`: The sum of all packet receive fees distributed to a payee for successful execution of `MsgRecvPacket`. |
There was a problem hiding this comment.
Yea, though the fact that the fees are stored as separate structs is an implementation detail imo. I think it makes sense to say that RecvFee here is the fee that will be distributed to the payee for a successful execution of RecvPacket
And in the escrowing section we can document that the recvFee along with other fees can be topped up multiple times. wdyt?
| The counterparty payee address registered on the destination chain is encoded into the packet acknowledgement and communicated as such to the source chain for fee distribution. | ||
| If a counterparty payee is not registered for the forward relayer on the destination chain, the escrowed fees will be refunded upon fee distribution. | ||
|
|
||
| A transaction must be submitted to the desintation chain including a `CounterpartyPayee` address of an account on the source chain. |
Description
ref: #1408
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes