Etherfi Sync Client

The Etherfi Sync Client is a tool designed to simplify the process of accessing validator keys for Node Operators who have won auctions.

Build and Use

go mod tidy
make
./etherfi-sync-clientv2

Remove files and executable

make clean

Remote Setup, Build, Use

On remote computer, make directory for sync client and curl the executable from url: https://github.com/GadzeFinance/etherfi-sync-clientv2/releases

# create directory and go inside it
mkdir sync-client
cd sync-client

# grab the executable from github
curl -LJO https://github.com/GadzeFinance/etherfi-sync-clientv2/releases/download/v1.0.4/<file-name-specified-in-release-table>

# unpack the executable
tar -xf <file-name-specified-in-release-table>

# make a new output directory for stake bids that have been won
mkdir output

# create configuration file
touch config.json

# edit the configuration file based on the config.json from here:
# https://github.com/GadzeFinance/etherfi-sync-clientv2/blob/master/config.json

{
  "GRAPH_URL": "",
  "BIDDER": "",
  "PRIVATE_KEYS_FILE_LOCATION": "",
  "OUTPUT_LOCATION": "",
  "PASSWORD": "",
  "IPFS_GATEWAY": ""
}

How to make a release

Checkout into the master branch
Run git pull origin master to make sure you have all the changes
Update the tag_name and release_name in .github/workflows/makerelease.yaml to the new version of the release
Commit your changes
Go to the actions page in the github repo
Click on Create Release with Binary in the side bar
Trigger the workflow using the Run Workflow button

Note: Pushes to the master branch will trigger a release