readme: Added most info

This commit is contained in:
Nathan Woodburn 2023-06-08 16:52:38 +10:00
parent 06a458e6ec
commit 3c3e24e2e8
Signed by: nathanwoodburn
GPG Key ID: 203B000478AD0EF1
15 changed files with 113 additions and 2 deletions

View File

@ -35,9 +35,19 @@ namespace FireWallet
} }
private void MainForm_Load(object sender, EventArgs e) private void MainForm_Load(object sender, EventArgs e)
{ {
LoadSettings();
if (userSettings.ContainsKey("hide-splash"))
{
if (userSettings["hide-splash"] == "false")
{
// Show splash screen
}
}
UpdateTheme(); UpdateTheme();
LoadNode(); LoadNode();
LoadSettings();
// Edit the theme of the navigation panel // Edit the theme of the navigation panel
panelNav.BackColor = ColorTranslator.FromHtml(theme["background-alt"]); panelNav.BackColor = ColorTranslator.FromHtml(theme["background-alt"]);
@ -130,6 +140,7 @@ namespace FireWallet
sw.WriteLine("explorer-domain: https://niami.io/domain/"); sw.WriteLine("explorer-domain: https://niami.io/domain/");
sw.WriteLine("confirmations: 1"); sw.WriteLine("confirmations: 1");
sw.WriteLine("portfolio-tx: 20"); sw.WriteLine("portfolio-tx: 20");
sw.WriteLine("hide-splash: false");
sw.Dispose(); sw.Dispose();
} }

View File

@ -20,3 +20,76 @@ in Bob wallet under settings > Wallet > API key.
If you change this key in HSD or Bob you will need to update it in FireWallet. If you change this key in HSD or Bob you will need to update it in FireWallet.
![Node settings](assets/node_settings.png) ![Node settings](assets/node_settings.png)
If you need to change your Node settings you can edit the file in `%appdata%\FireWallet\node.txt`
<br><br><br><br>
# Usage
Login to your wallet by entering your password (the same as the Bob password).
This password will be stored in memory until you Logout or close the wallet.
This means you will not need to enter your password again until you close the wallet.
# Portfolio
The portfolio page shows your current balance.
The locked balance is the amount of HNS that is currently locked in auctions.
This also includes the amount of HNS that is locked in closed auctions (aka the spent bid).
This page shows a list of your transactions.
Clicking on a Hash will open the transaction in an explorer.
You can change the number of transactions shown in the `portfolio-tx:` settings.
<br>
![Portfolio](assets/portfolio.png)
<br><br>
## Sending HNS
![Send](assets/send_hns.png)
## Receiving HNS or Domains
The receive page shows your current HNS address.
This is the address you can give to people to send you HNS or domains.
This address will change every time you receive HNS or domains to prevent address reuse.
![Receive](assets/receive.png)
## Domains
The domains page shows a list of your domains.
It also lets you search for domains.
Clicking on a domain will open the domain in the domain windows.
![Domains](assets/domains.png)
The domain windows shows the details of the domain.
This window also lets you auction and manage domains.
![Domain_Search](assets/domain_search.png)
![Domain_Manage](assets/domain_manage.png)
## Manage Domains
You can update the records of your domains by clicking on the `Edit DNS` or `Edit in Batch` buttons.
This will open a window where you can edit the records of your domain.
After you have made your changes you can click the `Send` button to either send the transaction to the network or to the batch window.
![DNS Editor](assets/dns.png)
# Batching
The batch window lets you send multiple transactions at once.
You can add transactions to the batch from the domain window or the DNS editor.
![Batch](assets/batch.png)
## Importing
You can also import a list of domains to the batch window.
![Batch Import](assets/batch_import.png)
## Exporting
You can export the batch to a file.
This file will store the transaction type, name, and any data needed to send the transaction.
You can then import this file to send the transactions.
An example of this file can be found [here](example-configs/batch.txt).

BIN
assets/DNS.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

BIN
assets/batch.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

BIN
assets/batch_import.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
assets/domain_manage.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

BIN
assets/domain_search.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

BIN
assets/domains.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

BIN
assets/portfolio.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

BIN
assets/receive.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

BIN
assets/send_hns.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

@ -0,0 +1,7 @@
woodburn1,BID,1,3
woodburn2,BID,1,3
woodburn3,BID,1,3
woodburn4,BID,1,3
woodburn5,BID,1,3
woodburn6,BID,1,4
woodburn8,TRANSFER,hs1qlmlgnx0g3ynk4ylxkkdh9c9nernclnfq4lw6s9

3
example-configs/node.txt Normal file
View File

@ -0,0 +1,3 @@
IP: 127.0.0.1
Network: 0
Key: my-super-secret-api-key

View File

@ -0,0 +1,7 @@
explorer-tx: http://lookup.tx/
explorer-addr: https://niami.io/address/
explorer-block: https://niami.io/block/
explorer-domain: https://niami.io/domain/
confirmations: 1
portfolio-tx: 20
hide-splash: false

10
example-configs/theme.txt Normal file
View File

@ -0,0 +1,10 @@
background: #000000
foreground: #8e05c2
background-alt: #3e065f
foreground-alt: #ffffff
transparent-mode: off
transparency-key: main
transparency-percent: 90
selected-bg: #000000
selected-fg: #ffffff
error: #ff0000