Class Client

Hierarchy

QueryClient
- Client

Constructors

constructor

new Client(options: ClientOptions): Client
Parameters
- options: ClientOptions
Returns Client
Overrides QueryClient.constructor
- Defined in client.ts:228

Properties

address

address: string

api

api: ApiPromise

balances

balances: Balances = ...

contracts

contracts: Contracts = ...

`Optional` extSigner

extSigner?: ExtSigner

farms

farms: QueryFarms = ...

keypair

keypair: KeyringPair

keypairType

keypairType: KeypairType

kvStore

kvStore: KVStore = ...

`Optional` mnemonicOrSecret

mnemonicOrSecret?: string

nodes

nodes: Nodes = ...

pricingPolicies

pricingPolicies: QueryPricingPolicies = ...

termsAndConditions

termsAndConditions: TermsAndConditions = ...

tftBridge

tftBridge: QueryTFTBridge = ...

tftPrice

tftPrice: QueryTFTPrice = ...

twins

twins: Twins = ...

url

url: string

utility

utility: Utility = ...

`Static` connections

connections: Map<string, ApiPromise> = ...

`Static` lock

lock: default = ...

Methods

`Private` _applyExtrinsic

_applyExtrinsic<T>(extrinsic: SubmittableExtrinsic<"promise", ISubmittableResult>, resultSections?: string[], resultEvents?: string[]): Promise<T>
Type Parameters
- T
Parameters
- extrinsic: SubmittableExtrinsic<"promise", ISubmittableResult>
- resultSections: string[] = []
- resultEvents: string[] = []
Returns Promise<T>
- Defined in client.ts:278

applyAllExtrinsics

applyAllExtrinsics<T>(extrinsics: ExtrinsicResult<T>[]): Promise<T[]>
Type Parameters
- T
Parameters
- extrinsics: ExtrinsicResult<T>[]
Returns Promise<T[]>
- Defined in client.ts:359

applyExtrinsic

applyExtrinsic<T>(extrinsic: SubmittableExtrinsic<"promise", ISubmittableResult>, resultSections?: string[], resultEvents?: string[]): Promise<T>
Type Parameters
- T
Parameters
- extrinsic: SubmittableExtrinsic<"promise", ISubmittableResult>
- resultSections: string[] = ...
- resultEvents: string[] = []
Returns Promise<T>
- Defined in client.ts:343

checkInputs

checkInputs(): void
Returns void
Overrides QueryClient.checkInputs
- Defined in client.ts:235

connect

connect(): Promise<void>
Returns Promise<void>
Inherited from QueryClient.connect
- Defined in client.ts:71

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Inherited from QueryClient.disconnect
- Defined in client.ts:107

disconnectAndExit

disconnectAndExit(): Promise<void>
Returns Promise<void>
Inherited from QueryClient.disconnectAndExit
- Defined in client.ts:116

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.

Returns
- A promise that resolves with the event data when the event matches the conditions.
Throws
- 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.
- timeoutInMinutes: number = 2
  
  The timeout value in minutes. Default is 2 minutes.
Returns Promise<T>
Inherited from QueryClient.listenForEvent
- Defined in client.ts:162

loadKeyPairOrSigner

loadKeyPairOrSigner(): Promise<void>
Returns Promise<void>
Overrides QueryClient.loadKeyPairOrSigner
- Defined in client.ts:261

patchExtrinsic

patchExtrinsic<R>(extrinsic: Extrinsic, options?: PatchExtrinsicOptions<R>): ExtrinsicResult<R>
Type Parameters
- R
Parameters
- extrinsic: Extrinsic
- options: PatchExtrinsicOptions<R> = {}
Returns ExtrinsicResult<R>
- Defined in client.ts:363

Generated using TypeDoc