https://github.com/byteball/btc-exchange
Exchange between Bytes and BTC in chatbot interface
https://github.com/byteball/btc-exchange
Last synced: 8 months ago
JSON representation
Exchange between Bytes and BTC in chatbot interface
- Host: GitHub
- URL: https://github.com/byteball/btc-exchange
- Owner: byteball
- License: mit
- Created: 2017-01-10T23:03:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-01-06T22:34:45.000Z (over 4 years ago)
- Last Synced: 2025-10-02T02:46:44.382Z (8 months ago)
- Language: JavaScript
- Size: 77.1 KB
- Stars: 8
- Watchers: 4
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BTC exchange
The exchange allows your customers to exchange bitcoins to bytes and bytes to bitcoins. No registration required, the customer just chats with a chatbot in his [Obyte wallet](../../../obyte-gui-wallet).
## Install
Install [bitcore](https://bitcore.io/guides/full-node/) and create new bitcore node:
```
bitcore create -d ~/.bitcore/data obyte-btc-exchange
```
(add `--testnet` to work on testnet). Here `~/.bitcore/data` is the location of your data directory where full Bitcoin bockchain will be stored, `obyte-btc-exchange` is the name of your node. `cd` to your node folder:
```
cd obyte-btc-exchange
```
Install `btc-exchange` service:
```
npm install btc-exchange
```
Edit your `bitcore-node.json` to add `btc-exchange` service and remove `web` service. The file should look like this:
```
{
"network": "livenet",
"port": 3001,
"services": [
"bitcoind",
"btc-exchange"
],
"servicesConfig": {
"bitcoind": {
"spawn": {
"datadir": "/home/YourUserName/.bitcore/data",
"exec": "/usr/lib/node_modules/bitcore/node_modules/bitcore-node/bin/bitcoind"
}
}
}
}
```
Start your node (which automatically starts the `btc-exchange` service):
```
bitcored
```
After you start it for the first time, it will exit immediately complaining about missing SQLite tables. Open your sqlite database:
```
sqlite3 ~/.config/bitcore/byteball.sqlite
```
and execute all SQL from [btc-exchange.sql](btc-exchange.sql), then start the node again. It will ask you about the name of the exchange (it will be displayed in chat windows of your clients) and your passphrase. Choose a good passphrase as it will protect your and your customers' bytes that will be stored online. The second time, your node will also exit complaining about missing admin_email conf setting. This is the email where you will receive important notifications from your node. Edit your `~/.config/bitcore/conf.json`, it should look like this:
```
{
"deviceName": "Byte-BTC Exchange",
"admin_email": "admin@yourdomain.com",
"from_email": "btc-exchange-alerts@yourdomain.com",
"hub": "obyte.org/bb",
"bWantNewPeers": false,
"socksHost": "127.0.0.1",
"socksPort": 9050,
"socksLocalDNS": false,
"control_addresses": ["DEVICE ADDRESS OF YOUR GUI WALLET"],
"payout_address": "YOUR OBYTE ADDRESS WHERE IT IS ALLOWED TO WITHDRAW PROFITS TO",
"permanent_paring_secret": "0000"
}
```
The socks* settings are recommended to run your node through TOR. Since you have to store large amounts of customers' bytes and bitcoins online, you don't want potential attackers to know your IP address, and TOR is a good way to hide it (see below). See the documentation of [headless wallet](../../../headless-obyte) and [core library](../../../ocore) to learn about other settings in `conf.json`.
After editing your `conf.json`, start the node again. It will take some time to sync with both Obyte and Bitcoin networks.
Every time your node starts, it prints its pairing code:
```
====== my device pubkey: A9bg4s0ZI36PcTp4p8sNywZ+DGeFm9dP75TcACI22Byz
my pairing code: A9bg4s0ZI36PcTp4p8sNywZ+DGeFm9dP75TcACI22Byz@obyte.org/bb#0000
```
Put this code on your site so that your customers are able to start an exchange by clicking a link:
```
start a chat with the exchange chatbot
```
If you open this link in your control device (specified in `control_addresses`), you have access to admin functions, see the documentation for [headless wallet](../../../headless-obyte). Type `balance` to see the current balances of the exchange:
## Security
Since you are keeping large amounts of customers' funds online, your exchange is a lucrative target for attackers. But unlike web-based exchanges, your exchange is running in chat interface, which makes it unnecessary to accept incoming connections and have publicly known IP addresses. This means that in addition to standard security measures, you can also completely hide the IP address of your server from potential attackers so that it won't be easy for them to learn what server to attack in the first place.
Although your node doesn't have to accept incoming connections, it still has to establish outgoing connections, at least with the hub, which can leak your IP address. To avoid that, run your node through TOR by setting `socksHost`, `socksPort`, and `socksLocalDNS` in your `conf.json`. Also, configure your bitcoin node to run through TOR by adding
```
proxy=127.0.0.1:9050
```
in your `bitcoin.conf`.
## API
This chatbot has an API allowing allowing users to set orders from an external headless-wallet in order to automatize their trading.
The GUI wallet is used to set initial orders and transfer byte and/or BTC, then the command `alias device_address` specifies the address of the device that can control the account.
Alias address at any time with `remove alias`.
Check (https://github.com/Papabyte/btc-exchange-dealer/blob/master/modules/exchange_bot_api.js) for an example of how to use this API.