atproto 0.0.1-preview.1

AT Protocol data model, repositories, identity, XRPC, OAuth and sessions

Readme Files Dependencies Versions

atproto#

Libraries for the AT Protocol in Zena: its data model, encodings, cryptography, identity resolution, and repositories.

Usage#

import {cidForValue, decodeCbor, encodeCbor} from 'atproto/cbor';
import {StringValue, newMap, stringField} from 'atproto/data';

let record = newMap([
  ('$type', new StringValue('app.bsky.feed.post')),
  ('text', new StringValue('Hello from Zena!')),
]);

let bytes = encodeCbor(record);
let cid = cidForValue(record);
let decoded = decodeCbor(bytes);

Libraries#

  • atproto/varint: multiformats unsigned varints.
  • atproto/multibase: multibase strings, and base58btc. The other base encodings are in zena:encoding.
  • atproto/cid: CIDs, their binary and string forms, and the CIDs atproto gives records and blobs.
  • atproto/data: the data model (Value and its cases), its JSON form, and blob references (BlobRef).
  • atproto/cbor: DAG-CBOR encoding and strict decoding, cidForValue, and sortedKeys, the order DAG-CBOR writes map keys in.
  • atproto/syntax: DIDs, handles, NSIDs, record keys, TIDs, datetimes, and CID strings.
  • atproto/car: CAR files and BlockMap, checking every block against its CID.
  • atproto/mst: the Merkle search tree: key heights, nodes, building a tree, and looking a key up through the nodes of a proof.
  • atproto/repo: commits, signing them, and verifying com.atproto.sync.getRecord proofs.
  • atproto/tid: timestamp identifiers, and a clock that hands out increasing ones.
  • atproto/didkey: public keys as multikeys, did:keys, and DID document verification methods, and checking atproto signatures with them.
  • atproto/did: what atproto reads from a DID document: the signing key, the PDS, and the claimed handle.
  • atproto/service-auth: service-auth JWTs, which an account's PDS signs so the account can call another service: creating them, checking them against the issuer's key, the audience, the method, and the time, and refusing a token presented twice (ReplayGuard).
  • atproto/session: signing in to an account's PDS with a password, refreshing and ending the session, and asking the PDS for service-auth tokens, with a password session or an OAuth one (AccountSession).
  • atproto/oauth: signing in with atproto OAuth as a public client, such as a command-line tool: finding the PDS's authorization server, the authorization request with PKCE and DPoP, trading the code for tokens, and a session that signs each request, follows the servers' nonces, refreshes and revokes its tokens.
  • atproto/dpop: DPoP keys and proofs: ES256 proofs for each request, checking them, and JWK thumbprints.
  • atproto/xrpc: an XRPC client, whose requests a RequestSigner can authorize one by one.
  • atproto/methods: the NSIDs of standard com.atproto methods, and xrpcPath, a method's path on a server.
  • atproto/plc: did:plc operations: building and signing them, the DID a genesis operation makes, and sending an operation to a PLC directory.
  • atproto/identity: resolving DIDs (did:plc, did:web) and handles (DNS over HTTPS, then HTTPS), checking handles in both directions.
  • atproto/sync: fetching a record and checking its proof against the DID document's key, fetching a blob and checking it against its CID, and listing a collection's records, which comes with no proof.

atproto/xrpc, atproto/identity, atproto/sync, atproto/session, atproto/oauth, and atproto/plc send requests with zena:fetch; atproto/oauth also reads the clock and draws random bytes. The other libraries have no imports from the host.

2.2 KiB Raw
/**
 * The NSIDs of the `com.atproto` XRPC methods these libraries call and the
 * PDS in `packages/pds` serves, named by their namespace and method, since
 * `com.atproto.repo.getRecord` and `com.atproto.sync.getRecord` share a
 * method name. Their lexicons are atproto's own, in
 * https://github.com/bluesky-social/atproto/tree/main/lexicons/com/atproto.
 */

export let IDENTITY_RESOLVE_HANDLE = 'com.atproto.identity.resolveHandle';

export let REPO_APPLY_WRITES = 'com.atproto.repo.applyWrites';
export let REPO_DELETE_RECORD = 'com.atproto.repo.deleteRecord';
export let REPO_DESCRIBE_REPO = 'com.atproto.repo.describeRepo';
export let REPO_GET_RECORD = 'com.atproto.repo.getRecord';
export let REPO_LIST_RECORDS = 'com.atproto.repo.listRecords';
export let REPO_PUT_RECORD = 'com.atproto.repo.putRecord';
export let REPO_UPLOAD_BLOB = 'com.atproto.repo.uploadBlob';

export let SERVER_CREATE_ACCOUNT = 'com.atproto.server.createAccount';
export let SERVER_CREATE_SESSION = 'com.atproto.server.createSession';
export let SERVER_DELETE_SESSION = 'com.atproto.server.deleteSession';
export let SERVER_DESCRIBE_SERVER = 'com.atproto.server.describeServer';
export let SERVER_GET_SERVICE_AUTH = 'com.atproto.server.getServiceAuth';
export let SERVER_GET_SESSION = 'com.atproto.server.getSession';
export let SERVER_REFRESH_SESSION = 'com.atproto.server.refreshSession';
export let SERVER_RESERVE_SIGNING_KEY = 'com.atproto.server.reserveSigningKey';

export let SYNC_GET_BLOB = 'com.atproto.sync.getBlob';
export let SYNC_GET_LATEST_COMMIT = 'com.atproto.sync.getLatestCommit';
export let SYNC_GET_RECORD = 'com.atproto.sync.getRecord';
export let SYNC_GET_REPO = 'com.atproto.sync.getRepo';

/** Every method above. */
export let ATPROTO_METHODS: Array<String> = [
  IDENTITY_RESOLVE_HANDLE, REPO_APPLY_WRITES, REPO_DELETE_RECORD, REPO_DESCRIBE_REPO, REPO_GET_RECORD,
  REPO_LIST_RECORDS, REPO_PUT_RECORD, REPO_UPLOAD_BLOB, SERVER_CREATE_ACCOUNT, SERVER_CREATE_SESSION,
  SERVER_DELETE_SESSION, SERVER_DESCRIBE_SERVER, SERVER_GET_SERVICE_AUTH, SERVER_GET_SESSION, SERVER_REFRESH_SESSION,
  SERVER_RESERVE_SIGNING_KEY, SYNC_GET_BLOB, SYNC_GET_LATEST_COMMIT, SYNC_GET_RECORD, SYNC_GET_REPO
];

/** The path of the XRPC method `method` on a server: `/xrpc/<method>`. */
export function xrpcPath(method: String): String {
  return `/xrpc/${method}`;
}
none
VersionPublishedDependenciesApproved by
0.0.1-preview.1 2026-11-19 none