Skip to content

the9ines/bolt-core-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

156 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bolt Core SDK

Open reference implementation of the Bolt Protocol for encrypted device-to-device file transfer.


What This Is

The SDK that all Bolt-based applications embed to speak Bolt Core. One codepath for pairing, TOFU pinning, handshake gating, envelope encryption, and the transfer state machine.

Note: The Bolt Protocol specification (PROTOCOL.md, LOCALBOLT_PROFILE.md) currently resides in this repository until bolt-protocol is fully separated.


Specification Documents

Document Description
PROTOCOL.md Bolt Protocol Core v1. Transport-agnostic specification.
LOCALBOLT_PROFILE.md LocalBolt Profile v1. Transport binding for the browser peer channel.

SDK Goals

  • Pluggable Profile bindings: apps provide Profile adapters (rendezvous + peer channel + encoding hooks)
  • Deterministic behavior: canonical serialization per Profile, stable state machine, strict conformance checks
  • Small surface area: minimal public API, strong invariants, reliable defaults
  • Transport-agnostic at Core level

SDK Non-Goals

  • Does not implement discovery or routing
  • Does not define UI or product policy
  • Does not require a daemon

Role in the Ecosystem

Relationship Repository
Specification bolt-protocol
Depends on this localbolt, localbolt-app, localbolt-v3, bytebolt-app, bolt-daemon

Packaging

  • Rust crate: bolt-core
  • TypeScript package: @the9ines/bolt-core

API Stability

As of version 0.1.0, the public API surface is considered stable under Semantic Versioning 2.0.0. See docs/SDK_STABILITY.md for the full stability contract, versioning policy, and breaking change checklist.


Spec Status

Document Version Status
Bolt Core v1 1.0.0 Draft
LocalBolt Profile v1 1.0.0 Draft

License

MIT

About

Bolt Core SDK — Open reference implementation of Bolt Protocol (Rust + TypeScript)

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors