Documentation
¶
Index ¶
- func BroadcastTx(clientCtx client.Context, txf Factory, msgs ...sdk.Msg) error
- func BuildSimTx(txf Factory, msgs ...sdk.Msg) ([]byte, error)
- func BuildUnsignedTx(txf Factory, msgs ...sdk.Msg) (client.TxBuilder, error)
- func CalculateGas(clientCtx gogogrpc.ClientConn, txf Factory, msgs ...sdk.Msg) (*tx.SimulateResponse, uint64, error)
- func ConvertTxToStdTx(codec *codec.LegacyAmino, tx signing.Tx) (legacytx.StdTx, error)
- func CopyTx(tx signing.Tx, builder client.TxBuilder, ignoreSignatureError bool) error
- func GenerateOrBroadcastTxCLI(clientCtx client.Context, flagSet *pflag.FlagSet, msgs ...sdk.Msg) error
- func GenerateOrBroadcastTxWithFactory(clientCtx client.Context, txf Factory, msgs ...sdk.Msg) error
- func GenerateTx(clientCtx client.Context, txf Factory, msgs ...sdk.Msg) error
- func Sign(txf Factory, name string, txBuilder client.TxBuilder, overwriteSig bool) error
- func SignWithPrivKey(signMode signing.SignMode, signerData authsigning.SignerData, ...) (signing.SignatureV2, error)
- func WriteGeneratedTxResponse(clientCtx client.Context, w http.ResponseWriter, br rest.BaseReq, ...)
- type Factory
- func (f Factory) AccountNumber() uint64
- func (f Factory) AccountRetriever() client.AccountRetriever
- func (f Factory) ChainID() string
- func (f Factory) Fees() sdk.Coins
- func (f Factory) Gas() uint64
- func (f Factory) GasAdjustment() float64
- func (f Factory) GasPrices() sdk.DecCoins
- func (f Factory) Keybase() keyring.Keyring
- func (f Factory) Memo() string
- func (f Factory) Sequence() uint64
- func (f Factory) SignMode() signing.SignMode
- func (f Factory) SimulateAndExecute() bool
- func (f Factory) TimeoutHeight() uint64
- func (f Factory) WithAccountNumber(accnum uint64) Factory
- func (f Factory) WithAccountRetriever(ar client.AccountRetriever) Factory
- func (f Factory) WithChainID(chainID string) Factory
- func (f Factory) WithFees(fees string) Factory
- func (f Factory) WithGas(gas uint64) Factory
- func (f Factory) WithGasAdjustment(gasAdj float64) Factory
- func (f Factory) WithGasPrices(gasPrices string) Factory
- func (f Factory) WithKeybase(keybase keyring.Keyring) Factory
- func (f Factory) WithMemo(memo string) Factory
- func (f Factory) WithSequence(sequence uint64) Factory
- func (f Factory) WithSignMode(mode signing.SignMode) Factory
- func (f Factory) WithSimulateAndExecute(sim bool) Factory
- func (f Factory) WithTimeoutHeight(height uint64) Factory
- func (f Factory) WithTxConfig(g client.TxConfig) Factory
- type GasEstimateResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BroadcastTx ¶
BroadcastTx attempts to generate, sign and broadcast a transaction with the given set of messages. It will also simulate gas requirements if necessary. It will return an error upon failure.
func BuildSimTx ¶
BuildSimTx creates an unsigned tx with an empty single signature and returns the encoded transaction or an error if the unsigned transaction cannot be built.
func BuildUnsignedTx ¶
BuildUnsignedTx builds a transaction to be signed given a set of messages. The transaction is initially created via the provided factory's generator. Once created, the fee, memo, and messages are set.
func CalculateGas ¶
func CalculateGas( clientCtx gogogrpc.ClientConn, txf Factory, msgs ...sdk.Msg, ) (*tx.SimulateResponse, uint64, error)
CalculateGas simulates the execution of a transaction and returns the simulation response obtained by the query and the adjusted gas amount.
func ConvertTxToStdTx ¶
ConvertTxToStdTx converts a transaction to the legacy StdTx format
func CopyTx ¶
CopyTx copies a Tx to a new TxBuilder, allowing conversion between different transaction formats. If ignoreSignatureError is true, copying will continue tx even if the signature cannot be set in the target builder resulting in an unsigned tx.
func GenerateOrBroadcastTxCLI ¶
func GenerateOrBroadcastTxCLI(clientCtx client.Context, flagSet *pflag.FlagSet, msgs ...sdk.Msg) error
GenerateOrBroadcastTxCLI will either generate and print and unsigned transaction or sign it and broadcast it returning an error upon failure.
func GenerateOrBroadcastTxWithFactory ¶
GenerateOrBroadcastTxWithFactory will either generate and print and unsigned transaction or sign it and broadcast it returning an error upon failure.
func GenerateTx ¶
GenerateTx will generate an unsigned transaction and print it to the writer specified by ctx.Output. If simulation was requested, the gas will be simulated and also printed to the same writer before the transaction is printed.
func Sign ¶
Sign signs a given tx with a named key. The bytes signed over are canconical. The resulting signature will be added to the transaction builder overwriting the previous ones if overwrite=true (otherwise, the signature will be appended). Signing a transaction with mutltiple signers in the DIRECT mode is not supprted and will return an error. An error is returned upon failure.
func SignWithPrivKey ¶
func SignWithPrivKey( signMode signing.SignMode, signerData authsigning.SignerData, txBuilder client.TxBuilder, priv cryptotypes.PrivKey, txConfig client.TxConfig, accSeq uint64, ) (signing.SignatureV2, error)
SignWithPrivKey signs a given tx with the given private key, and returns the corresponding SignatureV2 if the signing is successful.
func WriteGeneratedTxResponse ¶
func WriteGeneratedTxResponse( clientCtx client.Context, w http.ResponseWriter, br rest.BaseReq, msgs ...sdk.Msg, )
WriteGeneratedTxResponse writes a generated unsigned transaction to the provided http.ResponseWriter. It will simulate gas costs if requested by the BaseReq. Upon any error, the error will be written to the http.ResponseWriter. Note that this function returns the legacy StdTx Amino JSON format for compatibility with legacy clients. Deprecated: We are removing Amino soon.
Types ¶
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
Factory defines a client transaction factory that facilitates generating and signing an application-specific transaction.
func NewFactoryCLI ¶
NewFactoryCLI creates a new Factory.
func (Factory) AccountNumber ¶
func (Factory) AccountRetriever ¶
func (f Factory) AccountRetriever() client.AccountRetriever
func (Factory) GasAdjustment ¶
func (Factory) SimulateAndExecute ¶
SimulateAndExecute returns the option to simulate and then execute the transaction using the gas from the simulation results
func (Factory) TimeoutHeight ¶
func (Factory) WithAccountNumber ¶
WithAccountNumber returns a copy of the Factory with an updated account number.
func (Factory) WithAccountRetriever ¶
func (f Factory) WithAccountRetriever(ar client.AccountRetriever) Factory
WithAccountRetriever returns a copy of the Factory with an updated AccountRetriever.
func (Factory) WithChainID ¶
WithChainID returns a copy of the Factory with an updated chainID.
func (Factory) WithGasAdjustment ¶
WithGasAdjustment returns a copy of the Factory with an updated gas adjustment.
func (Factory) WithGasPrices ¶
WithGasPrices returns a copy of the Factory with updated gas prices.
func (Factory) WithKeybase ¶
WithKeybase returns a copy of the Factory with updated Keybase.
func (Factory) WithSequence ¶
WithSequence returns a copy of the Factory with an updated sequence number.
func (Factory) WithSignMode ¶
WithSignMode returns a copy of the Factory with an updated sign mode value.
func (Factory) WithSimulateAndExecute ¶
WithSimulateAndExecute returns a copy of the Factory with an updated gas simulation value.
func (Factory) WithTimeoutHeight ¶
WithTimeoutHeight returns a copy of the Factory with an updated timeout height.
type GasEstimateResponse ¶
type GasEstimateResponse struct {
GasEstimate uint64 `json:"gas_estimate" yaml:"gas_estimate"`
}
GasEstimateResponse defines a response definition for tx gas estimation.
func (GasEstimateResponse) String ¶
func (gr GasEstimateResponse) String() string
Source Files