https://github.com/decentralized-identity/uni-resolver-driver-did-btcr

A Universal Resolver driver for did:btcr identifiers.
https://github.com/decentralized-identity/uni-resolver-driver-did-btcr

btcr decentralized-identifiers universal-resolver wg-id

Last synced: about 2 months ago
JSON representation

A Universal Resolver driver for did:btcr identifiers.

• Host: GitHub
• URL: https://github.com/decentralized-identity/uni-resolver-driver-did-btcr
• Owner: decentralized-identity
• License: apache-2.0
• Created: 2020-01-06T14:23:21.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-06-14T22:44:29.000Z (over 1 year ago)
• Last Synced: 2024-04-14T04:46:09.230Z (8 months ago)
• Topics: btcr, decentralized-identifiers, universal-resolver, wg-id
• Language: Java
• Homepage:
• Size: 138 KB
• Stars: 1
• Watchers: 14
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![DIF Logo](https://raw.githubusercontent.com/decentralized-identity/universal-resolver/master/docs/logo-dif.png)

# Universal Resolver Driver: did:btcr

This is a [Universal Resolver](https://github.com/decentralized-identity/universal-resolver/) driver for **did:btcr** identifiers.

## Specifications

* [Decentralized Identifiers](https://w3c.github.io/did-core/)

* [DID Method Specification](https://w3c-ccg.github.io/didm-btcr/)

## 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](https://bitcoin.org/en/full-node) instance via JSON-RPC

   * `btcd`: Connects to a [btcd](https://github.com/btcsuite/btcd) instance via JSON-RPC

   * `bitcoinj`: Connects to Bitcoin using a local [bitcoinj](https://bitcoinj.github.io/) client

   * `blockcypherapi`: Connects to [BlockCypher's API](https://www.blockcypher.com/dev/bitcoin/)

 * 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`: ...