Skip to content

README.md

Latest commit

 

History

History
164 lines (106 loc) · 7.67 KB

README.md

File metadata and controls

164 lines (106 loc) · 7.67 KB

Verus Mobile

The iOS/Android Verus Mobile multi-coin Wallet

Welcome to the Verus Mobile multi-currency crypto wallet test release! This mobile wallet will be the core code base going forward for the Verus mobile experience, including PBaaS and crypto application support in the future. The features currently included are:

•Multiple account support, the ability to use different keys on the same phone

•VerusPay QR scanner integration, allowing users to go from scanning a Verus QR code to being prompted with a transaction to confirm in one step

•Support for 11 different coins, with more to come soon

•The ability to create VerusPay invoices compatible with the Verus Mobile app

Feel free to report any discovered bugs, issues, or suggestions by either publicly asking for community support on one of our mobile channels at https://discord.gg/VRKMP2S, or, for more discretion, emailing development@veruscoin.io.

Privacy Statement

No personal data is stored or collected by the Verus Mobile application, except as necessary for authentication. All authentication data is stored locally.

The Verus Mobile application uses the following permissions for the following reasons:

•Internet connectivity: In order to fetch and post data and communicate with the blockchain through Electrum servers, the app requires internet connectivity. The signing of transactions is done locally and private keys are not shared over any network.

•Access to system alerts: In order to notify the user of important ongoing events while using the Verus Mobile application, the Verus Mobile application uses the system alert framework on both iOS and Android.

•Camera and Audio access: The Verus Mobile application's VerusPay QR code scanner is designed to read and parse VerusQR codes, or VerusPay invoices through the camera, and requires camera access to work properly. The user will be prompted to allow camera access upon first opening the VerusPay feature. Due to the current constraints of the library being used for VerusPay, the user will be asked to enable audio by default when starting VerusPay for the first time. Choosing to disable audio should in no way affect VerusPay's functionality.

•Permission to vibrate the mobile device: The Verus Mobile application uses the vibration feature of the mobile device it is running on for VerusPay, in order to give feedback upon the scan of a QR code invoice.

•Permission to read/write to phone memory: The Verus Mobile application uses the mobile devices AsyncStorage memory storage to hold encrypted account data while the application isn't running.

Disclaimer

THIS IS EXPERIMENTAL SOFTWARE AND IT IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Build Instructions

Android (on Ubuntu)

  1. Clone GitHub repository, and cd into it

  2. Install Android Studio

  • Required SDK Components:
    • Android SDK 35 (33 or higher will work)
    • System Image for Emulator (Intel x86_64)
    • NDK version 27.0.12077973 (or change gradle.properties to match your precise version)

2a. Add ANDROID_HOME to ~/.bashrc (tested on Meerkat Release of Android Studio)

echo "export ANDROID_HOME=$HOME/Android/Sdk" >> ~/.bashrc

2b. If on Koala Release of Android Studio, these lines may be necessary instead:

echo "export ANDROID_SDK_ROOT=$HOME/Android/Sdk" >> ~/.bashrc
echo "export PATH=$PATH:$ANDROID_SDK_ROOT/emulator" >> ~/.bashrc
echo "export PATH=$PATH:$ANDROID_SDK_ROOT/platform-tools" >> ~/.bashrc

(Would advise checking if the lines are already present in file, personally)

  1. Install openjdk-17-jdk package

  2. Install nvm, select and use v18.14

# from https://github.com/nvm-sh/nvm?tab=readme-ov-file#install--update-script

# install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash

# install version 18.14
nvm install 18.14

# use 18.14. You will need to do this before you run `yarn` in any new terminals
nvm use 18.14

  1. Enable corepack with corepack enable for access to yarn commands

  2. Install rustup, and rust toolchain 1.81.0

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup toolchain install 1.81.0
rustup default 1.81.0
  1. Clone verus-android-wallet-sdk (master branch) repository, build and publish Maven artifacts locally, with steps below
cd ~
git clone https://github.com/VerusCoin/verus-android-wallet-sdk.git
cd verus-android-wallet-sdk

# stop here and open verus-android-wallet-sdk repo in Android studio, to download gradle with proper versions

# On Ubuntu 22.04 and later, if 'python' cmd does not map to python2.7, create a local.properties, so rust can locate it
echo "rust.pythonCommand=/usr/bin/python2" >> local.properties

# then run gradle wrapper to generate local Maven artifacts
./gradlew publishToMavenLocal

# this will install the artifacts locally in ~/.m2/repository/com/github/VerusCoin/verus-android-sdk` etc by module

  1. Run yarn install

  2. Open a separate withdow and run yarn start or npx react-native start

  3. Build and install by running yarn android

iOS (on macOS)

  1. Clone the GitHub repository and cd into it with a terminal window

  2. Install Xcode and the Xcode command line build tools (version >= 14.0.1)

  3. Install homebrew (version >= 3.6.14)

  4. Install rbenv to manage your ruby versions with brew install rbenv ruby-build

  5. Run rbenv init, rbenv install 3.4.1 and rbenv global 3.4.1

  • You may also need to edit ~/.zprofile to include rbenv path before system paths:
echo 'eval "$(export PATH=$HOME/.rbenv/shims:$PATH)"' >> $HOME/.zprofile

  1. Install cocoapods (version >= 1.11.3)

  2. Install node (version >= 16.14.1 - tested up to 18.14)

via Node Version Manager:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
nvm install 18.14
nvm use 18.14
  1. Install yarn (version >= 1.22.19)
nvm use 18.14
corepack enable

  1. Run yarn install

  2. Run cd ios && pod install, then if successful, cd ..

  3. Setup a rust development environment by installing sourcery with brew install sourcery, curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh, cargo install cargo-lipo, and installing rustup

  4. Run rustup target add aarch64-apple-ios x86_64-apple-ios aarch64-apple-ios-sim

  5. open in ios/verusmobile.xcworkspace in Xcode (DO NOT OPEN THE XCODEPROJ FILE)

  6. Run yarn bundle-ios

  7. Run yarn start in a terminal window within the Verus-Mobile directory

  8. Build the project in Xcode, or with yarn ios

Troubleshooting

Build error containing "Permission Denied"

If Xcode fails to build with an error mentioning "permission denied", try setting user permissions on iOS/Pods/ZcashLightClientKit/ZcashLightClientKit/zcashlc/zcashlc.h to read/write and re-building through Xcode

Failure to compile using cargo lipo --manifest-path

If Xcode fails to compile the Rust component correctly, you will get an error stating that a command starting with cargo lipo --manifest-path failed to execute. Try copying that command in its entirety and running it in a local terminal window. If that succeeds, rebuild through Xcode.