Skip to content

Update README.md #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
quincywooden wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,38 @@ Example code for building your own Ethereum smart contract API in [Node.js](http

## Setup

```
git clone git@github.com:compound-developers/api-guide-example.git
cd api-guide-example
npm install
```

**config.json**

The listed contract addresses and ABIs might be out of date. They can be confirmed here https://compound.finance/docs#networks.
The listed contract addresses and ABIs might be out of date. They can be confirmed [here](https://compound.finance/docs#networks).

**server.js**

1. Be sure to set an environment variable for the Ethereum wallet private
key.
1. Be sure to set an environment variable for the Ethereum wallet private key.
2. Replace the HTTP Provider URL with your own. [Infura provides free API keys](https://infura.io/).

```js
const walletPrivateKey = process.env.walletPrivateKey;
const web3 = new Web3('https://mainnet.infura.io/v3/_your_api_key_here_');
```

## Running

```
node server.js
```

## API Endpoint Example Calls

These are the possible calls that can be made with [cURL](https://curl.haxx.se/download.html).
These are the possible calls that can be made with [cURL](https://curl.se/download.html).

```bash
curl localhost:3000/wallet-balance/eth/
curl localhost:3000/wallet-balance/ceth/
curl localhost:3000/supply/eth/9000
curl localhost:3000/protocol-balance/eth/
curl localhost:3000/redeem/eth/123
```

Here is an example of outputs for a series of API calls. The wallet started out with 100 ETH.
Here is an example of outputs for a series of API calls. The wallet started with 100 ETH.

```bash
curl localhost:3000/wallet-balance/eth/
> 100

Expand Down Expand Up @@ -75,5 +65,3 @@ curl localhost:3000/wallet-balance/ceth/

curl localhost:3000/wallet-balance/eth/
> 99.995909700269046879

```