Skip to content

Latest commit

 

History

History

backend

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Resources
Resources
 
 
contracts
contracts
 
 
scripts
scripts
 
 
README.md
README.md
 
 
data.json
data.json
 
 
hardhat.config.js
hardhat.config.js
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 

README.md

Backend for Summerproject 2023

Structure

Installing

Clone the repository

cd .\summer-camp-2023\backend

Install the nescecary deppendencies:

npm install

Compile the project:

npx hardhat compile

Start the blockchain local instance:

npx hardhat node

Deploy the smart contracts:

npx hardhat run --network localhost scripts/deploy.js

Start the server:

node scripts/server/index.js

The Blockchain

In this repository are the smart contracts based on EIP-712 and EIP-1812 for Structured Data Types and Verifiable Claims respectively, to perform the registration and verification process of Verifiable Credentials on-chain.

Structure

Structure

The main objective is to have a credential registry for creating Liquor liscence and knowledge test verifiable credentials. There is the CredentialRegistry whose function is to maintain the main registry. However, it is not intended to interact directly with applications. That is why there is a contract that serves as a middleman to be able to register each type of credential, this contract is called ClaimsVerifier, and it is in charge of both registering credential hashes and verifying them by making internal calls to the CredentialRegistry.

Contracts

  • CredentialRegistry: Master credential registry

  • AbstractClaimsVerifier: Abstract class that represents a credential verifier

  • ClaimsVerifier: Class that allows verifying a specific type of credential. Receive the CredentialRegistry adress as a constructor argument.

  • ClaimTypes: Generic class that defines EIP712 domain types for credentials.

  • ICredentialRegistry: Interface that defines the main methods of a CredentialRegistry, as well as the metadata of each credential.

Security roles

The contracts make use of the OpenZeppelin Access Control System, for which two roles have been defined:

  • ISSUER_ROLE

  • SIGNER_ROLE

The ISSUER_ROLE should be assigned to any account that is going to register a credential in the ClaimsVerifier contract.

The SIGNER_ROLE should be assigned to any account that is going to sign a credential within the ClaimsVerifier contract.

Pre-requisites

  • NodeJS > 12.4
  • Etehrs @ 5.7.2
  • OpenZeppelin Contracts @ 3.0.0