Update BasicSwap

BasicSwap DEX is an open-source work in progress, and, as such, constant and regular updates are to be expected.

To benefit from new features, improvements, and bug fixes, it is recommended that you update your BasicSwap instance frequently.

This guide will show you how to update BasicSwap properly.

Update a Docker Image

If you’ve built BasicSwap using the Docker method, follow these steps to update your instance to the most up-to-date version.

Update BasicSwap to the most up-to-date version.

Navigate to your BasicSwap’s docker folder (where BasicSwap is installed).
cd basicswap/docker
Make sure BasicSwap is stopped.
docker-compose stop
Make sure you’re on the correct repository (has recently been changed).
git remote set-url origin https://github.com/basicswap/basicswap
Pull the latest BasicSwap updates from Github.
git pull
If you haven’t set your COINDATA_PATH variable permanently in your .env file, you’ll need to export the variable first.
export COINDATA_PATH=/var/data/coinswaps
Apply the updates you’ve pulled from Github to your docker image.
docker-compose build --no-cache
Launch BasicSwap
docker-compose up

Attention

If updating from versions below 0.21, you may need to add wallet=wallet.dat to the core config.

Update the core version of one or more coins you’ve enabled on BasicSwap. You need to first update BasicSwap before you can update coin cores.

Make sure your BasicSwap instance if up-to-date with the latest updates.
Navigate to your BasicSwap docker folder (where your BasicSwap docker image is located).
cd basicswap/docker
Make sure BasicSwap is stopped.
docker-compose stop
If you haven’t set your COINDATA_PATH variable permanently in your .env file, you’ll need to export the variable first.
export COINDATA_PATH=/var/data/coinswaps
Apply coin core updates to your docker image. Make sure to write what coin core(s) you want to update using the –withcoins argument.
docker-compose run --rm swapclient \
   basicswap-prepare --datadir=/coindata --preparebinonly --withcoins=monero,bitcoin

Attention

If updating from versions below 0.21, you may need to add wallet=wallet.dat to the core config.

Update Without Docker

If you’ve built BasicSwap without using the Docker method, follow these steps to update your instance to the most up-to-date version.

Tip

For Linux users, updating BasicSwap and the coin cores you’ve enabled is simplified through community-developed scripts available here on Github.

Update BasicSwap to the most up-to-date version.

Properly shutdown BasicSwap.
Prepare your BasicSwap to receive updates by executing these two commands one by one.
export SWAP_DATADIR=$HOME/coinswaps
. $SWAP_DATADIR/venv/bin/activate && python -V
Navigate to your BasicSwap folder and clear build cache.
cd $SWAP_DATADIR/basicswap
rm -rf $SWAP_DATADIR/basicswap/build
Make sure you’re on the correct repository (has recently been changed).
git remote set-url origin https://github.com/basicswap/basicswap
Pull the latest BasicSwap updates from Github.
git pull
Apply the updates to your BasicSwap instance
pip3 install .

Attention

If updating from versions below 0.21, you may need to add wallet=wallet.dat to the core config.

Update the core version of the coins you’ve enabled on BasicSwap. Note that you need to first update BasicSwap before you can update individual coin cores.

Properly shutdown BasicSwap.

Make sure your BasicSwap instance is up-to-date with the latest updates.
Apply coin core updates to your BasicSwap instance. Make sure to input what coin core(s) you want to update using the –withcoins argument.
basicswap-prepare --datadir=$SWAP_DATADIR -preparebinonly --withcoins=monero,bitcoin

Attention

If updating from versions below 0.21, you may need to add wallet=wallet.dat to the core config.