GITBOOK-71: grammar fix

guqicun · Feb 13, 2024 · f4c5d9c · f4c5d9c
1 parent a7f95fb
commit f4c5d9c
Show file tree

Hide file tree

Showing 25 changed files with 391 additions and 2 deletions.
diff --git a/docs/.gitbook/assets/approve_weth.png b/docs/.gitbook/assets/approve_weth.png
diff --git a/docs/.gitbook/assets/deposit_eth_to_weth.png b/docs/.gitbook/assets/deposit_eth_to_weth.png
diff --git a/docs/.gitbook/assets/ethereum_wallet.png b/docs/.gitbook/assets/ethereum_wallet.png
diff --git a/docs/.gitbook/assets/fund_destination_account.png b/docs/.gitbook/assets/fund_destination_account.png
diff --git a/docs/.gitbook/assets/query_asset_exists.png b/docs/.gitbook/assets/query_asset_exists.png
diff --git a/docs/.gitbook/assets/query_asset_exists_result.png b/docs/.gitbook/assets/query_asset_exists_result.png
diff --git a/docs/.gitbook/assets/query_destination_account.png b/docs/.gitbook/assets/query_destination_account.png
diff --git a/docs/.gitbook/assets/query_fees.png b/docs/.gitbook/assets/query_fees.png
diff --git a/docs/.gitbook/assets/query_register_token_fee.png b/docs/.gitbook/assets/query_register_token_fee.png
diff --git a/docs/.gitbook/assets/query_succesful_transfer.png b/docs/.gitbook/assets/query_succesful_transfer.png
diff --git a/docs/.gitbook/assets/query_successful_transfer_result.png b/docs/.gitbook/assets/query_successful_transfer_result.png
diff --git a/docs/.gitbook/assets/register_token.png b/docs/.gitbook/assets/register_token.png
diff --git a/docs/.gitbook/assets/send_token.png b/docs/.gitbook/assets/send_token.png
diff --git a/docs/.gitbook/assets/token_transfers_tab.png b/docs/.gitbook/assets/token_transfers_tab.png
diff --git a/docs/.gitbook/assets/transfer_token_1.png b/docs/.gitbook/assets/transfer_token_1.png
diff --git a/docs/.gitbook/assets/transfer_token_2.png b/docs/.gitbook/assets/transfer_token_2.png
diff --git a/docs/.gitbook/assets/transfer_token_3.png b/docs/.gitbook/assets/transfer_token_3.png
diff --git a/docs/.gitbook/assets/transfer_token_4.png b/docs/.gitbook/assets/transfer_token_4.png
diff --git a/docs/.gitbook/assets/transfer_token_success.png b/docs/.gitbook/assets/transfer_token_success.png
diff --git a/docs/.gitbook/assets/write_as_proxy.png b/docs/.gitbook/assets/write_as_proxy.png
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -26,5 +26,14 @@
 
 ## Other
 
-* [Bridges Workshop](other/bridge-workshop.md)
 * [Quick Start Guide](other/quick-start-guide.md)
+* [Processes for keeping track of dependency changes](other/processes-for-keeping-track-of-dependency-changes.md)
+* [Bridges Workshop](other/bridge-workshop.md)
+
+## Rococo Testnet
+
+* [Rococo-Sepolia Token Transfers](rococo-testnet/rococo-sepolia-token-transfers.md)
+
+## Runbooks
+
+* [Updating Snowbridge Pallets, BridgeHub & AssetHub Runtimes](runbooks/updating-snowbridge-pallets-bridgehub-and-assethub-runtimes.md)
diff --git a/docs/architecture/components.md b/docs/architecture/components.md
@@ -49,7 +49,7 @@ More concretely, they have a number of purposes in the bridge design:
 
 * When an ethereum user wishes to transfer ERC20 tokens over the bridge to the AssetHub parachain, the tokens are actually deposited into the agent instance corresponding to AssetHub.
 * When a Polkadot parachain sends a general-purpose message to a Solidity contract, on the Ethereum side, the message will be dispatched to the destination contract from the Agent instance corresponding to the origin parachain.
-* Offchain message relayers are incentivized by a fees & rewards system.
+* Off-chain message relayers are incentivized by a fees & rewards system.
   * Users wanting to send outbound messages to Polkadot need to pay fees into the agent contract corresponding to the destination parachain
   * Relayers submitting messages to the Gateway are rewarded from the agent contract corresponding to the origin parachain.
 

