cli

Documentation

Overview

Package cli contains helpers for various oasis-node subcommands.

Index

• func RunSubCommand(env *env.Env, logger *logging.Logger, name, binary string, args []string) error
• func RunSubCommandWithOutput(env *env.Env, logger *logging.Logger, name, binary string, args []string) (bytes.Buffer, error)
• func StartSubCommand(_ *env.Env, logger *logging.Logger, _, binary string, args []string, ...) (*exec.Cmd, error)
• type Config
• type ConsensusHelpers
  • func (c *ConsensusHelpers) EstimateGas(txPath string, signerPub signature.PublicKey) (transaction.Gas, error)
  • func (c *ConsensusHelpers) SubmitTx(txPath string) error
• type Factory
• type GenesisHelpers
  • func (g *GenesisHelpers) Check(genesisFilePath string) (string, error)
  • func (g *GenesisHelpers) Dump(genesisFilePath string) error
  • func (g *GenesisHelpers) Migrate(genesisFilePath string, newGenesisFilePath string) error
• type Helpers
  • func New(env *env.Env, factory Factory, logger *logging.Logger) *Helpers
  • func (h *Helpers) SetConfig(cfg Config)
  • func (h *Helpers) UnsafeReset(dataDir string, preserveRuntimeStorage, preserveLocalStorage, force bool) error
• type KeymanagerHelpers
  • func (k *KeymanagerHelpers) GenUpdate(nonce uint64, polPath string, polSigPaths []string, txPath string) error
  • func (k *KeymanagerHelpers) InitPolicy(runtimeID common.Namespace, serial uint32, rotationInterval beacon.EpochTime, ...) error
  • func (k *KeymanagerHelpers) SignPolicy(testKey, polPath, polSigPath string) error
• type RegistryHelpers
  • func (r *RegistryHelpers) GenerateRegisterEntityTx(entDir string, nonce uint64, txPath string) error
  • func (r *RegistryHelpers) GenerateRegisterRuntimeTx(baseDir string, runtime registry.Runtime, nonce uint64, txPath string) error

Functions

func RunSubCommand

func RunSubCommand(env *env.Env, logger *logging.Logger, name, binary string, args []string) error

RunSubCommand launches an oasis-node subcommand and waits for it to complete.

Stdout and stderr are redirected into a command-specific file.

func RunSubCommandWithOutput

func RunSubCommandWithOutput(env *env.Env, logger *logging.Logger, name, binary string, args []string) (bytes.Buffer, error)

RunSubCommandWithOutput launches an oasis-node subcommand and waits for it to complete.

Stdout and stderr are redirected into a buffer.

func StartSubCommand

func StartSubCommand(_ *env.Env, logger *logging.Logger, _, binary string, args []string, stdout, stderr io.Writer) (*exec.Cmd, error)

StartSubCommand launches an oasis-node subcommand.

It does not wait for the subcommand to complete.

Types

type Config

type Config struct {
	// NodeBinary is the path to the oasis-node binary file.
	NodeBinary string

	// GenesisFile is the path to the genesis document.
	GenesisFile string

	// NodeSocketPath is the path to the internal UNIX socket of a node that should be used for any
	// commands which require talking to a working oasis-node.
	NodeSocketPath string
}

Config is the CLI helper configuration.

type ConsensusHelpers

type ConsensusHelpers struct {
	// contains filtered or unexported fields
}

ConsensusHelpers contains the oasis-node consensus CLI helpers.

func (*ConsensusHelpers) EstimateGas

func (c *ConsensusHelpers) EstimateGas(txPath string, signerPub signature.PublicKey) (transaction.Gas, error)

EstimateGas is a wrapper for "consensus estimate_gas" subcommand.

func (*ConsensusHelpers) SubmitTx

func (c *ConsensusHelpers) SubmitTx(txPath string) error

SubmitTx is a wrapper for "consensus submit_tx" subcommand.

type Factory

type Factory interface {
	// GetCLIConfig returns the configuration required for constructing a CLI helper.
	GetCLIConfig() Config
}

Factory is an interface that can be used to construct CLI helpers.

type GenesisHelpers

type GenesisHelpers struct {
	// contains filtered or unexported fields
}

GenesisHelpers contains the oasis-node genesis CLI helpers.

func (*GenesisHelpers) Check

func (g *GenesisHelpers) Check(
	genesisFilePath string,
) (string, error)

Check is a wrapper for "genesis check" subcommand.

func (*GenesisHelpers) Dump

func (g *GenesisHelpers) Dump(
	genesisFilePath string,
) error

Dump is a wrapper for "genesis dump" subcommand.

func (*GenesisHelpers) Migrate

func (g *GenesisHelpers) Migrate(
	genesisFilePath string,
	newGenesisFilePath string,
) error

Migrate is a wrapper for "genesis migrate" subcommand.

type Helpers

type Helpers struct {
	Consensus  *ConsensusHelpers
	Registry   *RegistryHelpers
	Keymanager *KeymanagerHelpers
	Genesis    *GenesisHelpers
	// contains filtered or unexported fields
}

Helpers are the oasis-node cli helpers.

func New

func New(env *env.Env, factory Factory, logger *logging.Logger) *Helpers

New creates new oasis-node cli helpers.

func (*Helpers) SetConfig

func (h *Helpers) SetConfig(cfg Config)

SetConfig sets the configuration for the oasis-node cli helpers.

func (*Helpers) UnsafeReset

func (h *Helpers) UnsafeReset(dataDir string, preserveRuntimeStorage, preserveLocalStorage, force bool) error

UnsafeReset launches the unsafe-reset subcommand, clearing all consensus and (optionally) runtime state.

type KeymanagerHelpers

type KeymanagerHelpers struct {
	// contains filtered or unexported fields
}

KeymanagerHelpers contains the oasis-node keymanager CLI helpers.

func (*KeymanagerHelpers) GenUpdate

func (k *KeymanagerHelpers) GenUpdate(nonce uint64, polPath string, polSigPaths []string, txPath string) error

GenUpdate generates the update KM policy transaction.

func (*KeymanagerHelpers) InitPolicy

func (k *KeymanagerHelpers) InitPolicy(runtimeID common.Namespace, serial uint32, rotationInterval beacon.EpochTime, policies map[sgx.EnclaveIdentity]*secrets.EnclavePolicySGX, polPath string) error

InitPolicy generates the KM policy file.

func (*KeymanagerHelpers) SignPolicy

func (k *KeymanagerHelpers) SignPolicy(testKey, polPath, polSigPath string) error

SignPolicy signs the KM policy file using the given test key ("1", "2", or "3").

type RegistryHelpers

type RegistryHelpers struct {
	// contains filtered or unexported fields
}

RegistryHelpers contains the oasis-node registry CLI helpers.

func (*RegistryHelpers) GenerateRegisterEntityTx

func (r *RegistryHelpers) GenerateRegisterEntityTx(
	entDir string,
	nonce uint64,
	txPath string,
) error

GenerateRegisterEntityTx is a wrapper for "registry entity gen_register" subcommand.

func (*RegistryHelpers) GenerateRegisterRuntimeTx

func (r *RegistryHelpers) GenerateRegisterRuntimeTx(
	baseDir string,
	runtime registry.Runtime,
	nonce uint64,
	txPath string,
) error

GenerateRegisterRuntimeTx is a wrapper for "registry runtime gen_register" subcommand.