0.0.14 • Published 5 months ago

btco v0.0.14

Weekly downloads
-
License
-
Repository
-
Last release
5 months ago

Bitcoin Ordinals DID Method Logo


An ALPHA implementation of the did:btco DID method.. Not Financial Advice.

W3C Recommendations

DIF Work Items

W3C-CCG Work Items

Prerequisites

  1. Bun
  2. jq (if you want to validate DID documents)
  3. A bitcoin node
  4. An ordinals node with full sat index running as a server (can be ordinals.com for mainnet)
  5. Another ordinals node with full sat index to be used as a wallet
  6. UTXOs in the ordinals wallet

Installing

git clone https://github.com/aviarytech/btco.git
cd btco && bun install

Setup

Export API variables of interest

export ORD_API=https://ordinals.com
export ORD_SIGNET_API=https://signet.ordinals.com
export ORD_REGTEST_API=http://localhost:8080

Getting Started

This is still EXTREMELY alpha software. It is strongly recommend to get started on BTC test networks such as a local regtest (-r) or a broader network like signet (-s) before commit to spending valuable outputs.

List DIDS

bun run btco list

Or to view blank and unwritten DIDs

bun run btco list --blank

Create BTCO DID

bun run btco create <did:btco:51...> ./didDoc.json --fee-rate <feeRate>

Update BTCO DID

bun run btco update <did:btco:51...> ./didDoc.json --fee-rate <feeRate>

Deactivate BTCO DID

bun run btco deactivate <did:btco:51...> --fee-rate <feeRate>