Metadata-Version: 2.1
Name: defy
Version: 0.2.0
Summary: A command line tool to lookup balance on blockchain network
Home-page: https://github.com/punparin/defy-cli
Author: Parin Kobboon
Author-email: punparin@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: click (==7.1.2)
Requires-Dist: configparser (==5.0.2)
Requires-Dist: requests (==2.25.1)
Requires-Dist: tabulate (==0.8.9)
Requires-Dist: web3 (==5.17.0)
Requires-Dist: python-binance (==0.7.9)

[![Upload Python Package](https://github.com/punparin/defy-cli/actions/workflows/python_publish.yaml/badge.svg)](https://github.com/punparin/defy-cli/actions/workflows/python_publish.yaml) [![Python Test](https://github.com/punparin/defy-cli/actions/workflows/python_test.yaml/badge.svg)](https://github.com/punparin/defy-cli/actions/workflows/python_test.yaml) [![codecov](https://codecov.io/gh/punparin/defy-cli/branch/main/graph/badge.svg?token=0LT1TMH2VZ)](https://codecov.io/gh/punparin/defy-cli) [![CodeQL](https://github.com/punparin/defy-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/punparin/defy-cli/actions/workflows/codeql-analysis.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# DeFy CLI
> is a command line tool to lookup wallet and DeFi platforms balance on blockchain network


```sh-session
$ defy all 0x60226a096fdcc916xxxx1feb94f21096fdd9f2a1

Wallet      Price    Balance    Balance ($)
--------  -------  ---------  -------------
Warden       0.67   134.2319          89.95
ADA          1.21   260.1230         315.08
LINK        32.80    18.7821         616.00

Binance      Price    Balance    Balance ($)
---------  -------  ---------  -------------
ATOM         21.05    37.1745         782.70

Fulcrum      Deposit    Reward (BGOV)    Balance ($)
---------  ---------  ---------------  -------------
LINK         18.7800           4.2001         759.39

ValueDefi      Deposit    Reward    Balance    Balance ($)
-----------  ---------  --------  ---------  -------------
Warden-BUSD   980.7301  140.9000    1121.63        1873.24

Total Balance: $4436.36
```

Table of Contents
=================

   * [DeFy CLI](#defy-cli)
   * [Table of Contents](#table-of-contents)
      * [Prerequisite](#prerequisite)
      * [Installation](#installation)
      * [Support Platforms](#support-platforms)
      * [Support Exchanges](#support-exchanges)
      * [Support Networks](#support-networks)
      * [Commands](#commands)
         * [defy all [ADDRESS]](#defy-all-address)
         * [defy wallet [ADDRESS]](#defy-wallet-address)
         * [defy exchange](#defy-exchange)
         * [defy platform [ADDRESS]](#defy-platform-address)
         * [defy valuedefi [ADDRESS]](#defy-valuedefi-address)
         * [defy fulcrum [ADDRESS]](#defy-fulcrum-address)
      * [Known Issues](#known-issues)
         * [Timestamp for this request was 1000ms ahead of the server's time](#timestamp-for-this-request-was-1000ms-ahead-of-the-servers-time)

## Prerequisite
- (Optional) In case you would like to use Binance wallet lookup
  - [Binance API Key](https://www.binance.com/en-NG/support/faq/360002502072)
    `export binance_api_key=<BINANCE_API_KEY>`
  - [Binance API Secret](https://www.binance.com/en-NG/support/faq/360002502072)
    `export binance_api_secret=<BINANCE_API_SECRET>`

## Installation
```
$ pip install defy
```

## Support Platforms

|    Platform    | Features | Support |
|----------------|----------|---------|
| Fulcrum (BSC)  | Farm     |   ✅    |
| ValueDefi      | vSafe    |   ✅    |

## Support Exchanges

| Exchange  | Features | Support |
|-----------|----------|---------|
| Binance   | -        |   ✅    |

## Support Networks

| Network  | Support |
|-----------|---------|
| BSC Mainnet |  ✅   |

## Commands

* [`defy all [ADDRESS]`](#defy-all-address)
* [`defy wallet [ADDRESS]`](#defy-wallet-address)
* [`defy exchange`](#defy-exchange)
* [`defy platform [ADDRESS]`](#defy-platform-address)

### `defy all [ADDRESS]`
```
Usage: defy all [OPTIONS] ADDRESS

Options:
  -hsb, --hide-small-bal  `True` to hide small balance in wallet,
                          default=false

  -h, --help              Show this message and exit.
```

### `defy wallet [ADDRESS]`
```
Usage: defy wallet [OPTIONS] ADDRESS

Options:
  -hsb, --hide-small-bal  `True` to hide small balance in wallet,
                          default=false

  -h, --help              Show this message and exit.
```

### `defy exchange`
```
Usage: defy exchange [OPTIONS]

Options:
  -hsb, --hide-small-bal  `True` to hide small balance in wallet,
                          default=false

  -h, --help              Show this message and exit.
```

### `defy platform [ADDRESS]`
```
Usage: defy platform [OPTIONS] ADDRESS

Options:
  -hsb, --hide-small-bal  `True` to hide small balance in wallet,
                          default=false

  -h, --help              Show this message and exit.
```

### `defy valuedefi [ADDRESS]`
```
Usage: defy valuedefi [OPTIONS] ADDRESS

Options:
  -hsb, --hide-small-bal  `True` to hide small balance in wallet,
                          default=false

  -h, --help              Show this message and exit.
```

### `defy fulcrum [ADDRESS]`
```
Usage: defy valuedefi [OPTIONS] ADDRESS

Options:
  -hsb, --hide-small-bal  `True` to hide small balance in wallet,
                          default=false

  -h, --help              Show this message and exit.
```

## Known Issues

### Timestamp for this request was 1000ms ahead of the server's time

Run the following commands to resync machine's clock

> For Windows
```sh-session
$ net stop w32time
$ w32tm /unregister
$ w32tm /register
$ net start w32time
$ w32tm /resync
```

