From 337a89a89a44b7beb2f8b22d76e0af87415166b4 Mon Sep 17 00:00:00 2001 From: Gabriel mermelstein Date: Thu, 29 Aug 2024 14:32:44 -0600 Subject: [PATCH] migration instructions --- docs/guides/nwaku/migrate-version.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/guides/nwaku/migrate-version.md diff --git a/docs/guides/nwaku/migrate-version.md b/docs/guides/nwaku/migrate-version.md new file mode 100644 index 0000000..94d9cc8 --- /dev/null +++ b/docs/guides/nwaku/migrate-version.md @@ -0,0 +1,22 @@ +--- +title: Upgrade Instructions +hide_table_of_contents: true +sidebar_label: Upgrade Instructions +--- + +If you are currently using Waku and + +import { AccordionItem } from '@site/src/components/mdx' + + + 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// + ``` + + 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 compy 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