Skip to main content

Class: Validator

Validator provides direct access to remote Validator REST APIs.

Constructors

constructor

new Validator(config?)

Create a Validator instance with the specified connection configuration.

Parameters

NameTypeDescription
configPartial<ReadConfig>The connection configuration. This must include a baseUrl string. If passing the config from a pre-existing Database instance, it must have a non-null baseUrl key defined.

Defined in

@tableland/sdk/src/validator/index.ts:53

Properties

config

Readonly config: ReadConfig

Defined in

@tableland/sdk/src/validator/index.ts:46

Methods

getTableById

getTableById(params, signal?): Promise<Table>

Get table information

Description

Returns information about a single table, including schema information

Parameters

NameTypeDescription
paramsObject-
params.chainIdnumberDescription The parent chain to target Example ts 80001
params.tableIdstringDescription Table identifier Example ts 1
signal?Signal-

Returns

Promise<Table>

Defined in

@tableland/sdk/src/validator/index.ts:91


health

health(signal?): Promise<boolean>

Get health status

Description

Returns OK if the validator considers itself healthy

Parameters

NameType
signal?Signal

Returns

Promise<boolean>

Defined in

@tableland/sdk/src/validator/index.ts:75


pollForReceiptByTransactionHash

pollForReceiptByTransactionHash(params, controller?): Promise<Camelize<AssertedResponse>>

Wait for transaction status

Description

Polls for the status of a given transaction receipt by hash until

Parameters

NameTypeDescription
paramsObject-
params.chainIdnumberDescription The parent chain to target Example ts 80001
params.transactionHashstringDescription The transaction hash to request Example ts 0x02f319429b8a7be1cbb492f0bfbf740d2472232a2edadde7df7c16c0b61aa78b
controller?PollingController-

Returns

Promise<Camelize<AssertedResponse>>

Defined in

@tableland/sdk/src/validator/index.ts:135


queryByStatement

queryByStatement<T>(params, signal?): Promise<ObjectsFormat<T>>

Query the network

Description

Returns the results of a SQL read query against the Tabeland network

Type parameters

NameType
Tunknown

Parameters

NameType
paramsQueryParams<undefined | "objects">
signal?Signal

Returns

Promise<ObjectsFormat<T>>

Defined in

@tableland/sdk/src/validator/index.ts:105

queryByStatement<T>(params, signal?): Promise<TableFormat<T>>

Type parameters

NameType
Tunknown

Parameters

NameType
paramsQueryParams<"table">
signal?Signal

Returns

Promise<TableFormat<T>>

Defined in

@tableland/sdk/src/validator/index.ts:109


receiptByTransactionHash

receiptByTransactionHash(params, signal?): Promise<Camelize<AssertedResponse>>

Get transaction status

Description

Returns the status of a given transaction receipt by hash

Parameters

NameTypeDescription
paramsObject-
params.chainIdnumberDescription The parent chain to target Example ts 80001
params.transactionHashstringDescription The transaction hash to request Example ts 0x02f319429b8a7be1cbb492f0bfbf740d2472232a2edadde7df7c16c0b61aa78b
signal?Signal-

Returns

Promise<Camelize<AssertedResponse>>

Defined in

@tableland/sdk/src/validator/index.ts:124


version

version(signal?): Promise<Camelize<Required<{ binary_version?: string ; build_date?: string ; git_branch?: string ; git_commit?: string ; git_state?: string ; git_summary?: string ; version?: number }>>>

Get version information

Description

Returns version information about the validator daemon

Parameters

NameType
signal?Signal

Returns

Promise<Camelize<Required<{ binary_version?: string ; build_date?: string ; git_branch?: string ; git_commit?: string ; git_state?: string ; git_summary?: string ; version?: number }>>>

Defined in

@tableland/sdk/src/validator/index.ts:83


forChain

Static forChain(chainNameOrId): Validator

Create a new Validator instance that uses the default baseUrl for a given chain.

Parameters

NameTypeDescription
chainNameOrIdnumber | keyof TablelandNetworkConfigThe name or id of the chain to target.

Returns

Validator

A Validator with a default baseUrl.

Defined in

@tableland/sdk/src/validator/index.ts:66