{"id":20388371,"url":"https://github.com/waku-org/go-waku","last_synced_at":"2025-05-15T19:08:29.287Z","repository":{"id":36994164,"uuid":"346825085","full_name":"waku-org/go-waku","owner":"waku-org","description":"Go implementation of Waku v2 protocol","archived":false,"fork":false,"pushed_at":"2025-05-13T18:56:40.000Z","size":62127,"stargazers_count":126,"open_issues_count":28,"forks_count":51,"subscribers_count":30,"default_branch":"master","last_synced_at":"2025-05-13T19:55:26.266Z","etag":null,"topics":["decentralization","libp2p","peer-to-peer","privacy-preserving","waku"],"latest_commit_sha":null,"homepage":"https://waku.org/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/waku-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-APACHEv2","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-03-11T20:13:35.000Z","updated_at":"2025-04-11T14:56:42.000Z","dependencies_parsed_at":"2024-03-11T05:31:02.536Z","dependency_job_id":"eecfee8e-f9e0-4ed7-bb5b-f0491c546b71","html_url":"https://github.com/waku-org/go-waku","commit_stats":{"total_commits":1043,"total_committers":34,"mean_commits":"30.676470588235293","dds":"0.27900287631831255","last_synced_commit":"269417c5e979aeec92d323bed280d23da95379ea"},"previous_names":["status-im/go-waku"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waku-org%2Fgo-waku","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waku-org%2Fgo-waku/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waku-org%2Fgo-waku/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waku-org%2Fgo-waku/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/waku-org","download_url":"https://codeload.github.com/waku-org/go-waku/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254404357,"owners_count":22065641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["decentralization","libp2p","peer-to-peer","privacy-preserving","waku"],"created_at":"2024-11-15T03:09:32.833Z","updated_at":"2025-05-15T19:08:29.264Z","avatar_url":"https://github.com/waku-org.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# go-waku\nA Go implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10).\n\n\n\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://goreportcard.com/report/github.com/waku-org/go-waku\"\u003e\u003cimg src=\"https://goreportcard.com/badge/github.com/waku-org/go-waku\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://godoc.org/github.com/waku-org/go-waku\"\u003e\u003cimg src=\"http://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square\" /\u003e\u003c/a\u003e\n  \u003ca href=\"\"\u003e\u003cimg src=\"https://img.shields.io/badge/golang-%3E%3D1.20.0-orange.svg?style=flat-square\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://codeclimate.com/github/waku-org/go-waku/maintainability\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/426bdff6a339ff4d536b/maintainability\" /\u003e\u003c/a\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n## Install\n\n#### Building from source\n```\ngit clone https://github.com/waku-org/go-waku\ncd go-waku\nmake\n\n# See the available command line options with\n./build/waku --help\n```\n#### Nix\nYou can build Waku v2 node using [Nix](https://nixos.org/) [Flakes](https://nixos.wiki/wiki/Flakes):\n```sh\nnix build github:waku-org/go-waku\n```\nOr build the library using:\n```\nnix build github:waku-org/go-waku#library\n```\nTo start a shell with build dependencies use:\n```\nnix develop\n```\n\n#### Docker\n```\ndocker run -i -t -p 60000:60000 -p 9000:9000/udp \\\n  wakuorg/go-waku:latest \\ \n    --dns-discovery \\\n    --dns-discovery-url enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im \\\n    --discv5-discovery\n```\nor use the [image:tag](https://hub.docker.com/r/wakuorg/go-waku/tags) of your choice.\n\nor build and run the image with:\n\n```\ndocker build -t wakuorg/go-waku:latest .\n\ndocker run wakuorg/go-waku:latest --help\n```\n\n#### Building on windows\n\nWindows requires the following tools to be installed\n- git bash  (which is installed as part of [Git](https://git-scm.com/downloads))\n- [chocolatey](https://chocolatey.org/install)\n- [make](https://community.chocolatey.org/packages/make)\n- [mingw](https://community.chocolatey.org/packages/mingw)\n- [go](https://go.dev/doc/install)\n\n## Library\n```\ngo get github.com/waku-org/go-waku\n```\n\n## C Bindings\n```\nmake static-library\nmake dynamic-library\n```\n\n## Mobile libraries\nRequires [`gomobile`](https://pkg.go.dev/golang.org/x/mobile/cmd/gomobile)\n```\nmake mobile-android\nmake mobile-ios\n```\n\n## Tutorials and documentation\n- [Receive and send messages using Waku Relay](docs/api/relay.md)\n- [Send messages using Waku Lightpush](docs/api/lightpush.md)\n- [Encrypting and decrypting Waku Messages](docs/api/encoding.md)\n- [Retrieve message history using Waku Store](docs/api/store.md)\n- [C Bindings](library/c/README.md)\n- [Waku Specs](https://rfc.vac.dev/spec), has information of [waku topics](https://rfc.vac.dev/spec/23/), wakuv1/[wakuv2](https://rfc.vac.dev/spec/14/) message, [rln relay](https://rfc.vac.dev/spec/58/) etc.\n- [Enr](https://eips.ethereum.org/EIPS/eip-778), [Enrtree](https://eips.ethereum.org/EIPS/eip-1459)\n- [devp2p](https://github.com/ethereum/go-ethereum/tree/master/cmd/devp2p) tool for playing with enr/entree sync tree. [Tutorial](https://geth.ethereum.org/docs/developers/geth-developer/dns-discovery-setup)\n\n## Examples\nExamples of usage of go-waku as a library can be found in the `examples/` folder:\n\n- [**basic2**](examples/basic2) - demonstrates how to send and receive messages\n- [**chat2**](examples/chat2) - simple chat client using waku relay / lightpush + filter / store protocol to send/receive messages and retrieve message history\n- [**filter2**](examples/filter2) - demonstrates how to use filter protocol\n- [**c-bindings**](examples/c-bindings) - simple program to demonstrate how to consume the go-waku library via C FFI\n- [**waku-csharp**](examples/waku-csharp) - C# console application that uses the go-waku library via FFI\n- [**android-kotlin**](examples/android-kotlin) - android app that uses a .jar generated by gomobile using kotlin\n\n\n## Contribution\nThank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!\n\nIf you'd like to contribute to go-waku, please fork, fix, commit and send a pull request. If you wish to submit more complex changes though, please check up with the core devs first to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.\n\nTo build and test this repository, you need:\n  - [Go](https://golang.org/) (version 1.20)\n  - [protoc](https://grpc.io/docs/protoc-installation/) \n  - [protoc-gen-go](https://protobuf.dev/getting-started/gotutorial/#compiling-protocol-buffers)\n\nTo enable the git hooks:\n\n```bash\ngit config core.hooksPath hooks\n```\n\n## Bugs, Questions \u0026 Features\n\nIf you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/go-waku/issues/new/).\n\nFor more general discussion, help and latest news,  join **#go-waku** on [Vac Discord](https://discord.com/channels/864066763682218004/865466710924460034) or [Telegram](https://t.me/vacp2p).\n\n\n## License\nLicensed and distributed under either of\n\n* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT\n\nor\n\n* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)\n\nat your option. These files may not be copied, modified, or distributed except according to those terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaku-org%2Fgo-waku","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwaku-org%2Fgo-waku","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaku-org%2Fgo-waku/lists"}