secant-ios-wallet/README.md

67 lines
2.8 KiB
Markdown
Raw Normal View History

# Zashi iOS Wallet
2021-08-24 11:05:54 -07:00
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).
2021-08-24 11:05:54 -07:00
# Beta Testing
2021-08-24 11:05:54 -07:00
The Zashi IOS wallet is currently in closed beta testing, and will be publicly
available from the Apple Store when testing is complete.
2021-08-24 11:05:54 -07:00
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).
2021-08-24 11:05:54 -07:00
# Reporting an issue
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).
2021-08-24 11:05:54 -07:00
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)
2021-08-24 11:05:54 -07:00
for more information about the security and privacy limitations of the wallet.
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)
2021-08-24 11:05:54 -07:00
# Contributing
2021-08-24 11:05:54 -07:00
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.
2021-08-24 11:05:54 -07:00
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.
2021-08-24 11:05:54 -07:00
## Installation of Swiftgen & Swiftlint on Apple Silicon-based hardware
2021-08-24 11:05:54 -07:00
### Swiftgen
Install it using homebrew
```
$ brew install swiftgen
```
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.
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
```