Skip to content

A go command line utility providing a bunch of tools to use with a vega testnet

License

Notifications You must be signed in to change notification settings

natebolam/vegatools

 
 

Repository files navigation

Go Go coverage YAML lint

VEGATOOLS

This repo contains a suite of (sometimes) useful tools to use with the vega nodes API.

How to install

You can install this program by running the following go install command:

go install code.vegaprotocol.io/vegatools@latest

Make sure that your CGO_ENABLED environment variable is set to 0. This can be checked using this command:

go env

It can be set correctly by:

go env -w CGO_ENABLED=0

Available tools

Stream

Stream is a simple utility used to connect to a vega validator and listen to ALL events it produce.

Here's an example of how to run it:

vegatools stream --address=n09.testnet.vega.xyz:3002

This will listen to all event from this testnet node, run the following commands for a detailed help and filtering

vegatools stream -h

MarketDepthViewer

MarketDepthViewer is a utility that will display the market depth of a given market running on a node.

The basic command to run it is:

vegatools marketdepthviewer --address=n09.testnet.vega.xyz:3002

If there are multiple markets on a node it will display a list of them at startup and allow the user to select the one they wish to view. Pressing q will close the app.

LiquidityViewer

LiquidityViewer is a utility that displays the liquidity commitment of a user on a particular market.

The basic command to run it is:

vegatools liquidityviewer --address=n09.testnet.vega.xyz:3002

If there are multiple markets on the node it will list them and allow the user to select one. If there are multiple users on that market supplying liquidity then it will also list those and allow the user to select one. Pressing q will closer the app.

MarketStakeViewer

MarketStakeViewer is a utility that displays the current state of liquidity provision for all markets running on a node.

The basic command to run it is:

vegatools marketstakeviewer --address=n09.testnet.vega.xyz:3002

About

A go command line utility providing a bunch of tools to use with a vega testnet

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 98.8%
  • Makefile 1.2%