Protected
constructorReadonly
broadcastReadonly
broadcastReadonly
registryBroadcasts a signed transaction to the network without monitoring it.
If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure), an error is thrown.
If the transaction is broadcasted, a string
containing the hash of the transaction is returned. The caller then
usually needs to check if the transaction was included in a block and was successful.
Returns the hash of the transaction
Protected
forceProtected
forceProtected
getProtected
getThis API does not support setting the memo field of MsgTransfer
(only the transaction memo).
We'll remove this method at some point because trying to wrap the various message types is a losing strategy.
Please migrate to signAndBroadcast
with an MsgTransferEncodeObject
created in the caller code instead.
timeout in seconds
Gets account number and sequence from the API, creates a sign doc, creates a single signature and assembles the signed transaction.
The sign mode (SIGN_MODE_DIRECT or SIGN_MODE_LEGACY_AMINO_JSON) is determined by this client's signer.
You can pass signer data (account number, sequence and chain ID) explicitly instead of querying them from the chain. This is needed when signing for a multisig account, but it also allows for offline signing (See the SigningStargateClient.offline constructor).
Optional
explicitSignerData: SignerDataOptional
timeoutHeight: bigintOptional
timeoutHeight: bigintThis method is useful if you want to send a transaction in broadcast, without waiting for it to be placed inside a block, because for example I would like to receive the hash to later track the transaction with another tool.
Returns the hash of the transaction
Optional
timeoutHeight: bigintStatic
connectCreates an instance by connecting to the given CometBFT RPC endpoint.
This uses auto-detection to decide between a CometBFT 0.38, Tendermint 0.37 and 0.34 client.
To set the Comet client explicitly, use create
.
Static
connectCreates an instance by connecting to the given CometBFT RPC endpoint.
This uses auto-detection to decide between a CometBFT 0.38, Tendermint 0.37 and 0.34 client.
To set the Comet client explicitly, use createWithSigner
.
Static
createCreates an instance from a manually created Comet client.
Use this to use Comet38Client
or Tendermint37Client
instead of Tendermint34Client
.
Static
createCreates an instance from a manually created Comet client.
Use this to use Comet38Client
or Tendermint37Client
instead of Tendermint34Client
.
Static
offlineCreates a client in offline mode.
This should only be used in niche cases where you know exactly what you're doing, e.g. when building an offline signing application.
When you try to use online functionality with such a signer, an exception will be raised.
Generated using TypeDoc
Broadcasts a signed transaction to the network and monitors its inclusion in a block.
If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure), an error is thrown.
If the transaction is not included in a block before the provided timeout, this errors with a
TimeoutError
.If the transaction is included in a block, a
DeliverTxResponse
is returned. The caller then usually needs to check for execution success or failure.