docs: Modify Governor whitepaper to include information about Flow Cancelling #3982
Conversation
johnsaigle
force-pushed
the
flow-cancel-docs
branch
from
852dd3e
to
781eb8f
Compare
johnsaigle
dismissed stale reviews from SEJeff, bruce-riley, and djb15
via
27ec6e4
johnsaigle
force-pushed
the
flow-cancel-docs
branch
from
781eb8f
to
27ec6e4
Compare
johnsaigle
force-pushed
the
flow-cancel-docs
branch
from
27ec6e4
to
855c4fb
Compare
There was a problem hiding this comment.
The *Configuration*: heading should get a new bullet point for flow cancel.
| #### Headroom Calculations | ||
|
|
||
| The headroom for a given chain is the sum of the notional USD value of all transfers of governed tokens emitted from that chain within a 24 hour sliding window. | ||
| Inbound transfers of certain tokens can also decrease this sum, a process we refer to as Flow Canceling. The tokens are listed in [flow_cancel_tokens.go](https://github.com/wormhole-foundation/wormhole/blob/main/node/pkg/governor/flow_cancel_tokens.go). An inbound transfer of these tokens to chain will reduce that chain's outbound limit: effectively the net-flow is zero. This allows for a relaxing of the Governor's rate-limiting as it accounts for the net flow of these assets rather than calculating only the outbound value. |
There was a problem hiding this comment.
An inbound transfer of these tokens to chain will reduce that chain's outbound limit: effectively the net-flow is zero.
This sentence structure is odd and "these tokens to chain will..." sounds grammatically incorrect. Additionally, this does not reduce the chain's outbound limit but rather the calculated aggregate.
| @@ -69,7 +74,7 @@ Each Guardian publishes its Governor configuration and status on the Wormhole go | |||
|
|
|||
| ## Detailed Design | |||
|
|
|||
| The Governor is implemented as an additional package that defines (1) a `ChainGovernor` object, (2) `mainnet_tokens.go`, a single map of tokens that will be monitored, and (3) `mainnet_chains.go`, a map of chains governed by the chain governor. | |||
| The Governor is implemented as an additional package that defines (1) a `ChainGovernor` object, (2) `mainnet_tokens.go`, a single map of tokens that will be monitored, (3) `mainnet_chains.go`, a map of chains governed by the chain governor, and (4) `flow_cancel_tokens.go`, a map of tokens that can reduce the Governor's rate limit. | |||
There was a problem hiding this comment.
can reduce the Governor's rate limit.
nit: "can reduce a chains calculated aggregate flow." or some term that is more accurate than "reduce the ... limit" since the limit remains the same.
|
Converting to draft until #4016 is settled and merged. Once we have a flow cancel redeployed and new considerations are accounted for, I'll come back to this document and make sure it reflects the changes that we've made. |
A documentation PR that adds information on Flow Cancel Tokens added in #3798.
Please let me know if the level of detail is sufficient or if it would be better to move the text to another section.