This repository has been archived by the owner on Aug 3, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
59 changed files
with
17,293 additions
and
0 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: b7f9ec2e33cec3d80bb79e730212c317 | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
API docs | ||
======== | ||
|
||
This will list all API commands available in BarterDEX |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
Frequently Asked Questions | ||
========================== | ||
|
||
|
||
What is an atomic swap? | ||
----------------------- | ||
|
||
An Atomic Swap is an on-chain, direct exchange of 2 different coins. For example KMD <-> LTC or BTC <-> SYS. It is atomic, because in a decentralized exchange, both parties must be assured that the other party is not able to skip out on his part, resulting in a loss of funds for 1 party. | ||
|
||
Atomic means that a swap either totally succeeds or not at all. | ||
|
||
Certain safeguards are needed to make sure the stealing of funds is not possible by either party. | ||
|
||
What are Zcredits? | ||
------------------ | ||
|
||
zcredits are credits for being able to do zero confirmation swaps | ||
you get zcredits by depositing KMD and locking it for an x amount of weeks | ||
so if you deposit 10 KMD you get 10 zcredits, if i'm not mistaken | ||
|
||
What are UTXOs? | ||
--------------- | ||
|
||
UTXO stands for `Unspent Transaction Output`_. BarterDEX trades UTXOs, not balances. This makes trading different from trading on a centralized exchange. Because of the atomic swap protocol, UTXOs must have certain sizes to be eligible for a trade. | ||
|
||
Basically this means that you need to make at least 3 transactions to your smartaddress to be able to trade. These transactions should have sizes X, X * 1.2 and X * 0.1. | ||
|
||
Why are multiple UTXOs needed? | ||
------------------------------ | ||
|
||
BarterDEX is an UTXO based exchange. This means that 1 UTXO is exchanged for 1 other UTXO. For example: 1 KMD UTXO with a value of 32 KMD is traded for 1 BCH UTXO with a value of 0.5 BCH. | ||
|
||
Why can't I claim my expired 0-conf deposit? | ||
-------------------------------------------- | ||
|
||
This is due to avoid bad actors stealing the deposit, and depends on the time you made a deposit. Funds are available 3 - 10 days after the expiration of the number of weeks you defined when making the deposit. | ||
|
||
.. code-block:: c | ||
timestamp = (uint32_t) time(NULL); | ||
timestamp /= LP_WEEKMULT; | ||
timestamp += weeks + 2; | ||
timestamp *= LP_WEEKMULT; | ||
.. _Unspent Transaction Output: http://learnmeabitcoin.com/glossary/utxo | ||
|
||
Currently supported coins | ||
------------------------- | ||
|
||
===== ============ | ||
Coin Name | ||
===== ============ | ||
BTC Bitcoin | ||
LTC Litecoin | ||
KMD Komodo | ||
BTG Bitcoin Gold | ||
BCH Bitcoin Cash | ||
ZEC Zcash | ||
VTC VertCoin | ||
DOGE DogeCoin | ||
HUSH Hush | ||
DGB DigiByte | ||
XMCC Monoeci | ||
BTCH Bitcoin Hush | ||
CRC CrowdCoin | ||
VOT VoteCoin | ||
INN Innova | ||
MOON MoonCoin | ||
CRW Crown | ||
EFL eGulden | ||
GBX GoByte | ||
BCO BridgeCoin | ||
BLK BlackCoin | ||
ABY Applebyte | ||
STAK Straks | ||
XZC Zcoin | ||
QTUM QTUM | ||
PURA PURA | ||
DSR Desire | ||
MNZ Monaize | ||
BTCZ Bitcoin Z | ||
MAGA MagaCoin | ||
BSD Bitsend | ||
IOP IoP | ||
BLOCK BlockNET DX | ||
CHIPS CHIPS | ||
888 OctoCoin | ||
ARG Argentum | ||
GLT Global Token | ||
ZER Zero | ||
HODLC HOdlcoin | ||
UIS Unitus | ||
===== ============ | ||
|
||
All the `Komodo Platform assetchains`_ | ||
|
||
What are the differences between BarterDEX and BlockNET DX? | ||
----------------------------------------------------------- | ||
|
||
What are the differences between BarterDEX and Altcoin.io? | ||
---------------------------------------------------------- | ||
|
||
.. _Komodo Platform assetchains: https://www.komodoplatform.com/en/blog/komodo-smart-contracts-assetchains-and-geckochains | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
Getting Started with BarterDEX | ||
============================== | ||
|
||
What you need to know before using BarterDEX | ||
-------------------------------------------- | ||
|
||
differences between BarterDEX and a centralized exchange | ||
coin confirmation times | ||
|
||
UTXO trading: 2+ deposits minimum in order to trade. | ||
account for network fees | ||
Total balance is sum of utxos. | ||
change gets back into smartaddress, creating a new UTXO. | ||
|
||
alice and bob, which payments need to happen in order to atomically swap | ||
|
||
buying an order (mini auction story) | ||
request takes at least 60 seconds | ||
|
||
|
||
How does the decentralized orderbook work, p2p etc. not always uptodate | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
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 | ||
---------------------------------- | ||
|
||
How to use Barterdex using CLI | ||
------------------------------ | ||
|
||
- escape characters in passphrase | ||
|
||
How to become a Liquidity Provider | ||
---------------------------------- | ||
|
||
How to claim a 0-conf deposit manually | ||
-------------------------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
.. BarterDEX documentation master file, created by | ||
sphinx-quickstart on Tue Jan 16 16:12:09 2018. | ||
Welcome to BarterDEX's documentation! | ||
===================================== | ||
|
||
BarterDEX is a decentralized cryptocurrency exchange using atomic swaps to trade coin A directly with coin B, without needing to trust a third party. | ||
|
||
Todo | ||
|
||
- Tier Nolan protocol | ||
- Decentralized orderbooks | ||
- Decentralized ordermatching | ||
|
||
* :ref:`user-docs` | ||
* :ref:`developer` | ||
|
||
.. _user-docs: | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: User documentation | ||
|
||
faq | ||
getting_started | ||
guides | ||
|
||
.. _developer: | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Developer | ||
|
||
api | ||
whitepaper |
Oops, something went wrong.