Generate the License Key-Pair

You will learn to generate the public/secret key-pair that you need to authenticate the gateways.

Introduction

There are different ways to use Roq’s software

  • You can download and use any of the gateways. The features are limited but normally sufficient for you to evaluate the software. There is no need to contact Roq.

  • If you need to evaluate all software features, you should contact Roq by email and get a test license for a specific gateway.

  • A license agreement where you are allowed to use up to N gateways. You can freely use any of the available gateways.

For the licensed solutions you will need to generate a public/secret key-pair.

Conda

Download Miniforge

$ curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"

Install Miniforge

$ bash Miniforge3-Linux-x86_64.sh -b -p opt/conda

Note

We install to opt/conda but you could choose this to be anywhere you like.

Activate Conda

$ source opt/conda/bin/activate

Create a test environment

$ conda create -y -n test

Note

We use the name test but you could choose (almost) any name you like.

This creates a virtual environment for the conda-forge packages that you want to install.

Conda will take care of creating symlinks so your installation can be completely isolated from other virtual environments as well as your host system.

Activate the test environment

$ conda activate test

Install

Install Roq’s tools package

$ conda install -y -c https://roq-trading.com/conda/unstable roq-tools

Generate the Key-Pair

Create a new key-pair

$ roq-keygen > ~/roq_auth_keys.json

Important

You should keep this file SAFE and only ever share the PUBLIC key.

The public key

$ sed -n 's/.*public_key":"\([a-zA-Z0-9+-=]*\)".*/\1\n/p' ~/roq_auth_keys.json

Examples

Authenticate a gateway

$ roq-deribit --auth_keys_file ~/roq_auth_keys.json ...

Query the license server

$ roq-auth --auth_keys_file ~/roq_auth_keys.json deployment