gofer

README

Gofer CLI Readme

As in a tool that specializes in the delivery of special items.

Gofer is a tool that provides asset prices taken from various sources.

The original documentation from Chronicle Labs may still provide a useful reference for those looking at this tool. Additional updates are expected to continue on the main README for this repository.

The original documentation can be found here

Installation

To install Gofer you'll first need Go installed on your machine. Then you can use standard Go command:

go install github.com/orcfax/oracle-suite/cmd/gofer@latest

Alternatively, you can build Gofer using Makefile directly from the repository. This approach is recommended if you wish to work on Gofer source.

git clone https://github.com/orcfax/oracle-suite.git
cd oracle-suite
make gofer-snapshot

Usage

Once downloaded, you can begin to explorer the utilities functionality by checking out the command-line options.

Usage:
  gofer [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  config      Render the config file
  data        Return data points for given models
  help        Help about any command
  models      List all supported models
  run         Run the main service
  version     print the version details

Flags:
  -c, --config strings                                 config file
  -h, --help                                           help for gofer
  -f, --log.format text|json                           log format (default text)
  -v, --log.verbosity panic|error|warning|info|debug   verbosity level (default info)
      --version                                        version for gofer

Use "gofer [command] --help" for more information about a command.

Basic QA for Orcfax

Orcfax builds on the work of Chronicle Labs by providing more information in data responses that can be audited. HTTP response headers and body are included in all results so the data trail can be verified.

To access this data easily via this tool, we can use jq using a command such as follows:

./gofer data ADA/USD ADA/EUR BTC/USD ETH/USD USDT/USD -o orcfax \
  | jq -r '.[].message.raw[].response'

Via this command we can confirm a response header and body exist for each collector, and understand their contents.

License

The GNU Affero General Public License