Sign inSign up

iotaledger/uni-resolver-driver-iota

By iotaledger

•Updated over 1 year ago

Image
0

6.1K

iotaledger/uni-resolver-driver-iota repository overview

Issues Apache 2.0 license Discord StackExchange Docker

⁠Universal Resolver Driver for IOTA

This is a driver implementation of Universal Resolver⁠ for the did:iota identifier.

⁠Specifications

IOTA DID Method Specification v1.0⁠

⁠Example DIDs

did:iota:0xf4d6f08f5a1b80dd578da7dc1b49c886d580acd4cf7d48119dfeb82b538ad88a⁠

⁠Build and Run (Docker)

docker build . -t iotaledger/uni-resolver-driver-iota
docker run -p 8080:8080 iotaledger/uni-resolver-driver-iota
 curl -X GET localhost:8080/1.0/identifiers/<did>

⁠Build and Run (Rust)

cargo run --release

⁠Network Configuration

The resolver supports the 3 official IOTA networks as well as a custom one:

  • Mainnet
  • Testnet
  • Devnet
  • Custom
⁠Environment Variables

The following environment variables are used to configure the network:

VariableRequiredDescription
NETWORKYesNetwork type: "mainnet", "testnet", "devnet", or "custom"
IOTA_CUSTOM_NODE_ENDPOINTOnly for custom networkThe URL of your custom node
IOTA_CUSTOM_IDENTITY_PKG_IDOnly for custom networkThe identity package ID for your custom network

Note: at least one network must be configured.

⁠Multiple Network Configuration

You can specify multiple networks by providing a comma-separated list in the NETWORK environment variable. Examples are provided below.

⁠Example
⁠Single Network
NETWORK=testnet
⁠Multiple Networks
NETWORK=testnet,devnet
⁠Custom Network
NETWORK=custom
IOTA_CUSTOM_NODE_ENDPOINT=https://your-custom-node-endpoint.com
IOTA_CUSTOM_IDENTITY_PKG_ID=0x4bbd377239914fced5c1207a28443064050e880a1234858904e0ce31a5a9768c
⁠Custom Network with Multiple Clients
NETWORK=custom,testnet
IOTA_CUSTOM_NODE_ENDPOINT=https://your-custom-node-endpoint.com
IOTA_CUSTOM_IDENTITY_PKG_ID=0x4bbd377239914fced5c1207a28443064050e880a1234858904e0ce31a5a9768c

This will create two identity clients, one for the custom network and one for the testnet network.

⁠Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top⁠)

⁠License

Distributed under the Apache License. See LICENSE for more information.

(back to top⁠)

Tag summary

Content type

Image

Digest

sha256:24ddb6649…

Size

36.8 MB

Last updated

over 1 year ago

docker pull iotaledger/uni-resolver-driver-iota