arkgopool

README

ARK-GO Client Demo Usage

This app is just to show the basic usage of ark-go library. The app functionalities are currently targeted at delegate functionalities, but from code various API calls can be seen. Further functionalities will be added based on community feature requests.

See the demo console app shell recording here: https://asciinema.org/a/5yndxl794ncfpmjoqftuaiodm?t=8.

To see all the calls and usage of ARK-GO client library check the name_test.go classes in the core package!

ArkGo-Gui functionalities include:

• Sample config: settings/sample.config.toml. Copy file to config.toml for productive config. (cp sample.config.toml config.toml)
• Setting up delegate preferences in settings/config.toml. User can set his delegate address, sharing rations for voters and reward fund.
• Checking vote weight by voters, displaying fidelity in hoours and see the precalculated rewards before Sending.
• Manually sending the reward to users.
• Network switching (application can run on MAINNET as well as on DEVNET).
• Linking account for automated payments.
• Running in silent mode - to process automated reward payments to voters.
• Logging and overview of succesfull payments in a separate timestamped csv file, linked with sent and confirmed transactionsID from the blockchain (fields: Recepient, Amount, TimeStamp, TxID, VoteWieght).

Application was developed to help testing of the core library and to provide a tool for delegates to process automated payments/ or just manual payments.

Short guide

Run from source

$> cd $GOPATH/src/github.com/kristjank/ark-go/cmd/arkgopool
$> go run arkgo-gui.go

Build

$> cd $GOPATH/src/github.com/kristjank/ark-go/cmd/arkgopool
$> go build

Run in Windows

$> cd $GOPATH/src/github.com/kristjank/ark-go/cmd/arkgopool
$> ./arkgo-gui.exe

Run in Linux

$> cd $GOPATH/src/github.com/kristjank/ark-go/cmd/arkgopool
$> ./arkgopool

Configuration

$> cd arkgopool/settings
$> cp sample.config.toml config.toml
$> nano config.toml

Complete installation guide (ubuntu)

You will have to slightly adapt it to use the latest version. (Golang Download: https://golang.org/dl/)

$> curl -O https://storage.googleapis.com/golang/go1.8.3.linux-amd64.tar.gz
$> tar xvf go1.8.3.linux-amd64.tar.gz
$> sudo chown -R root:root ./go
$> sudo mv go /usr/local
$> sudo nano ~/.profile

Add at the end of the files:

export GOPATH=$HOME/work
export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin

Save the files.

$> source ~/.profile
$> mkdir work
$> go get github.com/kristjank/ark-go
$> cd ~/work/src/github.com/kristjank/ark-go
$> go get ./...
$> cd ~/work/src/github.com/kristjank/ark-go/cmd/arkgopool
$> go build
$> cd
$> ln -s ~/work/src/github.com/kristjank/ark-go/cmd/arkgopool arkgopool

Now you can run with:

$> cd arkgopool
$> ./arkgopool

Create and edit config.toml to define your own settings.

$> cd arkgopool/settings
$> cp sample.config.toml config.toml
$> nano config.toml

How to automate payment run

First, make sure that you did link your account. (Option 4)

Create a folder paymentlog in arkgopool:

$> cd arkgopool
$> mkdir paymentlog

Create such a file go-payment.sh in home:

#!/bin/bash
cd ~/work/src/github.com/kristjank/ark-go/main
./arkgopool -silent=true
mv paymentLog.csv paymentlog/$(date -d "today" +"%Y%m%d-%H.%M.%S")payments.log

Make it executable:

$> chmod +x go-payment.sh

Open crontab:

$> crontab -e

Add a line at the top (replace ~ with your absolute root path):

GOPATH=~/work

Add a line at the end and an empty line behind:

30 17 * * * ~/go-payment.sh

Save and now your payments will done automatic every day. Enjoy!

Thank you for checking in.

For more information about ark-go see the core package. That is where it all happens: /core

Authors

Chris (kristjan.kosic@gmail.com), with a lot of help from FX Thoorens fx@ark.io and ARK Community

Contributors

Jarunik (jens@hviid.ch), with a lot of help from Chris

Support this project

Ark address:AUgTuukcKeE4XFdzaK6rEHMD5FLmVBSmHk

License

Copyright (c) 2017 ARK, chris

--chris