Alkemi Earn Contracts
For local development of
alkemi-earn-contractsyou can setup the development environment on your machine.
As a pre-requisite, you need:
Clone the project and install all dependencies:
Compile the solidity contracts:
$ npm run compile
In a new terminal, launch an Ethereum RPC client, we use the default ganache-cli command to configure and run a local development ganache:
$ npm run ganache
Switch back to your other terminal and deploy the contracts:
$ npm run deploy
Run tests with:
$ npm run test
# lint solidity contracts
$ npm run prettier:contracts
# lint tests
$ npm run lint:tests
Code style is enforced through the CI test process, builds will fail if there're any linting errors.
If you come across an issue with Alkemi Protocol contracts, do a search in the Issues tab of this repo to make sure it hasn't been reported before. Follow these steps to help us prevent duplicate issues and unnecessary notifications going to the many people watching this repo:
- If the issue you found has been reported and is still open, and the details match your issue, give a "thumbs up" to the relevant posts in the issue thread to signal that you have the same issue. No further action is required on your part.
- If the issue you found has been reported and is still open, but the issue is missing some details, you can add a comment to the issue thread describing the additional details.
- If the issue you found has been reported but has been closed, you can comment on the closed issue thread and ask to have the issue reopened because you are still experiencing the issue. Alternatively, you can open a new issue, reference the closed issue by number or link, and state that you are still experiencing the issue. Provide any additional details in your post so we can better understand the issue and how to fix it.