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 NewTxBuilder(txEncoder sdk.TxEncoder, accNumber, seq, gas uint64, gasAdj float64, ...) 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) GetAccountNumber() uint64
  • func (bldr TxBuilder) GetChainID() string
  • func (bldr TxBuilder) GetFees() sdk.Coins
  • func (bldr TxBuilder) GetGas() uint64
  • func (bldr TxBuilder) GetGasAdjustment() float64
  • func (bldr TxBuilder) GetGasPrices() sdk.DecCoins
  • func (bldr TxBuilder) GetMemo() string
  • func (bldr TxBuilder) GetSequence() uint64
  • func (bldr TxBuilder) GetSimulateAndExecute() bool
  • func (bldr TxBuilder) GetTxEncoder() sdk.TxEncoder
  • 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 uint64) TxBuilder
  • func (bldr TxBuilder) WithChainID(chainID string) TxBuilder
  • func (bldr TxBuilder) WithFees(fees string) TxBuilder
  • func (bldr TxBuilder) WithGas(gas uint64) TxBuilder
  • func (bldr TxBuilder) WithGasPrices(gasPrices string) TxBuilder
  • func (bldr TxBuilder) WithMemo(memo string) TxBuilder
  • func (bldr TxBuilder) WithSequence(sequence uint64) TxBuilder
  • func (bldr TxBuilder) WithTxEncoder(txEncoder sdk.TxEncoder) 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 uint64      `json:"account_number"`
	Sequence      uint64      `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 {
	// contains filtered or unexported fields
}

TxBuilder implements a transaction context created in SDK modules.

func NewTxBuilder

func NewTxBuilder(
	txEncoder sdk.TxEncoder, accNumber, seq, gas uint64, gasAdj float64,
	simulateAndExecute bool, chainID, memo string, fees sdk.Coins, gasPrices sdk.DecCoins,
) TxBuilder

NewTxBuilder returns a new initialized TxBuilder.

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) GetAccountNumber

func (bldr TxBuilder) GetAccountNumber() uint64

GetAccountNumber returns the account number

func (TxBuilder) GetChainID

func (bldr TxBuilder) GetChainID() string

GetChainID returns the chain id

func (TxBuilder) GetFees

func (bldr TxBuilder) GetFees() sdk.Coins

GetFees returns the fees for the transaction

func (TxBuilder) GetGas

func (bldr TxBuilder) GetGas() uint64

GetGas returns the gas for the transaction

func (TxBuilder) GetGasAdjustment

func (bldr TxBuilder) GetGasAdjustment() float64

GetGasAdjustment returns the gas adjustment

func (TxBuilder) GetGasPrices

func (bldr TxBuilder) GetGasPrices() sdk.DecCoins

GetGasPrices returns the gas prices set for the transaction, if any.

func (TxBuilder) GetMemo

func (bldr TxBuilder) GetMemo() string

GetMemo returns the memo message

func (TxBuilder) GetSequence

func (bldr TxBuilder) GetSequence() uint64

GetSequence returns the transaction sequence

func (TxBuilder) GetSimulateAndExecute

func (bldr TxBuilder) GetSimulateAndExecute() bool

GetSimulateAndExecute returns the option to simulate and then execute the transaction using the gas from the simulation results

func (TxBuilder) GetTxEncoder

func (bldr TxBuilder) GetTxEncoder() sdk.TxEncoder

GetTxEncoder returns the transaction encoder

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 uint64) 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) WithFees

func (bldr TxBuilder) WithFees(fees string) TxBuilder

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

func (TxBuilder) WithGas

func (bldr TxBuilder) WithGas(gas uint64) TxBuilder

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

func (TxBuilder) WithGasPrices

func (bldr TxBuilder) WithGasPrices(gasPrices string) TxBuilder

WithGasPrices returns a copy of the context with updated gas prices.

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 uint64) TxBuilder

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

func (TxBuilder) WithTxEncoder

func (bldr TxBuilder) WithTxEncoder(txEncoder sdk.TxEncoder) TxBuilder

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