context

package
v0.6.0-rc0 Latest Latest
Warning

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

Go to latest
Published: Oct 24, 2018 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DeliverTxMarshalIndentJSON

func DeliverTxMarshalIndentJSON(dtx abci.ResponseDeliverTx) ([]byte, error)

func ErrInvalidAccount

func ErrInvalidAccount(addr sdk.AccAddress) error

ErrInvalidAccount returns a standardized error reflecting that a given account address does not exist.

func ErrInvalidBaseTx

func ErrInvalidBaseTx(errMsg string) error

ErrInvalidBaseTx returns a common error reflecting the failed BaseTx verification result

func ErrVerifyCommit

func ErrVerifyCommit(height int64) error

ErrVerifyCommit returns a common error reflecting that the blockchain commit at a given height can't be verified. The reason is that the base checkpoint of the certifier is newer than the given height

Types

type BaseTx

type BaseTx struct {
	LocalAccountName string `json:"name"`
	Password         string `json:"password"`
	ChainID          string `json:"chain_id"`
	AccountNumber    int64  `json:"account_number"`
	Sequence         int64  `json:"sequence"`
	Gas              int64  `json:"gas"`
	Fees             string `json:"fee"`
	Memo             string `json:"memo"`
}

func (BaseTx) Validate

func (baseTx BaseTx) Validate(cliCtx CLIContext) error

type CLIContext

type CLIContext struct {
	Codec           *wire.Codec
	AccDecoder      auth.AccountDecoder
	Client          rpcclient.Client
	Logger          io.Writer
	Height          int64
	NodeURI         string
	FromAddressName string
	//If GenerateOnly is true and FromAddressName is not specified, the signer is required for building msg
	SignerAddr    string
	AccountStore  string
	TrustNode     bool
	UseLedger     bool
	Async         bool
	JSON          bool
	PrintResponse bool
	Certifier     tmlite.Certifier
	GenerateOnly  bool
}

CLIContext implements a typical CLI context created in SDK modules for transaction handling and queries.

func NewCLIContext

func NewCLIContext() CLIContext

NewCLIContext returns a new initialized CLIContext with parameters from the command line using Viper.

func (CLIContext) BroadcastTx

func (cliCtx CLIContext) BroadcastTx(tx []byte) (*ctypes.ResultBroadcastTxCommit, error)

BroadcastTx broadcasts transaction bytes to a Tendermint node.

func (CLIContext) BroadcastTxAsync

func (cliCtx CLIContext) BroadcastTxAsync(tx []byte) (*ctypes.ResultBroadcastTx, error)

BroadcastTxAsync broadcasts transaction bytes to a Tendermint node asynchronously.

func (CLIContext) Certify

func (cliCtx CLIContext) Certify(height int64) (lite.Commit, error)

Certify verifies the consensus proof at given height

func (CLIContext) ConvertCoinToMainUnit

func (cliCtx CLIContext) ConvertCoinToMainUnit(coinsStr string) (coins []string, err error)

func (CLIContext) EnsureAccountExists

func (cliCtx CLIContext) EnsureAccountExists() error

EnsureAccountExists ensures that an account exists for a given context. An error is returned if it does not.

func (CLIContext) EnsureAccountExistsFromAddr

func (cliCtx CLIContext) EnsureAccountExistsFromAddr(addr sdk.AccAddress) error

EnsureAccountExistsFromAddr ensures that an account exists for a given address. Instead of using the context's from name, a direct address is given. An error is returned if it does not.

func (CLIContext) EnsureBroadcastTx

func (cliCtx CLIContext) EnsureBroadcastTx(txBytes []byte) error

EnsureBroadcastTx broadcasts a transactions either synchronously or asynchronously based on the context parameters. The result of the broadcast is parsed into an intermediate structure which is logged if the context has a logger defined.

func (CLIContext) GetAccount

func (cliCtx CLIContext) GetAccount(address []byte) (auth.Account, error)

GetAccount queries for an account given an address and a block height. An error is returned if the query or decoding fails.

func (CLIContext) GetAccountNumber

func (cliCtx CLIContext) GetAccountNumber(address []byte) (int64, error)

GetAccountNumber returns the next account number for the given account address.

func (CLIContext) GetAccountSequence

func (cliCtx CLIContext) GetAccountSequence(address []byte) (int64, error)

GetAccountSequence returns the sequence number for the given account address.

func (CLIContext) GetCoinType

func (cliCtx CLIContext) GetCoinType(coinName string) (types.CoinType, error)

func (CLIContext) GetFromAddress

func (cliCtx CLIContext) GetFromAddress() (from sdk.AccAddress, err error)

GetFromAddress returns the from address from the context's name.

func (CLIContext) GetNode

func (cliCtx CLIContext) GetNode() (rpcclient.Client, error)

GetNode returns an RPC client. If the context's client is not defined, an error is returned.

func (CLIContext) NetInfo

func (cliCtx CLIContext) NetInfo() (*ctypes.ResultNetInfo, error)

func (CLIContext) NumUnconfirmedTxs

func (cliCtx CLIContext) NumUnconfirmedTxs() (*ctypes.ResultUnconfirmedTxs, error)

func (CLIContext) ParseCoin

func (cliCtx CLIContext) ParseCoin(coinStr string) (sdk.Coin, error)

