nonbinary.computer
A better Rust ATProto crate
1[](https://crates.io/crates/jacquard) [](https://docs.rs/jacquard)
2
3# Jacquard
4
5A suite of Rust crates intended to make it much easier to get started with atproto development, without sacrificing flexibility or performance.
6
7[Jacquard is simpler](https://whtwnd.com/nonbinary.computer/3m33efvsylz2s) because it is designed in a way which makes things simple that almost every other atproto library seems to make difficult.
8
9It is also designed around zero-copy/borrowed deserialization: types like [`Post<'_>`](https://tangled.org/@nonbinary.computer/jacquard/blob/main/crates/jacquard-api/src/app_bsky/feed/post.rs) can borrow data (via the [`CowStr<'_>`](https://docs.rs/jacquard/latest/jacquard/cowstr/enum.CowStr.html) type and a host of other types built on top of it) directly from the response buffer instead of allocating owned copies. Owned versions are themselves mostly inlined or reference-counted pointers and are therefore still quite efficient. The `IntoStatic` trait (which is derivable) makes it easy to get an owned version and avoid worrying about lifetimes.
10
11## Features
12
13- Validated, spec-compliant, easy to work with, and performant baseline types
14- Designed such that you can just work with generated API bindings easily
15- Straightforward OAuth
16- Server-side convenience features
17- Lexicon Data value type for working with unknown atproto data (dag-cbor or json)
18- An order of magnitude less boilerplate than some existing crates
19- Batteries-included, but easily replaceable batteries.
20 - Easy to extend with custom lexicons using code generation or handwritten api types
21 - Stateless options (or options where you handle the state) for rolling your own
22 - All the building blocks of the convenient abstractions are available
23 - Use as much or as little from the crates as you need
24
25## 0.8.0 Release Highlights:
26
27**`jacquard-repo` crate**
28 - Complete implementation of the atproto repository spec
29 - [Sync v1.1](https://github.com/bluesky-social/proposals/blob/main/0006-sync-iteration/README.md#commit-validation-mst-operation-inversion) commit event support (both proof production and verification), well-validated in testing
30 - repository CAR file read/write support
31 - CAR file write order compatible with streaming mode from the [sync iteration proposal](https://github.com/bluesky-social/proposals/blob/main/0006-sync-iteration/README.md#streaming-car-processing)
32 - Big rewrite of all the errors in the crate, improvements to context and overall structure
33 - Made handle parsing a bit more permissive for a common case ('handle.invalid' when someone has a messed up handle), added a method to confirm syntactic validity (the correct way to confirm validity is resolve_handle() from the IdentityResolver trait, then fetching and comparing to the DID document).
34
35## Example
36
37Dead simple API client. Logs in with OAuth and prints the latest 5 posts from your timeline.
38
39```rust
40// Note: this requires the `loopback` feature enabled (it is currently by default)
41use clap::Parser;
42use jacquard::CowStr;
43use jacquard::api::app_bsky::feed::get_timeline::GetTimeline;
44use jacquard::client::{Agent, FileAuthStore};
45use jacquard::oauth::client::OAuthClient;
46use jacquard::oauth::loopback::LoopbackConfig;
47use jacquard::types::xrpc::XrpcClient;
48use miette::IntoDiagnostic;
49
50#[derive(Parser, Debug)]
51#[command(author, version, about = "Jacquard - OAuth (DPoP) loopback demo")]
52struct Args {
53 /// Handle (e.g., alice.bsky.social), DID, or PDS URL
54 input: CowStr<'static>,
55
56 /// Path to auth store file (will be created if missing)
57 #[arg(long, default_value = "/tmp/jacquard-oauth-session.json")]
58 store: String,
59}
60
61#[tokio::main]
62async fn main() -> miette::Result<()> {
63 let args = Args::parse();
64
65 // Build an OAuth client with file-backed auth store and default localhost config
66 let oauth = OAuthClient::with_default_config(FileAuthStore::new(&args.store));
67 // Authenticate with a PDS, using a loopback server to handle the callback flow
68 let session = oauth
69 .login_with_local_server(
70 args.input.clone(),
71 Default::default(),
72 LoopbackConfig::default(),
73 )
74 .await?;
75 // Wrap in Agent and fetch the timeline
76 let agent: Agent<_> = Agent::from(session);
77 let timeline = agent
78 .send(&GetTimeline::new().limit(5).build())
79 .await?
80 .into_output()?;
81 for (i, post) in timeline.feed.iter().enumerate() {
82 println!("\n{}. by {}", i + 1, post.post.author.handle);
83 println!(
84 " {}",
85 serde_json::to_string_pretty(&post.post.record).into_diagnostic()?
86 );
87 }
88
89 Ok(())
90}
91
92```
93
94If you have `just` installed, you can run the [examples](https://tangled.org/@nonbinary.computer/jacquard/tree/main/examples) using `just example {example-name} {ARGS}` or `just examples` to see what's available.
95
96> [!WARNING]
97> A lot of the streaming code is still pretty experimental. The examples work, though.\
98The modules are also less well-documented, and don't have code examples. There are also a lot of utility functions for conveniently working with the streams and transforming them which are lacking. Use [`n0-future`](https://docs.rs/n0-future/latest/n0_future/index.html) to work with them, that is what Jacquard uses internally as much as possible.\
99>I would also note the same for the repository crate until I've had more third parties test it.
100
101### Changelog
102
103[CHANGELOG.md](./CHANGELOG.md)
104
105<!--### Testimonials
106
107- ["the most straightforward interface to atproto I've encountered so far."](https://bsky.app/profile/offline.mountainherder.xyz/post/3m3xwewzs3k2v) - @offline.mountainherder.xyz
108
109- "It has saved me a lot of time already! Well worth a few beers and or microcontrollers" - [@baileytownsend.dev](https://bsky.app/profile/baileytownsend.dev)-->
110
111### Projects using Jacquard
112
113- [skywatch-phash-rs](https://tangled.org/@skywatch.blue/skywatch-phash-rs)
114- [PDS MOOver](https://pdsmoover.com/) - [tangled repository](https://tangled.org/@baileytownsend.dev/pds-moover)
115
116## Component crates
117
118Jacquard is broken up into several crates for modularity. The correct one to use is generally `jacquard` itself, as it re-exports most of the others.
119
120| | | |
121| --- | --- | --- |
122| `jacquard` | Main crate | [](https://crates.io/crates/jacquard) [](https://docs.rs/jacquard) |
123|`jacquard-common` | Foundation crate | [](https://crates.io/crates/jacquard-common) [](https://docs.rs/jacquard-common)|
124| `jacquard-axum` | Axum extractor and other helpers | [](https://crates.io/crates/jacquard-axum) [](https://docs.rs/jacquard-axum) |
125| `jacquard-api` | Autogenerated API bindings | [](https://crates.io/crates/jacquard-api) [](https://docs.rs/jacquard-api) |
126| `jacquard-oauth` | atproto OAuth implementation | [](https://crates.io/crates/jacquard-oauth) [](https://docs.rs/jacquard-oauth) |
127| `jacquard-identity` | Identity resolution | [](https://crates.io/crates/jacquard-identity) [](https://docs.rs/jacquard-identity) |
128| `jacquard-repo` | Repository primitives (MST, commits, CAR I/O) | [](https://crates.io/crates/jacquard-repo) [](https://docs.rs/jacquard-repo) |
129| `jacquard-lexicon` | Lexicon parsing and code generation | [](https://crates.io/crates/jacquard-lexicon) [](https://docs.rs/jacquard-lexicon) |
130| `jacquard-derive` | Macros for lexicon types | [](https://crates.io/crates/jacquard-derive) [](https://docs.rs/jacquard-derive) |
131
132## Development
133
134This repo uses [Flakes](https://nixos.asia/en/flakes)
135
136```bash
137# Dev shell
138nix develop
139
140# or run via cargo
141nix develop -c cargo run
142
143# build
144nix build
145```
146
147There's also a [`justfile`](https://just.systems/) for Makefile-esque commands to be run inside of the devShell, and you can generally `cargo ...` or `just ...` whatever just fine if you don't want to use Nix and have the prerequisites installed.
148
149[](./LICENSE)