chain

package
v0.14.1-0...-8b31b97 Latest Latest
Warning

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

 Go to latest Published: Mar 13, 2021 License: Apache-2.0 Imports: 61 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrFaucetIsNotEnabled is returned when faucet is not enabled in the config.yml.
	ErrFaucetIsNotEnabled = errors.New("faucet is not enabled in the config.yml")

	// ErrFaucetAccountDoesNotExist returned when specified faucet account in the config.yml does not exist.
	ErrFaucetAccountDoesNotExist = errors.New("specified account (faucet.name) does not exist")
)

Functions

This section is empty.

Types

type Account 

type Account struct {
	Name     string
	Address  string
	Mnemonic string `json:"mnemonic"`
	Coins    string
}

Account represents an account in the chain.

type App 

type App struct {
	Name       string
	Path       string
	ImportPath string
}

App keeps info about chain.

func NewAppAt 

func NewAppAt(path string) (App, error)

NewAppAt creates an App from the blockchain source code located at path.

func (App) CLI 

func (a App) CLI() string

CLI return appcli name.

func (App) D 

func (a App) D() string

D returns appd name.

func (App) N 

func (a App) N() string

N returns app name without dashes.

func (App) NCLI 

func (a App) NCLI() string

NCLI returns no-dash appcli name.

func (App) ND 

func (a App) ND() string

ND returns no-dash appd name.

func (App) Root 

func (a App) Root() string

Root returns the root path of app.

type CannotBuildAppError 

type CannotBuildAppError struct {
	Err error
}

func (*CannotBuildAppError) Error 

func (e *CannotBuildAppError) Error() string

func (*CannotBuildAppError) Unwrap 

func (e *CannotBuildAppError) Unwrap() error

type CannotStartAppError 

type CannotStartAppError struct {
	AppName string
	Err     error
}

func (*CannotStartAppError) Error 

func (e *CannotStartAppError) Error() string

func (*CannotStartAppError) ParseStartError 

func (e *CannotStartAppError) ParseStartError() string

ParseStartError parses the error into a clear error string The error logs from Cosmos SDK application are too extensive to be directly printed If the error is not recognized, returns an empty string

func (*CannotStartAppError) Unwrap 

func (e *CannotStartAppError) Unwrap() error

type Chain 

type Chain struct {
	Version cosmosver.Version
	// contains filtered or unexported fields
}

Chain provides programatic access and tools for a Cosmos SDK blockchain.

func New 

func New(ctx context.Context, path string, options ...Option) (*Chain, error)

New initializes a new Chain with options that its source lives at path.

func (*Chain) AppTOMLPath 

func (c *Chain) AppTOMLPath() (string, error)

AppTOMLPath returns app.toml path of the app.

func (*Chain) Binaries 

func (c *Chain) Binaries() ([]string, error)

Binaries returns the list of binaries available for the chain.

func (*Chain) Binary 

func (c *Chain) Binary() (string, error)

Binary returns the name of app's default (appd) binary.

func (*Chain) BinaryCLI 

func (c *Chain) BinaryCLI() string

BinaryCLI returns the name of app's secondary (appcli) binary.

func (*Chain) Build 

func (c *Chain) Build(ctx context.Context) error

Build builds an app.

func (*Chain) CLIHome 

func (c *Chain) CLIHome() (string, error)

CLIHome returns the blockchain node's home dir. This directory is the same as home for Stargate, it is a separate directory for Launchpad

func (*Chain) Commands 

func (c *Chain) Commands(ctx context.Context) (chaincmdrunner.Runner, error)

Commands returns the runner execute commands on the chain's binary

func (*Chain) Config 

func (c *Chain) Config() (conf.Config, error)

func (*Chain) ConfigTOMLPath 

func (c *Chain) ConfigTOMLPath() (string, error)

ConfigTOMLPath returns config.toml path of the app.

func (*Chain) DefaultHome 

func (c *Chain) DefaultHome() (string, error)

DefaultHome returns the blockchain node's default home dir when not specified in the app

func (*Chain) Faucet 

func (c *Chain) Faucet(ctx context.Context) (cosmosfaucet.Faucet, error)

Faucet returns the faucet for the chain or an error if the faucet configuration is wrong or not configured (not enabled) at all.

func (*Chain) GenesisPath 

func (c *Chain) GenesisPath() (string, error)

