Skip to content

kevin046/pythonBot

Repository files navigation

burntbot

Manage swaps, auto-returns and more with burntbot, a Python bot that interacts with the Shakepay API.

Features

  • Auto-return swaps of any amount to the sender
  • Initiate swaps quickly with fewer button presses
  • Check balances and see who owes you
  • Auto-shake using the bot to get shaking sats

Installation

Please refer to INSTALLING.md for instructions on how to install the bot.

Quick Start

This is ment for a quick refresher for those that already have the bot installed. It is highly recommended you view the INSTALLING.md document before you continue.

Running python start.py will start the bot. Startup flags can be found below:

python start.py [-v | --verbose] [-l | --listen] [-r=host:port]
	-v, --verbose	turns on verbose mode, which prints more information
	-l, --listen	turns on listen mode, which turns off the bot's auto-return feature
	-r=host:port	change the host address and port which the web UI binds to

This project also has a web UI. This can be found on port 5000. The web UI binds itself to 0.0.0.0 by default, this means that you can connect to it from any device on the same network if you go to the local machine's IP address in a web browser.

Contributing

Missing a feature you want? Something broken? Create an issue or pull request and help grow this project.

Donating

Feeling generous and want to donate some monetary value? Feel free to send it to me via Shakepay, my shaketag is @burnttoaster. Make sure you include a note that says no return, otherwise my own bot might return it!

License

This entire project is licensed under AGPL-3.0-or-later.

Acknowledgements

This project contains code or assets that are not mine, but reproduced or copied with permission:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors