cmd

Documentation

Overview

Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func AddTxFlagsToCmd(cmd *cobra.Command)
• func Execute()
• func NewRootCmd(log *zap.Logger, atom zap.AtomicLevel, o map[string]ClientOverrides) *cobra.Command
• func ReadHeight(flagSet *pflag.FlagSet) (int64, error)
• func ReadPageRequest(flagSet *pflag.FlagSet) (*tmquery.PageRequest, error)
• type ChainNotFoundError
  • func (e ChainNotFoundError) Error() string
• type ClientOverrides
• type Config
  • func (c *Config) GetClient(chainID string) *client.ChainClient
  • func (c *Config) GetDefaultClient() *client.ChainClient
  • func (c Config) MustYAML() []byte
• type GRPCMethodNotFoundError
  • func (e GRPCMethodNotFoundError) Error() string
• type GRPCServiceNotFoundError
  • func (e GRPCServiceNotFoundError) Error() string
• type KeyEnumeration

Constants

const (
	FlagCommission = "commission"
	FlagAll        = "all"
)

Variables

var (
	Version string
	Commit  string
)

var (
	FlagFrom = "from"
)

var ModuleBasics = []module.AppModuleBasic{
	auth.AppModuleBasic{},
	authz.AppModuleBasic{},
	bank.AppModuleBasic{},
	capability.AppModuleBasic{},

	gov.NewAppModuleBasic(
		[]client.ProposalHandler{
			paramsclient.ProposalHandler,
			upgradeclient.LegacyProposalHandler,
			upgradeclient.LegacyCancelProposalHandler,
		},
	),
	crisis.AppModuleBasic{},
	distribution.AppModuleBasic{},
	feegrant.AppModuleBasic{},
	mint.AppModuleBasic{},
	params.AppModuleBasic{},
	slashing.AppModuleBasic{},
	staking.AppModuleBasic{},
	upgrade.AppModuleBasic{},
	transfer.AppModuleBasic{},
	ibc.AppModuleBasic{},
}

Functions

func AddTxFlagsToCmd

func AddTxFlagsToCmd(cmd *cobra.Command)

AddTxFlagsToCmd defines common flags to be reused across cmds

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func NewRootCmd

func NewRootCmd(log *zap.Logger, atom zap.AtomicLevel, o map[string]ClientOverrides) *cobra.Command

NewRootCmd returns the root command for relayer.

o is used to override rpc clients and light providers for test. If o is nil, reasonable default values are used.

func ReadHeight

func ReadHeight(flagSet *pflag.FlagSet) (int64, error)

ReadHeight reads the height flag.

func ReadPageRequest

func ReadPageRequest(flagSet *pflag.FlagSet) (*tmquery.PageRequest, error)

ReadPageRequest reads and builds the necessary page request flags for pagination.

Types

type ChainNotFoundError

type ChainNotFoundError struct {
	Requested string
	Config    *Config
}

ChainNotFoundError is used when a requested chain does not exist. Its error message includes the list of known chains.

func (ChainNotFoundError) Error

func (e ChainNotFoundError) Error() string

type ClientOverrides

type ClientOverrides struct {
	RPCClient     rpcclient.Client
	LightProvider provtypes.Provider
}

ClientOverrides specifies an RPCClient and LightProvider to use for a specific chain.

This should only be set during tests.

type Config

type Config struct {
	DefaultChain string                               `yaml:"default_chain" json:"default_chain"`
	Chains       map[string]*client.ChainClientConfig `yaml:"chains" json:"chains"`
	// contains filtered or unexported fields
}

Config represents the config file for the relayer

func (*Config) GetClient

func (c *Config) GetClient(chainID string) *client.ChainClient

func (*Config) GetDefaultClient

func (c *Config) GetDefaultClient() *client.ChainClient

func (Config) MustYAML

func (c Config) MustYAML() []byte

MustYAML returns the yaml string representation of the Paths

type GRPCMethodNotFoundError

type GRPCMethodNotFoundError struct {
	TargetService string
	Requested     string
	Available     []*desc.MethodDescriptor
}

GRPCMethodNotFoundError is used when a requested gRPC method does not exist. Its error message includes the provided available services.

func (GRPCMethodNotFoundError) Error

func (e GRPCMethodNotFoundError) Error() string

type GRPCServiceNotFoundError

type GRPCServiceNotFoundError struct {
	Requested string
	Available []string
}

GRPCServiceNotFoundError is used when a requested gRPC service does not exist. Its error message includes the provided available services.

func (GRPCServiceNotFoundError) Error

func (e GRPCServiceNotFoundError) Error() string

type KeyEnumeration

type KeyEnumeration struct {
	KeyName   string            `json:"key_name"`
	Addresses map[string]string `json:"addresses"`
}