Class Client

_logger

_maxAttempts

_timer

defaultMaxQueryPayment

• get defaultMaxQueryPayment(): Hbar

• Returns Hbar

defaultMaxTransactionFee

• get defaultMaxTransactionFee(): null | Hbar

• Returns null | Hbar

defaultRegenerateTransactionId

• get defaultRegenerateTransactionId(): boolean

• Returns boolean

isClientShutDown

• get isClientShutDown(): boolean

• Returns boolean

ledgerId

• get ledgerId(): null | LedgerId

• Returns null | LedgerId

logger

• get logger(): null | Logger

• Get logger if set

  Returns null | Logger

maxAttempts

• get maxAttempts(): number

• Returns number

maxBackoff

• get maxBackoff(): number

• Returns number

maxNodeAttempts

• get maxNodeAttempts(): number

• Returns number

maxNodesPerTransaction

• get maxNodesPerTransaction(): number

• Returns number

maxQueryPayment

• get maxQueryPayment(): Hbar

• Returns Hbar

  Deprecated

  in a favor of defaultMaxQueryPayment

maxTransactionFee

• get maxTransactionFee(): null | Hbar

• Returns null | Hbar

  Deprecated

  • Use defaultMaxTransactionFee instead

minBackoff

• get minBackoff(): number

• Returns number

mirrorNetwork

• get mirrorNetwork(): string[]

• Returns string[]

network

• get network(): {
      [key: string]: string | AccountId;
  }

• Returns {
      [key: string]: string | AccountId;
  }

  • [key: string]: string | AccountId

networkName

• get networkName(): null | string

• Returns null | string

  Deprecated

networkUpdatePeriod

• get networkUpdatePeriod(): number

• Returns number

nodeMaxBackoff

• get nodeMaxBackoff(): number

• Returns number

nodeMaxReadmitPeriod

• get nodeMaxReadmitPeriod(): number

• Returns number

nodeMinBackoff

• get nodeMinBackoff(): number

• Returns number

nodeMinReadmitPeriod

• get nodeMinReadmitPeriod(): number

• Returns number

nodeWaitTime

• get nodeWaitTime(): number

• Returns number

operatorAccountId

• get operatorAccountId(): null | AccountId

• Returns null | AccountId

operatorPublicKey

• get operatorPublicKey(): null | PublicKey

• Returns null | PublicKey

requestTimeout

• get requestTimeout(): null | number

• Returns null | number

signOnDemand

• get signOnDemand(): boolean

• Returns boolean

close

• close(): void

• Returns void

getOperator

• getOperator(): null | ClientOperator

• Returns null | ClientOperator

isAutoValidateChecksumsEnabled

• isAutoValidateChecksumsEnabled(): boolean

• Returns boolean

isTransportSecurity

• isTransportSecurity(): boolean

• Returns boolean

ping

• ping(accountId): Promise<void>

• Parameters

  • accountId: string | AccountId

  Returns Promise<void>

pingAll

• pingAll(): Promise<void>

• Returns Promise<void>

setAutoValidateChecksums

• setAutoValidateChecksums(value): Client

• Parameters

  • value: boolean

  Returns Client

setDefaultMaxQueryPayment

• setDefaultMaxQueryPayment(defaultMaxQueryPayment): default<default, any>

• Set the maximum payment allowable for queries.

  Parameters

  • defaultMaxQueryPayment: Hbar

  Returns default<default, any>

setDefaultMaxTransactionFee

• setDefaultMaxTransactionFee(defaultMaxTransactionFee): Client

• Set the defaultimum fee to be paid for transactions executed by this client.

  Parameters

  • defaultMaxTransactionFee: Hbar

  Returns Client

setDefaultRegenerateTransactionId

• setDefaultRegenerateTransactionId(defaultRegenerateTransactionId): Client

• Set if a new transaction ID should be generated when a TRANSACTION_EXPIRED status is returned.

  Parameters

  • defaultRegenerateTransactionId: boolean

  Returns Client

setLedgerId