func (CLIContext) ParseCoins

func (cliCtx CLIContext) ParseCoins(coinsStr string) (coins sdk.Coins, err error)

func (CLIContext) Query

func (cliCtx CLIContext) Query(path string) (res []byte, err error)

Query performs a query for information about the connected node.

func (CLIContext) QueryStore

func (cliCtx CLIContext) QueryStore(key cmn.HexBytes, storeName string) (res []byte, err error)

QueryStore performs a query from a Tendermint node with the provided key and store name.

func (CLIContext) QuerySubspace

func (cliCtx CLIContext) QuerySubspace(subspace []byte, storeName string) (res []sdk.KVPair, err error)

QuerySubspace performs a query from a Tendermint node with the provided store name and subspace.

func (CLIContext) WithAccountDecoder

func (ctx CLIContext) WithAccountDecoder(decoder auth.AccountDecoder) CLIContext

WithAccountDecoder returns a copy of the context with an updated account decoder.

func (CLIContext) WithAccountStore

func (ctx CLIContext) WithAccountStore(accountStore string) CLIContext

WithAccountStore returns a copy of the context with an updated AccountStore.

func (CLIContext) WithCertifier

func (ctx CLIContext) WithCertifier(certifier tmlite.Certifier) CLIContext

WithCertifier - return a copy of the context with an updated Certifier

func (CLIContext) WithClient

func (ctx CLIContext) WithClient(client rpcclient.Client) CLIContext

WithClient returns a copy of the context with an updated RPC client instance.

func (CLIContext) WithCodec

func (ctx CLIContext) WithCodec(cdc *wire.Codec) CLIContext

WithCodec returns a copy of the context with an updated codec.

func (CLIContext) WithFromAddressName

func (ctx CLIContext) WithFromAddressName(addrName string) CLIContext

WithFromAddressName returns a copy of the context with an updated from address.

func (CLIContext) WithLogger

func (ctx CLIContext) WithLogger(w io.Writer) CLIContext

WithLogger returns a copy of the context with an updated logger.

func (CLIContext) WithNodeURI

func (ctx CLIContext) WithNodeURI(nodeURI string) CLIContext

WithNodeURI returns a copy of the context with an updated node URI.

func (CLIContext) WithTrustNode

func (ctx CLIContext) WithTrustNode(trustNode bool) CLIContext

WithTrustNode returns a copy of the context with an updated TrustNode flag.

func (CLIContext) WithUseLedger

func (ctx CLIContext) WithUseLedger(useLedger bool) CLIContext

WithUseLedger returns a copy of the context with an updated UseLedger flag.

type TxContext

type TxContext struct {
	Codec *wire.Codec

	AccountNumber int64
	Sequence      int64
	Gas           int64
	ChainID       string
	Memo          string
	Fee           string
	// contains filtered or unexported fields
}

TxContext implements a transaction context created in SDK modules.

func NewTxContextFromBaseTx

func NewTxContextFromBaseTx(cliCtx CLIContext, cdc *wire.Codec, baseTx BaseTx) (TxContext, error)

func NewTxContextFromCLI

func NewTxContextFromCLI() TxContext

NewTxContextFromCLI returns a new initialized TxContext with parameters from the command line using Viper.

func (TxContext) Build

func (txCtx TxContext) Build(msgs []sdk.Msg) (auth.StdSignMsg, error)

Build builds a single message to be signed from a TxContext given a set of messages. It returns an error if a fee is supplied but cannot be parsed.

func (TxContext) BuildAndSign

func (txCtx TxContext) BuildAndSign(name, passphrase string, msgs []sdk.Msg) ([]byte, error)

BuildAndSign builds a single message to be signed, and signs a transaction with the built message given a name, passphrase, and a set of messages.

func (TxContext) Sign

func (txCtx TxContext) Sign(name, passphrase string, msg auth.StdSignMsg) ([]byte, error)

Sign signs a transaction given a name, passphrase, and a single message to signed. An error is returned if signing fails.

func (TxContext) WithAccountNumber

func (txCtx TxContext) WithAccountNumber(accnum int64) TxContext

WithAccountNumber returns a copy of the context with an account number.

func (TxContext) WithChainID

func (txCtx TxContext) WithChainID(chainID string) TxContext

WithChainID returns a copy of the context with an updated chainID.

func (TxContext) WithCliCtx

func (txCtx TxContext) WithCliCtx(cliCtx CLIContext) TxContext

WithCliCtx returns a copy of the context with a CLIContext

func (TxContext) WithCodec

func (txCtx TxContext) WithCodec(cdc *wire.Codec) TxContext

WithCodec returns a copy of the context with an updated codec.

func (TxContext) WithFee

func (txCtx TxContext) WithFee(fee string) TxContext

WithFee returns a copy of the context with an updated fee.

func (TxContext) WithGas

func (txCtx TxContext) WithGas(gas int64) TxContext

WithGas returns a copy of the context with an updated gas.

func (TxContext) WithMemo

func (txCtx TxContext) WithMemo(memo string) TxContext

WithMemo returns a copy of the context with an updated memo.

func (TxContext) WithSequence

func (txCtx TxContext) WithSequence(sequence int64) TxContext

WithSequence returns a copy of the context with an updated sequence number.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL