diff --git a/docs/guides/nwaku/upgrade-instructions.md b/docs/guides/nwaku/upgrade-instructions.md index 38ff595..3f9236a 100644 --- a/docs/guides/nwaku/upgrade-instructions.md +++ b/docs/guides/nwaku/upgrade-instructions.md @@ -9,11 +9,12 @@ import { AccordionItem } from '@site/src/components/mdx' If you are currently using Nwaku, are running an old version and want to upgrade your node, please follow the below migration instructions for each release newer than your current running version - Named sharding was deprecated in this version. This means that pubsub topics will only be supported if they comply with the static sharding format: `/waku/2/rs//` +Named sharding was deprecated in this version. This means that pubsub topics will only be supported if they comply with the static sharding format: /waku/2/rs/<CLUSTER_ID>/<SHARD_ID>

- In order to migrate your existing application, you need to: +In order to migrate your existing application, you need to: - 1. Make sure that your clients are sending messages to pubsub topics in the required format - 2. When running a node with the `--pubsub-topic` CLI flag, the values provided should comply with the static sharding format - 3. If your application relies on nodes or clients that may not be updated immediately, keep your node on an older version while subscribing to both the currently pubsub topic and the new pubsub topic that will comply with the static sharding format. In that case, you can keep backward compatibility for a migration period. -
\ No newline at end of file +1. Make sure that your clients are sending messages to pubsub topics in the required format. +2. When running a node with the `--pubsub-topic` CLI flag, the values provided should comply with the static sharding format. +3. If your application relies on nodes or clients that may not be updated immediately, keep your node on an older version while subscribing to both the current pubsub topic and the new pubsub topic that will comply with the static sharding format. In that case, you can keep backward compatibility for a migration period. + +