Skip to content

Commit

Permalink
Update Solidity readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nkuba committed Apr 10, 2024
1 parent f46876f commit e85b231
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 4 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Bitcoin Liquid Staking

[![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

### pnpm
Expand Down
49 changes: 47 additions & 2 deletions solidity/README.md
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

0 comments on commit e85b231

Please sign in to comment.