Update the README for the Zashi iOS repository. (#914)
* Update the README for the Zashi IOS repository.
This commit is contained in:
Kris Nuttycombe
GitHub
parent
c76322c0fb
commit
26d6be7773
80
README.md
80
README.md
|
|
@ -1,40 +1,50 @@
|
|||
# secant-ios-wallet
|
||||
# Zashi iOS Wallet
|
||||
|
||||
This wallet is a Dogfooding effort towards Zcash Halo Arc / NU5 efforts.
|
||||
This is the official home of the Zashi Zcash wallet for Wallet, a no-frills
|
||||
Zcash mobile wallet leveraging the [Zcash Swift SDK](https://github.com/Electric-Coin-Company/zcash-swift-wallet-sdk).
|
||||
|
||||
# Motivation
|
||||
Dogfooding - _transitive verb_ - is the practice of an organization using its own product. This app was created to help us learn.
|
||||
# Beta Testing
|
||||
|
||||
Please take note: the wallet is not an official product by ECC, but rather a tool for learning about our libraries that it is built on. This means that we do not have robust infrastructure or user support for this application. We open sourced it as a resource to make wallet development easier for the Zcash ecosystem.
|
||||
The Zashi IOS wallet is currently in closed beta testing, and will be publicly
|
||||
available from the Apple Store when testing is complete.
|
||||
|
||||
# Disclaimers
|
||||
There are some known areas for improvement:
|
||||
If you'd like to be added to the waitlist to become a Zashi beta tester,
|
||||
please [sign up here](https://docs.google.com/forms/d/e/1FAIpQLSeQpykeMF8QcxnX5W8ya0pXIf5YPRRpUXD7H1gvbzv_WyASPw/viewform).
|
||||
|
||||
- This app is mainly intended for learning and improving the related libraries that it uses. There may be bugs.
|
||||
- Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user.
|
||||
- The wallet requires a trust in the server to display accurate transaction information.
|
||||
# Reporting an issue
|
||||
|
||||
See the [Wallet App Threat Model](https://zcash.readthedocs.io/en/latest/rtd_pages/wallet_threat_model.html)
|
||||
If you'd like to report a technical issue or feature request for the IOS
|
||||
Wallet, please file a GitHub issue [here](https://github.com/Electric-Coin-Company/zashi-ios/issues/new/choose).
|
||||
|
||||
For feature requests and issues related to the Zashi user interface that are
|
||||
not iOS-specific, please file a GitHub issue [here](https://github.com/Electric-Coin-Company/zashi/issues/new/choose).
|
||||
|
||||
If you wish to report a security issue, please follow our
|
||||
[Responsible Disclosure guidelines](https://github.com/Electric-Coin-Company/zashi/blob/master/responsible_disclosure.md).
|
||||
See the [Wallet App Threat Model](https://github.com/Electric-Coin-Company/zashi/blob/master/wallet_threat_model.md)
|
||||
for more information about the security and privacy limitations of the wallet.
|
||||
|
||||
If you'd like to sign up to help us test, reach out on discord and let us know! We're always happy to get feedback!
|
||||
General Zcash questions and/or support requests and are best directed to either:
|
||||
* [Zcash Forum](https://forum.zcashcommunity.com/)
|
||||
* [Discord Community](https://discord.io/zcash-community)
|
||||
|
||||
# Description
|
||||
# Contributing
|
||||
|
||||
iOS wallet using the Zcash iOS SDK that is maintained by core developers.
|
||||
Contributions are very much welcomed! Please read our [Contributing Guidelines](/CONTRIBUTING.md)
|
||||
and [Code of Conduct](/CONDUCT.md). Our backlog has many Issues tagged with the
|
||||
`good first issue` label. Please fork the repo and make a pull request for us
|
||||
to review.
|
||||
|
||||
This a reference wallet for the following set of features:
|
||||
- z2z transactions w/ encrypted memos
|
||||
- reply-to formatted memos
|
||||
- z2t transactions
|
||||
- transparent receive-only
|
||||
- autoshielding on threshold from receive only t-address
|
||||
Zashi Wallet uses [SwiftLint](https://github.com/realm/SwiftLint) and
|
||||
[SwiftGen](https://github.com/SwiftGen/SwiftGen) to conform to our coding
|
||||
guidelines for source code and generate accessors for assets. Please install
|
||||
these locally when contributing to the project, they are run automatically when
|
||||
you build.
|
||||
|
||||
note: z means sapling shielded addresses.
|
||||
## Installation of Swiftgen & Swiftlint on Apple Silicon-based hardware
|
||||
|
||||
# Installation of Swiftgen & Swiftlint on Apple Silicon chip
|
||||
### Swiftgen
|
||||
|
||||
## Swiftgen
|
||||
Install it using homebrew
|
||||
```
|
||||
$ brew install swiftgen
|
||||
|
|
@ -43,26 +53,14 @@ and create a symbolic link
|
|||
```
|
||||
ln -s /opt/homebrew/bin/swiftgen /usr/local/bin
|
||||
```
|
||||
## Swiftlint
|
||||
The project is setup to work with `0.50.3` version. We recommend to install it directly using [the official 0.50.3 package](https://github.com/realm/SwiftLint/releases/download/0.50.3/SwiftLint.pkg). If you follow this step there is no symbolic link needed.
|
||||
|
||||
### Swiftlint
|
||||
|
||||
The project is setup to work with `0.50.3` version. We recommend to install it
|
||||
directly using [the official 0.50.3 package](https://github.com/realm/SwiftLint/releases/download/0.50.3/SwiftLint.pkg).
|
||||
If you follow this step there is no symbolic link needed.
|
||||
|
||||
In case you already have swiftlint 0.50.3 ready on your machine and installed via homebrew, create a symbolic link
|
||||
```
|
||||
ln -s /opt/homebrew/bin/swiftlint /usr/local/bin
|
||||
```
|
||||
|
||||
# Contributing
|
||||
|
||||
Contributions are very much welcomed! Please read our [Contributing Guidelines](/CONTRIBUTING.md) and [Code of Conduct](/CONDUCT.md). Our backlog has many Issues tagged with the `good first issue` label. Please fork the repo and make a pull request for us to review.
|
||||
|
||||
Secant Wallet uses [SwiftLint](https://github.com/realm/SwiftLint) and [SwiftGen](https://github.com/SwiftGen/SwiftGen) to conform to our coding guidelines for source code and generate accessors for assets. Please install these locally when contributing to the project, they are run automatically when you build.
|
||||
|
||||
# Reporting an issue
|
||||
|
||||
If you wish to report a security issue, please follow our [Responsible Disclosure guidelines](https://github.com/zcash/ZcashLightClientKit/blob/master/responsible_disclosure.md).
|
||||
|
||||
For other kind of inquiries, feel welcome to open an Issue if you encounter a bug or would like to request a feature.
|
||||
|
||||
# License
|
||||
|
||||
MIT
|
||||
|
|
|
|||
Loading…
Reference in New Issue