Skip to content

Repository files navigation

@khoralabs/relay

A DID-authenticated encrypted blob transport framework — client, server, and contracts.

The relay provides a generic, deployable hub for opaque encrypted byte streams authenticated via Decentralized Identifiers (DIDs). It is the network transport layer for OBP/NBC sessions on the Khora network, but is designed to be used independently of any product.

Packages

Package Description
packages/relay (@khoralabs/relay) Unified library: client, crypto, contracts, admission, MLS, server, testing

Entrypoints

Import Role
@khoralabs/relay / ./client TypeScript client SDK
@khoralabs/relay/crypto DID utilities, encoding, signing, pairing-secret encryption
@khoralabs/relay/contracts Shared wire types
@khoralabs/relay/admission Pairing secrets, HMAC tickets, WS upgrade nonces
@khoralabs/relay/mls RFC 9420 MLS groups and KeyPackage pool
@khoralabs/relay/server Bun HTTP + WebSocket server library
@khoralabs/relay/testing Server test helpers

Apps

App Description
apps/relay-server Standalone relay server binary with SQLite persistence

Getting started

bun install

Run all checks before committing:

bun run verify

Hooks (via husky): pre-commit runs Biome; pre-push runs format check, typecheck, tests, and build; commit-msg runs agent-review.

Migration from split packages

"@khoralabs/relay-client"               "@khoralabs/relay/client" // or "@khoralabs/relay"
"@khoralabs/relay-crypto"               "@khoralabs/relay/crypto"
"@khoralabs/relay-contracts"            "@khoralabs/relay/contracts"
"@khoralabs/relay-mls"                  "@khoralabs/relay/mls"
"@khoralabs/relay-admission"            "@khoralabs/relay/admission"
"@khoralabs/relay-server-http"          "@khoralabs/relay/server"
"@khoralabs/relay-server-http/testing"  "@khoralabs/relay/testing"

Security

See SECURITY.md for vulnerability reporting and deployment hardening notes.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages