Skip to content

Commit

Permalink
Decrediton
Browse files Browse the repository at this point in the history
  • Loading branch information
jholdstock authored and dajohi committed Jan 25, 2021
1 parent 42a667f commit faec3a3
Show file tree
Hide file tree
Showing 26 changed files with 45 additions and 53 deletions.
3 changes: 2 additions & 1 deletion docs/getting-started/using-the-block-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
All blocks and transactions on the Decred blockchain
are visible through the use of the block explorer, [dcrdata](https://github.com/decred/dcrdata).

* Networks
Public instances of dcrdata are available for the following networks:

- [mainnet](https://dcrdata.decred.org)
- [testnet](https://testnet.decred.org)

Expand Down
Binary file modified docs/img/decrediton/accounts.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 modified docs/img/decrediton/autobuyer.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 modified docs/img/decrediton/consensus-rule-voting.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 modified docs/img/decrediton/export-transactions.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 modified docs/img/decrediton/governance.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 removed docs/img/decrediton/help.png
Binary file not shown.
Binary file modified docs/img/decrediton/history.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 modified docs/img/decrediton/overview.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 modified docs/img/decrediton/pool-stats.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 modified docs/img/decrediton/purchase-tickets.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 modified docs/img/decrediton/receive.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 modified docs/img/decrediton/security.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 modified docs/img/decrediton/send.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 modified docs/img/decrediton/settings.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 modified docs/img/decrediton/setup/chain-downloading.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 modified docs/img/decrediton/setup/privacy-options.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 modified docs/img/decrediton/setup/seed-entered.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 modified docs/img/decrediton/setup/spv-options.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 modified docs/img/decrediton/setup/startup.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 modified docs/img/decrediton/setup/wallet-seed.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 removed docs/img/decrediton/tickets.png
Binary file not shown.
Binary file modified docs/img/decrediton/troubleshooting/logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 1 addition & 3 deletions docs/wallets/decrediton/decrediton-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ A large progress bar on this screen shows the progress of the blockchain downloa

This means you can download the blockchain in multiple sessions if required.

You can begin to set up your wallet before the download completes. You have two options:
When the download has completed you can set up your wallet. You have two options:

1. [Create a New Wallet](#create-a-new-wallet) - Press this button if this is your first time using Decred.

Expand Down Expand Up @@ -130,5 +130,3 @@ Press **Create Wallet** and your wallet setup is complete. You will be taken bac
1. Select **Create Wallet**. Wait for the blockchain to be downloaded.

1. The blockchain will now be scanned for any transactions belonging to this wallet.

1. If you need to reconnect to your Voting Service Provider (VSP), you'll need to re-import your VSP API key, as described in the Tickets section on the [Using Decrediton](using-decrediton.md) page.
16 changes: 15 additions & 1 deletion docs/wallets/decrediton/decrediton-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,20 @@ Perform the same steps as described in ["Cannot see all my coins"](#cannot-see-a

## Debugging Other Errors

If you can start the wallet but get error messages when performing an operation, then the first thing is to verify the wallet logs from within Decrediton. Access the Help -> Logs page and look for any ERR messages:
If you can start the wallet but get error messages when performing an operation, then the first thing is to verify the wallet logs from within Decrediton. Access the Settings -> Logs page and look for any ERR messages:

![Logs Page](/img/decrediton/troubleshooting/logs.png)

## How to backup VSP redeem script

Now is a good time to back up your VSPs multi-sig voting script (or "redeem script").

--8<-- "script-warning.md"

Click on the gear icon next to your VSP. Then click on the donut icon that appears.

![Purchase Tickets page](/img/decrediton/redeem-script.png)

This will bring up your VSP's configuration details. Copy the string of characters in the `Script` field and store them in a safe location.

![Purchase Tickets page](/img/decrediton/redeem-script-field.png)
75 changes: 27 additions & 48 deletions docs/wallets/decrediton/using-decrediton.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The main menu of Decrediton is displayed on the left side of the window, and it

The overview tab gives a quick summary of your total DCR (available and locked in tickets) and a list of recent transactions.

Graphs of your balance, ticket and transaction over the last two weeks can be viewed here.
Graphs of your balance, ticket activity and transaction history over the last two weeks can be viewed here.

![Overview Tab](/img/decrediton/overview.png)

---

## Transactions
## On-chain Transactions

The transactions tab is split into four sections:
The on-chain transactions tab is split into four sections:

### Send

Expand All @@ -40,7 +40,6 @@ Once you have entered the details of your transaction, the estimated fee and tra

This is where you can generate wallet addresses to give to other people so they can
send you DCR. The address is displayed in the blue text box - it's the line that starts with Ds, or Ts on testnet. Simply choose the account you want funds to go to and select the **Generate New Address** button.
You can select the clipboard icon to copy the address and share it with the person sending you DCR.
Decred addresses can be used as many times as you want, but for privacy reasons it's best to generate a new one for each transaction. There's around 1.4E48 (that's 14 followed by 47 zeroes) addresses available so you don't need to worry about running out.

![Receive Tab](/img/decrediton/receive.png)
Expand All @@ -58,6 +57,8 @@ This tab shows allows you to export your transaction history in a .csv format. Y

![Export Tab](/img/decrediton/export-transactions.png)

<!-- TODO add Lightning Transactions here -->

---

## Governance
Expand All @@ -83,17 +84,11 @@ voting preferences if you change your mind about an agenda.

---

## Tickets

The tickets tab is split into four sections:

### Purchase
## Staking

Before you can purchase tickets you must first import the API key from your [VSP account](../../proof-of-stake/how-to-stake.md#pos-using-a-voting-service-provider-vsp).
The staking tab is split into four sections:

![Tickets Tab](/img/decrediton/tickets.png)

Once you have done this, the "Purchase Tickets" tab becomes active.
### Purchase Tickets

![Purchase Tickets page](/img/decrediton/purchase-tickets.png)

Expand All @@ -103,35 +98,25 @@ The total number of tickets you currently own is at the top of the page:
- **Immature Tickets** - Mined tickets which cannot vote until a 256 block maturing period has passed (around 20 hours)
- **Live Tickets** - Mature tickets eligible to be called to vote

#### Backup redeem script

Now is a good time to back up your VSPs multi-sig voting script (or "redeem script").

--8<-- "script-warning.md"

Click on the gear icon next to your VSP. Then click on the donut icon that appears.

![Purchase Tickets page](/img/decrediton/redeem-script.png)

This will bring up your VSP's configuration details. Copy the string of characters in the `Script` field and store them in a safe location.

![Purchase Tickets page](/img/decrediton/redeem-script-field.png)

#### Purchasing tickets

In order to purchase tickets you just need to select which account to purchase tickets from, how many tickets you want to buy, and then press the **Purchase** button.
In order to purchase tickets you just need to select which account to purchase tickets from, how many tickets you want to buy, select a VSP to use, and then press the **Purchase** button.

The "Automatic Ticket Buyer" panel allows you to enable the automated ticket buyer - Decrediton will continually buy tickets for you for as long as you keep it running. You can configure how the ticket buyer works using the options:

![Automatic Purchase panel](/img/decrediton/autobuyer.png)

- **From** - Funds to purchase tickets will come from this account
- **VSP** - Which VSP to purchase tickets with
- **From** - Funds to purchase tickets will come from this account
- **Balance to maintain** - If your balance is lower than this number, you will not buy tickets. The default of 0 will use all the funds in your account to buy tickets

### My Tickets
### Tickets Status

This tab shows a summary of all of your immature and live tickets. Filters and sorting options are available to make browsing the list easier.

This tab shows a summary of all of the tickets your wallet has ever purchased. Filters and sorting options are available to make browsing the list easier.
### Historic Tickets

This tab shows a summary of all of your tickets which voted, expired or were missed. Filters and sorting options are available to make browsing the list easier.

### Statistics

Expand All @@ -141,22 +126,11 @@ This page displays various statistics about all of the available VSPs. The dropd

---

## Accounts
## Privacy and Security

The accounts tab shows you the accounts in your wallet and allows you to add new ones.
Accounts in Decred work just like bank accounts.
They allow you to keep separate records of your DCR. This feature is most
useful for those who run businesses and wish to keep separate accounts for
tax records for example. Transferring DCR across accounts will create a
transaction on the blockchain.

![Accounts Tab](/img/decrediton/accounts.png)

---

## Security
<!-- TODO add Privacy here -->

The Security tab offers two key features - the ability to sign and verify messages using your private key, and the ability to validate addresses.
The Security Center tab offers two key features - the ability to sign and verify messages using your private key, and the ability to validate addresses.

![Security Tab](/img/decrediton/security.png)

Expand All @@ -176,11 +150,16 @@ A Decred address can be entered into the Validate Address text box, and Decredit

---

## Help
## Accounts

The help tab contains links to get help using Decrediton and to learn more about Decred. There are also links to our various communication platforms. The Tutorials section contains introductions to the ticket lifecycle and how Decred's proof-of-stake system works. It is also possible to view logs of the `dcrd`, `dcrwallet` and `decrediton` processes in the Logs section.
The accounts tab shows you the accounts in your wallet and allows you to add new ones.
Accounts in Decred work just like bank accounts.
They allow you to keep separate records of your DCR. This feature is most
useful for those who run businesses and wish to keep separate accounts for
tax records for example. Transferring DCR across accounts will create a
transaction on the blockchain.

![Help Tab](/img/decrediton/help.png)
![Accounts Tab](/img/decrediton/accounts.png)

---

Expand Down

0 comments on commit faec3a3

Please sign in to comment.