Skip to content

Commit

Permalink
docs: wiki restructuring
Browse files Browse the repository at this point in the history
  • Loading branch information
bochinchero committed Oct 21, 2024
1 parent 0a36067 commit 0bc9ec3
Show file tree
Hide file tree
Showing 7 changed files with 64 additions and 14 deletions.
56 changes: 42 additions & 14 deletions docs/wiki/Bison Wallet Setup Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ The selected native wallets will be created and Bison Wallet will connect to the
DEX server when you submit the form.

_**Note:** If you encounter an error about not being able to connect to the selected DEX
server during the quick configuration, you can always manually add a DEX server later._
server during the quick configuration, you can always manually add a DEX server later through the settings
panel._

## Backup Application Seed

Expand All @@ -154,7 +155,7 @@ It cannot be recovered by anyone, including the Bison Wallet developers. It is r
it down on paper and store that somewhere secure. If you decide to keep it on your computer,
it would be best to keep it in an encrypted document (do not forget the password) in case the file
or your computer is stolen.

haha
_**DO NOT, UNDER ANY CIRCUMSTANCES, GIVE YOUR SEED TO ANYONE!
NOT EVEN BISON WALLET OR DECRED DEVELOPERS!**_

Expand All @@ -166,14 +167,7 @@ is synchronized.

![Wallets Screen](./images/setup-guide/wallets-1.png)

While the blockchains are synchronizing in the background you can generate an address by clicking
the **Receive** button in the desired wallet page.

![Wallets Screen - Receive](./images/setup-guide/wallets-receive.png)

Once the transaction is confirmed, the **Available** balance will be updated.

# Creating an account on a DEX Server
# Creating a DEX Server account

Clicking the **Trade** button in the header will navigate to the [Trading](TODO-trading) screen.

Expand All @@ -182,18 +176,52 @@ Clicking the **Trade** button in the header will navigate to the [Trading](TODO-
The available markets on the connected DEX servers are listed on the left side of the screen.

An account can be created with the respective server by clicking the **Create Account** button
on the top right of the screen. This will open the **Select Bond Asset** screen.
on the top right of the screen. This will oapen the **Select Bond Asset** screen.

![Trading Screen](./images/setup-guide/bond-1.png)

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.
Read more about bonds in the [Fidelity Bonds](TODO-bonds) section of this wiki.
Fidelity Bonds act as an incentive good behaviour on the DEX servers and are required for
creating an account on every server. Read more about bonds in the [Fidelity Bonds](TODO-bonds)
section of this wiki.

Pre-paid bond is a code generated by the server operator to enable temporary
Pre-paid bonds are codes generated by the 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. 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.

# External Wallets
Once the bond asset is selected, a prompt to select the [Trading Tier](TODO-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](TODO-reputation) by engaging
in normal trading activity and successfully completing matches.

![Trading Tiers](./images/setup-guide/bond-2.png)

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.

![Bond Requirements](./images/setup-guide/bond-3.png)

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

![Confirm Bond Options](./images/setup-guide/bond-4.png)

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 markets screen will be displayed once the form has been submitted, indicating the status
of the submitted bond. The number of required confirmations will vary depending on the selected
bond asset.

![Awaiting bond confirmation](./images/setup-guide/bond-5.png)

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

![Bond COnfirmed](./images/setup-guide/bond-6.png)
22 changes: 22 additions & 0 deletions docs/wiki/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,28 @@ atomic swaps that exchange funds directly between wallets.
Going P2P empowers our users to trade directly, enhancing security,
censorship-resistance, privacy. and self-sovereignty.

# Supported Assets

Most users will use the native wallets that are already built into Bison Wallet.
Depending on the asset, you may be able to choose from: (1) a native
wallet, (2) an external full node wallet, or (3) an Electrum-based wallet.
Consult the following table for a summary of wallet support. If there is a
checkmark in the "native" column, no external software is required.

| Coin | native | full node | Electrum | notes |
|--------------|--------|-------------------------------------------------------------|---------------------------------------------------------------|------------------------------------------------------|
| Bitcoin || [v27.0](https://bitcoincore.org/en/download/) | [v4.5.5](https://electrum.org/) | |
| Decred || [v2.0.3](https://github.com/decred/decred-release/releases) | x | |
| Ethereum || geth IPC/http/ws | N/A | see <https://github.com/decred/dcrdex/wiki/Ethereum> |
| Polygon || | N/A | |
| Litecoin || [v0.21.2.1](https://litecoin.org/) | [v4.2.2](https://electrum-ltc.org/) | |
| Bitcoin Cash || [v27.0.0](https://bitcoincashnode.org/) | x | use only Bitcoin Cash Node for full node |
| Dogecoin | x | [v1.14.7.0](https://dogecoin.com/) | x | |
| Zcash | x | [v5.4.2](https://z.cash/download/) | x | |
| Dash | x | [v20.1.1](https://github.com/dashpay/dash/releases) | x | |
| Firo | x | [v0.14.13.3](https://github.com/firoorg/firo/releases) | [v4.1.5.5](https://github.com/firoorg/electrum-firo/releases) | |


# Atomic Swaps - review location

An Atomic Swap is a smart contract technology which makes possible to exchange coins from
Expand Down
Binary file added docs/wiki/images/setup-guide/bond-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wiki/images/setup-guide/bond-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wiki/images/setup-guide/bond-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wiki/images/setup-guide/bond-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wiki/images/setup-guide/bond-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0bc9ec3

Please sign in to comment.