diff --git a/.cspell.json b/.cspell.json index 77b6f0c..adac157 100644 --- a/.cspell.json +++ b/.cspell.json @@ -48,6 +48,8 @@ "dylib", "uncompromised", "reactjs", + "XMTP", + "permissioned", ], "flagWords": [], "ignorePaths": [ diff --git a/docs/guides/js-waku/light-send-receive.md b/docs/guides/js-waku/light-send-receive.md index cb58cf7..93058e9 100644 --- a/docs/guides/js-waku/light-send-receive.md +++ b/docs/guides/js-waku/light-send-receive.md @@ -50,7 +50,7 @@ const ChatMessage = new protobuf.Type("ChatMessage") ``` :::info -Please refer to the [Protobuf installation](/guides/js-waku/quick-start#create-a-message-structure) guide for adding the `protobufjs` package to your project. +Check out the [Protobuf installation](/guides/js-waku/quick-start#create-a-message-structure) guide for adding the `protobufjs` package to your project. ::: ## Send Messages Using Light Push diff --git a/docs/guides/js-waku/quick-start.md b/docs/guides/js-waku/quick-start.md index 6900b9e..2bd188f 100644 --- a/docs/guides/js-waku/quick-start.md +++ b/docs/guides/js-waku/quick-start.md @@ -2,7 +2,7 @@ title: Quick Start --- -This guide provides quick steps to start using the `js-waku` SDK by setting up a Waku node and sending messages using the [Relay protocol](/overview/concepts/protocols#relay). Please refer to the [installation guide](/guides/js-waku/#installation) for steps on adding `js-waku` to your project. +This guide provides quick steps to start using the `js-waku` SDK by setting up a Waku node and sending messages using the [Relay protocol](/overview/concepts/protocols#relay). Check out the [installation guide](/guides/js-waku/#installation) for steps on adding `js-waku` to your project. ## Create a Relay Node diff --git a/docs/guides/js-waku/relay-send-receive.md b/docs/guides/js-waku/relay-send-receive.md index c05bd8a..9b2ff19 100644 --- a/docs/guides/js-waku/relay-send-receive.md +++ b/docs/guides/js-waku/relay-send-receive.md @@ -53,7 +53,7 @@ const ChatMessage = new protobuf.Type("ChatMessage") ``` :::info -Please refer to the [Protobuf installation](/guides/js-waku/quick-start#create-a-message-structure) guide for adding the `protobufjs` package to your project. +Check out the [Protobuf installation](/guides/js-waku/quick-start#create-a-message-structure) guide for adding the `protobufjs` package to your project. ::: ## Send Messages Using Relay diff --git a/docs/guides/js-waku/use-waku-react.md b/docs/guides/js-waku/use-waku-react.md index 3514836..86cabca 100644 --- a/docs/guides/js-waku/use-waku-react.md +++ b/docs/guides/js-waku/use-waku-react.md @@ -68,7 +68,6 @@ function App() { // "node" is the created Relay Node // "error" captures any error that occurs during node creation // "isLoading" indicates whether the node is still being created - // Use these to handle states and render the UI in your application } ``` @@ -90,7 +89,6 @@ function App() { // "node" is the created Light Node // "error" captures any error that occurs during node creation // "isLoading" indicates whether the node is still being created - // Use these to handle states and render the UI in your application } ``` @@ -111,7 +109,6 @@ function App() { // "encoder" is the message encoder // "decoder" is the message decoder - // Use these to handle the messages in your application } ``` @@ -191,7 +188,6 @@ function App() { // "error" captures any error that occurs while receiving messages // "messages" contains a list of messages the subscription received // "isLoading" indicates whether the node is still subscribing to Filter - // Use these to handle states and render the UI in your application } ``` @@ -231,12 +227,11 @@ function App() { // "error" captures any error that occurs during message retrieval // "messages" contains a list of messages retrieved from the Store peer // "isLoading" indicates whether the node is still retrieving messages - // Use these to handle states and render the UI in your application } ``` :::info -To explore the available query options, please refer to the [Store Query Options](/guides/js-waku/store-retrieve-messages#store-query-options) guide. +To explore the available query options, check out the [Store Query Options](/guides/js-waku/store-retrieve-messages#store-query-options) guide. ::: ## Using @waku/react Providers @@ -277,7 +272,6 @@ import { useWaku } from "@waku/react"; function App() { // Create and start a Relay Node const { node, error, isLoading } = useWaku(); - // Use these to handle states and render the UI in your application } ``` @@ -315,7 +309,6 @@ import { useWaku } from "@waku/react"; function App() { // Create and start a Light Node const { node, error, isLoading } = useWaku(); - // Use these to handle states and render the UI in your application } ``` @@ -347,7 +340,6 @@ import { useContentPair } from "@waku/react"; function App() { // Create a message encoder and decoder pair const { encoder, decoder } = useContentPair(); - // Use these to handle the messages in your application } ``` diff --git a/docs/guides/nodes-and-sdks.md b/docs/guides/nodes-and-sdks.md index a302572..d6f40fb 100644 --- a/docs/guides/nodes-and-sdks.md +++ b/docs/guides/nodes-and-sdks.md @@ -15,7 +15,7 @@ The Waku Network is a decentralized, permissionless system where anyone can run | | Description | Documentation | | - | - | - | | [nwaku](https://github.com/waku-org/nwaku) | Nim-based Waku implementation to run a standalone node and access the network (recommended) | [Run a Nwaku Node](/guides/run-nwaku-node) | -| [go-waku](https://github.com/waku-org/go-waku) | Golang-based Waku implementation to run a standalone node and access the network | [Run a Go-Waku Node](https://github.com/waku-org/go-waku/tree/master/docs/operators) | +| [go-waku](https://github.com/waku-org/go-waku) | Golang-based Waku implementation to run a standalone node and access the network | COMING SOON | ## Integrate Using SDKs @@ -24,9 +24,9 @@ Waku is implemented in multiple SDKs, allowing it to integrate with different la | | Description | Documentation | | - | - | - | | [js-waku](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | [JavaScript Waku SDK](/guides/js-waku/) | -| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK designed for integration with native Nim applications | | -| [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for integration with Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, and Kotlin | | -| [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) | Rust wrapper using `go-waku` bindings designed for integration in Rust applications | | +| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK designed for integration with native Nim applications | COMING SOON | +| [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for integration with Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, and Kotlin | COMING SOON | +| [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) | Rust wrapper using `go-waku` bindings designed for integration in Rust applications | COMING SOON | ## Run on Mobile Devices @@ -34,15 +34,15 @@ Waku provides integrations tailored for mobile applications, enabling Waku to ru | | Description | Documentation | | - | - | - | -| [React Native](https://github.com/waku-org/waku-react-native) | React Native wrapper using `go-waku` bindings designed for native mobile integration | | -| Swift (iOS) | `go-waku` bindings for Swift applications to seamlessly integrate Waku | | -| Kotlin (Android) | `go-waku` bindings for Kotlin applications to seamlessly integrate Waku | | +| [React Native](https://github.com/waku-org/waku-react-native) | React Native wrapper using `go-waku` bindings designed for native mobile integration | COMING SOON | +| Swift (iOS) | `go-waku` bindings for Swift applications to seamlessly integrate Waku | COMING SOON | +| Kotlin (Android) | `go-waku` bindings for Kotlin applications to seamlessly integrate Waku | COMING SOON | ## More Integrations | | Description | Documentation | | - | - | - | -| JSON-RPC API | `JSON-RPC` API interface provided by `nwaku` and `go-waku` to interact with the Waku Network | | +| JSON-RPC API | `JSON-RPC` API interface provided by `nwaku` and `go-waku` to interact with the Waku Network | COMING SOON | | [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `js-waku` | [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) | | [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next `js-waku` project from various example templates | [Bootstrap DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app) | | [nwaku-compose](https://github.com/alrevuelta/nwaku-compose) | Pre-configured Docker Compose setup for running and monitoring a `nwaku` node using Prometheus and Grafana | [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) | \ No newline at end of file diff --git a/docs/guides/nwaku/build-source.md b/docs/guides/nwaku/build-source.md index 69afd38..a92d897 100644 --- a/docs/guides/nwaku/build-source.md +++ b/docs/guides/nwaku/build-source.md @@ -92,7 +92,7 @@ Nwaku will create the `wakunode2` binary in the `./build/` directory. ./build/wakunode2 --help ``` -To learn more about running nwaku, please refer to: +To learn more about running nwaku, check out these guides: - [Run a Nwaku Node](/guides/run-nwaku-node#run-the-node) - [Run Nwaku in a Docker Container](/guides/nwaku/run-docker) diff --git a/docs/guides/reference/node-config-methods.md b/docs/guides/reference/node-config-methods.md index a20d83e..f6b0f61 100644 --- a/docs/guides/reference/node-config-methods.md +++ b/docs/guides/reference/node-config-methods.md @@ -10,7 +10,7 @@ Waku nodes can be configured using a combination of the following methods: 4. Default values :::info -Note the precedence order: Each configuration method overrides the one below it (e.g., command line options override environment variables and configuration files). +Take note of the precedence order: Each configuration method overrides the one below it (e.g., command line options override environment variables and configuration files). ::: ## Command Line Options @@ -96,5 +96,5 @@ To see the default values of all [configuration options](/guides/reference/node- ``` :::tip -To explore the available node configuration options, please refer to the [Node Configuration Options](/guides/reference/node-config-options) guide. +To explore the available node configuration options, check out the [Node Configuration Options](/guides/reference/node-config-options) guide. ::: \ No newline at end of file diff --git a/docs/guides/reference/node-config-options.md b/docs/guides/reference/node-config-options.md index 12d3bb4..77e9474 100644 --- a/docs/guides/reference/node-config-options.md +++ b/docs/guides/reference/node-config-options.md @@ -161,5 +161,5 @@ Here are the available node configuration options, along with their default valu | `websocket-secure-cert-path` | | Secure websocket Certificate path: '/path/to/cert.txt' | :::tip -To configure your node using the provided configuration options, please refer to the [Node Configuration Methods](/guides/reference/node-config-methods) guide. +To configure your node using the provided configuration options, check out the [Node Configuration Methods](/guides/reference/node-config-methods) guide. ::: \ No newline at end of file diff --git a/docs/guides/run-nwaku-node.md b/docs/guides/run-nwaku-node.md index a6a07a2..fcde751 100644 --- a/docs/guides/run-nwaku-node.md +++ b/docs/guides/run-nwaku-node.md @@ -19,7 +19,7 @@ To run a node, you must have the `nwaku` binary. Nwaku provides multiple options #### Build the Binary -You can build the node binary directly from the [nwaku source code](https://github.com/waku-org/nwaku). To learn more, please refer to the [Build Nwaku from Source](/guides/nwaku/build-source) guide. +You can build the node binary directly from the [nwaku source code](https://github.com/waku-org/nwaku). Check out the [Build Nwaku from Source](/guides/nwaku/build-source) guide to learn more. #### Run Nwaku in Docker @@ -45,7 +45,7 @@ Once you have gotten the `nwaku` binary, run it using the [default configuration ``` :::tip -For more advanced configurations like enabling other protocols or maintaining a consistent `PeerID`, please refer to the [Node Configuration Methods](/guides/reference/node-config-methods) guide. +For more advanced configurations like enabling other protocols or maintaining a consistent `PeerID`, check out the [Node Configuration Methods](/guides/reference/node-config-methods) guide. ::: ## Bootstrap the Node diff --git a/docs/overview/concepts/content-topics.md b/docs/overview/concepts/content-topics.md index a224b93..48ddb01 100644 --- a/docs/overview/concepts/content-topics.md +++ b/docs/overview/concepts/content-topics.md @@ -2,7 +2,7 @@ title: Content Topics --- -`Content Topics` are metadata strings set by developers on outgoing messages to facilitate protocol-level features like selectively processing incoming messages ([Relay](/overview/concepts/protocols#relay) or [Filter](/overview/concepts/protocols#filter)) and retrieving historical messages ([Store](/overview/concepts/protocols#store)) that meet specific filtering criteria. Please refer to the [WAKU2-TOPICS](https://rfc.vac.dev/spec/23/#content-topics) specification to learn more. +`Content Topics` are metadata strings set by developers on outgoing messages to facilitate protocol-level features like selectively processing incoming messages ([Relay](/overview/concepts/protocols#relay) or [Filter](/overview/concepts/protocols#filter)) and retrieving historical messages ([Store](/overview/concepts/protocols#store)) that meet specific filtering criteria. Check out the [WAKU2-TOPICS](https://rfc.vac.dev/spec/23/#content-topics) specification to learn more. ## Naming Format diff --git a/docs/overview/concepts/discv5.md b/docs/overview/concepts/discv5.md index ff2bf17..a00b5f4 100644 --- a/docs/overview/concepts/discv5.md +++ b/docs/overview/concepts/discv5.md @@ -2,7 +2,7 @@ title: Discv5 --- -`Discv5` is a decentralized and efficient peer discovery mechanism for the Waku Network. It uses a [Distributed Hash Table (DHT)](https://en.wikipedia.org/wiki/Distributed_hash_table) for storing `ENR` records, providing resistance to censorship. `Discv5` offers a global view of participating nodes, enabling random sampling for load distribution. It uses bootstrap nodes as an entry point to the network, providing randomized sets of nodes for mesh expansion. Please refer to the [Discv5](https://rfc.vac.dev/spec/33/) specification to learn more. +`Discv5` is a decentralized and efficient peer discovery mechanism for the Waku Network. It uses a [Distributed Hash Table (DHT)](https://en.wikipedia.org/wiki/Distributed_hash_table) for storing `ENR` records, providing resistance to censorship. `Discv5` offers a global view of participating nodes, enabling random sampling for load distribution. It uses bootstrap nodes as an entry point to the network, providing randomized sets of nodes for mesh expansion. Check out the [Discv5](https://rfc.vac.dev/spec/33/) specification to learn more. #### Pros diff --git a/docs/overview/concepts/peer-exchange.md b/docs/overview/concepts/peer-exchange.md index 4529c97..ef4adb8 100644 --- a/docs/overview/concepts/peer-exchange.md +++ b/docs/overview/concepts/peer-exchange.md @@ -2,7 +2,7 @@ title: Peer Exchange --- -The primary objective of this protocol is to facilitate peer connectivity for resource-limited devices without relying on `Discv5`. The peer exchange protocol enables light nodes to request peers from other nodes within the network. To learn more, please refer to the [Peer Exchange](https://rfc.vac.dev/spec/34/) specification. +The primary objective of this protocol is to facilitate peer connectivity for resource-limited devices without relying on `Discv5`. The peer exchange protocol enables light nodes to request peers from other nodes within the network. Check out the [Peer Exchange](https://rfc.vac.dev/spec/34/) specification to learn more. :::info `Peer Exchange` enables requesting random peers from other network nodes without revealing information about their connectivity or neighborhood. diff --git a/docs/overview/reference/glossary.md b/docs/overview/reference/glossary.md index 178818b..e616055 100644 --- a/docs/overview/reference/glossary.md +++ b/docs/overview/reference/glossary.md @@ -52,7 +52,7 @@ Light push is a protocol enabling [light nodes](#light-node) to send [messages]( ### Mostly Offline -Mostly offline devices refer to clients who spend most of their time offline or disconnected from the internet and only occasionally to the internet and [Waku Network](#waku). Examples include browsers and mobile phones. +Mostly offline devices are clients who spend most of their time offline or disconnected from the internet and only occasionally to the internet and [Waku Network](#waku). Examples include browsers and mobile phones. ### Node diff --git a/docs/powered-by-waku.mdx b/docs/powered-by-waku.mdx index c0334f2..65b05bf 100644 --- a/docs/powered-by-waku.mdx +++ b/docs/powered-by-waku.mdx @@ -32,5 +32,13 @@ import { PoweredBy } from "@site/src/components/mdx"; logoSrcDark: "/img/the-graph-mark-white.svg", link: "https://thegraph.com/", }, + { + name: "XMTP", + description: + "Inter-blockchain account messaging protocol XMTP uses Waku to facilitate communication between nodes in its currently permissioned network.", + logoSrc: "/img/xmtp-mark-black.svg", + logoSrcDark: "/img/xmtp-mark-white.svg", + link: "https://xmtp.org", + }, ]} /> \ No newline at end of file diff --git a/package.json b/package.json index 2ae0776..59f6ff7 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ }, "dependencies": { "@acid-info/docusaurus-fathom": "^1.0.0-alpha.61", - "@acid-info/logos-docusaurus-preset": "^1.0.0-alpha.77", + "@acid-info/logos-docusaurus-preset": "^1.0.0-alpha.81", "@docusaurus/core": "^2.4.1", "@docusaurus/preset-classic": "^2.4.1", "@docusaurus/theme-mermaid": "^2.4.1", diff --git a/sidebars.js b/sidebars.js index 60bc7ba..78f3b7b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -7,10 +7,6 @@ const sidebars = { "overview/history", "overview/why-waku", "overview/use-cases", - { - type: 'html', - value: 'Nodes and SDKs', - }, { type: "category", label: "Concepts", @@ -45,6 +41,10 @@ const sidebars = { "overview/reference/research-in-progress", "overview/reference/waku-vs-libp2p", ] + }, + { + type: 'html', + value: 'Nodes and SDKs', } ], guides: [ diff --git a/static/img/xmtp-mark-black.svg b/static/img/xmtp-mark-black.svg new file mode 100644 index 0000000..0c0ce0c --- /dev/null +++ b/static/img/xmtp-mark-black.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/static/img/xmtp-mark-white.svg b/static/img/xmtp-mark-white.svg new file mode 100644 index 0000000..be6f26b --- /dev/null +++ b/static/img/xmtp-mark-white.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/yarn.lock b/yarn.lock index 9427246..36a2cbc 100644 --- a/yarn.lock +++ b/yarn.lock @@ -33,14 +33,14 @@ "@easyops-cn/docusaurus-search-local" "^0.33.6" lodash "^4.17.21" -"@acid-info/logos-docusaurus-preset@^1.0.0-alpha.77": - version "1.0.0-alpha.77" - resolved "https://registry.yarnpkg.com/@acid-info/logos-docusaurus-preset/-/logos-docusaurus-preset-1.0.0-alpha.77.tgz#b68eda33f9d5f61135a360d38a3732629196403b" - integrity sha512-P89o3MgDwR/LYsoIp4KJHcRX5VxpeEp3WYgUkAiFVvLw4AsTvsQdIgiH3vtbAnf9fZ+5gu3ZNuc7pz+MUxwCHw== +"@acid-info/logos-docusaurus-preset@^1.0.0-alpha.81": + version "1.0.0-alpha.81" + resolved "https://registry.yarnpkg.com/@acid-info/logos-docusaurus-preset/-/logos-docusaurus-preset-1.0.0-alpha.81.tgz#8a654fd676dd2bfacf42ec39f850bfa4ccbbe507" + integrity sha512-pZNWhiTdaHWyJlncBL37xjaoOMd76FXFcAq0glqPGKqcRLbyq+tBBuSh0JRo86SKNkFW8ZAgGl3XlmSDwCAgyQ== dependencies: "@acid-info/docusaurus-og" "^1.0.0-alpha.76" "@acid-info/logos-docusaurus-search-local" "^1.0.0-alpha.47" - "@acid-info/logos-docusaurus-theme" "^1.0.0-alpha.76" + "@acid-info/logos-docusaurus-theme" "^1.0.0-alpha.81" "@docusaurus/core" "^2.4.1" "@docusaurus/module-type-aliases" "^2.4.1" "@docusaurus/preset-classic" "^2.4.1" @@ -70,10 +70,10 @@ satori "^0.10.1" sharp "^0.32.1" -"@acid-info/logos-docusaurus-theme@^1.0.0-alpha.76": - version "1.0.0-alpha.76" - resolved "https://registry.yarnpkg.com/@acid-info/logos-docusaurus-theme/-/logos-docusaurus-theme-1.0.0-alpha.76.tgz#7ce8f8c3ba3517744563251877974d5990b69360" - integrity sha512-+holM3FLS1RQrWrptVCFE1vsoGqv87V4oQygagD6Y9hiFR7CUDeO3Wiemy8L1AKVOfqO1s0rvEudH7IWD+sBsA== +"@acid-info/logos-docusaurus-theme@^1.0.0-alpha.81": + version "1.0.0-alpha.81" + resolved "https://registry.yarnpkg.com/@acid-info/logos-docusaurus-theme/-/logos-docusaurus-theme-1.0.0-alpha.81.tgz#34ec1cd51f8ec827ae653d24fb92267069bd6a0d" + integrity sha512-cbCcVShPmEW5k+jyYnVGIttDOtHG9ohH5HKjXMc+kXUl2WJN1hUxt4oTo/TJD16b+Rlbe2RuTT+yorzdKyGHlA== dependencies: "@acid-info/docusaurus-og" "^1.0.0-alpha.76" "@acid-info/lsd-react" "^0.1.0-alpha.15"