Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 806 Bytes

README.md

File metadata and controls

16 lines (12 loc) · 806 Bytes

BNS X

BNS X is a protocol for extending and improving the Bitcoin Naming System (BNS).

At the time of writing, all aspects of the BNS X protocol are in development and unreleased.

This project is a monorepo, which includes a few packages:

  • Clarity contracts and tests
    • Clarity contracts for the protocol are at the root level of the project. The contracts themselves live under ./contracts/. Tests are under ./tests/.
    • Auto-generated Clarity code documentation can be found under ./docs.
    • This project uses Clarinet for testing and other Clarity development purposes.
  • Web app
    • A web app for interfacing with BNS X can be found under ./web
  • Indexer
    • A basic indexer for BNS X on-chain data is under `./indexer/