options

Documentation

Overview

Package options contains a set of common CLI options and helper functions to use them.

Index

• Constants
• Variables
• func GetNetwork(ctx *cli.Context) netmode.Magic
• func GetRPCClient(gctx context.Context, ctx *cli.Context) (*client.Client, cli.ExitCoder)
• func GetTimeoutContext(ctx *cli.Context) (context.Context, func())

Constants

const DefaultTimeout = 10 * time.Second

DefaultTimeout is the default timeout used for RPC requests.

const RPCEndpointFlag = "rpc-endpoint"

RPCEndpointFlag is a long flag name for RPC endpoint. It can be used to check for flag presence in the context.

Variables

var Network = []cli.Flag{
	cli.BoolFlag{Name: "privnet, p"},
	cli.BoolFlag{Name: "mainnet, m"},
	cli.BoolFlag{Name: "testnet, t"},
	cli.BoolFlag{Name: "unittest", Hidden: true},
}

Network is a set of flags for choosing the network to operate on (privnet/mainnet/testnet).

var RPC = []cli.Flag{
	cli.StringFlag{
		Name:  RPCEndpointFlag + ", r",
		Usage: "RPC node address",
	},
	cli.DurationFlag{
		Name:  "timeout, s",
		Usage: "Timeout for the operation (10 seconds by default)",
	},
}

RPC is a set of flags used for RPC connections (endpoint and timeout).

Functions

func GetNetwork

func GetNetwork(ctx *cli.Context) netmode.Magic

GetNetwork examines Context's flags and returns the appropriate network. It defaults to PrivNet if no flags are given.

func GetRPCClient

func GetRPCClient(gctx context.Context, ctx *cli.Context) (*client.Client, cli.ExitCoder)

GetRPCClient returns an RPC client instance for the given Context.

func GetTimeoutContext

func GetTimeoutContext(ctx *cli.Context) (context.Context, func())

GetTimeoutContext returns a context.Context with default of user-set timeout.