feat: interactive setup

.github/workflows/build.yml

@@ -53,7 +53,7 @@ jobs:
     name: Build binary launcher
     strategy:
       matrix:
-        go-version: [ 1.15.x ]
+        go-version: [ 1.16.x ]
         os: [ linux, darwin, windows ]
         arch: [ amd64, arm64 ]
         exclude:

.github/workflows/release.yml

@@ -29,7 +29,7 @@ jobs:
     name: Build artifacts
     strategy:
       matrix:
-        go-version: [ 1.15.x ]
+        go-version: [ 1.16.x ]
         os: [ linux, darwin, windows ]
         arch: [ amd64, arm64 ]
         exclude:

launcher/cmd/console.go

@@ -1,3 +1,23 @@
 package cmd
 
-// TODO console
+import (
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	rootCmd.AddCommand(consoleCmd)
+}
+
+var consoleCmd = &cobra.Command{
+	Use:   "console",
+	Short: "Start the console",
+	PreRunE: func(cmd *cobra.Command, args []string) error {
+		return launcher.Apply()
+	},
+	RunE: func(cmd *cobra.Command, args []string) error {
+		ctx, cancel := newContext()
+		defer cancel()
+		return launcher.StartConsole(ctx)
+	},
+}
+

launcher/cmd/root.go

