Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bonedaddy/go-compound
Golang client for compound.finace api and smart contracts
https://github.com/bonedaddy/go-compound
blockchain bot compound-finance dapp defi ethereum golang trading
Last synced: 21 days ago
JSON representation
Golang client for compound.finace api and smart contracts
- Host: GitHub
- URL: https://github.com/bonedaddy/go-compound
- Owner: bonedaddy
- License: apache-2.0
- Created: 2019-08-05T20:31:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T21:13:14.000Z (over 1 year ago)
- Last Synced: 2024-10-04T13:15:05.954Z (about 1 month ago)
- Topics: blockchain, bot, compound-finance, dapp, defi, ethereum, golang, trading
- Language: Go
- Homepage:
- Size: 31.2 MB
- Stars: 23
- Watchers: 3
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# go-compound
> **WARNING: this code deals with money both by making blockchain calls and returning information that can be used to lose/gain money. Please use cautiously and dont come complaining if you end up losing money.**
`go-compound` is a Golang client, and library for interacting with the compound.finace API, and interacting with the compound contracts, allowing for the creation of bots trading with the Compound protocol.
# Contents
* `abi` contains json abi definitions for various compound smart contracts
* `bindigns` contains `abigen` generated golang bindings for the various abi's
* `client` contains a client library to build applications that use the compound.finance API and interact with the smart contracts
* `cmd` contains a small command-line client
* `models` contains Golang types for the various responses that the API gives. Currently it has types for `CTokenService` and `AccountService` responses.
* `pb` contains protobuf definitions for the compound APIs. Do not use
* `sampler` contains [sampler](https://github.com/sqshq/sampler) configurations to enable console based monitoring of your compound accounts
# Current Capabilities
## APIs
* Complete [AccountService](https://compound.finance/developers/api#AccountService) calls
* Complete [CTokenService](https://compound.finance/developers/api#CTokenService) calls
## Client Library
* Access to APIs via Golang programs, and not having to deal with raw http calls
* Watch account health, signalling and printing on different account health states
* Retrieve supply interest earned for a particular token
* Retrieve total supply interest earned
* Retrieve borrow interest owed for a particular token
* Borrow from any compound contract
* Get borrow rate for any compound contract
* Retrieve list of liquidatable addresses
## CLI
* Pretty print full `AccountService::AccountResponse` information, suitable for piping to `jq`
* Retrieve account health
* Retrieve supply interest earned for a particular token
* Retrieve total supply interest earned
* Retrieve borrow interest owed for a particular token
* Retrieve a list of addresses that can be liquidated
## Monitoring
* Enables monitoring your account with [sampler](https://github.com/sqshq/sampler).
* Default sampler config located in `sampler/sampler.yml` however you'll need to replace the addresses as needed.
# Long Term Goals
* Enable persisting retrieve data locally in a DB for fast lookups
* Enable report generation of your holdings
* Enable the `MarketHistoryService` API
* Enable graphing of `MarketHistoryService` metrics
* Enable arbitrage between uniswap and compound
* Enable things like spotting interest rate arbitrages
* Repayment arbitrages
* ???
# Links
* [API Docs](https://compound.finance/developers/api)
* [Compound GitHub](https://github.com/compound-finance/)
* [Compound App](https://app.compound.finance/)
* [Compound Website](https://compound.finance/)
* [comproi](https://www.comproi.com/#)
* [Defi Saver Compound Manager](https://defisaver.com/compound/manage)
* [chiragkhatri.me/compound-liquidator](https://chiragkhatri.me/compound-liquidator/)
* [azizjalel.com/liquidator](https://azizjalel.com/comp/index2.php)
* [Compound Liquidation Calculator](https://azizjalel.github.io/compoundcalc/)
* [aleth.io (analytics)](https://aleth.io/)
* [zeroin (compound management)](https://beta.zerion.io)
# Support
If you like this application feel free to send me some ETH, or whatever (shit)coins you want to get rid of `0xc7459562777DDf3A1A7afefBE515E8479Bd3FDBD`.
# Misc Q&A's
* Q: on the compound token contracts, what's the different between `exchangeRateCurrent` and `exchangeRateStored`
* A: Current calls accrueInterest - stored returns the last computed value