-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
47 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,48 @@ | ||
# Acre | ||
# Acre Contracts | ||
|
||
Acre is a “liquid staking” solution that allows people to earn yield on their Bitcoin via yield farming on Ethereum. | ||
Acre protocol smart contracts. | ||
|
||
[![Solidity](https://github.com/thesis/acre/actions/workflows/solidity.yaml/badge.svg?branch=main&event=push)](https://github.com/thesis/acre/actions/workflows/solidity.yaml) | ||
|
||
## Development | ||
|
||
### Installation | ||
|
||
This project uses [pnpm](https://pnpm.io/) as a package manager ([installation documentation](https://pnpm.io/installation)). | ||
|
||
To install the dependencies execute: | ||
|
||
```bash | ||
pnpm install | ||
``` | ||
|
||
### Testing | ||
|
||
To run the test execute: | ||
|
||
``` | ||
$ pnpm test | ||
``` | ||
|
||
### Deploying | ||
|
||
We deploy our contracts with | ||
[hardhat-deploy](https://www.npmjs.com/package/hardhat-deploy) via | ||
|
||
``` | ||
$ pnpm run deploy [--network <network>] | ||
``` | ||
|
||
Check the `"networks"` entry of `hardhat.config.ts` for supported networks. | ||
|
||
## Contract Addresses | ||
|
||
The official mainnet and testnet contract addresses are listed below. | ||
|
||
### Mainnet | ||
|
||
TBD | ||
|
||
### Sepolia | ||
|
||
TBD |