Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TFClient

Hierarchy

  • Client
    • TFClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TFClient(url: string, mnemonic: string, storeSecret: string | Uint8Array, keypairType?: KeypairType): TFClient

Properties

address

address: string

api

api: ApiPromise

balances

balances: TFBalances = ...

contracts

contracts: TFContracts = ...

Optional extSigner

extSigner?: ExtSigner

farms

farms: QueryFarms

keypair

keypair: KeyringPair

keypairType

keypairType: KeypairType = KeypairType.sr25519

kvStore

kvStore: TFKVStore = ...

mnemonic

mnemonic: string

Optional mnemonicOrSecret

mnemonicOrSecret?: string

nodes

nodes: Nodes

pricingPolicies

pricingPolicies: QueryPricingPolicies

storeSecret

storeSecret: string | Uint8Array

termsAndConditions

termsAndConditions: TFTermsAndConditions = ...

tftBridge

tftBridge: QueryTFTBridge

tftPrice

tftPrice: TFTPrice = ...

twins

twins: TFTwins = ...

url

url: string

utility

utility: Utility

Static connections

connections: Map<string, ApiPromise>

Static lock

lock: default

Methods

applyAllExtrinsics

  • applyAllExtrinsics<T>(extrinsics: ExtrinsicResult<T>[]): Promise<T[]>

  • Type Parameters

    • T

    Parameters

    • extrinsics: ExtrinsicResult<T>[]

    Returns Promise<T[]>

applyExtrinsic

  • applyExtrinsic<T>(extrinsic: SubmittableExtrinsic<"promise", ISubmittableResult>, resultSections?: string[], resultEvents?: string[]): Promise<T>

  • Type Parameters

    • T

    Parameters

    • extrinsic: SubmittableExtrinsic<"promise", ISubmittableResult>
    • Optional resultSections: string[]
    • Optional resultEvents: string[]

    Returns Promise<T>

checkInputs

  • checkInputs(): void

  • Returns void

connect

  • connect(): Promise<void>

  • Returns Promise<void>

disconnect

  • disconnect(): Promise<void>

  • Returns Promise<void>

disconnectAndExit

  • disconnectAndExit(): Promise<void>

  • Returns Promise<void>

listenForEvent

  • listenForEvent<T>(section: string, method: string, validator: validatorFunctionType, timeoutInMinutes?: number): Promise<T>

  • Listens for a specific event on the chain and resolves when the event matches the specified conditions.

    throws

    {Error} - If the section or method is not defined on the chain.

    rejects

    If no response is received within the given time or if an error occurs during validation.

    Type Parameters

    • T

    Parameters

    • section: string

      The section of the event to listen for.

    • method: string

      The method of the event to listen for.

    • validator: validatorFunctionType

      The validator function to validate the event data.

    • Optional timeoutInMinutes: number

      The timeout value in minutes. Default is 2 minutes.

    Returns Promise<T>

    • A promise that resolves with the event data when the event matches the conditions.

loadKeyPairOrSigner

  • loadKeyPairOrSigner(): Promise<void>

  • Returns Promise<void>

patchExtrinsic

  • patchExtrinsic<R>(extrinsic: Extrinsic, options?: PatchExtrinsicOptions<R>): ExtrinsicResult<R>

  • Type Parameters

    • R

    Parameters

    • extrinsic: Extrinsic
    • Optional options: PatchExtrinsicOptions<R>

    Returns ExtrinsicResult<R>

Generated using TypeDoc