FactomProject / factom-did-driver

Universal Resolver driver for identities on the Factom Blockchain

Universal Resolver Driver: did:factom

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

Specifications

• Decentralized Identifiers
• Factom DID Method Specification

Example DIDs

did:factom:f26e1c422c657521861ced450442d0c664702f49480aec67805822edfcfee758

Build and Run (Docker)

docker build -f ./docker/Dockerfile . -t universalresolver/driver-did-factom
docker run -p 8080:8080 universalresolver/driver-did-factom
curl -X GET http://localhost:8080/1.0/identifiers/did:factom:f26e1c422c657521861ced450442d0c664702f49480aec67805822edfcfee758

Build and Run (python)

1. First, get the driver's dependencies pip3 install -r requirements.txt
2. Then, run the driver python3 did_factom_driver.py
3. The driver will now be accessible to curl at localhost:8080

Driver Environment Variables

The driver recognizes the following environment variables:

uniresolver_driver_did_factom_factomConnection

• Specifies the type of connection used to interact with the Factom blockchain:factomd or harmony. (Note: the harmony connection type only supports resolution of mainnet DIDs, and will fallback to the factomd connection)
• Default value: factomd

uniresolver_driver_did_factom_rpcUrlMainnet

• Specifies the JSON-RPC URL of a factomd instance running on mainnet
• Default value: https://api.factomd.net

uniresolver_driver_did_factom_rpcUrlTestnet

• Specifies the JSON-RPC URL of a factomd instance running on the community testnet
• Default value: https://dev.factomd.net

uniresolver_driver_did_factom_tfaExplorerApiUrlMainet

• Specifies the URL of the TFA explorer API on mainnet
• Default value: https://explorer.factoid.org/api/v1

uniresolver_driver_did_factom_tfaExplorerApiUrlTestnet

• Specifies the URL of the TFA explorer API on testnet
• Default value: https://testnet.factoid.org/api/v1

uniresolver_driver_did_factom_harmonyApiUrl

• Specifies the URL of a Factom Harmony Connect API
• Default value: https://api.factom.com/v1

uniresolver_driver_did_factom_harmonyApiAppId

• Specifies the app_id to be sent in request headers to the Factom Harmony Connect API
• Default value: N/A

uniresolver_driver_did_factom_harmonyApiAppKey

• Specifies the app_key to be sent in request headers to the Factom Harmony Connect API
• Default value: N/A

uniresolver_driver_did_factom_harmonyApiCachingEnabled

• Specifies whether or not to use cached results (true or false)
• Default value: false

Driver Metadata

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

• version: The version of this Factom identity (currently 1)
• name: The array of partial names that the identity was initialized with.
• stage: The current state of the DID on the blockchain, could be any of the following:
  • pending: The identity chain has been submitted for creation, and is waiting to be included in a Directory Block
  • factom: The identity chain has been created and included in a Directory Block (i.e. confirmed)
  • anchored: The identity chain has been created and confirmed, and the directory block that it was included in has been anchored to Bitcoin and/or Ethereum
• createdHeight: The Directory Block height that the identity chain was created at (null if stage is pending)
• publicKeyHistory: All public keys ever active for this identity, along with information about it's window of activation