GenesisPath returns genesis.json path of the app.

func (*Chain) Home 

func (c *Chain) Home() (string, error)

Home returns the blockchain node's home dir.

func (*Chain) ID 

func (c *Chain) ID() (string, error)

ID returns the chain's id.

func (*Chain) Init 

func (c *Chain) Init(ctx context.Context) error

Init initializes chain.

func (*Chain) InitAccounts 

func (c *Chain) InitAccounts(ctx context.Context, conf conf.Config) error

InitAccounts initializes the chain accounts and creates validator gentxs

func (*Chain) IsInitialized 

func (c *Chain) IsInitialized() (bool, error)

IsInitialized checks if the chain is initialized the check is performed by checking if the gentx dir exist in the config

func (*Chain) RPCPublicAddress 

func (c *Chain) RPCPublicAddress() (string, error)

RPCPublicAddress points to the public address of Tendermint RPC, this is shared by other chains for relayer related actions.

func (*Chain) RelayerAdd 

func (c *Chain) RelayerAdd(base64Info string) error

RelayerAdd adds another chain by its relayer info to establish a connnection in between.

func (*Chain) RelayerInfo 

func (c *Chain) RelayerInfo() (base64Info string, err error)

RelayerInfo initializes or updates relayer setup for the chain itself and returns a meta info to share with other chains so they can connect.

func (*Chain) SDKVersion 

func (c *Chain) SDKVersion() cosmosver.MajorVersion

SDKVersion returns the version of SDK used to build the blockchain.

func (*Chain) Serve 

func (c *Chain) Serve(ctx context.Context, options ...ServeOption) error

Serve serves an app.

func (*Chain) StoragePaths 

func (c *Chain) StoragePaths() (paths []string, err error)

type Config 

type Config struct {
	SdkVersion      string
	EngineAddr      string
	AppBackendAddr  string
	AppFrontendAddr string
}

Config used to configure development handler.

type LogLvl 

type LogLvl int
const (
	LogSilent LogLvl = iota
	LogRegular
	LogVerbose
)

type Option 

type Option func(*Chain)

Option configures Chain.

func CLIHomePath 

func CLIHomePath(path string) Option

CLIHomePath replaces chain's cli configuration home path with given path.

func HomePath 

func HomePath(path string) Option

HomePath replaces chain's configuration home path with given path.

func ID 

func ID(id string) Option

ID replaces chain's id with given id.

func KeyringBackend 

func KeyringBackend(keyringBackend chaincmd.KeyringBackend) Option

KeyringBackend specify the keyring backend to use for the chain command

func LogLevel 

func LogLevel(level LogLvl) Option

LogLevel sets logging level.

type Plugin 

type Plugin interface {
	// Name of a Cosmos version.
	Name() string

	// Setup performs the initial setup for plugin.
	Setup(context.Context) error

	// ConfigCommands returns step.Exec configuration for config commands.
	Configure(context.Context, chaincmdrunner.Runner, string) error

	// GentxCommand returns step.Exec configuration for gentx command.
	Gentx(context.Context, chaincmdrunner.Runner, Validator) (path string, err error)

	// PostInit hook.
	PostInit(string, starportconf.Config) error

	// StartCommands returns step.Exec configuration to start servers.
	Start(context.Context, chaincmdrunner.Runner, starportconf.Config) error

	// StoragePaths returns a list of where persistent data kept.
	StoragePaths() []string

	// Home returns the blockchain node's home dir.
	Home() string

	// CLIHome returns the cli blockchain node's home dir.
	CLIHome() string

	// Version of the plugin.
	Version() cosmosver.MajorVersion

	// SupportsIBC reports if app support IBC.
	SupportsIBC() bool
}

type ServeOption 

type ServeOption func(*serveOptions)

ServeOption provides options for the serve command

func ServeForceReset 

func ServeForceReset() ServeOption

ServeForceReset allows to force reset of the state when the chain is served and on every source change

func ServeResetOnce 

func ServeResetOnce() ServeOption

ServeResetOnce allows to reset of the state when the chain is served once

type Validator 

type Validator struct {
	Name                    string
	Moniker                 string
	StakingAmount           string
	CommissionRate          string
	CommissionMaxRate       string
	CommissionMaxChangeRate string
	MinSelfDelegation       string
	GasPrices               string
}

Source Files

View all Source files

Directories

Path Synopsis

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.