Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 4.01 KB

README.md

File metadata and controls

101 lines (66 loc) · 4.01 KB
Raw

DIF Logo

Universal Resolver Driver: did:erc725

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

Specifications

Example DIDs

did:erc725:ropsten:2F2B37C890824242Cb9B0FE5614fA2221B79901E

Configuration

For downloading the dependencies of this project a Personal Access Token for GitHub must be configured in file settings.xml according to Creating a personal access token for the command line. Then add them to environment variable,

GITHUB_READ_PACKAGES_OWNER=OWNER
GITHUB_READ_PACKAGES_TOKEN=TOKEN

Build and Run (Docker)

docker build -f ./docker/Dockerfile . -t universalresolver/driver-did-erc725
docker run -p 8080:8080 universalresolver/driver-did-erc725
curl -X GET http://localhost:8080/1.0/identifiers/did:erc725:ropsten:2F2B37C890824242Cb9B0FE5614fA2221B79901E

Build (native Java)

Maven build:

mvn --settings settings.xml clean install

Driver Environment Variables

The driver recognizes the following environment variables:

uniresolver_driver_did_erc725_ethereumConnection

  • Specifies how the driver interacts with the Ethereum blockchain.
  • Possible values:
    • jsonrpc: Connects to a geth instance via JSON-RPC
    • hybrid: Connects to a geth instance via JSON-RPC as well as to the EtherScan API
  • Default value: hybrid

uniresolver_driver_did_erc725_rpcUrlMainnet

  • Specifies the JSON-RPC URL of a geth instance running on Mainnet.
  • Default value: https://mainnet.infura.io/v3/fd9e225bc1234f49b48b295c611078eb

uniresolver_driver_did_erc725_rpcUrlRopsten

  • Specifies the JSON-RPC URL of a geth instance running on Ropsten.
  • Default value: https://ropsten.infura.io/v3/fd9e225bc1234f49b48b295c611078eb

uniresolver_driver_did_erc725_rpcUrlRinkeby

  • Specifies the JSON-RPC URL of a geth instance running on Rinkeby.
  • Default value: https://rinkeby.infura.io/v3/fd9e225bc1234f49b48b295c611078eb

uniresolver_driver_did_erc725_rpcUrlKovan

  • Specifies the JSON-RPC URL of a geth instance running on Kovan.
  • Default value: https://kovan.infura.io/v3/fd9e225bc1234f49b48b295c611078eb

uniresolver_driver_did_erc725_etherscanApiMainnet

  • Specifies the URL of the EtherScan API for Mainnet.
  • Default value: http://api.etherscan.io/api

uniresolver_driver_did_erc725_etherscanApiRopsten

  • Specifies the URL of the EtherScan API for Ropsten.
  • Default value: http://api-ropsten.etherscan.io/api

uniresolver_driver_did_erc725_etherscanApiRinkeby

  • Specifies the URL of the EtherScan API for Rinkeby.
  • Default value: http://api-rinkeby.etherscan.io/api

uniresolver_driver_did_erc725_etherscanApiKovan

  • Specifies the URL of the EtherScan API for Kovan.
  • Default value: http://api-kovan.etherscan.io/api

Driver Metadata

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

  • managementKeys: MANAGEMENT keys as defined by ERC725.
  • managementAddresses: MANAGEMENT key addresses as defined by ERC725.
  • actionKeys: ACTION keys as defined by ERC725.
  • actionAddresses: ACTION key addresses as defined by ERC725.
  • claimKeys: CLAIM keys as defined by ERC725.
  • claimAddresses: CLAIM key addresses as defined by ERC725.
  • encryptionKeys: ENCRYPTION keys as defined by ERC725.
  • encryptionAddresses: ENCRYPTION key addresses as defined by ERC725.