Skip to content

Latest commit

 

History

History
146 lines (94 loc) · 3.44 KB

README.md

File metadata and controls

146 lines (94 loc) · 3.44 KB
Raw

tdex-app

📱 Mobile app for making trades on TDEX

Table of Contents

  1. Install
  2. Development
  3. Release

Install

Development

Below is a list of commands you will probably find useful for development.

Expose ElectrumX endpoints through websocket

For now Nigiri doesn't support websocket connections to ElectrumX. But you can use

$ docker run --net=nigiri -d -p 1234:1234 ghcr.io/vi/websocat:0.11.0 -b ws-l:0.0.0.0:1234 tcp:electrs-liquid:50001

yarn serve

Runs the project in development/watch mode in the browser. Your project will be rebuilt upon changes.

yarn build

Transpile TypeScript and bundles the app for production to the build folder.

yarn android

Runs the app on the Emulator with target Android

yarn ios

Runs the app on the Simulator with target iOS

yarn lint

Runs eslint on the whole project

Run with a regtest TDex Daemon

Requirements

  • Docker/compose

Nigiri

First, you need a Liquid regtest node to simulate a blockchain enviroment. The fastest way is to download and install Nigiri CLI

  • Download and install nigiri command line interface
$ curl https://getnigiri.vulpem.com | bash
  • Close and reopen your terminal, then start Bitcoin and Liquid
$ nigiri start --liquid

That's it. Quickly inspect the Liquid blockchain on http://localhost:5001 for Liquid. The Esplora REST API interface is on http://locahost:3001

TDex Daemon

  • Pull the tdex daemon container
$ docker pull ghcr.io/tdex-network/tdexd:latest
  • Run on Regtest connecting to Nigiri explorer and using regtest LBTC asset hash and mint USDt
$ yarn tdex:run
  • Clean
$ yarn tdex:clean

Pegin in regtest

  • Change elements configuration by adding fedpegscript=51210269e0180bc9e0be7648d6e9c17f3664bc3ebcee40f3a46cf4b42e583e96b911b951ae and commenting initialfreecoins=2100000000000000 Otherwise you should get error {"code":-26,"message":"pegin-no-witness,nopeg-inwitnessattached"}

  • Change LBTC_ASSET[network].assetHash in ./src/utils/constants.ts to 056293ee681516f2d61bb7ce63030351d5e02d61aef9fb00d30f27f55d935b18

$ nigiri start --liquid
  • Generate coins for testing
$ ./script/pegin.sh

Release

Requirements

  • xCode
  • Android Studio
  • fastlane brew install fastlane

Internal testing

For internal releases (Testflight or debug APK):

  • iOS: build on local machine with fastlane and upload to TestFlight
    • yarn build:ios
    • fastlane ios beta (this will increment build number only)
  • Android: APK build on local machine with fastlane
    • yarn build:android
    • fastlane android apk

Stores

To release to stores:

  • run tag.sh to make a new git tag, increments iOS & Android projects and push it to master
  • iOS: build on local machine with fastlane and upload to AppStore
    • yarn build:ios
    • fastlane ios prod
  • Android: APK build on local machine with fastlane
    • yarn build:android
    • fastlane android prod
  • The git tag will trigger release.yml to create a Github Release.