• setLedgerId(ledgerId): Client

• Parameters

  • ledgerId: string | LedgerId

  Returns Client

setLogger

• setLogger(logger): Client

• Set logger

  Parameters

  • logger: Logger

  Returns Client

setMaxAttempts

• setMaxAttempts(maxAttempts): Client

• Parameters

  • maxAttempts: number

  Returns Client

setMaxBackoff

• setMaxBackoff(maxBackoff): Client

• Parameters

  • maxBackoff: null | number

  Returns Client

setMaxNodeAttempts

• setMaxNodeAttempts(maxNodeAttempts): Client

• Parameters

  • maxNodeAttempts: number

  Returns Client

setMaxNodesPerTransaction

• setMaxNodesPerTransaction(maxNodesPerTransaction): Client

• Parameters

  • maxNodesPerTransaction: number

  Returns Client

setMaxQueryPayment

• setMaxQueryPayment(maxQueryPayment): default<default, any>

• Parameters

  • maxQueryPayment: Hbar

  Returns default<default, any>

  Deprecated

  in a favor of setDefaultMaxQueryPayment() Set the maximum payment allowable for queries.

setMaxTransactionFee

• setMaxTransactionFee(maxTransactionFee): Client

• Parameters

  • maxTransactionFee: Hbar

  Returns Client

  Deprecated

  • Use setDefaultMaxTransactionFee() instead Set the maximum fee to be paid for transactions executed by this client.

setMinBackoff

• setMinBackoff(minBackoff): Client

• Parameters

  • minBackoff: null | number

  Returns Client

setNetworkFromAddressBook

• setNetworkFromAddressBook(addressBook): Client

• Parameters

  • addressBook: default

  Returns Client

setNetworkName

• setNetworkName(networkName): Client

• Parameters

  • networkName: ClientNetworkName

  Returns Client

  Deprecated

setNetworkUpdatePeriod

• setNetworkUpdatePeriod(networkUpdatePeriod): Client

• Parameters

  • networkUpdatePeriod: number

  Returns Client

setNodeMaxBackoff

• setNodeMaxBackoff(nodeMaxBackoff): Client

• Parameters

  • nodeMaxBackoff: number

  Returns Client

setNodeMaxReadmitPeriod

• setNodeMaxReadmitPeriod(nodeMaxReadmitPeriod): Client

• Parameters

  • nodeMaxReadmitPeriod: number

  Returns Client

setNodeMinBackoff

• setNodeMinBackoff(nodeMinBackoff): Client

• Parameters

  • nodeMinBackoff: number

  Returns Client

setNodeMinReadmitPeriod

• setNodeMinReadmitPeriod(nodeMinReadmitPeriod): Client

• Parameters

  • nodeMinReadmitPeriod: number

  Returns Client

setNodeWaitTime

• setNodeWaitTime(nodeWaitTime): Client

• Parameters

  • nodeWaitTime: number

  Returns Client

setOperator

• setOperator(accountId, privateKey): Client

• Set the account that will, by default, pay for transactions and queries built with this client.

  Parameters

  • accountId: string | AccountId

  • privateKey: string | PrivateKey

  Returns Client

setOperatorWith

• setOperatorWith(accountId, publicKey, transactionSigner): Client

• Sets the account that will, by default, pay for transactions and queries built with this client.

  Parameters

  • accountId: string | AccountId

  • publicKey: string | PublicKey

  • transactionSigner: ((message) => Promise<Uint8Array>)

    • • (message): Promise<Uint8Array>

      • Parameters

        • message: Uint8Array

        Returns Promise<Uint8Array>

  Returns Client

setRequestTimeout

• setRequestTimeout(requestTimeout): Client

• Parameters

  • requestTimeout: number

    Number of milliseconds

  Returns Client

setSignOnDemand

• setSignOnDemand(signOnDemand): void

• Parameters

  • signOnDemand: boolean

  Returns void

setTransportSecurity

• setTransportSecurity(transportSecurity): Client

• Parameters

  • transportSecurity: boolean

  Returns Client