search

Tonomy-Foundation / Tonomy-ID

Tonomy ID is the cross-platform mobile wallet (Android and iOS) for public and private Antelope blockchains. This application allows you to sign transactions on the block chain, share your DID and Verifiable Credentials containing your identity with others in a consensual way and log into web2 and web3 applications.
Apache License 2.0
13 stars 1 forks source link
android blockchain eosio ios mobile recovery ssi wallet

readme

Tonomy-ID

Tonomy ID is the cross-platform mobile wallet (Android and iOS) for public and private Antelope blockchains. This application allows you to sign transactions on the block chain, share your DID and Verifiable Credentials containing your identity with others in a consensual way and log into web2 and web3 applications. If you lose your phone several mechanisms exist to allow you to recover your account without trusting anyone with custody of your private keys.

Tonomy ID is a React Native application in typescript.

Dependencies

MAKE SURE YOU ARE WORKING FROM THE DEVELOPMENT BRANCH!!!

Install

MAKE SURE YOU ARE WORKING FROM THE DEVELOPMENT BRANCH!!!

yarn

Pre-run build (first time and each time new RN only packages are installed)

This is to create an expo build so you can down an .apk or .ipa file from https://expo.dev which you can use to run the app. You can't Run from the Official Expo App.

  1. Create an expo account to build the app. https://expo.dev/signup
  2. (for first time build only) export EXPO_FIRST_TIME=true
  3. (for every time after first time only) Change the value of "projectId" in prepare.app.config.ts to the vale of the "Project ID" in https://expo.dev
  4. (for IOS only) Run yarn run build:ios:create to create a device profile for your phone
  5. Run yarn run build:ios (ios) or yarn run build:android (android) to build the app for your phone
  6. Return to https://expo.dev/ and click on the Tonomy ID project build and download the App.
  7. Install the created app on your phone.

Having issues here or running the app? Checkout:

https://github.com/Tonomy-Foundation/Tonomy-ID-Integration/blob/development/TROUBLESHOOT.md

Run

MAKE SURE YOU ARE WORKING FROM THE DEVELOPMENT BRANCH!!!

You NEED to follow the above Pre-run build steps above before you can start the app!

yarn run start

Run with the Staging / Demo environment and build

Testing Staging / Demo Tonomy ID locally without needing to wait for deploy to Play store. This has the advantage of being able to see logs inside Tonomy ID as it runs

  1. Change to "appName": "Tonomy ID Development" in config.staging.json or config.demo.json
  2. Run EXPO_NODE_ENV=staging yarn run start or EXPO_NODE_ENV=demo yarn run start
  3. Connect via QR and bundle and load the app
  4. Scroll down >> "Open React Native dev men"
  5. Click "Settings"
  6. Turn ON "JS Minify"
  7. Turn OFF "JS Dev Mode"
  8. Reload

This is now running in production mode connected to the staging environment.

Run Staging or Demo and see debug logs (Android only)

  1. Install adb on your pc (https://dl.google.com/android/repository/platform-tools-latest-windows.zip)
  2. Put the location of the folder inside Path env system variable or you can navigate to the folder and call adb.exe directly
  3. Run adb logcat *:S ReactNative:V ReactNativeJS:V or ./adb.exe logcat*:S ReactNative:V ReactNativeJS:V in the command line to catch debug messages of reactNative only. Try adb logcat -s ReactNative:V ReactNativeJS:V if that doesn't work.
  4. Enable developer mode on your phone.
  5. Enable USB debug on your phone.
  6. Connect your phone to the pc with a usb cable.
  7. Open the the react native app you want to debug.

Update the Tonomy-ID-SDK version to the latest

yarn run updateSdkVersion development
# or
yarn run updateSdkVersion master

File structure of components

https://learn.habilelabs.io/best-folder-structure-for-react-native-project-a46405bdba7

Configuration and environment variables

Set the configuration variables in the desired file in ./src/config

config.json is used by default. Staging config file is choosing based on the value of environment variable EXPO_NODE_ENV

Values for EXPO_NODE_ENV

Values for EXPO_PLATFORM

Other environment variables override the values in the config file:

Linting

Linting is done with eslint. Install the recommended VS Code plugin to see markers in your code.

yarn run lint

Error handling

See errors.ts. All errors have a registered unique code enum.

Common errors and how to fix

Origin not found

You might be running in stand-alone mode and trying to complete the SSO loin flow. This is not possible stand-alone mode.

FIX: Run Tonomy ID using ./app.sh with the Tonomy ID Integration repository.

Releases

Release versioning is done automatically with https://github.com/marketplace/actions/automated-version-bump. This will do a major, minor or patch release based on words in the commits. See Workflow for details.