Tonomy-ID-integration

Developer environment to run Tonomy ID locally alongside a blockchain node, and the demo app.

All developers contributing to the project should check Contributors Guide and first check the Troubleshoot Guide if you have issues installing or running.

Environment details

Repositories

• Tonomy ID - Our expo (React Native) cross-platform mobile wallet for public & private Antelope blockchains.
  • Directory Structure
• SDK - typescript library used in Tonomy ID to interact and call with the Antelope blockchain and services.
  • Contracts (inside SDK repo) - Antelope smart contracts to run the governance, identity, DAO, token and other ecosystem tools.
  • Microservice (inside SDK repo) - nextjs peer to peer message broker for communication between different identities.
• Apps Websites
  • Accounts - A reactjs application to facilitate the SSO login with Tonomy ID to web apps
  • Developers Console - Tonomy Developers Console
  • Demo - A reactjs application to show demo flows with Tonomy ID and Tonomy ID SSO

Environment compatibility

• Linux debian distribution (Ubuntu 20.0.4 LTS used)

Hardware suggestions:

• 2 Gb RAM minimum
• 2 core minimum

Dependencies

In case you have problems here is a list of the dependencies

• Docker v20.10+
• Docker Compose v1.29+
• npm with corepack enabled v20+. Suggested to install with nvm v0.35+

Check out the file ./scripts/install_prerequisits.sh. This can be used as a guide to install all dependencies on an Ubuntu 18+ machine. Run the script line-by-line, as sometimes you need to exit terminal or restart your machine to continue.

Pre-run (one time)

In the Tonomy-ID repository you need to set up the expo build and install it on your phone. See instructions here

https://github.com/Tonomy-Foundation/Tonomy-ID/tree/development#pre-run-build-first-time-and-each-time-new-rn-only-packages-are-installed

Run

Follow these steps one by one & read them carefully. Do not rush through it.

• Clone the repo
• git checkout development
• ./app.sh and read what each command does
• ./app.sh gitinit
• ./app.sh install
• ./app.sh init
• Now, you can do one of the following;
• ./app.sh start
  • Open the installed Tonomy ID app downloaded from https://expo.dev (See #pre-run-one-time)
  • Check out the links shown
• ./app.sh log antelope
• ./app.sh stop or ./app.sh reset or ./app.sh reset all

See TROUBLESHOOT.md to fix common issues when running the app.

Test all

Run all the above steps up to and including ./app.sh install, then:

• ./app.sh link
• ./app.sh test

Environment variables

To run in staging or testnet or mainnet, use:

export NODE_ENV=staging
#or
export NODE_ENV=testnet
#or 
export NODE_ENV=production
#then
./app.sh start

Debugging

Uses debug package.

How to use:

• export DEBUG="tonomy*" all tonomy logs
• export DEBUG="tonomy-sdk*" all Tonomy ID SDK logs
• export DEBUG="tonomy-id*" all Tonomy ID logs
• export DEBUG="tonomy-app-websites*" all Tonomy App Website logs
• export DEBUG="tonomy-communication*" all Tonomy Communication logs

Other examples:

• export DEBUG="tonomy-sdk:services:communication:communication" to see all logs from the /Tonomy-ID-SDK/src/sdk/services/communication/communication.ts module
• export DEBUG="*" all debug logs from all installed packages
• export DEBUG="tonomy*,-tonomy-sdk*" all tonomy logs except for tonomy-id-sdk

DEBUG is set in ./scripts/helpers.sh:L142

Servers

See ./servers/README.md