Implementation of ballena.io smart contracts on the Binance Smart Chain. In-depth documentation on ballena.io is available at docs.ballena.io.
In the docs folder you will find all documentation related to the implementation of the smart contracts.
Our contracts are written in Solidity and our tests and scripts in TypeScript.
If you want to contribute, familiarity with Hardhat, Ethers, Waffle and TypeChain is needed.
Before running any command, make sure to install dependencies:
$ yarn install
Compile the smart contracts with Hardhat:
$ yarn compile
Compile the smart contracts and generate TypeChain artifacts:
$ yarn typechain
Lint the Solidity code:
$ yarn lint:sol
Lint the TypeScript code:
$ yarn lint:ts
Run the Prettier formatter:
$ yarn prettier
Run the tests:
$ yarn test
Generate the code coverage report:
$ yarn coverage
Delete the smart contract artifacts, the Hardhat cache, TypeChain types and the coverage reports:
$ yarn clean
For any concerns or feedback, open an issue or visit us on Discord to discuss.
Everything is released under the MIT license.