Skip to content

Commit

Permalink
BSX Release Update
Browse files Browse the repository at this point in the history
  • Loading branch information
cryptoguard committed Dec 8, 2022
1 parent dfc2244 commit e8611bf
Show file tree
Hide file tree
Showing 21 changed files with 1,282 additions and 51 deletions.
Binary file modified _static/media/images/basicswap_orders.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _static/media/images/basicswap_orders2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _static/media/images/basicswap_wallets.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
7 changes: 4 additions & 3 deletions basicswap-dex/basicswap_compared.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ To get a better idea of how BasicSwap :term:`DEX <DEX>` compares to other crypto

**Order Books**

An order book is an aggregated and public list of orders put by other traders. It is possible to either make an order at the desired price (meaning adding a new order to the public list of orders) or take one already listed by another trader.
An order book is an aggregated and public list of offers put by other traders. It is possible to either place an offer on the books, at the desired price, or take one already listed by another trader.

Typically, order books require a central database to host the order data. It is also often used to determine trading fees, with a different fee model being proposed for makers and takers.
Because BasicSwap is entirely decentralized, it uses SMSG to host order data and display it to other peers. It also charges no fee at all.
Typically, order books require a central database to host the data. It is also often used to determine trading fees, with a different fee model being proposed for "makers" and "takers".

Because BasicSwap is entirely decentralized, its order book is powered by the open-source SMSG network, as opposed to databases, and charges no fee at all.

.. container:: toggle

Expand Down
37 changes: 24 additions & 13 deletions basicswap-dex/basicswap_explained.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ BasicSwap was built in direct response to the increasingly invasive demands and
What is it?
^^^^^^^^^^^

.. figure:: ../_static/media/images/basicswap_orders.jpg
.. figure:: ../_static/media/images/basicswap_orders.png
:align: center
:alt: BasicSwap's order book — WIP, design subject to change
:target: ../_static/media/images/basicswap_orders.jpg
:target: ../_static/media/images/basicswap_orders.png

BasicSwap's order book — WIP/Beta, UI/UX subject to change

Expand Down Expand Up @@ -67,21 +67,32 @@ BasicSwap is still in beta. That means that, while it offers most of the basic t
Compatible Coins
^^^^^^^^^^^^^^^^

.. figure:: ../_static/media/images/basicswap_wallets.jpg
.. figure:: ../_static/media/images/basicswap_wallets.png
:align: center
:alt: BasicSwap's wallets page — WIP, design subject to change
:target: ../_static/media/images/basicswap_wallets.jpg
:target: ../_static/media/images/basicswap_wallets.png

BasicSwap's wallets page — WIP/Beta, UI/UX subject to change

BasicSwap already offers decentralized trading services for the following cryptocurrencies.

* **Bitcoin**
* **Monero**
* **Particl**
* **PIVX**
* **Litecoin**
* **Namecoin**
BasicSwap already offers decentralized trading services for the following cryptocurrencies (`check it out on BasicSwap website <https://basicswapdex.com/markets>`_).

+----------------------------------+---------------------------------------------+
| **Coin Name** | **Ticker** |
+----------------------------------+---------------------------------------------+
| Bitcoin | BTC |
+----------------------------------+---------------------------------------------+
| Monero | XMR |
+----------------------------------+---------------------------------------------+
| Dash | DASH |
+----------------------------------+---------------------------------------------+
| Litecoin | LTC |
+----------------------------------+---------------------------------------------+
| Firo | FIRO |
+----------------------------------+---------------------------------------------+
| PIVX | PIVX |
+----------------------------------+---------------------------------------------+
| Particl | PART |
+----------------------------------+---------------------------------------------+

We are looking at adding many other coins, including ETH and its ERC-20 tokens, following the release of the open beta. Any Bitcoin-based and Segwit-enabled :term:`cryptocurrency` can get integrated with minimal effort. Other token-issuing blockchains like Fantom, Solana, Avalanche, Polygon, or BSC may become available on BasicSwap at a later stage of the integration roadmap.

Expand Down Expand Up @@ -112,7 +123,7 @@ Gateways, each with pros and cons, may display things differently or provide a d

* **Slower setup** — The local client needs to be manually compiled and the initial setup process can take some time and tinkering.
* **No web access** — The DEX has to be accessed from a local client and cannot be used from the convenience of a web browser.
* **Must stay online** — Your BasicSwap :term:`node <node>` needs to remain online to broadcast your orders in the order book and execute trades.
* **Must stay online** — Your BasicSwap :term:`node <node>` needs to remain online to keep your offer(s) listed on the order book and execute trades.
* **Heavy** — You need to download and store the full blockchain nodes of the coins you’ve enabled, which can take a considerable amount of space.

.. container:: toggle
Expand Down
189 changes: 186 additions & 3 deletions basicswap-guides/basicswapguides_addremovecoins.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,188 @@
=======================
Enable or Disable Coins
=======================

.. title::
BasicSwap DEX Coin Usage Guide

.. meta::
:description lang=en: Learn how to enable or disable coins on your BasicSwap instance.
:keywords lang=en: Particl, DEX, Trading, Exchange, Buy Crypto, Sell Crypto, Installation, Quickstart, Blockchain, Privacy, E-Commerce, multi-vendor marketplace, online marketplace

By default, :term:`BasicSwap <BasicSwap>` only comes with Particl enabled, but you can easily enable other coins that you want to trade.

This guide will show you how to enable or disable coins on BasicSwap.

----

