Skip to content
This repository has been archived by the owner on Aug 3, 2022. It is now read-only.

Commit

Permalink
todo and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
jorian committed Mar 1, 2018
1 parent ebd05aa commit 60ab98c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 42 deletions.
10 changes: 5 additions & 5 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ WORK IN PROGRESS! This will list all API commands available in BarterDEX. WORK I
Introduction
------------

BarterDEX uses a custom-made peer-to-peer network and has Remote Procedure Calls (RPC) to talk with and get information from the BarterDEX network. If you installed BarterDEX by following the <INSERT LINK TO THAT GUIDE HERE> CLI manual installation guide, you'll have a lot of these commands ready to use in the ``~/SuperNET/iguana/dexscripts`` folder. These API docs will explain what each command does and what the possible arguments for each method are.
BarterDEX uses a custom-made peer-to-peer network and has Remote Procedure Calls (RPC) to talk with and get information from the BarterDEX network. If you installed BarterDEX by following the :ref:`cli-manual-installation-guide` guide, you'll have a lot of these commands ready to use in the ``~/SuperNET/iguana/dexscripts`` folder. These API docs will explain what each command does and what the possible arguments for each method are.

``marketmaker`` is the process that is started on a machine.
``marketmaker`` is the system process that is started on a machine.

You need to set a strong passphrase (prior to starting marketmaker) and userpass to be able to talk to BarterDEX using RPC. The passphrase is what determines the addresses and the userpass value, and will be needed in the startup arguments when starting the marketmaker process on your machine (see below).

Expand Down Expand Up @@ -82,7 +82,7 @@ A node that doesn't relay (client node) has the following marketmaker startup ar

Optional:

- ``wif`` when set to 1, the ``setpassphrase`` API call will show WIF addresses for all smartaddresses.
- ``wif`` when set to 1, the ``setpassphrase`` API call will show WIF keys for all smartaddresses.

After ``marketmaker`` started successfully, the first RPC to be issued will always return a ``getcoin`` <REF TO GETCOIN> call for all coins, using 'default' as the default passphrase. This will also return the default userpass, which will need to be used to set the passphrase of the user, using the ``passphrase`` api call:

Expand Down Expand Up @@ -209,7 +209,7 @@ sendrawtransaction
Docker
------

lukechilds has provided a `docker image`_ for BarterDEX.
lukechilds has provided a `docker image for BarterDEX`_.

.. _docker image: https://github.com/lukechilds/docker-barterdex-api
.. _docker image for BarterDEX: https://github.com/lukechilds/docker-barterdex-api

18 changes: 0 additions & 18 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ Note that apart from supporting the above requirements, no additional custom cod

.. _BIP65 (Check LockTime Verify): https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki

How does the BarterDEX trading mechanism work?
----------------------------------------------


Electrum or Native?
-------------------
Expand Down Expand Up @@ -96,10 +93,6 @@ Is it free to cancel an order?

Yes. Placing orders and sending a request doesn't cost you anything. Only when your request has found a willing trade partner and a connection has been established, the dexfee and transaction fees will be paid.

How do I cancel an order?
-------------------------

This touches on the specifics of BarterDEX being a glorified auction instead of an exchange. <MORE INFO NEEDED>

How do I get the private key of my smartaddress?
------------------------------------------------
Expand Down Expand Up @@ -193,17 +186,6 @@ These fees do not take standard transaction fees into account, which for BarterD

At the time of this writing, BlockDX has yet to release (a beta of) their DEX and its source code. Until then, no proper comparison can be made between BlockDX and BarterDEX. It is clear though, that BlockDX is going to be the closest 'competitor' to BarterDEX.

What are the differences between BarterDEX and Altcoin.io?
----------------------------------------------------------

What are the differences between BarterDEX and Waves DEX?
---------------------------------------------------------

Can I privately swap coins with another person?
-----------------------------------------------

What is a Liquidity Provider (LP) node?
---------------------------------------

Do I need to leave BarterDEX running all the time?
--------------------------------------------------
Expand Down
20 changes: 1 addition & 19 deletions docs/source/guides.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,7 @@
Guides
======

How to use your native wallet with BarterDEX
--------------------------------------------

- make sure to have valid .conf file set, with at least a rpcuser and (strong!) rpcpassword
- when a transaction was sent to the smartaddress after using it for the first time, the wallet needs to be rescanned.

<coin>d -rescan in CLI
start <coin>-qt from CLI and add -rescan


How to build BarterDEX from source
----------------------------------
.. _cli-manual-installation-guide:

How to use BarterDEX using CLI
------------------------------
Expand Down Expand Up @@ -136,16 +125,9 @@ Insomnia is a great tool to replace the terminal window, but still be able to is
Download Insomnia here: https://insomnia.rest



How to become a Liquidity Provider
----------------------------------

How to create a new BarterDEX trading network
---------------------------------------------

Since BarterDEX is a peer-to-peer network, seeded by some ip-addresses to create the network, others can create a BarterDEX network of their own. This enables people to trade within a private group of traders, or to trade directly from person to person.

See :ref:`new-or-private-network` in the API docs on how to do this.

How to claim a 0-conf deposit manually
--------------------------------------

0 comments on commit 60ab98c

Please sign in to comment.