context

Documentation

Index

• func MakeSignature(name, passphrase string, msg StdSignMsg) (sig auth.StdSignature, err error)
• type StdSignMsg
  • func (msg StdSignMsg) Bytes() []byte
• type TxBuilder
  • func NewTxBuilderFromCLI() TxBuilder
  • func (bldr TxBuilder) Build(msgs []sdk.Msg) (StdSignMsg, error)
  • func (bldr TxBuilder) BuildAndSign(name, passphrase string, msgs []sdk.Msg) ([]byte, error)
  • func (bldr TxBuilder) BuildWithPubKey(name string, msgs []sdk.Msg) ([]byte, error)
  • func (bldr TxBuilder) Sign(name, passphrase string, msg StdSignMsg) ([]byte, error)
  • func (bldr TxBuilder) SignStdTx(name, passphrase string, stdTx auth.StdTx, appendSig bool) (signedStdTx auth.StdTx, err error)
  • func (bldr TxBuilder) WithAccountNumber(accnum int64) TxBuilder
  • func (bldr TxBuilder) WithChainID(chainID string) TxBuilder
  • func (bldr TxBuilder) WithCodec(cdc *codec.Codec) TxBuilder
  • func (bldr TxBuilder) WithFee(fee string) TxBuilder
  • func (bldr TxBuilder) WithGas(gas int64) TxBuilder
  • func (bldr TxBuilder) WithMemo(memo string) TxBuilder
  • func (bldr TxBuilder) WithSequence(sequence int64) TxBuilder

Functions

func MakeSignature

func MakeSignature(name, passphrase string, msg StdSignMsg) (sig auth.StdSignature, err error)

MakeSignature builds a StdSignature given key name, passphrase, and a StdSignMsg.

Types

type StdSignMsg

type StdSignMsg struct {
	ChainID       string      `json:"chain_id"`
	AccountNumber int64       `json:"account_number"`
	Sequence      int64       `json:"sequence"`
	Fee           auth.StdFee `json:"fee"`
	Msgs          []sdk.Msg   `json:"msgs"`
	Memo          string      `json:"memo"`
}

StdSignMsg is a convenience structure for passing along a Msg with the other requirements for a StdSignDoc before it is signed. For use in the CLI.

func (StdSignMsg) Bytes

func (msg StdSignMsg) Bytes() []byte

get message bytes

type TxBuilder

type TxBuilder struct {
	Codec         *codec.Codec
	AccountNumber int64
	Sequence      int64
	Gas           int64 // TODO: should this turn into uint64? requires further discussion - see #2173
	GasAdjustment float64
	SimulateGas   bool
	ChainID       string
	Memo          string
	Fee           string
}

TxBuilder implements a transaction context created in SDK modules.

func NewTxBuilderFromCLI

func NewTxBuilderFromCLI() TxBuilder

NewTxBuilderFromCLI returns a new initialized TxBuilder with parameters from the command line using Viper.

func (TxBuilder) Build

func (bldr TxBuilder) Build(msgs []sdk.Msg) (StdSignMsg, error)

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

func (TxBuilder) BuildAndSign

func (bldr TxBuilder) 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 (TxBuilder) BuildWithPubKey

func (bldr TxBuilder) BuildWithPubKey(name string, msgs []sdk.Msg) ([]byte, error)

BuildWithPubKey builds a single message to be signed from a TxBuilder given a set of messages and attach the public key associated to the given name. It returns an error if a fee is supplied but cannot be parsed or the key cannot be retrieved.

func (TxBuilder) Sign

func (bldr TxBuilder) Sign(name, passphrase string, msg 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 (TxBuilder) SignStdTx

func (bldr TxBuilder) SignStdTx(name, passphrase string, stdTx auth.StdTx, appendSig bool) (signedStdTx auth.StdTx, err error)

SignStdTx appends a signature to a StdTx and returns a copy of a it. If append is false, it replaces the signatures already attached with the new signature.

func (TxBuilder) WithAccountNumber

func (bldr TxBuilder) WithAccountNumber(accnum int64) TxBuilder

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

func (TxBuilder) WithChainID

func (bldr TxBuilder) WithChainID(chainID string) TxBuilder

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

func (TxBuilder) WithCodec

func (bldr TxBuilder) WithCodec(cdc *codec.Codec) TxBuilder

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

func (TxBuilder) WithFee

func (bldr TxBuilder) WithFee(fee string) TxBuilder

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

func (TxBuilder) WithGas

func (bldr TxBuilder) WithGas(gas int64) TxBuilder

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

func (TxBuilder) WithMemo

func (bldr TxBuilder) WithMemo(memo string) TxBuilder

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

func (TxBuilder) WithSequence

func (bldr TxBuilder) WithSequence(sequence int64) TxBuilder

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