cli

package
v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 14, 2023 License: Apache-2.0 Imports: 68 Imported by: 0

Documentation

Overview

Package network implements and exposes a fully operational in-process Tendermint test network that consists of at least one or potentially many validators. This test network can be used primarily for integration tests or unit test suites.

The test network utilizes SimApp as the ABCI application and uses all the modules defined in the Cosmos SDK. An in-process test network can be configured with any number of validators as well as account funds and even custom genesis state.

When creating a test network, a series of Validator objects are returned. Each Validator object has useful information such as their address and public key. A Validator will also provide its RPC, P2P, and API addresses that can be useful for integration testing. In addition, a Tendermint local RPC client is also provided which can be handy for making direct RPC calls to Tendermint.

Note, due to limitations in concurrency and the design of the RPC layer in Tendermint, only the first Validator object will have an RPC and API client exposed. Due to this exact same limitation, only a single test network can exist at a time. A caller must be certain it calls Cleanup after it no longer needs the network.

A typical testing flow might look like the following: 

type IntegrationTestSuite struct {
	suite.Suite

	cfg     testutil.Config
	network *testutil.Network
}

func (s *IntegrationTestSuite) SetupSuite() {
	s.T().Log("setting up integration test suite")

	cfg := testutil.DefaultConfig()
	cfg.NumValidators = 1

	s.cfg = cfg
	s.network = testutil.New(s.T(), cfg)

	_, err := s.network.WaitForHeight(1)
	s.Require().NoError(err)
}

func (s *IntegrationTestSuite) TearDownSuite() {
	s.T().Log("tearing down integration test suite")

	// This is important and must be called to ensure other tests can create
	// a network!
	s.network.Cleanup()
}

func (s *IntegrationTestSuite) TestQueryBalancesRequestHandlerFn() {
	val := s.network.Validators[0]
	baseURL := val.APIAddress

	// Use baseURL to make API HTTP requests or use val.RPCClient to make direct
	// Tendermint RPC calls.
	// ...
}

func TestIntegrationTestSuite(t *testing.T) {
	suite.Run(t, new(IntegrationTestSuite))
}

Index

Constants

View Source 
const (
	// EncodingTypeJSON defines the types are JSON encoded or need to be encoded using JSON.
	EncodingTypeJSON = iota
	// EncodingTypeProto defines the types are proto encoded or need to be encoded using proto.
	EncodingTypeProto
)

Variables

This section is empty.

Functions

func ExecQuery 

func ExecQuery(clientCtx client.Context, cmd *cobra.Command, args []string, result codec.ProtoMarshaler, opts ...ExecQueryOption) error

ExecQuery executes a CLI query onto the provided Network.

func ExecTx 

func ExecTx(network *Network, cmd *cobra.Command, txSender sdk.AccAddress, args []string, opt ...ExecTxOption) (*sdk.TxResponse, error)

func FillWalletFromValidator 

func FillWalletFromValidator(
	addr sdk.AccAddress, balance sdk.Coins, val *Validator, feesDenom string,
) error

FillWalletFromValidator fills the wallet with some coins that come from the validator. Used for cli tests.

func NewAccount 

func NewAccount(network *Network, uid string) sdk.AccAddress

Creates a new account with a random mnemonic, stores the mnemonic in the keyring, and returns the address.

args:

  • network: the network in which to create the account and key
  • uid: a unique identifier to ensure duplicate accounts are not created

ret:

  • addr: the address of the new account

func PassGovProposal 

func PassGovProposal(s suite.Suite, network *Network)

func QueryBaseAssetPrice 

func QueryBaseAssetPrice(clientCtx client.Context, pair asset.Pair, direction string, amount string) (*vpooltypes.QueryBaseAssetPriceResponse, error)

func QueryCumulativePremiumFraction 

func QueryCumulativePremiumFraction(clientCtx client.Context, pair asset.Pair) (*perptypes.QueryCumulativePremiumFractionResponse, error)

func QueryOracleExchangeRate 

func QueryOracleExchangeRate(clientCtx client.Context, pair asset.Pair) (*oracletypes.QueryExchangeRateResponse, error)

func QueryPosition 

func QueryPosition(ctx client.Context, pair asset.Pair, trader sdk.AccAddress) (*perptypes.QueryPositionResponse, error)

func QueryVpoolReserveAssets 

func QueryVpoolReserveAssets(clientCtx client.Context, pair asset.Pair,
) (*vpooltypes.QueryReserveAssetsResponse, error)

Types

type AppConstructor 

type AppConstructor = func(val Validator) servertypes.Application

AppConstructor defines a function which accepts a network configuration and creates an ABCI Application to provide to Tendermint.

type Config 

type Config struct {
	Codec             codec.Codec
	LegacyAmino       *codec.LegacyAmino // TODO: Remove!
	InterfaceRegistry codectypes.InterfaceRegistry

	TxConfig         client.TxConfig
	AccountRetriever client.AccountRetriever
	AppConstructor   AppConstructor             // the ABCI application constructor
	GenesisState     map[string]json.RawMessage // custom genesis state to provide
	TimeoutCommit    time.Duration              // the consensus commitment timeout
	ChainID          string                     // the network chain-id
	NumValidators    int                        // the total number of validators to create and bond
	Mnemonics        []string                   // custom user-provided validator operator mnemonics
	BondDenom        string                     // the staking bond denomination
	MinGasPrices     string                     // the minimum gas prices each validator will accept
	AccountTokens    sdk.Int                    // the amount of unique validator tokens (e.g. 1000node0)
	StakingTokens    sdk.Int                    // the amount of tokens each validator has available to stake
	BondedTokens     sdk.Int                    // the amount of tokens each validator stakes
	StartingTokens   sdk.Coins                  // Additional tokens to be added to the starting block to validators
	PruningStrategy  string                     // the pruning strategy each validator will have
	EnableLogging    bool                       // enable Tendermint logging to STDOUT
	CleanupDir       bool                       // remove base temporary directory during cleanup
	SigningAlgo      string                     // signing algorithm for keys
	KeyringOptions   []keyring.Option
}

Config defines the necessary configuration used to bootstrap and start an in-process local testing network.

func BuildNetworkConfig 

func BuildNetworkConfig(appGenesis app.GenesisState) Config

BuildNetworkConfig returns a configuration for a local in-testing network

type EncodingType 

type EncodingType int

EncodingType defines the encoding methodology for requests and responses.

type ExecQueryOption 

type ExecQueryOption func(queryOption *queryOptions)

ExecQueryOption defines a type which customizes a CLI query operation.

func WithQueryEncodingType 

func WithQueryEncodingType(e EncodingType) ExecQueryOption

WithQueryEncodingType defines how the response of the CLI query should be decoded.

type ExecTxOption 

type ExecTxOption func(*execTxOptions)

func WithKeyringBackend 

func WithKeyringBackend(keyringBackend string) ExecTxOption

func WithTxBroadcastMode 

func WithTxBroadcastMode(broadcastMode string) ExecTxOption

func WithTxCanFail 

func WithTxCanFail(canFail bool) ExecTxOption

WithTxCanFail will not make ExecTx return an error in case the response code of the TX is not ok.

func WithTxFees 

func WithTxFees(feeCoins sdk.Coins) ExecTxOption

func WithTxSkipConfirmation 

func WithTxSkipConfirmation(skipConfirmation bool) ExecTxOption

type Network 

type Network struct {
	T          *testing.T
	BaseDir    string
	Validators []*Validator

	Config Config
}

Network defines a local in-process testing network using SimApp. It can be configured to start any number of validators, each with its own RPC and API clients. Typically, this test network would be used in client and integration testing where user input is expected.

Note, due to Tendermint constraints in regards to RPC functionality, there may only be one test network running at a time. Thus, any caller must be sure to Cleanup after testing is finished in order to allow other tests to create networks. In addition, only the first validator will have a valid RPC and API server/client.

func NewNetwork 

func NewNetwork(t *testing.T, cfg Config) *Network

NewNetwork creates a new Network for integration tests.

func (*Network) Cleanup 

func (n *Network) Cleanup()

Cleanup removes the root testing (temporary) directory and stops both the Tendermint and API services. It allows other callers to create and start test networks. This method must be called when a test is finished, typically in a defer.

func (*Network) LatestHeight 

func (n *Network) LatestHeight() (int64, error)

LatestHeight returns the latest height of the network or an error if the query fails or no validators exist.

func (*Network) SendTx 

func (n *Network) SendTx(addr sdk.AccAddress, msgs ...sdk.Msg) (*sdk.TxResponse, error)

func (*Network) WaitForDuration 

func (n *Network) WaitForDuration(duration time.Duration) error

WaitForDuration waits for at least the duration provided in blockchain time.

func (*Network) WaitForHeight 

func (n *Network) WaitForHeight(h int64) (int64, error)

WaitForHeight performs a blocking check where it waits for a block to be committed after a given block. If that height is not reached within a timeout, an error is returned. Regardless, the latest height queried is returned.

func (*Network) WaitForHeightWithTimeout 

func (n *Network) WaitForHeightWithTimeout(h int64, t time.Duration) (int64, error)

WaitForHeightWithTimeout is the same as WaitForHeight except the caller can provide a custom timeout.

func (*Network) WaitForNextBlock 

func (n *Network) WaitForNextBlock() error

WaitForNextBlock waits for the next block to be committed, returning an error upon failure.

type Validator 

type Validator struct {
	AppConfig  *srvconfig.Config
	ClientCtx  client.Context
	Ctx        *server.Context
	Dir        string
	NodeID     string
	PubKey     cryptotypes.PubKey
	Moniker    string
	APIAddress string
	RPCAddress string
	P2PAddress string
	Address    sdk.AccAddress
	ValAddress sdk.ValAddress
	RPCClient  tmclient.Client
	// contains filtered or unexported fields
}

Validator defines an in-process Tendermint validator node. Through this object, a client can make RPC and API calls and interact with any client command or handler.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.