Skip to content

Commit

Permalink
* Removed PoktScan API from bot
Browse files Browse the repository at this point in the history
 * Removed staking & error notifications (seeking for API alternatives in the future)
 * Added support for notification of bot releases
 * Added menu entry to show app information (version numbers)
 * Fixed database issue affecting balances and stats when backend blocking response
  • Loading branch information
ipazc committed Apr 14, 2022
1 parent 8dd94da commit 6ec0674
Show file tree
Hide file tree
Showing 24 changed files with 185 additions and 694 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@
# PoktBot

![graph](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.3/docs/images/poktbot_logo.png "Logo")

[![PyPI version](https://badge.fury.io/py/poktbot.svg)](https://badge.fury.io/py/poktbot)
[![Documentation Status](https://readthedocs.org/projects/poktbot/badge/?version=v0.1.2)](https://poktbot.readthedocs.io/en/v0.1.2/?badge=v0.1.2)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.2/LICENSE)
[![Documentation Status](https://readthedocs.org/projects/poktbot/badge/?version=v0.1.3)](https://poktbot.readthedocs.io/en/v0.1.3/?badge=v0.1.3)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.3/LICENSE)
[![stability-experimental](https://img.shields.io/badge/stability-experimental-orange.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#experimental)
![Docker Pulls](https://img.shields.io/docker/pulls/cryptonglab/poktbot)

PoktBot is a Telegram bot that was born with the mission of helping with the daily tracking of PocketNetwork nodes and their staking rewards.

The bot is highly configurable, allowing to track many nodes at once, to generate graph/reports of rewards and to retrieve notifications based on detected errors and status, among other functionalities.

![graph](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.2/docs/images/poktbot.gif "Graph")
![graph](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.3/docs/images/poktbot.gif "Graph")

## Docs
* [Getting started](https://poktbot.readthedocs.io/en/v0.1.2/).
* [Installation guide](https://poktbot.readthedocs.io/en/v0.1.2/installation/).
* [Configuration guide](https://poktbot.readthedocs.io/en/v0.1.2/configuration/).
* [Getting started](https://poktbot.readthedocs.io/en/v0.1.3/).
* [Installation guide](https://poktbot.readthedocs.io/en/v0.1.3/installation/).
* [Configuration guide](https://poktbot.readthedocs.io/en/v0.1.3/configuration/).


## Features
* Provides an easy way to monitoring Pocket Network validator nodes status.
* Errors monitoring and notification.
![Cert-expiration](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.2/docs/images/certificate_expiration_min.png "Certification expired")
![Cert-expiration](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.3/docs/images/certificate_expiration_min.png "Certification expired")
* Staking monitoring and notification.
![Begin-unstake](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.2/docs/images/begin_unstake_min.png "Begin unstake")
![Begin-unstake](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.3/docs/images/begin_unstake_min.png "Begin unstake")


* Provides useful stats about node rewards and performance.
* Daily rewards.
* Monthly rewards.
* Graph of rewards evolution.
![Stats-result](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.2/docs/images/stats.png "Stats result")
![Stats-result](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.3/docs/images/stats.png "Stats result")


* Multi-node and multi-user approach.
Expand All @@ -40,7 +41,7 @@ The bot is highly configurable, allowing to track many nodes at once, to generat
* Admin, same than Investor but also able to add/remove admins, investors and nodes.

* Creation of economic reports to follow node economics or tax filing.
![Balances](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.2/docs/images/balances.png "Balances")
![Balances](https://raw.githubusercontent.com/cryptonglab/poktbot/v0.1.3/docs/images/balances.png "Balances")

* Fully configurable behaviour. Every aspect of the bot is configurable with a configuration file,
and some options through the bot interface itself.
Expand Down
25 changes: 11 additions & 14 deletions docs/configuration.md

Large diffs are not rendered by default.

Binary file added docs/images/poktbot_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ plugins:
- macros
repo_url: https://github.com/cryptonglab/poktbot
extra:
version: 0.1.2
version: 0.1.3
project_name: PoktBot
project_name_lowercase: poktbot
3 changes: 1 addition & 2 deletions poktbot/api/node/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
from poktbot.api.node.node_errors import PocketNodeErrors
from poktbot.api.node.node_transactions import PocketNodeTransactions


__all__ = ["PocketNodeTransactions", "PocketNodeErrors"]
__all__ = ["PocketNodeTransactions"]

189 changes: 0 additions & 189 deletions poktbot/api/node/node_errors.py

This file was deleted.

Loading

0 comments on commit 6ec0674

Please sign in to comment.