TellerBot

---

@TellerBot is an asynchronous Telegram Bot written in Python to help you meet people that you can swap money with.

Requirements

• Python >= 3.8
• MongoDB
• Motor - asynchronous Python driver for MongoDB
• AIOgram - asynchronous Python library for Telegram Bot API
• Emoji - emoji for Python

Installation and launch

Using Docker (recommended)

1. Clone the repository:

git clone https://github.com/fincubator/tellerbot
cd tellerbot

2. Create environment file from example:

cp .env.example .env

3. Personalize settings by modifying .env with your preferable text editor.
4. Create a new Telegram bot by talking to @BotFather and get its API token.
5. Create a file containing Telegram bot's API token with filename specified in TOKEN_FILENAME from .env (example in secrets/tbtoken).
6. (Optional) If you're going to support escrow, set ESCROW_ENABLED=true in .env and create a file containing JSON mapping blockchain names to bot's WIF and API nodes with filename specified in ESCROW_FILENAME from .env (example in secrets/escrow.json).
7. Create a file containing database password with filename specified in DATABASE_PASSWORD_FILENAME from .env (example in secrets/dbpassword).
8. Install Docker Compose version no less than 1.26.0.
9. Start container:

docker-compose up --build

For subsequent launches starting container is enough.

Manual

1. Clone the repository:

git clone https://github.com/fincubator/tellerbot
cd tellerbot

2. Install Python version no less than 3.8 with pip.
3. Install requirements:

pip install -r requirements.txt
pip install -r requirements-escrow.txt  # If you're going to support escrow

4. Compile translations:

pybabel compile -d locale/ -D bot

5. Create environment file from example:

cp .env.example .env

6. Personalize settings by modifying .env with your preferable text editor. Remove INTERNAL_HOST and DATABASE_HOST if you want bot and database running on localhost.
7. Create a new Telegram bot by talking to @BotFather and get its API token.
8. Create a file containing Telegram bot's API token with filename specified in TOKEN_FILENAME from .env (example in secrets/tbtoken).
9. (Optional) If you're going to support escrow, set ESCROW_ENABLED=true in .env and create a file containing JSON mapping blockchain names to bot's WIF and API nodes with filename specified in ESCROW_FILENAME from .env (example in secrets/escrow.json).
10. Create a file containing database password with filename specified in DATABASE_PASSWORD_FILENAME from .env (example in secrets/dbpassword).
11. Install and start MongoDB server.
12. Set environment variables:

export $(sed 's/#.*//' .env | xargs)

13. Create database user:

./mongo-init.sh

14. Restart MongoDB server with access control enabled.
15. Launch TellerBot:

python .

For subsequent launches setting enviroment variables and launching TellerBot is enough.

Contributing

You can help by working on opened issues, fixing bugs, creating new features, improving documentation or translating bot messages to your language.

Before contributing, please read CONTRIBUTING.md first.

License

TellerBot is released under the GNU Affero General Public License v3.0. See COPYING for the full licensing conditions.