⚡️🔗 BitcoinVoucherBot

Welcome to the BitcoinVoucherBot repository! We're excited to share our user-friendly, privacy-focused tool that simplifies the process of swapping your Bitcoin. Built on the innovative Nostr protocol, our bot offers an exceptional experience while keeping your transactions secure.

🌟 Key Features

• Intuitive commands for a seamless user experience.
• Push Sats to your Lightning Address or swap Bitcoin to your on-chain address.
• Detailed step-by-step guidance throughout the swapping process.
• Strong focus on privacy with encrypted and decentralized architecture.
• Compatible with a variety of Nostr clients.

📚 Prerequisities

In order to run this container you'll need docker installed.

• Windows
• OSX
• Linux

👨‍💻 Usage

1. Activate a connection to the change provider

You can run the system on your VPS. In order to connect to the exchange provider, please contact the team at:

[email protected] - npub15hmupf99kr4dua7zc458utg2kvnqkhx8wm3ljy8sz6v4f8jxfdtqqxht55

You need:

• connection IP of your machine, to be allowed to connect to API
• a key of yours in UUID4 format, that will be used by the provider to send webhooks

After activation, you will be provided by:

• API key (needed to make calls to the system)
• API docs

2. Chekout the code from GitHub

git clone https://github.com/BitcoinVoucherBot/bitnostr.git
cd bitnostr

3. Rename settings.tpl.json into settings.json:

mv settings.tpl.json settings.json

4. Fill missing required fields:

   • nostr_private_key: Your Nostr bot private key
   • nostr_public_key: Your Nostr bot public key
   • bvb_api_key: Your BitcoinVoucherBot API key
   • bot_api_key: Your Bot API key

5. Run the docker compose

docker compose up -d --build

🔍 Implemented NIPs (Nostr Implementation Possibilities)

• NIP-01: Basic protocol flow description
• NIP-04: Encrypted Direct Message
• NIP-05: Mapping Nostr keys to DNS-based internet identifiers

✅ Tested clients

• Snort
• Iris
• Coracle
• Damus (iOS)
• Amethyst (Android)

📖 USER GUIDE

For a complete user's guide on how to use the BitcoinVoucherBot, please check out our step-by-step guide.

💼 License

This project is licensed under the MIT License - see the LICENSE file for details

⚠️ Disclaimer

This Bot running on Nostr protocol which is in an early stage of development.

• It might have some bugs.
• Still beta.

We welcome your feedback and suggestions! If you have any questions or need assistance, please feel free to create an issue, add PRs, or provide any feedback!

🤙 Contact on Nostr

albi ⚡️ - npub1zy79gha2cfztu0use9qyu6cfp0h3kjr9sxdu6svurkdm68w2xzfqh7h3k3
massmux - npub1sej07d37lnfk592wlh9uv2dy68jv2y0ez98p6dw7w0llx89hswesvs5fqm