Class SigningStargateClient

Hierarchy (view full)

Constructors

constructor

Properties

broadcastPollIntervalMs broadcastTimeoutMs registry

Methods

broadcastTx broadcastTxSync delegateTokens disconnect forceGetQueryClient forceGetTmClient getAccount getAllBalances getBalance getBalanceStaked getBlock getChainId getDelegation getHeight getQueryClient getSequence getTmClient getTx searchTx sendIbcTokens sendTokens sign signAndBroadcast signAndBroadcastSync simulate undelegateTokens withdrawRewards connect connectWithSigner create createWithSigner offline

Constructors

Protected constructor

Properties

Readonly broadcastPollIntervalMs

broadcastPollIntervalMs: undefined | number

Readonly broadcastTimeoutMs

broadcastTimeoutMs: undefined | number

Readonly registry

registry: Registry

Methods

broadcastTx

  • broadcastTx(tx, timeoutMs?, pollIntervalMs?): Promise<DeliverTxResponse>

  • 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.

    Parameters

    • tx: Uint8Array
    • timeoutMs: number = 60_000
    • pollIntervalMs: number = 3_000

    Returns Promise<DeliverTxResponse>

broadcastTxSync

  • broadcastTxSync(tx): Promise<string>

  • Broadcasts 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.

    Parameters

    • tx: Uint8Array

    Returns Promise<string>

    Returns the hash of the transaction

delegateTokens

  • delegateTokens(delegatorAddress, validatorAddress, amount, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string
    • amount: Coin
    • fee: number | "auto" | StdFee
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

disconnect

Protected forceGetQueryClient

Protected forceGetTmClient

getAccount

getAllBalances

  • getAllBalances(address): Promise<readonly Coin[]>

  • Queries all balances for all denoms that belong to this address.

    Uses the grpc queries (which iterates over the store internally), and we cannot get proofs from such a method.

    Parameters

    • address: string

    Returns Promise<readonly Coin[]>

getBalance

  • getBalance(address, searchDenom): Promise<Coin>

  • Parameters

    • address: string
    • searchDenom: string

    Returns Promise<Coin>

getBalanceStaked

  • getBalanceStaked(address): Promise<null | Coin>

  • Parameters

    • address: string

    Returns Promise<null | Coin>

getBlock

  • getBlock(height?): Promise<Block>

  • Parameters

    • Optional height: number

    Returns Promise<Block>

getChainId

  • getChainId(): Promise<string>

  • Returns Promise<string>

getDelegation

  • getDelegation(delegatorAddress, validatorAddress): Promise<null | Coin>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string

    Returns Promise<null | Coin>

getHeight

  • getHeight(): Promise<number>

  • Returns Promise<number>

Protected getQueryClient

getSequence

Protected getTmClient

  • getTmClient(): undefined | TendermintClient

  • Returns undefined | TendermintClient

getTx

searchTx

sendIbcTokens

  • sendIbcTokens(senderAddress, recipientAddress, transferAmount, sourcePort, sourceChannel, timeoutHeight, timeoutTimestamp, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • senderAddress: string
    • recipientAddress: string
    • transferAmount: Coin
    • sourcePort: string
    • sourceChannel: string
    • timeoutHeight: undefined | Height
    • timeoutTimestamp: undefined | number

      timeout in seconds

    • fee: number | "auto" | StdFee
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

sendTokens

  • sendTokens(senderAddress, recipientAddress, amount, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • senderAddress: string
    • recipientAddress: string
    • amount: readonly Coin[]
    • fee: number | "auto" | StdFee
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

sign

  • sign(signerAddress, messages, fee, memo, explicitSignerData?): Promise<TxRaw>

  • 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).

    Parameters

    • signerAddress: string
    • messages: readonly EncodeObject[]
    • fee: StdFee
    • memo: string
    • Optional explicitSignerData: SignerData

    Returns Promise<TxRaw>

signAndBroadcast

  • signAndBroadcast(signerAddress, messages, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • signerAddress: string
    • messages: readonly EncodeObject[]
    • fee: number | "auto" | StdFee
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

signAndBroadcastSync

  • signAndBroadcastSync(signerAddress, messages, fee, memo?): Promise<string>

  • This 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.

    Parameters

    • signerAddress: string
    • messages: readonly EncodeObject[]
    • fee: number | "auto" | StdFee
    • memo: string = ""

    Returns Promise<string>

    Returns the hash of the transaction

simulate

  • simulate(signerAddress, messages, memo): Promise<number>

  • Parameters

    • signerAddress: string
    • messages: readonly EncodeObject[]
    • memo: undefined | string

    Returns Promise<number>

undelegateTokens

  • undelegateTokens(delegatorAddress, validatorAddress, amount, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string
    • amount: Coin
    • fee: number | "auto" | StdFee
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

withdrawRewards

  • withdrawRewards(delegatorAddress, validatorAddress, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string
    • fee: number | "auto" | StdFee
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

Static connect

  • connect(endpoint, options?): Promise<StargateClient>

  • Creates an instance by connecting to the given Tendermint RPC endpoint.

    This uses auto-detection to decide between a Tendermint 0.37 and 0.34 client. To set the Tendermint client explicitly, use create.

    Parameters

    Returns Promise<StargateClient>

Static connectWithSigner

  • connectWithSigner(endpoint, signer, options?): Promise<SigningStargateClient>

  • Creates an instance by connecting to the given Tendermint RPC endpoint.

    This uses auto-detection to decide between a Tendermint 0.37 and 0.34 client. To set the Tendermint client explicitly, use createWithSigner.

    Parameters

    Returns Promise<SigningStargateClient>

Static create

  • create(tmClient, options?): Promise<StargateClient>

  • Creates an instance from a manually created Tendermint client. Use this to use Tendermint37Client instead of Tendermint34Client.

    Parameters

    Returns Promise<StargateClient>

Static createWithSigner

Static offline

  • offline(signer, options?): Promise<SigningStargateClient>

  • Creates 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.

    Parameters

    Returns Promise<SigningStargateClient>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc