# Alkemi Earn Contracts

[![MythXBadge](https://badgen.net/https/api.mythx.io/v1/projects/bdc732b7-27d2-4a17-be68-0a1f842ed64b/badge/data?cache=300\&icon=https://raw.githubusercontent.com/ConsenSys/mythx-github-badge/main/logo_white.svg)](https://docs.mythx.io/dashboard/github-badges)

> Implementation of Alkemi Earn Contracts in Solidity. [earn.alkemi.network](https://earn.alkemi.network/)

## Table of Contents

* [Get Started](#get-started)
  * [Local development](#local-development)
* [Testing](#testing)
  * [Code Linting](#code-linting)
* [Networks](#networks)
  * [Mainnets](#mainnet-deployments)
    * [Ethereum Mainnet](#ethereum-mainnet)
* [Documentation](#documentation)
* [Issues](#issues)

## Get Started

For local development of `alkemi-earn-contracts` you can setup the development environment on your machine.

### Local development

For local development it is recommended to use [ganache](http://truffleframework.com/ganache/) to run a local development chain. Using the ganache simulator no full Ethereum node is required.

As a pre-requisite, you need:

* Node.js
* npm

Clone the project and install all dependencies:

```
git clone git@github.com:AlkemiNetwork/alkemi-earn-contracts.git
cd alkemi-earn-contracts/

# install project dependencies
$ npm i
```

Compile the solidity contracts:

```
$ npm run compile
```

![](https://raw.githubusercontent.com/AlkemiNetwork/alkemi-reserve-contracts/master/docs/assets/alk-compile.gif)

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
```

## Testing

Run tests with:

```
$ npm run test
```

### Code Linting

Linting is setup for `JavaScript` with [ESLint](https://eslint.org) & Solidity with [Solhint](https://protofire.github.io/solhint/) and [Prettier](https://prettier.io/).

```
# 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.

## Networks

#### Ethereum Mainnet

| Contract Name                       | Contract Address                           |
| ----------------------------------- | ------------------------------------------ |
| AlkemiEarnVerified                  | 0x397c315d64D74d82A731d656f9C4D586D200F90A |
| Alkemi Earn Verified Implementation | 0x847e3e4d335f118c8aed9a09c15261581e1a01ad |

### Testnet Deployments

#### Kovan Testnet

| Contract Name        | Contract Address                           |
| -------------------- | ------------------------------------------ |
| Alkemi Earn Verified | 0x87F8D2fDeFD6Ebd0D4d03719C1DE10f4aDE2C7f5 |

#### Rinkeby Testnet

| Contract Name                       | Contract Address                           |
| ----------------------------------- | ------------------------------------------ |
| Alkemi Earn Verified Proxy          | 0xccFcc25E498c40c67baD046F55bDB01F0eeDA870 |
| Alkemi Earn Verified Implementation | 0x0F96218c31dE1d2fDA48451c9873056eD690fcbe |
| AlkemiEarnPublic Upgrade Proxy      | 0x2A871001f53C48A1d0e6d19684cb06ae1aA40120 |
| AlkemiEarnPublic Implementation     | 0xd33fAD40F32E16eCC4aBC9cdcfDB586F5772d315 |

#### Ropsten Testnet

| Contract Name        | Contract Address                           |
| -------------------- | ------------------------------------------ |
| Alkemi Earn Verified | 0x877fc552EE05123A9532Da4511aaA5c6F212ECc0 |

## Documentation

* [Contracts Documentation](https://docs.alkemi.network/earn-contracts)

## Issues

If you come across an issue with Alkemi Protocol contracts, do a search in the [Issues](https://github.com/AlkemiNetwork/alkemi-earn-contracts/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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.alkemi.network/earn-contracts/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.