@@ -14,7 +14,7 @@ import (
 var (
 	rootCmd = &cobra.Command{
 		Use:           "launcher",
-		Short:         fmt.Sprintf("XUD environment launcher"),
+		Short:         fmt.Sprintf("OpenDEX environment launcher"),
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}

launcher/cmd/setup.go

@@ -7,6 +7,7 @@ import (
 
 type SetupOptions struct {
 	NoPull bool
+	Interactive bool
 }
 
 var (
@@ -15,6 +16,7 @@ var (
 
 func init() {
 	setupCmd.PersistentFlags().BoolVar(&setupOpts.NoPull, "nopull", false, "don't pull images")
+	setupCmd.PersistentFlags().BoolVarP(&setupOpts.Interactive, "interactive", "i", false, "interactive setup")
 	rootCmd.AddCommand(setupCmd)
 }
 
@@ -28,6 +30,6 @@ var setupCmd = &cobra.Command{
 		ctx, cancel := newContext()
 		defer cancel()
 		ctx = context.WithValue(ctx, "rescue", false)
-		return launcher.Setup(ctx, !setupOpts.NoPull)
+		return launcher.Setup(ctx, !setupOpts.NoPull, setupOpts.Interactive)
 	},
 }

launcher/core/console/bash.go

@@ -0,0 +1,196 @@
+package console
+
+import (
+	"github.com/sirupsen/logrus"
+	"os"
+	"os/exec"
+)
+
+var logger = logrus.NewEntry(logrus.StandardLogger())
+
+var help = `\
+Opendex-cli shortcut commands
+  addcurrency <currency>                    add a currency
+  <swap_client> [decimal_places]
+  [token_address]
+  addpair <pair_id|base_currency>           add a trading pair
+  [quote_currency]
+  ban <node_identifier>                     ban a remote node
+  buy <quantity> <pair_id> <price>          place a buy order
+  [order_id]
+  closechannel <currency>                   close any payment channels with a
+  [node_identifier ] [--force]              peer
+  connect <node_uri>                        connect to a remote node
+  create                                    create a new opendexd instance and set a
+                                            password
+  discovernodes <node_identifier>           discover nodes from a specific peer
+  getbalance [currency]                     get total balance for a given
+                                            currency
+  getinfo                                   get general info from the local opendexd
+                                            node
+  getnodeinfo <node_identifier>             get general information about a
+                                            known node
+  listcurrencies                            list available currencies
+  listorders [pair_id] [owner]              list orders from the order book
+  [limit]
+  listpairs                                 get order book's available pairs
+  listpeers                                 list connected peers
+  openchannel <currency> <amount>           open a payment channel with a peer
+  [node_identifier] [push_amount]
+  orderbook [pair_id] [precision]           display the order book, with orders
+                                            aggregated per price point
+  removecurrency <currency>                 remove a currency
+  removeorder <order_id> [quantity]         remove an order
+  removepair <pair_id>                      remove a trading pair
+  restore [backup_directory]                restore an opendexd instance from seed
+  sell <quantity> <pair_id> <price>         place a sell order
+  [order_id]
+  shutdown                                  gracefully shutdown local opendexd node
+  streamorders [existing]                   stream order added, removed, and
+                                            swapped events (DEMO)
+  tradehistory [limit]                      list completed trades
+  tradinglimits [currency]                  trading limits for a given currency
+  unban <node_identifier>                   unban a previously banned remote
+  [--reconnect]                             node
+  unlock                                    unlock local opendexd node
+  walletdeposit <currency>                  gets an address to deposit funds to
+                                            opendexd
+  walletwithdraw [amount] [currency]        withdraws on-chain funds from opendexd
+  [destination] [fee]
+
+General commands
+  report                                    report issue
+  logs                                      show service log
+  start                                     start service
+  stop                                      stop service
+  restart                                   restart service
+  up                                        bring up the environment
+  help                                      show this help
+  exit                                      exit opendexd-ctl shell
+
+CLI commands
+  bitcoin-cli                               bitcoind cli
+  litecoin-cli                              litecoind cli
+  lndbtc-lncli                              lnd cli
+  lndltc-lncli                              lnd cli
+  geth                                      geth cli
+  opendex-cli                                     opendexd cli
+  boltzcli                                  boltz cli
+
+Boltzcli shortcut commands  
+  boltzcli <chain> deposit 
+  --inbound [inbound_balance]               deposit from boltz (btc/ltc)
+  boltzcli <chain> withdraw 
+  <amount> <address>                        withdraw from boltz channel
+`
+
+func writeInitScript(network string, f *os.File) {
+	f.WriteString(`\
+export NETWORK=` + network + `
+export PS1="$NETWORK > "
+function help() {
+	echo "` + help + `"
+}
+function start() {
+	docker start ${NETWORK}_${1}_1 
+}
+function stop() {
+	docker stop ${NETWORK}_${1}_1
+}
+function restart() {
+	docker restart ${NETWORK}_${1}_1
+}
+function down() {
+	echo "Not implemented yet!"
+}
+function logs() {
+	docker logs --tail=100 ${NETWORK}_${1}_1
+}
+function report() {
+	cat <<EOF
+Please click on https://github.com/opendexnetwork/opendexd/issues/\
+new?assignees=kilrau&labels=bug&template=bug-report.md&title=Short%2C+concise+\
+description+of+the+bug, describe your issue, drag and drop the file "${NETWORK}\
+.log" which is located in "{logs_dir}" into your browser window and submit \
+your issue.
+EOF
+}
+function opendex-cli() {
+	docker exec -it ${NETWORK}_opendexd_1 opendex-cli $@
+}
+function lndbtc-lncli() {
+	docker exec -it ${NETWORK}_lndbtc_1 lncli -n ${NETWORK} -c bitcoin $@
+}
+function lndltc-lncli() {
+	docker exec -it ${NETWORK}_lndltc_1 lncli -n ${NETWORK} -c litecoin $@
+}
+function geth() {
+	docker exec -it ${NETWORK}_geth_1 geth $@
+}
+function bitcoin-ctl() {	
+	if [[ $NETWORK == "testnet" ]]; then
+		docker exec -it ${NETWORK}_bitcoind_1 -testnet -user xu -password xu bitcoind $@
+	else
+		docker exec -it ${NETWORK}_bitcoind_1 -user xu -password xu bitcoind $@
+	fi
+}
+function litecoin-ctl() {
+	if [[ $NETWORK == "testnet" ]]; then
+		docker exec -it ${NETWORK}_litecoind_1 -testnet -user xu -password xu litecoind $@
+	else
+		docker exec -it ${NETWORK}_litecoind_1 -user xu -password xu litecoind $@
+	fi
+}
+function boltzcli() {
+	docker exec -it ${NETWORK}_boltz_1 wrapper $@
+}
+
+alias getinfo='opendex-cli getinfo'
+alias addcurrency='opendex-cli addcurrency'
+alias addpair='opendex-cli addpair'
+alias ban='opendex-cli ban'
+alias buy='opendex-cli buy'
+alias closechannel='opendex-cli closechannel'
+alias connect='opendex-cli connect'
+alias create='opendex-cli create'
+alias discovernodes='opendex-cli discovernodes'
+alias getbalance='opendex-cli getbalance'
+alias getnodeinfo='opendex-cli getnodeinfo'
+alias listcurrencies='opendex-cli listcurrencies'
+alias listorders='opendex-cli listorders'
+alias listpairs='opendex-cli listpairs'
+alias listpeers='opendex-cli listpeers'
+alias openchannel='opendex-cli openchannel'
+alias orderbook='opendex-cli orderbook'
+alias removeallorders='opendex-cli removeallorders'
+alias removecurrency='opendex-cli removecurrency'
+alias removeorder='opendex-cli removeorder'
+alias removepair='opendex-cli removepair'
+alias restore='opendex-cli restore'
+alias sell='opendex-cli sell'
+alias shutdown='opendex-cli shutdown'
+alias streamorders='opendex-cli streamorders'
+alias tradehistory='opendex-cli tradehistory'
+alias tradinglimits='opendex-cli tradinglimits'
+alias unban='opendex-cli unban'
+alias unlock='opendex-cli unlock'
+alias walletdeposit='opendex-cli walletdeposit'
+alias walletwithdraw='opendex-cli walletwithdraw'
+`)
+}
+
+func startBash() error {
+	network := os.Getenv("NETWORK")
+	f, err := os.CreateTemp(os.TempDir(), "init.*.bash")
+	if err != nil {
+		logger.Errorf("Failed to write init.bash: %s", err)
+		return nil
+	}
+	defer f.Close()
+	writeInitScript(network, f)
+	c := exec.Command("bash", "--init-file", f.Name())
+	c.Stdin = os.Stdin
+	c.Stdout = os.Stdout
+	c.Stderr = os.Stderr
+	return c.Run()
+}

launcher/core/console/console.go

@@ -0,0 +1,43 @@
+package console
+
+import (
+	"fmt"
+	"runtime"
+)
+
+const (
+	DefaultBanner = `
+             .___                         __  .__   
+           __| _/____ ___  ___      _____/  |_|  |  
+          / __ |/ __ \\  \/  /    _/ ___\   __\  |  
+         / /_/ \  ___/ >    <     \  \___|  | |  |__
+         \____ |\___  >__/\_ \     \___  >__| |____/
+              \/    \/      \/         \/           
+
+--------------------------------------------------------------
+`)
+
+type Console struct {
+	Banner string
+	ShowBanner bool
+}
+
+var DefaultConsole *Console
+
+func init() {
+	DefaultConsole = &Console{
+		Banner: DefaultBanner,
+		ShowBanner: true,
+	}
+}
+
+func (t *Console) Start() error {
+	if t.ShowBanner {
+		fmt.Println(t.Banner)
+	}
+	if runtime.GOOS == "windows" {
+		return startPowershell()
+	} else {
+		return startBash()
+	}
+}

launcher/core/console/powershell.go

@@ -0,0 +1,5 @@
+package console
+
+func startPowershell() error {
+	return nil
+}

launcher/core/launcher.go

@@ -2,11 +2,13 @@ package core
 
 import (
 	"bufio"
+	"context"
 	"crypto/tls"
 	"errors"
 	"fmt"
 	"github.com/iancoleman/strcase"
 	"github.com/mitchellh/go-homedir"
+	"github.com/opendexnetwork/opendex-docker/launcher/core/console"
 	"github.com/opendexnetwork/opendex-docker/launcher/log"
 	"github.com/opendexnetwork/opendex-docker/launcher/service/arby"
 	"github.com/opendexnetwork/opendex-docker/launcher/service/bitcoind"
@@ -51,6 +53,7 @@ type Launcher struct {
 	ConfigFile        string
 
 	PasswordUnsetMarker string
+	BackupUnsetMarker   string
 	ExternalIp          string
 
 	rootCmd *cobra.Command
@@ -59,6 +62,8 @@ type Launcher struct {
 	rootLogger *logrus.Logger
 
 	LogFile *os.File
+
+	Console *console.Console
 }
 
 func defaultHomeDir() (string, error) {
@@ -208,6 +213,7 @@ func NewLauncher() (*Launcher, error) {
 			return nil, err
 		}
 	}
+	backupUnsetMarker := filepath.Join(networkDir, ".backup-unset")
 
 	backupDir := getBackupDir(networkDir, dockerComposeFile)
 	defaultBackupDir := getDefaultBackupDir(networkDir)
@@ -237,13 +243,15 @@ func NewLauncher() (*Launcher, error) {
 		DockerComposeFile:   dockerComposeFile,
 		ConfigFile:          configFile,
 		PasswordUnsetMarker: passwordUnsetMarker,
+		BackupUnsetMarker:   backupUnsetMarker,
 		ExternalIp:          externalIp,
 		client: &http.Client{
 			Transport: &http.Transport{
 				TLSClientConfig: &config,
 			},
 		},
 		LogFile: f,
+		Console: console.DefaultConsole,
 	}
 
 	l.Services, l.ServicesOrder, err = initServices(&l, network)
@@ -545,3 +553,7 @@ func (t *Launcher) GetDataDir() string {
 func (t *Launcher) Close() {
 	_ = t.LogFile.Close()
 }
+
+func (t *Launcher) StartConsole(ctx context.Context) error {
+	return t.Console.Start()
+}