chore: docs update and Getting Started

This commit is contained in:
Andre Neves 2019-04-14 20:54:40 -04:00
parent 6a45a18f90
commit 8a313ba457
7 changed files with 3695 additions and 1410 deletions

View File

@ -8,12 +8,13 @@ import { DownloadButton } from './components/download-button';
# Zepio Documentation
**Zepio** is a Sapling-enabled shielded-address first Zcash wallet, featuring cross-platform applications (macOS, Windows and Linux), `mainnet` and `testnet` support, and dark and light themes.
**Zepio** is a Sapling-enabled shielded-address first Zcash wallet, featuring cross-platform applications (macOS, Windows and Linux), built-in full node with support for`mainnet` and `testnet`, as well as dark and light themes.
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/dashboard.png' />
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/light.png' />
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/receive.png' />
<DownloadButton label='Download Zepio (macOS | Windows | Linux)' />
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/light.png' />
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/receive.png' />
> **Zepio** is NOT affiliated with the Electric Coin Company.

View File

@ -3,37 +3,41 @@ name: Installation
route: /installation
---
import { DownloadButton } from './components/download-button';
# Installation
**Zepio** runs on Windows, macOS and Linux and is available to download from the GitHub releases page. Follow the platform-specific instructions below to install **Zepio**. You can also compile the application from source.
<DownloadButton label='Download Zepio (macOS | Windows | Linux)' />
## Supported Platforms
### macOS
Download the macOS release named `Zepio-X.X.X.dmg` and double-click on file to open it. Drag Zepio to the Applications link to install. You will need to give authorization for the program to run.
Download the macOS release named `Zepio-vX.X.X.dmg` and double-click on file to open it. Drag Zepio to the Applications link to install. You may need to give system authorization for the program to run.
### Windows
Download and run the .exe installer (named Zepio Setup X.X.X.exe) and follow the prompts. You will need to give authorization for the program to run.
Download and run the `Zepio-Windows-vX.X.X.exe` installer and follow the prompts. You may need to give authorization for the program to run.
### Linux
If you are on Debian/Ubuntu, download the .deb package and install it.
If you are on Debian or Ubuntu, download the `.deb` package and install it:
`sudo dpkg -i linux-deb-zecwallet-v0.6.6.deb`
`sudo apt install -f`
Or you can download and run the binaries directly.
Or you can download and run the binaries directly, like so:
`tar -xvf zecwallet-v0.6.6.tar.gz`
`tar -xvf zepio-vX.X.X.tar.gz`
`./zecwallet-v0.6.6/zecwallet`
`./zepio-vX.X.X/zecwallet`
## Verifying the download
Starting from vX.X.X all **Zepio** releases are signed and contain checksums that may be validated to ensure the integrity of the downloaded software. The current signatures and checksums are available to download via the `signatures-vX.X.X.tar.gz` file on the releases page.
Starting with version `vX.X.X`, all **Zepio** releases are signed and contain checksums that may be validated to ensure the integrity of the downloaded software. The current signatures and checksums are available to download via the `signatures-vX.X.X.zip` file on the releases page.
## Signatures
@ -57,7 +61,7 @@ Once the key has been imported, you can run the following command to verify the
Assuming a good signature, you will see a similar output to the below.
`gpg --verify Zepio-X.X.X.dmg.sig Zepio-X.X.X.dmg`
`gpg --verify Zepio-vX.X.X.dmg.sig Zepio-vX.X.X.dmg`
`gpg: Signature made Wed 20 Mar 11:06:04 2019 PST`
@ -69,19 +73,15 @@ Assuming a good signature, you will see a similar output to the below.
The file `sha256sum-vX.X.X.txt` contains the SHA256 checksums for each download. You can verify that the file you downloaded matches this checksum via the following command:
`sha256sum Zepio-X.X.X.dmg`
`sha256sum Zepio-vX.X.X.dmg`
`f818d42e2850050ff9fa22408f595d51855ceaa895336e67a0.6.661c339bc24 Zepio-X.X.X.dmg`
`f818d42e2850050ff9fa22408f595d51855ceaa895336e67a0.6.661c339bc24 Zepio-vX.X.X.dmg`
## System requirements
If using the embedded zcashd the recommended system requirements are 5GB of free RAM and 30GB of free disk (the size of the blockchain increases over time).
If using the embedded `zcashd` full node daemon, the recommended system requirements are 5GB of free RAM and 30GB of free disk (the size of the blockchain increases over time).
## Compiling from source
For an in-depth explanation on how to build **Zepio** from source, please follow the `Building` section of the project's codebase README.
## Upgrading
It is important to keep your version of **Zepio** up to date as new features are regularly added and bugs fixed. To download, follow the instructions to install as your data directory and wallet will be untouched throughout.
For an in-depth explanation on how to build **Zepio** from source, please follow the `Building` section of the project's `README`.

