README.md

Indy smart contracts

Prerequisites to run

• node > v18.15.0
• yarn

Install dependencies

> yarn install

Compile contracts

> yarn compile

The following folders should be generated as the result:

• artifacts - completed contract specification
• typechain-types - typescript bindings for contracts

Run tests

> yarn test

Main Contracts

• AccountControl - contract to manage permissions for transactions and new contracts deployment
  • AccountControl TS contract wrapper class
• RoleControl - contract to manage (assign/revoke) account roles.
  • RoleControl TS contract wrapper class
• IndyDidRegistry - indybesu DID Registry
  • IndyDidRegistry TS contract wrapper class
• EthereumExtDidRegistry - Ethereum DID Registry extended with permission checks
  • DidRegistry TS contract wrapper class
• SchemaRegistry - contract to manage Schemas
  • SchemaRegistry TS contract wrapper class
• CredentialDefinitionRegistry - contract to manage Credential Definitions
  • CredentialDefinitionRegistry TS contract wrapper class
• ValidatorControl - contract to manage network validator nodes.
  • ValidatorControl TS contract wrapper class
• UpgradeControl - contract to control deployed smart contracts and their versions (proposing and approving new versions).
  • Upgrading TS contract wrapper class
• LegacyMappingRegistry - contract to store mapping for legacy identifiers.
  • LegacyMappingRegistry TS contract wrapper class

Demos

You can find sample scripts demonstrating the usage of deployed contracts in the demo folder.

• Account management - deploy/read/writer transactions.

  > yarn demo/account
  

• Demo flow - create/resolve DID/Schema/Credential Definition using did:indy2 method.

  > yarn demo/flow
  

• Demo flow - create/resolve DID/Schema/Credential Definition using did:ethr method.

  > yarn demo/flow-with-did-ethr
  

• Roles management - get/assign/revoke role to/from account.

  > yarn demo/roles
  

• Upgrade management - propose/approve upgradable contract implementation.

  > yarn demo/upgrade
  

• Validators management - get list of current validators.

  > yarn demo/validators
  

Helper Scripts

• Genesis - helper scripts to generate genesis state for injecting smart contracts.

socl tool must be installed on the machine.

Steps

1. Prepare the input file with the initial state of each contract.

2. Compile contracts:

   yarn solc-compile
   

   • artifacts and compiled-contracts folders with compiled contracts will be generated as the result of the execution.

3. Execute script generating the contracts content for the network genesis file:

   yarn genesis/generate

   • ContractsGenesis.json file will be generated as the result

4. Put the whole block into the alloc section of the network genesis file.

5. If you changed the default address of ValidatorControl contract: Set address of ValidatorControl contract into validatorcontractaddress field of the qbft section of the genesis file.

6. If you changed the default address of AccountControl contract: Set address of AccountControl contract into permissions-accounts-contract-address field of the config.toml file.