From 2f9ed55b8c08e32c44b5fe5fd848d13d58786c64 Mon Sep 17 00:00:00 2001 From: Leo Date: Thu, 21 Jan 2021 11:59:06 +0100 Subject: [PATCH] docs: document that PokeProposals are no longer needed --- docs/assumptions.md | 8 ++++---- docs/solana_program.md | 4 ++++ 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/assumptions.md b/docs/assumptions.md index dd52f7b1..deed8949 100644 --- a/docs/assumptions.md +++ b/docs/assumptions.md @@ -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 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 -request retransmission of their lockup, resulting in re-observation by nodes and another round of consensus. During -chain replay, nodes will re-process events from connected chains up from a given block height, check whether a VAA has -already been submitted to Solana, and initiate a round of consensus for missed lockups. +The mitigation for this is a polling control loop in the case of Solana or chain replay for other chains. On Solana, the +node will consistently poll for unprocessed lockups, resulting in re-observation by nodes and another round of +consensus. During chain replay, nodes will re-process events from connected chains up from a given block height, check +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 lockup will always result in the same VAA body hash. All connected chains keep a permanent record of whether a given VAA diff --git a/docs/solana_program.md b/docs/solana_program.md index d683152d..ab29be0d 100644 --- a/docs/solana_program.md +++ b/docs/solana_program.md @@ -20,6 +20,10 @@ Initializes a new Bridge at `bridge`. 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 | | ----- | ------ | ------------ | ------ | --------- | ----- | ------- | | 0 | proposal | TransferOutProposal | | ✅ | ️ | ✅ |