oppi.li
1
2
3# indigo: atproto libraries and services in golang
4
5Some Bluesky software is developed in Typescript, and lives in the [bluesky-social/atproto](https://github.com/bluesky-social/atproto) repository. Some is developed in Go, and lives here.
6
7## What is in here?
8
9**Go Services:**
10
11- **relay** ([README](./cmd/relay/README.md)): relay reference implementation
12- **rainbow** ([README](./cmd/rainbow/README.md)): firehose "splitter" or "fan-out" service
13- **palomar** ([README](./cmd/palomar/README.md)): fulltext search service for <https://bsky.app>
14- **hepa** ([README](./cmd/hepa/README.md)): auto-moderation bot for [Ozone](https://ozone.tools)
15
16**Developer Tools:**
17
18**goat** ([README](./cmd/goat/README.md)): CLI for interacting with network: CAR files, firehose, APIs, etc
19
20**Go Packages:**
21
22> ⚠️ All the packages in this repository are under active development. Features and software interfaces have not stabilized and may break or be removed.
23
24| Package | Docs |
25| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26| `api/atproto`: generated types for `com.atproto.*` Lexicons | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/api/atproto) |
27| `api/bsky`: generated types for `app.bsky.*` Lexicons | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/api/bsky) |
28| `atproto/crypto`: crytographic signing and key serialization | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/atproto/crypto) |
29| `atproto/identity`: DID and handle resolution | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/atproto/identity) |
30| `atproto/syntax`: string types and parsers for identifiers | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/atproto/syntax) |
31| `atproto/lexicon`: schema validation of data | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/atproto/lexicon) |
32| `mst`: Merkle Search Tree implementation | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/mst) |
33| `repo`: account data storage | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/repo) |
34| `xrpc`: HTTP API client | [](https://pkg.go.dev/mod/github.com/bluesky-social/indigo/xrpc) |
35
36The TypeScript reference implementation, including PDS and bsky AppView services, is at [bluesky-social/atproto](https://github.com/bluesky-social/atproto). Source code for the Bluesky Social client app (for web and mobile) can be found at [bluesky-social/social-app](https://github.com/bluesky-social/social-app).
37
38## Development Quickstart
39
40First, you will need the Go toolchain installed. We develop using the latest stable version of the language.
41
42The Makefile provides wrapper commands for basic development:
43
44 make build
45 make test
46 make fmt
47 make lint
48
49Individual commands can be run like:
50
51 go run ./cmd/relay
52
53The [HACKING](./HACKING.md) file has a list of commands and packages in this repository and some other development tips.
54
55## What is atproto?
56
57_not to be confused with the [AT command set](https://en.wikipedia.org/wiki/Hayes_command_set) or [Adenosine triphosphate](https://en.wikipedia.org/wiki/Adenosine_triphosphate)_
58
59The Authenticated Transfer Protocol ("ATP" or "atproto") is a decentralized social media protocol, developed by [Bluesky Social PBC](https://bsky.social). Learn more at:
60
61- [Overview and Guides](https://atproto.com/guides/overview) 👈 Best starting point
62- [Github Discussions](https://github.com/bluesky-social/atproto/discussions) 👈 Great place to ask questions
63- [Protocol Specifications](https://atproto.com/specs/atp)
64- [Blogpost on self-authenticating data structures](https://bsky.social/about/blog/3-6-2022-a-self-authenticating-social-protocol)
65
66The Bluesky Social application encompasses a set of schemas and APIs built in the overall AT Protocol framework. The namespace for these "Lexicons" is `app.bsky.*`.
67
68## Contributions
69
70> While we do accept contributions, we prioritize high quality issues and pull requests. Adhering to the below guidelines will ensure a more timely review.
71
72**Rules:**
73
74- We may not respond to your issue or PR.
75- We may close an issue or PR without much feedback.
76- We may lock discussions or contributions if our attention is getting DDOSed.
77- We do not provide support for build issues.
78
79**Guidelines:**
80
81- Check for existing issues before filing a new one, please.
82- Open an issue and give some time for discussion before submitting a PR.
83- Issues are for bugs & feature requests related to the golang implementation of atproto and related services.
84 - For high-level discussions, please use the [Discussion Forum](https://github.com/bluesky-social/atproto/discussions).
85 - For client issues, please use the relevant [social-app](https://github.com/bluesky-social/social-app) repo.
86- Stay away from PRs that:
87 - Refactor large parts of the codebase
88 - Add entirely new features without prior discussion
89 - Change the tooling or libraries used without prior discussion
90 - Introduce new unnecessary dependencies
91
92Remember, we serve a wide community of users. Our day-to-day involves us constantly asking "which top priority is our top priority." If you submit well-written PRs that solve problems concisely, that's an awesome contribution. Otherwise, as much as we'd love to accept your ideas and contributions, we really don't have the bandwidth.
93
94## Are you a developer interested in building on atproto?
95
96Bluesky is an open social network built on the AT Protocol, a flexible technology that will never lock developers out of the ecosystems that they help build. With atproto, third-party can be as seamless as first-party through custom feeds, federated services, clients, and more.
97
98## License
99
100This project is dual-licensed under MIT and Apache 2.0 terms:
101
102- MIT license ([LICENSE-MIT](https://github.com/bluesky-social/indigo/blob/main/LICENSE-MIT) or http://opensource.org/licenses/MIT)
103- Apache License, Version 2.0, ([LICENSE-APACHE](https://github.com/bluesky-social/indigo/blob/main/LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
104
105Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.