zcash-ios-wallet

Motivation

Dogfooding - transitive verb - is the practice of an organization using its own product. This app was created to help us learn.

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 infrasturcture or user support for this application. We open sourced it as a resource to make wallet development easier for the Zcash ecosystem.

Description

iOS wallet using the Zcash iOS SDK that is maintained by core developers.

There are some known areas for improvement:

Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user.
The wallet might display inaccurate transaction information if it is connected to an untrustworthy server.

See the Wallet App Threat Model for more information about the security and privacy limitations of the wallet.

Prerequisites

make sure you can build ZcashLightClientKit Demo Apps successfully

Building the App

Clone the project, make sure you have the latest Xcode Version
Create env-vars.sh file at ${SRCROOT} See Instructions
make sure that your environment has the variable ZCASH_NETWORK_ENVIRONMENT set toMAINNETor TESTNET.
Navigate to the wallet directory where the Podfile file is located and run pod install
open the wallet.xcworkspace file
locate the .params files that are missing in the project and include them at the specified locations
build and run on simulator.

To Log or not to Log

This is our internal dogfooding app, and we implemented some level of event logging to be able to study user interactions and improve the User Experience with Zcash on mobile devices.

No Logs please

You can build and run the app without it by using the wallet-no-logging

The "no logging" target does not even build or include the Mixpanel sdk on your build or any code related with it. You can make sure of this by looking at the code yourself. If you think there's a better way achieve this, please open an Issue with your proposal. :-)

I want to use Mixpanel

If you wish to use mixpanel in your own build, make sure to include the following line in your env-vars.sh file export MIXPANEL_TOKEN="YOUR_TOKEN" And build the wallet target. Sourcery will pick it up and generate the Constants.generated.swift file that the Mixpanel SDK will use to send the events to your board

I use some other kind of tracker...

that I would like to include in my project. The app does not care about the details of the event logger as long as it implements this protocol

protocol EventLogging {
    func track(_ event: LogEvent, properties: KeyValuePairs<String, String>)
}

You can implement your own tracker proxy

Troubleshooting

No network environment....

if you see this message when building: No network environment. Set ZCASH_NETWORK_ENVIRONMENT to MAINNET or TESTNET make sure your dev environment has this variable set before the build starts. DO NOT CHANGE IT DURING THE BUILD PROCESS.

If the variable was properly set after you've seen this message, you will need to either a) set it manually on the pod's target or b) doing a clean pod install and subsequent build.

a) setting the flag manually

on your workspace, select the Pods project
on the Targets pane, select ZcashLightClientKit
go to build settings
scroll down to see ZCASH_NETWORK_ENVIRONMENT and complete with TESTNET or MAINNET

jellehelsen / zcash-ios-wallet