Skip to content

Commit

Permalink
restructure (#17)
Browse files Browse the repository at this point in the history
refactored the project to be a more idiomatic go
Co-authored-by: Brice Aldrich <[email protected]>
  • Loading branch information
DefinitelyNotAGoat authored May 2, 2020
1 parent b1df84d commit 01b36c5
Show file tree
Hide file tree
Showing 160 changed files with 3,466 additions and 14,307 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
PROJECT_NAME := "tzpay"
VERSION := "v2.0.0"
VERSION := "v2.5.0-alpha"
PKG := "github.com/goat-systems/$(PROJECT_NAME)"
PKG_LIST := $(shell go list ${PKG}/... | grep -v /vendor/)
GO_FILES := $(shell find . -name '*.go' | grep -v /vendor/ | grep -v _test.go)
Expand Down
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ go get -u github.com/goat-systems/tzpay/v2

### Linux
```
wget https://github.com/goat-systems/tzpay/releases/download/v2.3.0-alpha/tzpay_linux_amd64
wget https://github.com/goat-systems/tzpay/releases/download/v2.5.0-alpha/tzpay_linux_amd64
sudo mv tzpay_linux_amd64 /usr/local/bin/tzpay
sudo chmod a+x /usr/local/bin/tzpay
```
Expand All @@ -30,14 +30,7 @@ docker run --rm -ti goatsystems/tzpay:latest tzpay [command] \

## Usage

### Initializing

tzpay uses boltdb to safely store your edesk. You're edesk will be aes encrypted with you're wallet password as the key.
In order for tzpay to intialize this database you must first run tzpay with the `TZPAY_WALLET_SECRET` enviroment variable.

`TZPAY_WALLET_SECRET` should be set to the edesk of your wallet. On the first run, tzpay will store the secret with aes encryption, and then remove the enviroment variable from the enviroment. It is recommend that you export this in your shell on your first run, so that it doesn't persist in a file somewhere.

On you're first run you should have the following enviroment variables:
### Required Enviroment Variables
```
TZPAY_HOST_NODE=<TODO (e.g. http://127.0.0.1:8732)>
TZPAY_BAKERS_FEE=<TODO (e.g. 0.05 for 5%)>
Expand All @@ -46,22 +39,12 @@ TZPAY_WALLET_SECRET=<TODO (e.g. edesk...)>
TZPAY_WALLET_PASSWORD=<TODO (e.g. password)>
```


### Required Enviroment Variables After Initialization
```
TZPAY_HOST_NODE=<TODO (e.g. http://127.0.0.1:8732)>
TZPAY_BAKERS_FEE=<TODO (e.g. 0.05 for 5%)>
TZPAY_DELEGATE=<TODO (e.g. tz1SUgyRB8T5jXgXAwS33pgRHAKrafyg87Yc)>
TZPAY_WALLET_PASSWORD=<TODO (e.g. password)>
```

### Optional Enviroment Variables
```
TZPAY_BLACKLIST=<TODO (e.g. tz1W3HW533csCBLor4NPtU79R2TT2sbKfJDH, tz1W3HW533csCBLor4NPtU79R2TT2sbKfjh7)>
TZPAY_BLACKLIST=<TODO (e.g. some_blacklist_file.json)>
TZPAY_NETWORK_GAS_LIMIT=<TODO (e.g. 30000)>
TZPAY_NETWORK_FEE=<TODO (e.g. 3000)>
TZPAY_MINIMUM_PAYMENT=<TODO (e.g. 3000)>
TZPAY_BOLT_DB=<TODO (e.g. ~/home/apps/.tzpay/tzpay.db)>
```

### Help
Expand Down
250 changes: 0 additions & 250 deletions cli/internal/baker/baker.go

This file was deleted.

Loading

0 comments on commit 01b36c5

Please sign in to comment.