View File

@ -11,31 +11,55 @@ import { Image } from './components/image';
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/dashboard.png' />
**Zepio**'s Dashboard is the entry point of the application. The following are possible on the Dashboard:
* See an overview of the balance of coins available for spending (shielded and transparent)
* See a list of most recent transactions performed
* See more details about a single transaction by clicking on the list item
**Zepio**'s Dashboard is the entry point of the application. This is where a user can get an overview of the latest state and updates to the wallet. More specifically, a user is faced with the following when inside of the Dashboard:
* Overview of the balance of coins available for spending (`shielded` and `transparent`).
* Overview of the USD-denominated value of the funds.
* Chronological list of the most recent transactions performed within the wallet.
* Details of a specific transaction.
* Network base chain (`mainnet` or `testnet`).
* Full node daemon status (`built-in` or `custom`).
* Network synchronization status pill (`ready`, `syncing`, `error`).
## Send
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/send.png' />
Image + Text of functionalities and capabilities
The Send view provides an easy way to send ZEC to any other Zcash address. To the right is an overview of the transaction being created, and to the right you will find a smart form. To begin, select a source address to send ZEC from -- the selector shows all available addresses and their respective funds.
Next, select a ZEC amount that you wish to send. Use the arrow to the right of the input if you wish to send all of the funds available in that address.
The next field is the Zcash address the funds are being sent to. It's a smart input, so all addresses pasted are checked for validity. You will see either `VALID` or `INVALID` to the right of the input -- you won't be able to submit a transaction to an address that does not validate. If sending to a shielded address, the user will also be shown a memo field that accepts either HEX or ASCII formatting.
It is advised to use the `default` fee of 0.0001 ZEC to refrain from having your transactions distinguised from the rest. That being said, if you'd like to send a transaction with a specific transaction fee, just use the `Show Additional Options` toggler. Low, medium, and high amounts are proposed, but you are also able to enter a custom ZEC value.
## Receive
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/receive.png' />
Image + Text of functionalities and capabilities
The Receive view provides information about all addresses in the wallet. For complete privacy on your transactions, make sure to use shielded addresses (start with `zs`). Transparent addresses, which provide no privacy capabiltiies, are available inside `Show Other Address Types`. You are able to generate as many addresses as needed, both shielded and transaparent addresses.
Clicking on the address item itself will present you with a QR code and more details about the address, such as address and available funds. Along with the copy address buttons, you are just 1 to 2 clicks away from receiving funds.
## Transactions
## Transaction Details
## Settings
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/settings.png' />
Image + Text of functionalities and capabilities
The Settings view provides options to further configure **Zepio** for your own specific wants and needs. The following actions are possible inside of the Settings view:
* Change between `mainnet` and `testnet` Zcash chains.
* Toggle between `Light` and `Dark` **Zepio** themes.
* Import and export address-specific private keys.
* Backup `wallet.dat` file.
## Console
<Image src='https://raw.githubusercontent.com/andrerfneves/zepio-docs/develop/docz/assets/console.png' />
Image + Text of functionalities and capabilities
The Console view displays the information from the built-in `zcashd` full node. It provides further insights into the status of the embedded node such as block height, network solution rate, and number of connections. It also details the longevity of the running node process.
In case you run into any synchronization issues, the Console is a good place to start getting more details.
> Please note that if you are running your own `zcashd` full node, **Zepio** will not display the Console view.

View File

