mod_client.md

Module client

Provides information about library.

Functions

get_api_reference – Returns Core Library API reference

version – Returns Core Library version

build_info

Types

ClientError

ClientConfig

NetworkConfig

CryptoConfig

AbiConfig

ResultOfGetApiReference

ResultOfVersion

ResultOfBuildInfo

Functions

get_api_reference

Returns Core Library API reference

type ResultOfGetApiReference = {
    api: any
};

function get_api_reference(): Promise<ResultOfGetApiReference>;

Result

• api: API

version

Returns Core Library version

type ResultOfVersion = {
    version: string
};

function version(): Promise<ResultOfVersion>;

Result

• version: string – Core Library version

build_info

type ResultOfBuildInfo = {
    build_info: any
};

function build_info(): Promise<ResultOfBuildInfo>;

Result

• build_info: any

Types

ClientError

type ClientError = {
    code: number,
    message: string,
    data: any
};

• code: number
• message: string
• data: any

ClientConfig

type ClientConfig = {
    network?: NetworkConfig,
    crypto?: CryptoConfig,
    abi?: AbiConfig
};

• network?: NetworkConfig
• crypto?: CryptoConfig
• abi?: AbiConfig

NetworkConfig

type NetworkConfig = {
    server_address?: string,
    network_retries_count?: number,
    message_retries_count?: number,
    message_processing_timeout?: number,
    wait_for_timeout?: number,
    out_of_sync_threshold?: bigint,
    access_key?: string
};

• server_address?: string
• network_retries_count?: number
• message_retries_count?: number
• message_processing_timeout?: number
• wait_for_timeout?: number
• out_of_sync_threshold?: bigint
• access_key?: string

CryptoConfig

type CryptoConfig = {
    mnemonic_dictionary?: number,
    mnemonic_word_count?: number,
    hdkey_derivation_path?: string,
    hdkey_compliant?: boolean
};

• mnemonic_dictionary?: number
• mnemonic_word_count?: number
• hdkey_derivation_path?: string
• hdkey_compliant?: boolean

AbiConfig

type AbiConfig = {
    workchain?: number,
    message_expiration_timeout?: number,
    message_expiration_timeout_grow_factor?: number
};

• workchain?: number
• message_expiration_timeout?: number
• message_expiration_timeout_grow_factor?: number

ResultOfGetApiReference

type ResultOfGetApiReference = {
    api: any
};

• api: API

ResultOfVersion

type ResultOfVersion = {
    version: string
};

• version: string – Core Library version

ResultOfBuildInfo

type ResultOfBuildInfo = {
    build_info: any
};

• build_info: any