Class Validator

constructor

• new Validator(config?): Validator

• Create a Validator instance with the specified connection configuration.

  Parameters

  • config: Partial<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.

  Returns Validator

Readonly config

getTableById

• getTableById(params, opts?): Promise<Table>

• Get table information

  Parameters

  • params: {
        chainId: number;
        tableId: string;
    }

    • chainId: number

      Description

      The parent chain to target

      Example

      80001
      Copy

    • tableId: string

      Description

      Table identifier

      Example

      1
      Copy

  • opts: Signal = {}

  Returns Promise<Table>

  Description

  Returns information about a single table, including schema information

health

• health(opts?): Promise<boolean>

• Get health status

  Parameters

  • opts: Signal = {}

  Returns Promise<boolean>

  Description

  Returns OK if the validator considers itself healthy

pollForReceiptByTransactionHash

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

• Wait for transaction status

  Parameters

  • params: {
        chainId: number;
        transactionHash: string;
    }

    • chainId: number

      Description

      The parent chain to target

      Example

      80001
      Copy

    • transactionHash: string

      Description

      The transaction hash to request

      Example

      0x02f319429b8a7be1cbb492f0bfbf740d2472232a2edadde7df7c16c0b61aa78b
      Copy

  • opts: SignalAndInterval = {}

  Returns Promise<Camelize<AssertedResponse>>

  Description

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

queryByStatement

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

• Query the network

  Type Parameters

  • T = unknown

  Parameters

  • params: QueryParams<undefined | "objects">

  • Optional opts: Signal

  Returns Promise<ObjectsFormat<T>>

  Description

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

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

• Type Parameters

  • T = unknown

  Parameters

  • params: QueryParams<"table">

  • Optional opts: Signal

  Returns Promise<TableFormat<T>>

receiptByTransactionHash

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

• Get transaction status

  Parameters

  • params: {
        chainId: number;
        transactionHash: string;
    }

    • chainId: number

      Description

      The parent chain to target

      Example

      80001
      Copy

    • transactionHash: string

      Description

      The transaction hash to request

      Example

      0x02f319429b8a7be1cbb492f0bfbf740d2472232a2edadde7df7c16c0b61aa78b
      Copy

  • opts: Signal = {}

  Returns Promise<Camelize<AssertedResponse>>

  Description

  Returns the status of a given transaction receipt by hash

version

• version(opts?): 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

  Parameters

  • opts: 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;
  }>>>

  Description

  Returns version information about the validator daemon

Static forChain

• forChain(chainNameOrId): Validator

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

  Parameters

  • chainNameOrId: number | keyof TablelandNetworkConfig

    The name or id of the chain to target.

  Returns Validator

  A Validator with a default baseUrl.