Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: wiki restructuring #3026

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/wiki/Contribution-Guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contribution Guide
<a id="top"/>

We welcome your contributions to dcrdex.

Expand Down Expand Up @@ -49,3 +49,8 @@ should first
**dcrdex** is a great place to get started, but you would be expected to take on
only smaller jobs until you are comfortable navigating the code and have shown
the ability to communicate and follow through.


---

[⤴ Back to Top](#top)
133 changes: 133 additions & 0 deletions docs/wiki/Creating-a-DCRDEX-Server-Account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
<a id="top"></a>

_Last updated for Bison Wallet v1.0.0._

**Contents**

- [Create Account](#create-account)
- [Fidelity Bonds](#fidelity-bonds)
- [Pre-paid Bonds](#pre-paid-bonds)
- [Bond Submission](#bond-submission)

This guide assumes you have already [downloaded and installed](Download-and-Install) Bison Wallet,
and ran the [Quick Configuration](Quick-Configuration).

# Create Account

Clicking the `Trade` button in the header will navigate to the [Trade](./Using-BIson-Wallet.md#trade) view.
The available markets on the connected DCRDEX servers are listed on the left side of the screen.


<img src="./images/setup-guide/trade-1.png" width="1200" alt="">


An account can be created with the respective server by clicking the `Create Account` button
on the top right of the screen.



<img src="./images/setup-guide/trade-2.png" width="1200" alt="">



This will open the `Select Bond Asset` prompt.



<img src="./images/setup-guide/bond-1.png" width="1200" alt="">


# Fidelity Bonds

A fidelity bond are funds that are temporarily locked in an on-chain contract,
which is only redeemable by the user who posted the bond after a certain time.
Fidelity Bonds act as an incentive good behaviour on the DCRDEX servers and are required for
creating an account on every server.

### Pre-paid Bonds

Pre-paid bonds are codes generated by the DCRDEX server operator to enable temporary
trading access for individual users, once the pre-paid bond has expired, the user
will have to post a bond to maintain their trading tier.



> [!NOTE]
> Pre-paid bonds are available upon request in our [Matrix](https://matrix.to/#/#dex:decred.org) and
[Discord](https://discord.com/channels/349993843728449537/454306570180886530) channels.


# Bond Submission

Once the bond asset is selected, a prompt to select the
[Trading Tier](./Using-BIson-Wallet.md#changing-trading-tier) will appear.
Increasing your tier enables trading of larger quantities at a time. A higher tier also
increase your capacity for violations before trading privileges are completely suspended.

Trading limits are also increased as you establish
[reputation](./Using-BIson-Wallet.md#reputation-score) by engaging
in normal trading activity and successfully completing matches.



<img src="./images/setup-guide/bond-2.png" width="1200" alt="">


Clicking the `Submit` button display a new prompt indicating the requirements for submitting
a bond with the selected asset. The synchronization status and available funds, along with
a deposit address for the selected bond asset.

This is your own wallet, and you can send as much as you like to it since only the amount
required for the bond will be spent in the next step. The remaining amount, minus a small
reserve for future bond transactions, will be in your available balance.

For example, you can send yourself 5 DCR and only the required amount
(0.10 DCR in the case pictured above) will be spent to create the bond in the next step,
with an equivalent amount plus fees in reserves. The remainder goes to your available balance,
which can then be traded, sent, or simply held in the wallet.



<img src="./images/setup-guide/bond-3.png" width="1200" alt="">


Once the wallet has synchronized and sufficient funds are available, a prompt will appear
to confirm the selected bond options.



<img src="./images/setup-guide/bond-4.png" width="1200" alt="">


Clicking the `Submit` button will temporarily lock the specified funds in a fidelity bond
contract, these funds are only redeemable by you in the future.

The trade view will be displayed once the form has been submitted. The status of the submitted
bond transaction will be indicated on the top right. The number of required confirmations will vary
depending on the selected bond asset.



<img src="./images/setup-guide/bond-5.png" width="1200" alt="">


Once the bond transaction has been confirmed, the order submission section will be visible in the
top right of the markets tab.



<img src="./images/setup-guide/bond-6.png" width="1200" alt="">



It is recommended to export your DCRDEX account information whenever they are created since your bonds
are not automatically restored from just the application seed, refer to the
[Export DCRDEX Account](Managing-your-DCRDEX-Accounts#export-dcrdex-account) section of this wiki for
more information.


---

Next Section: [Using Bison Wallet](Using-BIson-Wallet)

[⤴ Back to Top](#top)
198 changes: 0 additions & 198 deletions docs/wiki/DEX-Trading-Account-Management.md

This file was deleted.

29 changes: 29 additions & 0 deletions docs/wiki/Development-and-Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<a id="top"/>

**Looking to contribute? We need your help** to make DEX &#35;1.

Nearly all development is done in Go and JavaScript. Work is coordinated
through [the repo issues](https://github.com/decred/dcrdex/issues),
so that's the best place to start.
Before beginning work, chat with us in the
[DEX Development room](https://matrix.to/#/!EzTSRQITaqHuFBDFhM:decred.org?via=decred.org&via=matrix.org&via=zettaport.com).
The pace of development is pretty fast right now, so you'll be expected to keep
your pull requests moving through the review process.

Check out these wiki pages for more information.

- [Contribution Guide](Contribution-Guide)
- [DCRDEX Specification](https://github.com/decred/dcrdex/blob/master/spec/README.mediawiki)
- [Client control API](Client-control-API)
- [Integrating New Assets](Integrating-New-Assets)
- [Simnet Testing](Simnet-Testing) - Recommended for development.
- [Testnet Testing](Testnet-Testing) - Recommended for poking around.
- [Test App Server](Test-App-Server) - Useful for GUI development, or just to try everything out
without needing to create wallets or connect to a **dcrdex** server.
- [Getting Started with Fuzzing](Getting-Started-With-Fuzzing)
- [Localization and Translations](Localization-and-Translation)
- [Wiki Contribution Guide](Wiki-Contribution-Guide)

---

[⤴ Back to Top](#top)
Loading