docs: document that PokeProposals are no longer needed

This commit is contained in:
Leo 2021-01-21 11:59:06 +01:00
parent b5d8993f44
commit 2f9ed55b8c
2 changed files with 8 additions and 4 deletions

View File

@ -21,10 +21,10 @@ periodically attempt to retransmit signatures for VAAs which failed to reach con
network outages. Longer network outages, leading to timeouts, and correlated crashes of a superminority of nodes may network outages. Longer network outages, leading to timeouts, and correlated crashes of a superminority of nodes may
result in lockups being dropped. result in lockups being dropped.
The mitigation for this is the PokeVAA mechanism on Solana or chain replay for other chains. On Solana, a user can The mitigation for this is a polling control loop in the case of Solana or chain replay for other chains. On Solana, the
request retransmission of their lockup, resulting in re-observation by nodes and another round of consensus. During node will consistently poll for unprocessed lockups, resulting in re-observation by nodes and another round of
chain replay, nodes will re-process events from connected chains up from a given block height, check whether a VAA has consensus. During chain replay, nodes will re-process events from connected chains up from a given block height, check
already been submitted to Solana, and initiate a round of consensus for missed lockups. whether a VAA has already been submitted to Solana, and initiate a round of consensus for missed lockups.
This carries no risk and can be done any number of times. VAAs are fully deterministic and idempotent - any given This carries no risk and can be done any number of times. VAAs are fully deterministic and idempotent - any given
lockup will always result in the same VAA body hash. All connected chains keep a permanent record of whether a given VAA lockup will always result in the same VAA body hash. All connected chains keep a permanent record of whether a given VAA

View File

@ -20,6 +20,10 @@ Initializes a new Bridge at `bridge`.
Pokes a `TransferOutProposal` so it is reprocessed by the guardians. Pokes a `TransferOutProposal` so it is reprocessed by the guardians.
**Deprecated:** PokeProposals were a workaround for unreliable message delivery on Solana. Now that this has been fixed
using a control loop (https://github.com/certusone/wormhole/commit/fd6c54de836cb9f4c423aa334b73546a139c0ee6), poking is
no longer required. The feature is left in place for backwards compatibility reasons.
| Index | Name | Type | signer | writeable | empty | derived | | Index | Name | Type | signer | writeable | empty | derived |
| ----- | ------ | ------------ | ------ | --------- | ----- | ------- | | ----- | ------ | ------------ | ------ | --------- | ----- | ------- |
| 0 | proposal | TransferOutProposal | | ✅ | | ✅ | | 0 | proposal | TransferOutProposal | | ✅ | | ✅ |