@ -15,21 +15,21 @@ The debug.log file is the first place to start for troubleshooting issues. The f
> `Linux: ~/.zcash/debug.log`
If you have specified a custom datadir option then the debug.log file will be located in that directory. Using a tool such as tail you can view the last 100 lines with the following command:
If you have specified a custom `datadir` option then the debug.log file will be located in that directory. Using a tool such as tail you can view the last 100 lines with the following command:
`tail -n 100 ~/.zcash/debug.log`
## Could not start embedded `zcashd`
This means Zepio couldnt start its embedded zcashd for some reason. Zepio should display the error reported from `zcash` in the loading screen. You might be able to solve this by simply restarting Zepio, but if you repeatedly see this error, it might be one of the following reasons:
This means **Zepio** couldnt start its embedded `zcashd` full node daemon for some reason. **Zepio** should display the error reported from `the daemon` in the loading screen. You might be able to solve this by simply restarting **Zepio**, but if you repeatedly see this error, it might be one of the following reasons:
> You might have corrupt zcash params: In this case, you may try deleting your params and letting ZecWallet download them again.
> You might have corrupt zcash params: In this case, you may try deleting your params and letting **Zepio** download them again.
If all else fails, you can run an external `zcashd` and Zepio will connect to it.
If all else fails, you can run an external `zcashd` and **Zepio** will seamlessly connect to it.
## Shielded transactions are not displayed in the transaction tab
By default, `zcashd` does not store outgoing shielded transactions. To overcome this, Zepio will store shielded transaction information locally. There is no way (currently) of recovering the information about outgoing fully shielded spends, so deleting the application and reinstalling will result in a loss of metadata.
By default, `zcashd` does not store outgoing shielded transactions. To overcome this, **Zepio** will store shielded transaction information locally. There is no way (currently) of recovering the information about outgoing fully shielded spends, so deleting the application and reinstalling will result in a loss of metadata.
## My issue isnt resolved

View File

