diff --git a/FireWallet/MainForm.cs b/FireWallet/MainForm.cs index 4614075..2903906 100644 --- a/FireWallet/MainForm.cs +++ b/FireWallet/MainForm.cs @@ -35,9 +35,19 @@ namespace FireWallet } private void MainForm_Load(object sender, EventArgs e) { + LoadSettings(); + + if (userSettings.ContainsKey("hide-splash")) + { + if (userSettings["hide-splash"] == "false") + { + // Show splash screen + } + } + UpdateTheme(); LoadNode(); - LoadSettings(); + // Edit the theme of the navigation panel panelNav.BackColor = ColorTranslator.FromHtml(theme["background-alt"]); @@ -130,6 +140,7 @@ namespace FireWallet sw.WriteLine("explorer-domain: https://niami.io/domain/"); sw.WriteLine("confirmations: 1"); sw.WriteLine("portfolio-tx: 20"); + sw.WriteLine("hide-splash: false"); sw.Dispose(); } diff --git a/README.md b/README.md index 81cd118..bc86c17 100644 --- a/README.md +++ b/README.md @@ -19,4 +19,77 @@ You can get the API key from the HSD launch command or 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. -![Node settings](assets/node_settings.png) \ No newline at end of file +![Node settings](assets/node_settings.png) +If you need to change your Node settings you can edit the file in `%appdata%\FireWallet\node.txt` + +



+# 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. + +
+ +![Portfolio](assets/portfolio.png) + +

+## 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). \ No newline at end of file diff --git a/assets/DNS.png b/assets/DNS.png new file mode 100644 index 0000000..f418f86 Binary files /dev/null and b/assets/DNS.png differ diff --git a/assets/batch.png b/assets/batch.png new file mode 100644 index 0000000..fb31dfa Binary files /dev/null and b/assets/batch.png differ diff --git a/assets/batch_import.png b/assets/batch_import.png new file mode 100644 index 0000000..a57c668 Binary files /dev/null and b/assets/batch_import.png differ diff --git a/assets/domain_manage.png b/assets/domain_manage.png new file mode 100644 index 0000000..74c7977 Binary files /dev/null and b/assets/domain_manage.png differ diff --git a/assets/domain_search.png b/assets/domain_search.png new file mode 100644 index 0000000..6ac7989 Binary files /dev/null and b/assets/domain_search.png differ diff --git a/assets/domains.png b/assets/domains.png new file mode 100644 index 0000000..a8c6622 Binary files /dev/null and b/assets/domains.png differ diff --git a/assets/portfolio.png b/assets/portfolio.png new file mode 100644 index 0000000..83b1d75 Binary files /dev/null and b/assets/portfolio.png differ diff --git a/assets/receive.png b/assets/receive.png new file mode 100644 index 0000000..84bd27c Binary files /dev/null and b/assets/receive.png differ diff --git a/assets/send_hns.png b/assets/send_hns.png new file mode 100644 index 0000000..3a2008b Binary files /dev/null and b/assets/send_hns.png differ diff --git a/example-configs/batch.txt b/example-configs/batch.txt new file mode 100644 index 0000000..1c12280 --- /dev/null +++ b/example-configs/batch.txt @@ -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 \ No newline at end of file diff --git a/example-configs/node.txt b/example-configs/node.txt new file mode 100644 index 0000000..2df3178 --- /dev/null +++ b/example-configs/node.txt @@ -0,0 +1,3 @@ +IP: 127.0.0.1 +Network: 0 +Key: my-super-secret-api-key diff --git a/example-configs/settings.txt b/example-configs/settings.txt new file mode 100644 index 0000000..1835d67 --- /dev/null +++ b/example-configs/settings.txt @@ -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 \ No newline at end of file diff --git a/example-configs/theme.txt b/example-configs/theme.txt new file mode 100644 index 0000000..09dbfa5 --- /dev/null +++ b/example-configs/theme.txt @@ -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 \ No newline at end of file