mirror of
https://github.com/basicswap/basicswap.git
synced 2024-09-29 09:51:07 +00:00
181 lines
4.9 KiB
Markdown
181 lines
4.9 KiB
Markdown
|
|
## Source code
|
|
|
|
git clone https://github.com/tecnovert/basicswap.git
|
|
|
|
|
|
## Run Using Docker
|
|
|
|
Docker must be installed and started:
|
|
|
|
docker -v
|
|
|
|
Should return a line containing `Docker version`...
|
|
|
|
|
|
It's recommended to setup docker to work without sudo:
|
|
|
|
https://docs.docker.com/engine/install/linux-postinstall/
|
|
|
|
|
|
#### Create the images:
|
|
|
|
cd basicswap/docker
|
|
docker-compose build
|
|
|
|
|
|
#### Prepare the datadir:
|
|
|
|
Set XMR_RPC_HOST and BASE_XMR_RPC_PORT to a public XMR node or exclude to run a local node.
|
|
|
|
Set xmrrestoreheight to the current xmr chain height.
|
|
|
|
CURRENT_XMR_HEIGHT=$(curl https://localmonero.co/blocks/api/get_stats | jq .height)
|
|
|
|
Adjust `--withcoins` and `--withoutcoins` as desired, eg: `--withcoins=monero,bitcoin`. By default only Particl is loaded.
|
|
|
|
export COINDATA_PATH=/var/data/coinswaps
|
|
docker run --rm -e XMR_RPC_HOST="node.xmr.to" -e BASE_XMR_RPC_PORT=18081 -t --name swap_prepare -v $COINDATA_PATH:/coindata i_swapclient \
|
|
basicswap-prepare --datadir=/coindata --withcoins=monero --htmlhost="0.0.0.0" --xmrrestoreheight=$CURRENT_XMR_HEIGHT
|
|
|
|
**Record the mnemonic from the output of the above command.**
|
|
|
|
|
|
##### FastSync
|
|
|
|
Use `--usebtcfastsync` to optionally initialise the Bitcoin datadir with a chain snapshot from btcpayserver FastSync.
|
|
[FastSync README.md](https://github.com/btcpayserver/btcpayserver-docker/blob/master/contrib/FastSync/README.md)
|
|
|
|
|
|
#### Set the timezone (optional):
|
|
|
|
Edit the `.env` file in the docker directory, set TZ to your local timezone.
|
|
Valid options can be listed with: `timedatectl list-timezones`
|
|
|
|
|
|
#### Start the container:
|
|
|
|
export COINDATA_PATH=/var/data/coinswaps
|
|
docker-compose up
|
|
|
|
Open in browser: `http://localhost:12700`
|
|
|
|
|
|
|
|
### Add a coin
|
|
|
|
docker-compose stop
|
|
export COINDATA_PATH=/var/data/coinswaps
|
|
docker run --rm -t --name swap_prepare -v $COINDATA_PATH:/coindata i_swapclient basicswap-prepare --datadir=/coindata --addcoin=bitcoin
|
|
|
|
You can copy an existing pruned datadir (excluding bitcoin.conf and any wallets) over to `$COINDATA_PATH/bitcoin`
|
|
Remove any existing wallets after copying over a pruned chain or the Bitcoin daemon won't start.
|
|
|
|
|
|
|
|
## Windows
|
|
|
|
#### Setup WSL 2 and Docker Desktop
|
|
[docs.docker.com/docker-for-windows/wsl](https://docs.docker.com/docker-for-windows/wsl/)
|
|
|
|
|
|
Open a wsl terminal
|
|
Windows key + R -> "wsl" -> Enter
|
|
|
|
|
|
Install Git:
|
|
|
|
sudo apt update
|
|
sudo apt install git
|
|
|
|
|
|
Download the BasicSwap code:
|
|
|
|
git clone https://github.com/tecnovert/basicswap.git
|
|
cd basicswap/docker/
|
|
|
|
|
|
It's significantly faster to set COINDATA_PATH in the linux filesystem.
|
|
You can access it from the windows side at: `\\wsl$\Ubuntu`
|
|
|
|
Continue from the [Run Using Docker](#run-using-docker) section.
|
|
|
|
|
|
## Run Without Docker:
|
|
|
|
|
|
### Ubuntu Setup:
|
|
|
|
apt-get install -y wget python3-pip gnupg unzip protobuf-compiler automake libtool pkg-config curl jq
|
|
|
|
### OSX Setup:
|
|
|
|
Install Homebrew (See https://brew.sh/):
|
|
|
|
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
|
|
|
Dependencies:
|
|
|
|
brew install wget unzip python git protobuf gnupg automake libtool pkg-config curl jq
|
|
|
|
Close the terminal and open a new one to update the python symlinks.
|
|
|
|
|
|
### Basicswap:
|
|
|
|
export SWAP_DATADIR=/Users/$USER/coinswaps
|
|
mkdir -p "$SWAP_DATADIR/venv"
|
|
python3 -m venv "$SWAP_DATADIR/venv"
|
|
. $SWAP_DATADIR/venv/bin/activate && python -V
|
|
cd $SWAP_DATADIR
|
|
wget -O coincurve-anonswap.zip https://github.com/tecnovert/coincurve/archive/anonswap.zip
|
|
unzip coincurve-anonswap.zip
|
|
cd $SWAP_DATADIR/coincurve-anonswap
|
|
pip3 install .
|
|
|
|
|
|
cd $SWAP_DATADIR
|
|
git clone https://github.com/tecnovert/basicswap.git
|
|
cd $SWAP_DATADIR/basicswap
|
|
|
|
If installed on OSX, you may need to install additional root ssl certificates for the ssl module.
|
|
From https://pypi.org/project/certifi/
|
|
|
|
sudo python3 bin/install_certifi.py
|
|
|
|
|
|
Continue installing Basicswap
|
|
|
|
protoc -I=basicswap --python_out=basicswap basicswap/messages.proto
|
|
pip3 install .
|
|
|
|
|
|
Prepare the datadir:
|
|
|
|
CURRENT_XMR_HEIGHT=$(curl https://localmonero.co/blocks/api/get_stats | jq .height)
|
|
|
|
XMR_RPC_HOST="node.xmr.to" BASE_XMR_RPC_PORT=18081 basicswap-prepare --datadir=$SWAP_DATADIR --withcoins=monero --xmrrestoreheight=$CURRENT_XMR_HEIGHT
|
|
|
|
OR using a local XMR daemon:
|
|
basicswap-prepare --datadir=$SWAP_DATADIR --withcoins=monero --xmrrestoreheight=$CURRENT_XMR_HEIGHT
|
|
|
|
Record the mnemonic from the output of the above command.
|
|
|
|
Start Basicswap:
|
|
|
|
basicswap-run --datadir=$SWAP_DATADIR
|
|
|
|
Open in browser: `http://localhost:12700`
|
|
It may take a few minutes to start as the coin daemons are started before the http interface.
|
|
|
|
|
|
Add a coin:
|
|
export SWAP_DATADIR=/Users/$USER/coinswaps
|
|
basicswap-prepare --usebtcfastsync --datadir=/$SWAP_DATADIR --addcoin=bitcoin
|
|
|
|
|
|
Start after installed:
|
|
|
|
export SWAP_DATADIR=/Users/$USER/coinswaps
|
|
. $SWAP_DATADIR/venv/bin/activate && python -V
|
|
basicswap-run --datadir=$SWAP_DATADIR
|