@violetprotocol/violetid
v1.4.0
Published
[hardhat]: https://hardhat.org/ [hardhat-badge]: https://img.shields.io/badge/Built%20with-Hardhat-FFDB1C.svg [license]: https://opensource.org/licenses/MIT [license-badge]: https://img.shields.io/badge/License-MIT-blue.svg
Downloads
8
Readme
VioletID Onchain Registry
The VioletID registry is an onchain registry maintained by Violet, providing attributes - a.k.a statuses
- by wallet
address registered with Violet. For more details please visit our docs:
https://docs.violet.co/
Usage
Pre Requisites
Before being able to run any command, you need to create a .env
file and set a BIP-39 compatible mnemonic as an
environment variable. You can follow the example in .env.example
. If you don't already have a mnemonic, you can use
this website to generate one.
Then, proceed with installing dependencies:
$ yarn install
Compile
Compile the smart contracts with Hardhat:
$ yarn compile
TypeChain
Compile the smart contracts and generate TypeChain bindings:
$ yarn typechain
Test
Run the tests with Hardhat:
$ yarn test
Lint Solidity
Lint the Solidity code:
$ yarn lint:sol
Lint TypeScript
Lint the TypeScript code:
$ yarn lint:ts
Coverage
Generate the code coverage report:
$ yarn coverage
Report Gas
See the gas usage per unit test and average gas per method call:
$ REPORT_GAS=true yarn test
Clean
Delete the smart contract artifacts, the coverage reports and the Hardhat cache:
$ yarn clean
Deploy
Deploy the contracts to Hardhat Network:
$ yarn deploy --greeting "Bonjour, le monde!"
Tips
Syntax Highlighting
If you use VSCode, you can get Solidity syntax highlighting with the hardhat-solidity extension.
Using GitPod
GitPod is an open-source developer platform for remote development.
To view the coverage report generated by yarn coverage
, just click Go Live
from the status bar to turn the server
on/off.