Status: downuntil further notice
Status: up | Required CPUs: 2 for light, 4 for full | RAM: 2GB for light, 16GB for full | Disk: 1GB for light, 200GB for full | Initial Sync Time: 15 mins for light, 24h for full
Status: down | Required CPUs: 2 for light, 4 for full | RAM: 2GB for light, 16GB for full | Disk: 1GB for light, 1TB for full | Initial Sync Time: 30 mins for light, 72h for full
armv8), which should cover most devices and services.
sudo apt install docker.io. If you are using any version besides Ubuntu 20.04, follow the official docker install instructions. Also make sure that the current user can run docker commands. Test with
docker run hello-world. If this fails, follow these instructions. This guide was written using Ubuntu 20.04 LTS.
backup-dir = "/media/USB/"in
mainnet.confand can be changed any time. Alternatively, you can consider running your environment on two hard drives in RAID 1 to protect against data loss.
statuscommand to check on the your setup's health and sync progress. The default light setup should show
Readyafter some seconds:
opendex-clicommands without the need to prepend
opendex-cli, e.g. simply type
getinfoto get basic information about your opendex node. Run
helpto get an always up-to-date list of commands. Append
-jto any command to get JSON instead of the formatted output, e.g. using
listpeersto see other opendexd nodes on the network:
getbalanceoverview. If you want to follow what is happening under the hood, you can do so by typing
logs boltz. For ETH, currently one still needs to trigger a manual channel creation in a second step after funds were deposited:
orderbook. It might take several seconds to see orders after opendexd was started due to the decentralized nature of the order exchange. Use
orderbook btc/usdtto show the order book for BTC/USDT only:
getbalanceto check your balance before the swap.
sell 0.1 btc/usdt 7171to sell 0.1 btc for a price of 7171 USDT per BTC. If your order was matched, settlement shouldn't take longer than a couple of seconds.
getbalanceto check your balance after the swap. You are now owning 0.1 BTC less and 717 USDT more.
marginas premium. When orders are filled on OpenDEX, arby takes care of executing a counter trade on the CEX to lock in profits. At the time of writing, arby supports connecting to Binance and Kraken, but more exchanges will be added over time; check arby's FAQ for an up-to-date list. We'll use Binance as example in the following. You will need funds for at least one supported asset on Binance (e.g. BTC) for arby to start issuing orders. To activate arby,
opendexd ctland run
cp ~/.opendexd-docker/mainnet/sample-mainnet.conf ~/.opendexd-docker/mainnet/mainnet.confto create a config file for your environment. Then edit the following options in
bash ~/opendexd.sh) and accept the prompt to add arby. After a minute you should see arby's automatically issued orders based on your Binance and OpenDEX balance via
listorders. Completed OpenDEX trades are listed in
tradehistory. You can follow actions taken by arby with
opendex ctlcan be printed by typing
opendex ctl. It allows to use client's cli (e.g.
lncli), check client status, logs and many more.
~/.opendex-dockerwhere blockchain & wallet data is stored in by default. Customize the wallet & chain data directory by creating a global opendex-docker config file with
cp ~/.opendex-docker/sample-opendex-docker.conf ~/.opendex-docker/opendex-docker.conf, then edit
bash opendex.sh --helpto get an overview of all available parameters. To e.g. use another directory for your mainnet environment, you can run
bash opendex.sh --mainnet-dir /path/to/temp/mainnet/dir.
cp ~/.opendex-docker/mainnet/sample-mainnet.conf ~/.opendex-docker/mainnet/mainnet.conf, then edit
opendex ctlfrom anywhere: Add the line
alias opendex="bash ~/opendex.sh"to the end of
~/.bash_aliaseson Linux and
bash_profileon Mac, then
opendex ctlany time and re-enter with
bash ~/opendex.sh; the environment will stay up.
opendex-dockerenvironment by default. You will need to run
unlockyour environment with your password.
opendex ctl. A restart can be achieved with
downfirst and then running
opendex-dockeronly uses offical opendexd releases for mainnet. Testnet is running the latest
opendexdmaster and is updated frequently.
gethshows sync status 99.99% for longer than 72h, you are probably running geth on a drive that is too slow for geth to catch up with the chain. In this case,
downthe environment and run a performance test of the disk as desribed here. If results are below the 100 MB/s mark, you can either switch to a faster SSD, use the default light setup connecting to an open geth node or use infura.
Failed to launch environment, try disconnecting the VPN.
opendex-dockerfrom your machine, run the following commands when the environment is