Releases: mflowrs/BitStory
BitStory Protocol v1.0.0
BitStory v1.0.0 — Initial public release
This is the first public release of BitStory, a protocol for publishing signed, structured messages anchored on Bitcoin.
BitStory defines:
- a minimal canonical JSON format,
- a small set of message types (PO / PF / PG),
- a deterministic signing and verification model,
- and a clear separation between on-chain anchoring and off-chain indexing.
This release provides the specification and reference implementations needed to build interoperable clients and indexers.
What’s included
Protocol specification
-
Canonical JSON format and message definitions
spec/json-format.md -
HTTP API / indexer specification
spec/api.md
Reference examples
-
Post example
examples/post_example.json -
Profile example
examples/profile_example.json -
Page example
examples/page_example.json
Reference clients
-
Python reference client
client/python/bitstory_client.py -
JavaScript (ESM) reference client
client/js/bitstory_client.mjs
These clients implement:
- construction of valid BitStory messages (PO / PF / PG),
- canonical JSON encoding,
- signing with recoverable secp256k1 signatures,
- verification and public key recovery.
Whitepaper
- BitStory Whitepaper v1.0
whitepaper/BitStory_Whitepaper_V1.0.pdf
The whitepaper describes:
- design goals and rationale,
- the security model,
- economic considerations,
- versioning and extensibility principles.
Stability and compatibility
- This release defines version 1.0 of the BitStory format.
- Future versions may extend the protocol, but backward compatibility is a core design goal.
- Implementers are encouraged to discuss extensions and edge cases via GitHub Discussions before diverging from the specification.
Getting started
A recommended reading order:
- JSON format specification
- Example messages
- Reference clients
- API / indexer specification
- Whitepaper
Feedback and discussion
Questions, feedback and interoperability discussions are welcome via
GitHub Discussions.
Concrete bugs or documentation issues should be reported via GitHub Issues.
Security
This release does not include wallet key management or transaction creation logic.
Security-related concerns should be reported privately using admin@bitstory.org.