loopring_sdk

@loopring-web/loopring-sdk / Exports / BaseAPI

Class: BaseAPI

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new BaseAPI(param, timeout?, baseUrlMap?)

Parameters

Name Type Default value
param InitParam undefined
timeout number 6000
baseUrlMap Object undefined
baseUrlMap.1 string "https://api3.loopring.io"
baseUrlMap.5 string "https://uat2.loopring.io"

Defined in

api/base_api.ts:104

Properties

baseUrl

Protected baseUrl: string = ""

Defined in

api/base_api.ts:39


baseUrlMap

Private baseUrlMap: undefined | { [key: number]: string; }

Defined in

api/base_api.ts:102


chainId

Protected chainId: ChainId = ChainId.MAINNET

Defined in

api/base_api.ts:40


timeout

Private timeout: number

Defined in

api/base_api.ts:101


KEY_MESSAGE

Static KEY_MESSAGE: string = KEY_MESSAGE

Defined in

api/base_api.ts:38

Methods

genErr

genErr(err): RESULT_INFO

Parameters

Name Type
err Error | AxiosResponse<any> & Error

Returns

RESULT_INFO

Defined in

api/base_api.ts:41


getAvailableBroker

getAvailableBroker(request): Promise<{ broker: string }>

Parameters

Name Type
request GetAvailableBrokerRequest

Returns

Promise<{ broker: string }>

Defined in

api/base_api.ts:123


getCounterFactualInfo

getCounterFactualInfo<T>(request): Promise<{ counterFactualInfo: undefined | CounterFactualInfo ; error?: RESULT_INFO ; raw_data: T }>

Type parameters

Name Type
T extends unknown

Parameters

Name Type
request GetCounterFactualInfoRequest

Returns

Promise<{ counterFactualInfo: undefined | CounterFactualInfo ; error?: RESULT_INFO ; raw_data: T }>

Defined in

api/base_api.ts:136


makeReq

Protected makeReq(): Request

Returns

Request

Defined in

api/base_api.ts:182


returnTxHash

Protected returnTxHash<T>(raw_data): RESULT_INFO | Omit<T, "resultInfo"> & { raw_data: Omit<T, "resultInfo"> }

Type parameters

Name Type
T extends TX_HASH_API

Parameters

Name Type
raw_data T

Returns

RESULT_INFO | Omit<T, "resultInfo"> & { raw_data: Omit<T, "resultInfo"> }

Defined in

api/base_api.ts:82


setBaseUrl

setBaseUrl(baseUrl): void

Parameters

Name Type
baseUrl string

Returns

void

Defined in

api/base_api.ts:178


setChainId

setChainId(chainId): void

Parameters

Name Type
chainId ChainId

Returns

void

Defined in

api/base_api.ts:170