.. contents:: Table of Contents
:local:
:backlinks: none
:depth: 2

----

.. attention::

Currently, each coin you add has to be added **one by one**. Repeat the following step for each coin you want to enable.

.. attention::

Currently, adding a new coin to BasicSwap requires you to download its blockchain locally. We are working on adding more options, such as using light services and access gateways (i.e., web), which will be available at a later beta stage.

BasicSwap on Docker
===================
Add or Remove Coins
===================

Coming soon™
If you've built :term:`BasicSwap` using the Docker method, follow these steps to enable or disable coins your instance to the most up-to-date version.

.. tabs::

.. group-tab:: Enable Coins

.. rst-class:: bignums

#. Stop the docker image (this will shut down all BasicSwap processes).

.. code-block:: bash
docker-compose stop
#. Enable coins by typing the following commands accompanied by the coin you want to enable after the :guilabel:`--addcoin`.

.. code-block:: bash
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
.. note::

You can copy an existing pruned datadir (excluding :guilabel:`bitcoin.conf` and any wallets) over to :guilabel:`$COINDATA_PATH/bitcoin`. Remove any existing wallets after copying over a pruned chain, or the Bitcoin daemon won't start.

.. group-tab:: Disable Coins

.. rst-class:: bignums

.. rst-class:: bignums

#. Stop BasicSwap completely.

.. code-block:: bash
docker-compose stop
#. Remove the coin's record in the :guilabel:`basicswap.json` config file.

.. code-block:: bash
sudo nano /var/data/coinswaps/basicswap.json
In this example, here is the excerpt you would remove from :guilabel:`basicswap.json` if you wanted to remove Monero.

.. code-block:: bash
"monero": {
"connection_type": "rpc",
"manage_daemon": true,
"manage_wallet_daemon": true,
"rpcport": 29798,
"zmqport": 30898,
"walletrpcport": 29998,
"rpchost": "127.0.0.1",
"walletrpchost": "127.0.0.1",
"walletrpcuser": "xmr_wallet_user",
"walletrpcpassword": "xmr_wallet_pwd",
"walletfile": "swap_wallet",
"datadir": "/coindata/monero",
"bindir": "/coindata/bin/monero",
"restore_height": 2731435,
"blocks_confirmed": 7,
"walletsdir": "/coindata/monero"
},
#. Launch BasicSwap normally.

.. code-block:: bash
COINDATA_PATH=/var/data/coinswaps && docker-compose up
BasicSwap Without Docker
========================

If you've built :term:`BasicSwap` without using the Docker method, follow these steps to add or remove coins to your BasicSwap instance.

.. tabs::

.. group-tab:: Enable Coins

.. rst-class:: bignums

#. Stop BasicSwap completely.

.. code-block:: bash
docker-compose stop
#. Enable coins by typing the following commands accompanied by the coin you want to enable after the :guilabel:`--addcoin`.

.. code-block:: bash
export SWAP_DATADIR=/Users/$USER/coinswaps && basicswap-prepare --usebtcfastsync --datadir=/$SWAP_DATADIR --addcoin=bitcoin
#. Activate the change to your BasicSwap instance.

.. code-block::
export SWAP_DATADIR=/Users/$USER/coinswaps && . $SWAP_DATADIR/venv/bin/activate && python -V
.. note::

You can copy an existing pruned datadir (excluding :guilabel:`bitcoin.conf` and any wallets) over to :guilabel:`$COINDATA_PATH/bitcoin`. Remove any existing wallets after copying over a pruned chain, or the Bitcoin daemon won't start.

.. group-tab:: Disable Coins

.. rst-class:: bignums

#. Stop BasicSwap completely.

#. Remove the coin's record in the :guilabel:`basicswap.json` config file.

.. code-block:: bash
sudo nano /Users/$USER/coinswaps/basicswap.json
In this example, here is the excerpt you would remove from :guilabel:`basicswap.json` if you wanted to remove Monero.

.. code-block:: bash
"monero": {
"connection_type": "rpc",
"manage_daemon": true,
"manage_wallet_daemon": true,
"rpcport": 29798,
"zmqport": 30898,
"walletrpcport": 29998,
"rpchost": "127.0.0.1",
"walletrpchost": "127.0.0.1",
"walletrpcuser": "xmr_wallet_user",
"walletrpcpassword": "xmr_wallet_pwd",
"walletfile": "swap_wallet",
"datadir": "/coindata/monero",
"bindir": "/coindata/bin/monero",
"restore_height": 2731435,
"blocks_confirmed": 7,
"walletsdir": "/coindata/monero"
},
#. Once that is done, save the changes with :kbd:`CTRL` + :kbd:`X`, following by an :kbd:`ENTER`.

#. Launch BasicSwap normally.

----

.. seealso::

- BasicSwap Explained - :doc:`BasicSwap Explained <../basicswap-dex/basicswap_explained>`
- BasicSwap Guides - :doc:`Install BasicSwap <../basicswap-guides/basicswapguides_installation>`
- BasicSwap Guides - :doc:`Update BasicSwap <../basicswap-guides/basicswapguides_update>`
- BasicSwap Guides - :doc:`Route BasicSwap Through Tor <../basicswap-guides/basicswapguides_update>`
- BasicSwap Guides - :doc:`Make an Offer <../basicswap-guides/basicswapguides_make>`
- BasicSwap Guides - :doc:`Take an Offer <../basicswap-guides/basicswapguides_take>`

0 comments on commit e8611bf

Please sign in to comment.