diff --git a/docs/other/processes-for-keeping-track-of-dependency-changes.md b/docs/other/processes-for-keeping-track-of-dependency-changes.md
@@ -0,0 +1,76 @@
+---
+description: Methods to keep up to date with Snowbridge dependency updates.
+---
+
+# Processes for keeping track of dependency changes
+
+## Polkadot Changes
+
+The [polkadot-sdk](https://github.com/paritytech/polkadot-sdk) is ultimately the place where any changes in the following components will be made. Snowbridge has several dependencies on components in the [polkadot-sdk](https://github.com/paritytech/polkadot-sdk):
+
+* Polkadot's relay chain
+* Bridge Hub parachain
+* Substrate
+* Cumulus
+
+### Releases
+
+The best way to get notifications about any changes in the polkadot-sdk, is to watch releases. See the last section on how to turn on notifications for [polkadot-sdk releases](https://github.com/paritytech/polkadot-sdk/releases).
+
+### Polkadot-SDK tests
+
+Snowbridge has a set of tests that test common bridge functionality, like register and sending a token from Ethereum to Polkadot, and to send the token back from Polkadot to Ethereum. These tests run on the polkadot-sdk CI, and so any incompatibility stemming from changes made in the polkadot-sdk will be caught by failing tests. These tests use the Rococo bridge hub and asset hub runtimes. It tests runtime configurations and Snowbridge pallets. The developer making the incompatible or breaking changes is responsible for making the fix as well. Noteworthy tests are:
+
+* [Snowbridge emulated tests](https://github.com/paritytech/polkadot-sdk/blob/master/cumulus/parachains/integration-tests/emulated/tests/bridges/bridge-hub-rococo/src/tests/snowbridge.rs)
+* [Snowbridge runtime tests](https://github.com/paritytech/polkadot-sdk/blob/master/cumulus/parachains/runtimes/bridge-hubs/bridge-hub-rococo/tests/snowbridge.rs)
+
+### Smoke Tests
+
+Apart from unit and emulated tests in the polkadot-sdk, Snowbridge also has a set of smoke tests, which uses a local testnet with a local Polkadot relay chain, asset hub and bridge hub parachains and Ethereum nodes. These smoke tests ultimately catch changes in the polkadot-sdk that may not have been caught by the polkadot-sdk tests.
+
+These tests are run when a PR is merged into the polkadot-sdk repo - _<mark style="color:purple;">TODO we need to set this up</mark>_.
+
+### Updating Snowfork Polkadot-SDK Fork
+
+Since the Snowbridge team primarily works on a [fork of the polkadot-sdk](https://github.com/Snowfork/polkadot-sdk), the fork periodically needs to be updated from the [original repository](https://github.com/paritytech/polkadot-sdk). Pulling the latest code from paritytech/polkadot-sdk:master into snowfork/polkadot-sdk:snowbridge (the “snowbridge” branch is like our “main” branch) is another way to become aware of any changes. This update should be done bi-monthly, at the very least.
+
+
+
+## Ethereum Changes
+
+### Light Client Protocol
+
+Ethereum consensus protocol changes are tracked on [https://github.com/ethereum/consensus-specs](https://github.com/ethereum/consensus-specs). Similarly to the polkadot-sdk, the release page should be watched for releases. Apart from this, on the main readme page of the Ethereum consensus repo page, any change stating “Light client sync protocol changes” should be followed:
+
+### Ethereum Network Updates
+
+Ethereum network updates are available at [https://blog.ethereum.org/category/protocol](https://blog.ethereum.org/category/protocol). At the bottom of the page is an email subscribe form signup. Sign up to get email notifications about protocol changes.&#x20;
+
+### Lodestar
+
+Snowbridge uses Lodestar as consensus node to relay headers to the on-chain light client. Lodestar should be kept up to date to support the latest Ethereum fork. Lodestar’s releases can be followed here:
+
+[https://github.com/ChainSafe/lodestar/releases/](https://github.com/ChainSafe/lodestar/releases/tag/v1.15.0)
+
+The release notes often contain the relevancy for a certain update, e.g. for v1.15.0: “This update is recommended to all users of Lodestar and mandatory for those running Sepolia and Holesky testnets. This release is also ready for the Gnosis Chain Chiado fork.”
+
+
+
+## Enable Notifications for Releases on Github
+
+To get notifications for Github repository releases, go to the Github repository, click on Watch -> Custom -> Releases.
+
+Recommended repository releases to watch:
+
+* [ethereum/consensus-specs](https://github.com/ethereum/consensus-specs)
+* [ChainSafe/lodestar](https://github.com/ChainSafe/lodestar/releases/tag/v1.15.0)
+* [paritytech/polkadot-sdk](https://github.com/paritytech/polkadot-sdk)
+
+<figure><img src="https://lh7-us.googleusercontent.com/MsdyEhct1vKgHCgXWiFDvLg5DJ7CFPjSg52LpNNpATjmf0tzubFAI3Ti6nsAP2N5Rr8TdKlOnpmohObMXO9FJB6FFtSB2mqJ-Xdytq_BFxyTltpCxjex1PPJ793bXEqMbH7j5MlcjcB2zO1LAy_x2FI" alt=""><figcaption><p>Enable release notifications on Github</p></figcaption></figure>
+
+## Update Notifications Checklist
+
+* [ ] [ethereum/consensus-specs](https://github.com/ethereum/consensus-specs) Github releases
+* [ ] [ChainSafe/lodestar](https://github.com/ChainSafe/lodestar/releases/tag/v1.15.0) Github releases
+* [ ] [paritytech/polkadot-sdk](https://github.com/paritytech/polkadot-sdk) Github releases
+* [ ] [Ethereum network update email notifications](https://blog.ethereum.org/category/protocol)