{"id":38298570,"url":"https://github.com/arborchat/sprout-go","last_synced_at":"2026-01-17T02:21:55.084Z","repository":{"id":93117987,"uuid":"206542442","full_name":"arborchat/sprout-go","owner":"arborchat","description":"A Golang Implementation of the Sprout Protocol, mirrored from sourcehut","archived":false,"fork":false,"pushed_at":"2020-10-31T21:42:16.000Z","size":338,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-09T00:26:21.053Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://git.sr.ht/~whereswaldon/sprout-go","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arborchat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-09-05T10:59:23.000Z","updated_at":"2021-05-07T13:37:19.000Z","dependencies_parsed_at":"2023-03-24T06:03:00.964Z","dependency_job_id":null,"html_url":"https://github.com/arborchat/sprout-go","commit_stats":{"total_commits":148,"total_committers":2,"mean_commits":74.0,"dds":0.006756756756756799,"last_synced_commit":"5dae1cbb80f64260e3d1ee75c1761e9ea19df5f1"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/arborchat/sprout-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arborchat%2Fsprout-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arborchat%2Fsprout-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arborchat%2Fsprout-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arborchat%2Fsprout-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arborchat","download_url":"https://codeload.github.com/arborchat/sprout-go/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arborchat%2Fsprout-go/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28492215,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T00:50:05.742Z","status":"online","status_checked_at":"2026-01-17T02:00:07.808Z","response_time":85,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-01-17T02:21:55.022Z","updated_at":"2026-01-17T02:21:55.072Z","avatar_url":"https://github.com/arborchat.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sprout-go\n\n[![builds.sr.ht status](https://builds.sr.ht/~whereswaldon/sprout-go.svg)](https://builds.sr.ht/~whereswaldon/sprout-go?)\n[![GoDoc](https://godoc.org/git.sr.ht/~whereswaldon/sprout-go?status.svg)](https://godoc.org/git.sr.ht/~whereswaldon/sprout-go)\n\nThis is an implementation of the [Sprout Protocol](https://man.sr.ht/~whereswaldon/arborchat/specifications/sprout.md) in Go. It provides methods\nto send and receive protocol messages in Sprout. Sprout is one part of the\nArbor Chat project.\n\n\u003e NOTE: this package requires using a fork of golang.org/x/crypto, and you must therefore include the following in your `go.mod`:\n\u003e ```\n\u003e     replace golang.org/x/crypto =\u003e github.com/ProtonMail/crypto \u003cversion-from-sprout-go's-go.mod\u003e\n\u003e ```\n\n## About Arbor\n\n![arbor logo](https://git.sr.ht/~whereswaldon/forest-go/blob/master/img/arbor-logo.png)\n\nArbor is a chat system that makes communication clearer. It explicitly captures context that other platforms ignore, allowing you to understand the relationship between each message and every other message. It also respects its users and focuses on group collaboration.\n\nYou can get information about the Arbor project [here](https://man.sr.ht/~whereswaldon/arborchat/).\n\nFor news about the project, join our [mailing list](https://lists.sr.ht/~whereswaldon/arbor-dev)!\n\n## Relay\n\nThis repo currently contains an example implementation of an Arbor Relay, which is analagous to a \"server\" in a traditional chat system. You can find it in `cmd/relay`.\n\n### Local testing\n\nIf you want to run a local relay to test something, it's very easy!\n\nFirst, install [`mkcert`](https://github.com/FiloSottile/mkcert) so that you can create trusted local TLS certificates.\n\nThen do the following:\n\n```sh\nmkcert --install # configure your local CA\nmkcert localhost 127.0.0.1 ::1 arbor.local # generate a trusted cert for local addresses\nmkdir grove # create somewhere to store arbor forest data\n\n# Copy any nodes you want the relay to have into this grove directory.\n# To copy from your local sprig installation:\ncp ~/.config/sprig/grove/* grove/\n# Adapt this as necessary if your history is stored elsewhere.\n\nrelay -certpath ./localhost+3.pem -keypath ./localhost+3-key.pem -grovepath ./grove/\n```\n\nYou can now connect to this relay with any client on the address `localhost:7777`, `arbor.local:7777`, and the other names that you configured in the certificate.\n\n### Writing sprout by hand\n\nIf you want to examine the behavior of a sprout relay, it is sometimes convenient to directly connect to the relay.\n\nTo do this, install [`socat`](http://www.dest-unreach.org/socat/) (it's probably in your package manager). If you want to test against the official arbor relay you can do:\n\n```sh\nsocat openssl:arbor.chat:7117 stdio\n```\n\nYou can then type valid [sprout protocol messages](https://man.sr.ht/~whereswaldon/arborchat/specifications/sprout.md) and see the relay's responses.\n\nHere's an example session that you could replicate:\n\n```\nversion 1 0.0\n```\n\nResponse:\n\n```\nstatus 1 0\n```\n\nWe advertise our protocol version as 0.0 and the relay agrees to use that version.\n\n\n```\nlist 2 1 3\n```\n\nResponse:\n\n```\nresponse 2 1\nSHA512_B32__mw9nEYu_XAgnw0mRRNO60J2bqIOOBmalIXgOqxoKV-o \u003cbase64url-node-data\u003e\n```\n\nWe request a list of the three most recent communities. We only get one back because the relay currently only knows about one.\n\n\n```\nleaves_of 3 SHA512_B32__mw9nEYu_XAgnw0mRRNO60J2bqIOOBmalIXgOqxoKV-o 3\n```\n\nResponse:\n\n```\nresponse 3 3\nSHA512_B32__S7wybDxauEZEYJCRenemN2WB5woupuHlRU-Gj5eVU8M \u003cbase64url-node-data\u003e\nSHA512_B32__GITqdhoPqbECv6Sb03zW8H7Ry0M8dScmQwMcrdeoEwI \u003cbase64url-node-data\u003e\nSHA512_B32___wCB6e6y9cWhjdHGyI4ki-qGa-GVWTmgP8ZtYpIK7O0 \u003cbase64url-node-data\u003e\n```\n\nWe request three leaves of the one community that exists.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farborchat%2Fsprout-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farborchat%2Fsprout-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farborchat%2Fsprout-go/lists"}