Upgrades README improvements #417
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
cam-schultz
requested review from
iansuvak,
feuGeneA,
geoff-vball,
minghinmatthewlam,
bernard-avalabs and
michaelkaplan13
Co-authored-by: bernard-avalabs <[email protected]> Signed-off-by: cam-schultz <[email protected]>
Co-authored-by: bernard-avalabs <[email protected]> Signed-off-by: cam-schultz <[email protected]>
|
|
||
| ### Pausing Teleporter version interactions | ||
|
|
||
| Dapps that inherit from `TeleporterUpgradeable` can pause Teleporter interactions by calling `TeleporterUpgradeable.pauseTeleporterAddress`. This function prevents the dApp contract from interacting with the paused Teleporter address when sending or receiving Teleporter messages. |
There was a problem hiding this comment.
think we should clarify that Teleporter itself is not paused, and it's just the dApp's sending/receiving of messages
There was a problem hiding this comment.
I tried to achieve this by saying that "Teleporter interactions" are paused - can you suggest an alternate phrasing?
Co-authored-by: Michael Kaplan <[email protected]> Signed-off-by: cam-schultz <[email protected]>
cam-schultz
requested review from
geoff-vball,
minghinmatthewlam and
michaelkaplan13
michaelkaplan13
previously approved these changes
Jul 12, 2024
geoff-vball
previously approved these changes
Jul 12, 2024
Co-authored-by: Michael Kaplan <[email protected]> Signed-off-by: cam-schultz <[email protected]>
cam-schultz
dismissed stale reviews from geoff-vball and michaelkaplan13
via
9d36ddd
geoff-vball
approved these changes
Jul 12, 2024
michaelkaplan13
approved these changes
Jul 12, 2024
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.
Why this should be merged
Fixes #406 by reorganizing existing documentation to separate contract implementation and contract management sections. Also adds example cast commands for pausing/unpausing Teleporter versions from the dApp contract.
How this works
How this was tested
How is this documented