Skip to content

Latest commit

 

History

History
114 lines (72 loc) · 6.23 KB

README.md

File metadata and controls

114 lines (72 loc) · 6.23 KB
Raw

Indy-Cordapp

Provides the basic Corda flows for working with an Indy Ledger

Process

In terms of Indy

Hyperledger Indy Ledger is a platform for providing DIDs (Decentralized IDs) and verifiable Credentials.

Every Indy-enabled node should run an instance of IndyService to managed all the operations with the Indy Ledger.

The private information such as Keys and Credentials are stored in Wallet. The wallet is unique for every Indy user and must be created for every instance of IndyService. By default it is in the ~/.indy_client/ folder. Delete it manually or with a Gradle task cleanDefaultPool to have a clean run.

The shared information such as Shames and Credential Definitions are stored in Indy Pool. We recommend running it as a Docker container, locally or remotely. You can download a pre-build Docker image from DockerHub or use indy-sdk to compose an image yourselves.

Indy Configuration

Each IndyService can be configured with its own indy.properties

  • indyuser.walletName - the name of the Wallet
  • indyuser.walletType - the type of the Wallet
  • indyuser.role - the role of the service
  • indyuser.did - a preconfigured DID of the node
  • indyuser.seed - a seed to generate private keys of the node
  • indyuser.genesisFile - absolute path to a Genesis file or relative to a resource folder. Must start with /
  • indyuser.wallet - deprecated

Example indy.properties file:

indyuser.walletName=Issuer
indyuser.walletType=CordaWalletType
indyuser.role=trustee
indyuser.did=V4SGRU86Z58d6TV7PBUe6f
indyuser.seed=000000000000000000000000Trustee1
indyuser.genesisFile=/docker_pool_transactions_genesis.txt

Indy Terminology

  • DID - a.k.a. Decentralized Identity - a mean for trustable interactions with the subject (e.i. Bob)

  • Attribute - a small piece of information (e.i. Bob's age)

  • Schema - a digital description of Attributes an entity can provide (e.i. Bob can provide his name and age). For more please see Indy documentation.

  • Credential - a statement about an Attribute that you can prove to 3rd party (e.i. Bob's age is more than 18)

  • Credential Definition - a signed template for a Credential (e.i. Bob is ready to issue Credentials about his age). For more please see Indy documentation.

  • Wallet - local storage for private keys and saved Credentials

  • Genesis File - a file to get access to an Indy network. For some networks you can find Genesis files in the genesis directory

In terms of Corda

Corda Platform provides a secure peer-to-peer network for transporting Indy entities such as Schemas, Credentials and verifying Attributes.

Corda Terminology

  • Node - a peer that hosts a Corda service or executes a CORDAPP application.
  • X500 Name - a unique identifier by which any Corda node can be found
  • Flow - a sequence of steps involving multiple Nodes and updating the Corda ledger
  • State - data that can be transferred through the Corda network
  • Service - a.k.a. Node Service - a sub function of a Corda Node. Usually accessible through ServiceHub

Components

Flows

Utility Flows

Services

  • IndyService - A Corda service for dealing with Indy Ledger infrastructure such as pools, credentials, wallets.

Build

gradle clean build

Net Topology

The system assumes that the Corda network contains several IndyService nodes that correspond to business entities.

At least one node must be a Trustee to be able to grant permissions to other nodes. In the current realisation a Trustee must have indyuser.seed=000000000000000000000000Trustee1 in its configuration file.

Typical flow

  1. Add permissions to issue from TRUSTEE to every verified issuer in your system with AssignPermissionsFlow
  2. Create some schemas and credential definitions by specific issuers with CreateSchemaFlow and CreateCredentialDefinitionFlow
  3. Issue credential to some provers with IssueCredentialFlow
  4. Verify these credentials by some verifiers with VerifyCredentialFlow
  5. Revoke outdated credentials by issuer with RevokeCredentialFlow