Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 2.3 KB

README.md

File metadata and controls

74 lines (48 loc) · 2.3 KB
Raw

DIF Logo

Universal Resolver Driver: did:btcr

This is a Universal Resolver driver for did:btcr identifiers.

Specifications

Example DIDs

 did:btcr:xz35-jznz-q9yu-ply
 did:btcr:xkrn-xz7q-qsye-28p
 did:btcr:x705-jznz-q3nl-srs

Build and Run (Docker)

docker build -f ./docker/Dockerfile . -t universalresolver/driver-did-btcr
docker run -p 8080:8080 universalresolver/driver-did-btcr
curl -X GET http://localhost:8080/1.0/identifiers/did:btcr:xz35-jznz-q9yu-ply

Build (native Java)

mvn clean install

Driver Environment Variables

The driver recognizes the following environment variables:

uniresolver_driver_did_btcr_bitcoinConnection

  • Specifies how the driver interacts with the Bitcoin blockchain.
  • Possible values:
    • bitcoind: Connects to a bitcoind instance via JSON-RPC
    • btcd: Connects to a btcd instance via JSON-RPC
    • bitcoinj: Connects to Bitcoin using a local bitcoinj client
    • blockcypherapi: Connects to BlockCypher's API
  • Default value: blockcypherapi

uniresolver_driver_did_btcr_rpcUrlMainnet

  • Specifies the JSON-RPC URL of a bitcoind/btcd instance running on Mainnet.
  • Default value: http://user:pass@localhost:8332/

uniresolver_driver_did_btcr_rpcUrlTestnet

  • Specifies the JSON-RPC URL of a bitcoind/btcd instance running on Testnet.
  • Default value: http://user:pass@localhost:18332/

uniresolver_driver_did_btcr_rpcCertMainnet

  • Specifies the server TLS certificate of the bitcoind/btcd instance running on Mainnet.
  • Default value: ``

uniresolver_driver_did_btcr_rpcCertTestnet

  • Specifies the server TLS certificate of the bitcoind/btcd instance running on Testnet.
  • Default value: ``

Driver Metadata

The driver returns the following metadata in addition to a DID document:

  • fragmentUri: ...
  • chain: ...
  • blockHeight: ...
  • blockIndex: ...