@ -3,35 +3,40 @@ name: FAQ
route: /faq
---
import { DownloadButton } from './components/download-button';
# FAQ
## Where do I download the wallet software?
## Where do I download the Zepio software?
**Zepio** is available to download from the Zcash Foundation GitHub repository. The releases page lists the latest available downloads for each platform.
<DownloadButton label='Download Zepio' />
Zepio is available to download from the Zcash Foundation GitHub repository. The releases page lists the latest available downloads for each platform.
## Which version of Zepio should I download?
You should always aim to stay at the latest stable build. See the [installation](http://changeme.com) section for more details.
You should always aim to stay at the latest stable build. See the [installation](/installation) section for more details.
## How do I verify the download file?
Starting from v0.6.0 all Zepio releases are signed. You may download the detached signatures on the releases page and verify that the software was signed with the published public key. In addition, each release contains SHA256 checksums that may additionally be verified.
Starting from v0.6.0 all **Zepio** releases are signed. You may download the attached signatures on the releases page and verify that the software was signed with the published public key. In addition, each release contains SHA256 checksums that may additionally be verified.
## Is Zepio a light client?
No, Zepio requires a full `zcashd` node in order to operate. A light client protocol is currently in development that would substantially reduce the storage and bandwidth requirements for a light wallet. Currently, to use shielded transactions, you need to run a full node. Zepio has a built-in `zcashd` node, but it will also play well with your custom `zcashd` setup.
No, **Zepio** requires a full `zcashd` node in order to operate. A light client protocol is currently in development that would substantially reduce the storage and bandwidth requirements for **Zepio**. Currently, to use shielded transactions, you need to run a full node. **Zepio** has a built-in `zcashd` node, but it will also play well with your custom `zcashd` setup.
## How large is the Zcash blockchain data?
Currently, the blockchain data directory is around 27GB (May 2019) and will continue to grow over time.
Currently, the blockchain data directory is around 27GB (April 2019) and will continue to grow over time.
## Can I use a custom fee?
Yes. It is advised to maintain the default `0.0001 ZEC` fee to prevent your transactions from being distinguishable. However, you can find the custom fee picker inside of the Advanced Options on the Send view.
Yes. It is advised to maintain the default `0.0001 ZEC` fee to prevent your transactions from being distinguishable. However, you can find the custom fee picker inside of the `Advanced Options` on the `Send` view.
## Whats the difference between Transparent, Sprout and Sapling addresses?
Transparent addresses start with a `t` prefix and are just like Bitcoin addresses, offering no privacy properties. Sprout addresses have a `zc` prefix and are the first generation of Zcash shielded addresses. Sprout addresses have been superseded by Sapling addresses which have a `zs` prefix. While Sprout addresses may still be used, it is recommended to use Sapling addresses due to the performance improvements and updated system parameters.
Transparent addresses start with a `t` prefix and behave just like Bitcoin addresses, offering no specific privacy properties. Sprout addresses have a `zc` prefix and are the first generation of Zcash shielded addresses. Sprout addresses have been superseded by Sapling addresses which have a `zs` prefix. While Sprout addresses may still be used, it is recommended to use Sapling addresses due to the performance improvements and updated system parameters.
> Note that on testnet, transparent addresses have a prefix `tm`, Sprout have a `zt` prefix and Sapling `ztestsapling`.
@ -49,31 +54,31 @@ By default, the location of the data directory, which stores the wallet, zcash.c
## Where is zcash.conf located?
zcash.conf is located in the default data directory and will be in this location even if the datadir parameter has been set to a custom value.
`zcash.conf` is located in the default data directory and will be in this location even if the `datadir` parameter has been set to a custom value.
## Can I use Zepio with an external node?
Yes. Zepio is able to read your zcash.conf file and connect to your external node.
Yes. **Zepio** is able to read your `zcash.conf` file and connect to your external node.
## Does Zepio work on testnet?
Yes, Zepio supports both `mainnet` and `testnet`. To switch between the chains, head over to Settings > Zcash Network. Beware that Zepio will need to sync the entire blockchain data for each of the chains.
Yes, **Zepio** supports both `mainnet` and `testnet`. To switch between the chains, head over to `Settings` > `Zcash Network`. Beware that **Zepio** will need to sync the entire blockchain data for either/both chains before you are able to spend coins.
## Does Zepio support viewing keys?
Not yet, as zcashd doesnt currently support Sapling viewing keys.
Not yet, as `zcashd` doesnt currently support Sapling viewing keys.
## Is the wallet encrypted?
No, wallet encryption is currently disabled by zcashd. You should use full-disk encryption (or encryption of your home directory) to protect your wallet.dat file at rest, and should assume (even unprivileged) users who are running on your OS can read your wallet.dat file.
No, wallet encryption is currently disabled by `zcashd`. You should use full-disk encryption (or encryption of your home directory) to protect your `wallet.dat` file at rest, and should assume (even unprivileged) users who are running on your OS can read your `wallet.dat` file.
## Why does my change go to a new address?
Like Bitcoin, when using transparent addresses, change from a transaction goes to a new transparent address. Zepio allows you to set an option to automatically send this change to a Sapling address via the application Options. As the feature was added in Bitcoin as a measure to preserve privacy and prevent trivial linking of transactions on the blockchain, shielded (z) addresses do not have this property and any change is returned to the sending (z) address by default.
Like Bitcoin, when using transparent addresses, change from a transaction goes to a new transparent address. This feature was added in Bitcoin as a measure to preserve privacy and prevent trivial linking of transactions on the blockchain. On the other hand shielded (z) addresses do not have this property and any change is returned to the sending (z) address by default.
## Will Zepio remember my outgoing shielded sends?
Yes, by default Zepio will store shielded sends locally as zcashd does not provide this information.
Yes, by default **Zepio** will store outgoing shielded transactions locally as `zcashd` does not provide this information.
## Can I use Zepio with a hardware wallet?
@ -81,4 +86,4 @@ No, this is currently not supported.
## Can I remove an address from the wallet?
No, addresses cannot be removed from the wallet. It is advised that you export the private keys for addresses you are interested in and then delete the wallet.dat file. You can then import the private keys you require in a fresh, empty wallet.
No, addresses cannot be removed from the wallet. In order to remove addresses, it is advised that you export the private keys for the addresses you are interested in, and then delete the `wallet.dat` file. You can then import the private keys you require in a fresh, empty wallet.

View File

@ -5,46 +5,45 @@ route: /terms
# Terms of Service
> Terms updated on May 1st, 2019
> Terms updated on April 14th, 2019
## Terms
By accessing the website at https://docs.zepiowallet.com, you are agreeing to be bound by these terms of service, all applicable laws and regulations, and agree that you are responsible for compliance with any applicable local laws. If you do not agree with any of these terms, you are prohibited from using the application or accessing this site. The materials contained in this website are protected by applicable copyright and trademark law.
By accessing the website at https://zepiowallet.com, you are agreeing to be bound by these terms of service, all applicable laws and regulations, and agree that you are responsible for compliance with any applicable local laws. If you do not agree with any of these terms, you are prohibited from using the application or accessing this site. The materials contained in this website are protected by applicable copyright and trademark law.
## License
Permission is granted to temporarily download one copy of the materials (information or software) on Zepio's website for personal, non-commercial transitory viewing only. This is the grant of a license, not a transfer of title, and under this license you may not:
* modify or copy the materials;
Permission is granted to temporarily download one copy of the materials (information or software) on **Zepio**'s website for personal, non-commercial transitory viewing only. This is the grant of a license, not a transfer of title, and under this license you may not:
* use the materials for any commercial purpose, or for any public display (commercial or non-commercial);
* attempt to decompile or reverse engineer any software contained on Zepio's website;
* attempt to decompile or reverse engineer any software contained on **Zepio**'s website;
* remove any copyright or other proprietary notations from the materials;
* or transfer the materials to another person or “mirror” the materials on any other server.
This license shall automatically terminate if you violate any of these restrictions and may be terminated by Zepio at any time. Upon terminating your viewing of these materials or upon the termination of this license, you must destroy any downloaded materials in your possession whether in electronic or printed format.
This license shall automatically terminate if you violate any of these restrictions and may be terminated by **Zepio** at any time. Upon terminating your viewing of these materials or upon the termination of this license, you must destroy any downloaded materials in your possession whether in electronic or printed format.
> [MIT License 2019](https://github.com/andrerfneves/zepio/blob/master/LICENSE.md)
## Disclaimer
The materials on Zepio's website are provided on an as is basis. Zepio makes no warranties, expressed or implied, and hereby disclaims and negates all other warranties including, without limitation, implied warranties or conditions of merchantability, fitness for a particular purpose, or non-infringement of intellectual property or other violation of rights.
The materials on **Zepio**'s website are provided on an as is basis. **Zepio** makes no warranties, expressed or implied, and hereby disclaims and negates all other warranties including, without limitation, implied warranties or conditions of merchantability, fitness for a particular purpose, or non-infringement of intellectual property or other violation of rights.
Further, Zepio does not warrant or make any representations concerning the accuracy, likely results, or reliability of the use of the materials on its website or otherwise relating to such materials or on any sites linked to this site.
Further, **Zepio** does not warrant or make any representations concerning the accuracy, likely results, or reliability of the use of the materials on its website or otherwise relating to such materials or on any sites linked to this site.
## Limitations
In no event shall Zepio or its suppliers be liable for any damages (including, without limitation, damages for loss of data or profit, or due to business interruption) arising out of the use or inability to use the materials on Zepio's website or application, even if Zepio or a Zepio authorized representative has been notified orally or in writing of the possibility of such damage. Because some jurisdictions do not allow limitations on implied warranties, or limitations of liability for consequential or incidental damages, these limitations may not apply to you.
In no event shall **Zepio** or its suppliers be liable for any damages (including, without limitation, damages for loss of data or profit, or due to business interruption) arising out of the use or inability to use the materials on **Zepio**'s website or application, even if **Zepio** or a **Zepio** authorized representative has been notified orally or in writing of the possibility of such damage. Because some jurisdictions do not allow limitations on implied warranties, or limitations of liability for consequential or incidental damages, these limitations may not apply to you.
## Accuracy of Materials
The materials appearing on Zepio's website could include technical, typographical, or photographic errors. Zepio does not warrant that any of the materials on its website are accurate, complete or current. Zepio may make changes to the materials contained on its website at any time without notice. However Zepio does not make any commitment to update the materials.
The materials appearing on **Zepio**'s website could include technical, typographical, or photographic errors. **Zepio** does not warrant that any of the materials on its website are accurate, complete or current. **Zepio** may make changes to the materials contained on its website at any time without notice. However **Zepio** does not make any commitment to update the materials.
## Links
Zepio has not reviewed all of the sites linked to its website and is not responsible for the contents of any such linked site. The inclusion of any link does not imply endorsement of the site by Zepio. Use of any such linked website is at the users own risk.
**Zepio** has not reviewed all of the sites linked to its website and is not responsible for the contents of any such linked site. The inclusion of any link does not imply endorsement of the site by **Zepio**. Use of any such linked website is at the users own risk.
## Modifications
Zepio may revise these terms of service for its website at any time without notice. By using this website you are agreeing to be bound by the then current version of these terms of service.
**Zepio** may revise these terms of service for its website at any time without notice. By using this website you are agreeing to be bound by the then current version of these terms of service.
## Governing Law

4956
yarn.lock

File diff suppressed because it is too large Load Diff