Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bout3fiddy/tricrypto_impermanent_loss
Get your LP positions on Curve's v2 tricrypto pool (mainnet)
https://github.com/bout3fiddy/tricrypto_impermanent_loss
blockchain brownie cryptocurrency curve-finance ethereum etherscan-api infura-api python3 smart-contracts
Last synced: 9 days ago
JSON representation
Get your LP positions on Curve's v2 tricrypto pool (mainnet)
- Host: GitHub
- URL: https://github.com/bout3fiddy/tricrypto_impermanent_loss
- Owner: bout3fiddy
- License: apache-2.0
- Created: 2021-06-29T16:37:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-18T13:35:45.000Z (over 3 years ago)
- Last Synced: 2023-03-12T01:23:08.115Z (over 1 year ago)
- Topics: blockchain, brownie, cryptocurrency, curve-finance, ethereum, etherscan-api, infura-api, python3, smart-contracts
- Language: Python
- Homepage:
- Size: 48.8 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# not actively maintained! Active development is instead being done in [a Curve-Tracker repository](https://github.com/Curve-Tracker/tricrypto-contract-transaction-parser)
# Curve TriCrypto Position Tracker
Tricrypto Position Tracker is a tool that allows a liquidity provider in [Curve's new v2 liquidity pool for US Dollar (Tether; USDT), Wrapped Bitcoin (WBTC) and Ether (ETH)](https://curve.fi/tricrypto) on the Ethereum blockchain. This tool enables monitoring one's liquidity pool positions.
### Available Functionality
1. Get current position in TriCrypto pool.
### Planned
1. Get Deposits and value of tokens when deposited.
2. Get Get Withdrawls and value of tokens when withdrawn.
### Holy Grail
*Historical LP positions*
## Installation
There are a few packages to install in order to run the scripts in this repository. The user also needs API keys from [Etherscan](https://etherscan.io/apis) and [Infura](https://infura.io/) in order to query the blockchain for transactions and infer positions.
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install the requirements in this repository. The user is encouraged to use virtual environments. The instructions here are tested on a 2021 Mac M1 Air.
Requirements: Python > 3.6.0
```bash
# clone this repo
git clone https://github.com/bout3fiddy/tricrypto_impermanent_loss.git
# create virtual environment first
python3 -m venv venv
# activate virtual environment
source ./venv/bin/activate
# update pip
python3 -m pip install --upgrade pip
# install requirements
pip install -r ./requirements.txt
```
This should give you most of the tools necessary for running the scripts. There are a few more steps needed to run [eth-brownie](https://eth-brownie.readthedocs.io/en/stable/), which is one of the frameworks used to interact with the Ethereum blockchain (mainnet).
To install eth-brownie, you need the following:
- Node.js > 6.11.5
- npm
- ganache-cli
1. Install Node.js from [here](https://nodejs.org/). To check Node Installation:
```bash
node -v
```
2. Install npm from [here](https://npmjs.com/get-npm). To check version:
```bash
npm -v
```
3. Install [ganache-cli](https://www.trufflesuite.com/ganache)
```bash
npm install -g ganache-cli
ganache-cli --version
```
## Usage
Codebase is still under progress. Instructions will be updated soon.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[Apache License 2.0](https://github.com/bout3fiddy/tricrypto_impermanent_loss/blob/main/LICENSE)