Execute payout transactions

CHANGELOG.md

@@ -12,6 +12,7 @@
 - Calculating reward distribution [\#124](https://github.com/NodeFactoryIo/vedran/pull/124) ([MakMuftic](https://github.com/MakMuftic))
 - Add payout CLI command [\#126](https://github.com/NodeFactoryIo/vedran/pull/126) ([MakMuftic](https://github.com/MakMuftic))
 - Support WS connections [#\132](https://github.com/NodeFactoryIo/vedran/pull/132) ([MakMuftic](https://github.com/MakMuftic))
+- Execute payout transactions [\#127](https://github.com/NodeFactoryIo/vedran/pull/127) ([MakMuftic](https://github.com/MakMuftic))
 
 ### Fix
 

README.md

@@ -64,6 +64,8 @@ Start command will start application on 2 ports that need to be exposed to publi
 
 `--auth-secret` authentication secret used for generating tokens
 
+`--wallet-secret` - loadbalancers wallet secret
+
 ### Most important flags
 
 `--server-port` - port on which RPC API is exposed  - **DEFAULT** [80]
@@ -84,9 +86,9 @@ Start command will start application on 2 ports that need to be exposed to publi
 
 `--capacity` - maximum number of nodes allowed to connect - **DEFAULT** [-1] unlimited capacity
 
-`--whitelist` - Comma separated list of node id-s, if provided only these nodes will be allowed to connect. This flag can't be used together with --whitelist-file flag, only one option for setting whitelisted nodes can be used - **DEFAULT** no nodes whitelisted
+`--whitelist` - comma separated list of node id-s, if provided only these nodes will be allowed to connect. This flag can't be used together with --whitelist-file flag, only one option for setting whitelisted nodes can be used - **DEFAULT** no nodes whitelisted
 
-`--whitelist-file` - Path to file with node id-s in each line that should be whitelisted. This flag can't be used together with --whitelist flag, only one option for setting whitelisted nodes can be used - **DEFAULT** no file used
+`--whitelist-file` - path to file with node id-s in each line that should be whitelisted. This flag can't be used together with --whitelist flag, only one option for setting whitelisted nodes can be used - **DEFAULT** no file used
 
 `--fee` - value between 0-1 representing fee percentage that loadbalancer will take - **DEFAULT** [0.1]
 
@@ -96,6 +98,33 @@ Start command will start application on 2 ports that need to be exposed to publi
 
 `--log-file` - path to file in which logs will be saved - **DEFAULT** [stdout]
 
+## Payouts
+
+### Automatic payout
+
+When starting _vedran loadbalancer_ it is possible to configure automatic payout by providing these flags:
+
+`--wallet-secret` - loadbalancers wallet secret
+
+`--payout-interval` - automatic payout interval specified as number of days
+
+`--payout-reward` - defined reward amount that will be distributed on the payout (amount in Planck)
+
+If all flags have been provided than each {_payout-interval_} days automatic payout will be started.
+
+### Manual payout
+
+It is possible to run payout script at any time by invoking `vedran payout` command trough console.
+This command has two required flags:
+
+`--secret` - loadbalancer wallet secret
+
+`--reward` - defined reward amount that will be distributed on the payout (amount in Planck)
+
+Additionally, it is possible to change url on which payout script will connect with loadbalancer when executing transactions by setting flag (default value will be _http://localhost:80_)
+
+`--load-balancer-url` - loadbalancer url
+
 ## Vedran loadbalancer API
 
 `POST   api/v1/nodes`

cmd/payout.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"github.com/NodeFactoryIo/vedran/internal/script"
+	"github.com/NodeFactoryIo/vedran/internal/ui"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"net/url"
@@ -49,7 +50,7 @@ func init() {
 	_ = payoutCmd.MarkFlagRequired("secret")
 	payoutCmd.Flags().StringVar(
 		&totalReward,
-		"total-reward",
+		"reward",
 		"",
 		"[REQUIRED] total reward pool in Planck",
 	)
@@ -65,10 +66,15 @@ func init() {
 func payoutCommand(_ *cobra.Command, _ []string) {
 	DisplayBanner()
 	fmt.Println("Payout script running...")
-	err := script.ExecutePayout(secret, totalRewardAsFloat64, loadbalancerURL)
+	transactions, err := script.ExecutePayout(secret, totalRewardAsFloat64, loadbalancerURL)
+	if transactions != nil {
+		// display even if only part of transactions executed
+		ui.DisplayTransactionsStatus(transactions)
+	}
 	if err != nil {
 		log.Errorf("Unable to execute payout, because of: %v", err)
 		return
+	} else {
+		log.Info("Payout execution finished")
 	}
-	log.Info("Payout execution finished")
 }

cmd/start.go

@@ -3,6 +3,8 @@ package cmd
 import (
 	"errors"
 	"fmt"
+	schedulepayout "github.com/NodeFactoryIo/vedran/internal/schedule/payout"
+	"net/url"
 	"strconv"
 	"strings"
 
@@ -33,6 +35,12 @@ var (
 	selection      string
 	serverPort     int32
 	publicIP       string
+	walletSecret   string
+	// payout related flags
+	payoutNumberOfDays         int32
+	payoutTotalReward          string
+	payoutTotalRewardAsFloat64 float64
+	autoPayoutDisabled         bool
 	// logging related flags
 	logLevel string
 	logFile  string
@@ -101,6 +109,23 @@ var startCmd = &cobra.Command{
 		if whitelistArray != nil && whitelistFile != "" {
 			return errors.New("only one flag for setting whitelisted nodes should be set")
 		}
+
+		if walletSecret == "" {
+			return errors.New("payout secret needs to be set")
+		}
+
+		autoPayoutDisabled = payoutNumberOfDays == 0 && payoutTotalReward == ""
+		if !autoPayoutDisabled {
+			if payoutNumberOfDays <= 0 {
+				return errors.New("invalid payout interval")
+			}
+			rewardAsFloat64, err := strconv.ParseFloat(payoutTotalReward, 64)
+			if err != nil {
+				return errors.New("invalid total reward value")
+			}
+			payoutTotalRewardAsFloat64 = rewardAsFloat64
+		}
+
 		return nil
 	},
 }
@@ -198,6 +223,26 @@ func init() {
 		"20000:30000",
 		"[OPTIONAL] Range of ports which is used to open tunnels")
 
+	startCmd.Flags().StringVar(
+		&walletSecret,
+		"wallet-secret",
+		"",
+		"[REQUIRED] Loadbalancer wallet secret",
+	)
+
+	startCmd.Flags().Int32Var(
+		&payoutNumberOfDays,
+		"payout-interval",
+		0,
+		"[OPTIONAL] Payout interval in days, meaning each X days automatic payout will be executed")
+
+	startCmd.Flags().StringVar(
+		&payoutTotalReward,
+		"payout-reward",
+		"",
+		"[REQUIRED] Total reward pool in Planck",
+	)
+
 	RootCmd.AddCommand(startCmd)
 }
 
@@ -231,6 +276,11 @@ func startCommand(_ *cobra.Command, _ []string) {
 	}
 	log.Debugf("Whitelisting set to: %t", whitelistEnabled)
 
+	if !autoPayoutDisabled {
+		lbUrl, _ := url.Parse("http://" + publicIP + ":" + string(serverPort))
+		schedulepayout.StartScheduledPayout(payoutNumberOfDays, walletSecret, payoutTotalRewardAsFloat64, lbUrl)
+	}
+
 	tunnel.StartHttpTunnelServer(tunnelServerPort, pPool)
 	loadbalancer.StartLoadBalancerServer(configuration.Configuration{
 		AuthSecret:          authSecret,
@@ -244,5 +294,6 @@ func startCommand(_ *cobra.Command, _ []string) {
 		TunnelServerAddress: tunnelServerAddress,
 		PortPool:            pPool,
 		WhitelistEnabled:    whitelistEnabled,
+		Secret:              walletSecret,
 	})
 }

go.mod

@@ -3,15 +3,18 @@ module github.com/NodeFactoryIo/vedran
 go 1.15
 
 require (
+	github.com/NodeFactoryIo/go-substrate-rpc-client v1.1.1-0.20201117130410-fe8589d08563
 	github.com/asdine/storm/v3 v3.2.1
 	github.com/cenkalti/backoff v2.2.1+incompatible
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
+	github.com/ethereum/go-ethereum v1.9.24 // indirect
 	github.com/golang/gddo v0.0.0-20200831202555-721e228c7686
 	github.com/gorilla/mux v1.8.0
-	github.com/gorilla/websocket v1.4.0
+	github.com/gorilla/websocket v1.4.1
+	github.com/gosuri/uitable v0.0.4
 	github.com/inconshreveable/go-vhost v0.0.0-20160627193104-06d84117953b
 	github.com/sirupsen/logrus v1.6.0
 	github.com/spf13/cobra v1.0.0
 	github.com/stretchr/testify v1.6.1
-	golang.org/x/net v0.0.0-20200625001655-4c5254603344
+	golang.org/x/net v0.0.0-20200822124328-c89045814202
 )