chore: base setup
This commit is contained in:
Andre Neves
commit
2fae641730
|
|
@ -0,0 +1,81 @@
|
|||
{
|
||||
"parser": "babel-eslint",
|
||||
"extends": [
|
||||
"airbnb",
|
||||
"plugin:flowtype/recommended"
|
||||
],
|
||||
"env": {
|
||||
"browser": true,
|
||||
"node": true,
|
||||
"mocha": true
|
||||
},
|
||||
"plugins": ["flowtype"],
|
||||
"settings": {
|
||||
"flowtype": {
|
||||
"onlyFilesWithFlowAnnotation": true
|
||||
}
|
||||
},
|
||||
"rules": {
|
||||
"jsx-quotes": ["error", "prefer-single"],
|
||||
"import/prefer-default-export": [
|
||||
"off"
|
||||
],
|
||||
"no-underscore-dangle": [
|
||||
"off"
|
||||
],
|
||||
"react/jsx-filename-extension": [
|
||||
1,
|
||||
{ "extensions": [".js"] }
|
||||
],
|
||||
"jsx-a11y/anchor-is-valid": [
|
||||
"error",
|
||||
{
|
||||
"components": [
|
||||
"Link"
|
||||
],
|
||||
"specialLink": [
|
||||
"to",
|
||||
"hrefLeft",
|
||||
"hrefRight"
|
||||
],
|
||||
"aspects": [
|
||||
"noHref",
|
||||
"invalidHref",
|
||||
"preferButton"
|
||||
]
|
||||
}
|
||||
],
|
||||
"jsx-a11y/label-has-associated-control": [
|
||||
"error",
|
||||
{
|
||||
"required": {
|
||||
"some": [
|
||||
"nesting",
|
||||
"id"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"jsx-a11y/label-has-for": [
|
||||
"error",
|
||||
{
|
||||
"required": {
|
||||
"some": [
|
||||
"nesting",
|
||||
"id"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"jsx-a11y/no-autofocus": [ 0, {
|
||||
"ignoreNonDOM": true
|
||||
}],
|
||||
"max-len": ["error", {
|
||||
"code": 100,
|
||||
"ignoreUrls": true,
|
||||
"ignoreComments": true,
|
||||
"ignoreStrings": true,
|
||||
"ignorePattern": "<p[^>]*>.*?</p>"
|
||||
}]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
[ignore]
|
||||
|
||||
[include]
|
||||
|
||||
[libs]
|
||||
|
||||
[lints]
|
||||
|
||||
[options]
|
||||
|
||||
[strict]
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
|
||||
|
||||
# dependencies
|
||||
/node_modules
|
||||
/.pnp
|
||||
.pnp.js
|
||||
.docz
|
||||
|
||||
# testing
|
||||
/coverage
|
||||
|
||||
# production
|
||||
/build
|
||||
|
||||
# misc
|
||||
.DS_Store
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Zepio Documentation
|
||||
|
||||
## License
|
||||
|
||||
MIT © Zcash Foundation 2019
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
name: Home
|
||||
route: /
|
||||
---
|
||||
|
||||
# Zepio Documentation
|
||||
|
||||
Use the sidebar menu to browse the docs
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
name: Installation
|
||||
route: /installation
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
Use the sidebar menu to browse the docs
|
||||
|
||||
|
||||
## Linux
|
||||
|
||||
Linux
|
||||
|
||||
## macOS
|
||||
|
||||
macOS
|
||||
|
||||
## Windows
|
||||
|
||||
Windows
|
||||
|
||||
## From Source
|
||||
|
||||
Source
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
name: Getting Started
|
||||
route: /getting-started
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
Use the sidebar menu to browse the docs
|
||||
|
||||
## Dashboard
|
||||
|
||||
Dashboard
|
||||
|
||||
## Send
|
||||
|
||||
Send
|
||||
|
||||
## Receive
|
||||
|
||||
Receive
|
||||
|
||||
## Settings
|
||||
|
||||
Settings
|
||||
|
||||
## Console
|
||||
|
||||
Console
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
name: Troubleshooting
|
||||
route: /troubleshooting
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
Your privacy is important to us. It is ZecWallet’s policy to completely respect your privacy regarding any information.
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
---
|
||||
name: FAQ
|
||||
route: /faq
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
||||
Your privacy is important to us. It is ZecWallet’s policy to completely respect your privacy regarding any information.
|
||||
|
||||
## Where do I download the software?
|
||||
|
||||
Zepio is available to download from the Zcash Foundation GitHub repository. The releases page lists the latest available downloads for each platform.
|
||||
|
||||
## Which version should I download?
|
||||
|
||||
See the installation section for more details specific for your platform.
|
||||
|
||||
## How do I verify the download file?
|
||||
|
||||
Starting from v0.5.10 all ZecWallet 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. For more information, see the Verifying the download section of the Installation guide.
|
||||
|
||||
## Is ZecWallet a light client?
|
||||
|
||||
No, ZecWallet requires a full zcashd node 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.
|
||||
|
||||
## How large is the blockchain?
|
||||
|
||||
Currently, the blockchain data directory is around 22GB (Feb 2019) and will continue to grow over time.
|
||||
|
||||
## Can I change the location of the data directory?
|
||||
|
||||
If you are starting ZecWallet for the first time, then you can choose the Advanced Config option and select the desired location of your data directory, which may, for example, be on a separate disk.
|
||||
|
||||
## Can I use a custom fee?
|
||||
|
||||
Yes, though it is advised to use the default 0.0001 fee to prevent your transactions from being distinguishable, you may override this behaviour in the app Options
|
||||
|
||||
## What’s the difference between Transparent, Sprout and Sapling addresses?
|
||||
|
||||
Transparent addresses start with a t prefix and are transparent like Bitcoin and offer no privacy properties. Sprout addresses have a zc prefix and are the first generation of 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. To move funds between Sprout and Sapling addresses see the turnstile migration documentation. For more detailed information on the types of addresses in Zcash see this page.
|
||||
|
||||
Note that on testnet, transparent addresses have a prefix tm, Sprout have a zt prefix and Sapling ztestsapling.
|
||||
|
||||
## How long does a Sapling transaction take?
|
||||
|
||||
Sapling greatly reduced the time taken to perform shielded proofs down to just a few seconds though this value does depend on hardware and the number of shielded inputs/outputs. Sending from a transparent address to a Sapling one is typically completed in under 0.5 seconds. Legacy Sprout transactions take in the order of 70-90 seconds but this is also dependent on hardware and the number of JoinSplits. For more information see this post.
|
||||
|
||||
## Where is the default data directory on each platform?
|
||||
|
||||
By default, the location of the data directory, which stores the wallet, zcash.conf and all blockchain data, is found in the following locations. It is possible to move this data directory.
|
||||
|
||||
* Windows: %HOMEPATH%\AppData\Roaming\Zcash
|
||||
* macOS: ~/Library/Application Support/Zcash
|
||||
* Linux: ~/.zcash
|
||||
|
||||
## 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.
|
||||
|
||||
## Can I use ZecWallet with an external node?
|
||||
|
||||
Yes, see this section for how to connect to an external zcashd.
|
||||
|
||||
## Does ZecWallet work on testnet?
|
||||
|
||||
Yes, ZecWallet will work on testnet. To do so add the following lines to your zcash.conf file, replacing the existing values if present:
|
||||
|
||||
## Does ZecWallet support payment disclosure?
|
||||
|
||||
Not yet. While payment disclosure works on Sprout addresses, zcashd has not yet been updated to support Sapling. There is a plan to support this once implemented by zcashd.
|
||||
|
||||
## Does ZecWallet support viewing keys?
|
||||
|
||||
Not yet, as zcashd doesn’t currently support Sapling viewing keys and will be implemented in ZecWallet once supported
|
||||
|
||||
## 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.
|
||||
|
||||
## 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. ZecWallet 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.
|
||||
|
||||
## Will ZecWallet remember my outgoing shielded sends?
|
||||
|
||||
Yes, by default ZecWallet will store shielded sends locally as zcashd does not provide this information. You can override this behaviour via the Options setting and you can remove any stored transactions at any time by choosing the Clear History button (note that these will not be later recoverable if you delete them).
|
||||
|
||||
## Can I use ZecWallet with a hardware wallet?
|
||||
|
||||
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.
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
name: Privacy Policy
|
||||
route: /privacy
|
||||
---
|
||||
|
||||
# Privacy Policy
|
||||
|
||||
> Policy updated on May 1st, 2019
|
||||
|
||||
**Your privacy is of utmost importance to us. It is Zepio's policy to completely respect your privacy regarding any information needed for the application to provide you with the needed services.**
|
||||
|
||||
Zepio does not collect or store any personally identifiable information or any information relating to the usage of the application. We do not share any personally identifyable information publicly or with third-parties.
|
||||
|
||||
Zepio's website may link to external sites that are not operated by us. Please beware that we have no control over the content and practices of those sites, and cannot accept responsibility or liability for their respective privacy policies and terms of service.
|
||||
|
||||
Your continued use of our website and application will be regarded as acceptance of our practices around privacy and personal information. If you have any further questions about data collection, feel free to get in touch.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
name: Terms of Service
|
||||
route: /terms
|
||||
---
|
||||
|
||||
# Terms of Service
|
||||
|
||||
> Terms updated on May 1st, 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.
|
||||
|
||||
## 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;
|
||||
* 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;
|
||||
* 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.
|
||||
|
||||
> [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.
|
||||
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
## 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 user’s 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.
|
||||
|
||||
## Governing Law
|
||||
|
||||
These terms and conditions are governed by and construed in accordance with the laws of USA and you irrevocably submit to the exclusive jurisdiction of the courts in that State or location.
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
/* eslint-disable import/no-extraneous-dependencies */
|
||||
|
||||
export default {
|
||||
title: 'Zepio Documentation',
|
||||
description: 'Zepio Documentation',
|
||||
plugins: [],
|
||||
htmlContext: {
|
||||
head: {
|
||||
links: [
|
||||
{
|
||||
rel: 'stylesheet',
|
||||
href: 'https://fonts.googleapis.com/css?family=PT+Sans:400,700',
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
{
|
||||
"name": "zepio-docs",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"author": {
|
||||
"name": "Andre Neves",
|
||||
"email": "andrerfneves@protonmail.com",
|
||||
"url": "https://andrenev.es"
|
||||
},
|
||||
"scripts": {
|
||||
"start": "yarn docz:dev",
|
||||
"docz:dev": "docz dev --port 4000",
|
||||
"docz:build": "docz build"
|
||||
},
|
||||
"dependencies": {
|
||||
"polished": "^2.3.1",
|
||||
"react": "^16.7.0",
|
||||
"react-dom": "^16.7.0",
|
||||
"react-router-dom": "^4.3.1",
|
||||
"react-scripts": "2.1.2",
|
||||
"styled-components": "^4.1.3",
|
||||
"webpack": "4.19.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"docz": "^0.13.7",
|
||||
"docz-plugin-css": "^0.11.0",
|
||||
"docz-theme-default": "^0.13.7",
|
||||
"eslint-config-airbnb": "^17.1.0",
|
||||
"flow-bin": "^0.89.0",
|
||||
"glow": "^1.2.1",
|
||||
"pre-commit": "^1.2.2",
|
||||
"webpack-hot-client": "^4.1.1"
|
||||
},
|
||||
"eslintConfig": {
|
||||
"extends": "react-app"
|
||||
},
|
||||
"browserslist": [
|
||||
">0.2%",
|
||||
"not dead",
|
||||
"not ie <= 11",
|
||||
"not op_mini all"
|
||||
],
|
||||
"pre-commit": [
|
||||
"lint:precommit",
|
||||
"flow:precommit"
|
||||
]
|
||||
}
|
||||
Loading…
Reference in New Issue