loopring_sdk

@loopring-web/loopring-sdk / Exports / DefiAPI

Class: DefiAPI

Hierarchy

• BaseAPI

  ↳ DefiAPI

Table of contents

Constructors

• constructor

Properties

• baseUrl
• chainId
• KEY_MESSAGE

Methods

• genErr
• getAvailableBroker
• getCounterFactualInfo
• getDefiMarkets
• getDefiReward
• getDefiToken
• getDefiTransaction
• getDualBalance
• getDualIndex
• getDualInfos
• getDualPrices
• getDualTransactions
• getDualUserLocked
• getStakeProducts
• getStakeSummary
• getStakeTransactions
• makeReq
• orderDefi
• orderDual
• returnTxHash
• sendStake
• sendStakeClaim
• sendStakeRedeem
• setBaseUrl
• setChainId

Constructors

constructor

• new DefiAPI(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"

Inherited from

BaseAPI.constructor

Defined in

api/base_api.ts:104

Properties

baseUrl

• Protected baseUrl: string = ""

Inherited from

BaseAPI.baseUrl

Defined in

api/base_api.ts:39

---

chainId

• Protected chainId: ChainId = ChainId.MAINNET

Inherited from

BaseAPI.chainId

Defined in

api/base_api.ts:40

---

KEY_MESSAGE

▪ Static KEY_MESSAGE: string = KEY_MESSAGE

Inherited from

BaseAPI.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

Inherited from

BaseAPI.genErr

Defined in

api/base_api.ts:41

---

getAvailableBroker

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

Parameters

Name	Type
request	GetAvailableBrokerRequest

Returns

Promise<{ broker: string }>

Inherited from

BaseAPI.getAvailableBroker

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 }>

Inherited from

BaseAPI.getCounterFactualInfo

Defined in

api/base_api.ts:136

---

getDefiMarkets

▸ getDefiMarkets<R>(request, url?): Promise<{ marketArr: string[] ; marketArrStr: string ; markets: LoopringMap<DefiMarketInfo> ; pairs: LoopringMap<TokenRelatedInfo> ; raw_data: R ; tokenArr: string[] ; tokenArrStr: string }>

Type parameters

Name
R

Parameters

Name	Type	Default value
request	GetDefiMarketRequest	undefined
url	string	LOOPRING_URLs.GET_DEFI_MARKETS

Returns

Promise<{ marketArr: string[] ; marketArrStr: string ; markets: LoopringMap<DefiMarketInfo> ; pairs: LoopringMap<TokenRelatedInfo> ; raw_data: R ; tokenArr: string[] ; tokenArrStr: string }>

Defined in

api/defi_api.ts:80

---

getDefiReward

▸ getDefiReward<R>(request, apiKey): Promise<RESULT_INFO | { lastDayRewards: string ; raw_data: R ; rewards: [] ; totalNum: number ; totalRewards: string }>

Type parameters

Name
R

Parameters

Name	Type
request	GetUserDefiRewardRequest
apiKey	string

Returns

Promise<RESULT_INFO | { lastDayRewards: string ; raw_data: R ; rewards: [] ; totalNum: number ; totalRewards: string }>

Defined in

api/defi_api.ts:219

---

getDefiToken

▸ getDefiToken<R>(): Promise<{ addressIndex: LoopringMap<string> ; idIndex: LoopringMap<string> ; raw_data: R ; tokensMap: LoopringMap<TokenInfo> }>

Type parameters

Name
R

Returns

Promise<{ addressIndex: LoopringMap<string> ; idIndex: LoopringMap<string> ; raw_data: R ; tokensMap: LoopringMap<TokenInfo> }>

Defined in

api/defi_api.ts:27

---

getDefiTransaction

▸ getDefiTransaction<R>(request, apiKey): Promise<RESULT_INFO | { raw_data: R ; totalNum: number ; userDefiTxs: UserDefiTxsHistory[] }>

Type parameters

Name
R

Parameters

Name	Type
request	GetUserDefiTxRequest
apiKey	string

Returns

Promise<RESULT_INFO | { raw_data: R ; totalNum: number ; userDefiTxs: UserDefiTxsHistory[] }>

Defined in

api/defi_api.ts:254

---

getDualBalance

▸ getDualBalance<R>(request?): Promise<any>

Type parameters

Name
R

Parameters

Name	Type	Default value
request	undefined	undefined

Returns

Promise<any>

Defined in

api/defi_api.ts:327

---

getDualIndex

▸ getDualIndex(request): Promise<any>

Parameters

Name	Type
request	Object
request.baseSymbol	string
request.quoteSymbol	string

Returns

Promise<any>

Defined in

api/defi_api.ts:397

---

getDualInfos

▸ getDualInfos<R>(request): Promise<RESULT_INFO | { dualInfo: { balance: DualBalance[] ; index: DualIndex ; infos: DualProductAndPrice[] ; rules: DualRulesCoinsInfo[] } ; raw_data: R ; totalNum: number }>

Type parameters

Name
R

Parameters

Name	Type
request	GetDualInfosRequest

Returns

Promise<RESULT_INFO | { dualInfo: { balance: DualBalance[] ; index: DualIndex ; infos: DualProductAndPrice[] ; rules: DualRulesCoinsInfo[] } ; raw_data: R ; totalNum: number }>

Defined in

api/defi_api.ts:288

---

getDualPrices

▸ getDualPrices(request): Promise<any>

Parameters

Name	Type
request	GetDualPricesRequest

Returns

Promise<any>

Defined in

api/defi_api.ts:375

---

getDualTransactions

▸ getDualTransactions(request, apiKey): Promise<any>

Parameters

Name	Type
request	GetUserDualTxRequest
apiKey	string

Returns

Promise<any>

Defined in

api/defi_api.ts:420

---

getDualUserLocked

▸ getDualUserLocked(__namedParameters, apiKey): Promise<any>

Parameters

Name	Type
__namedParameters	DualUserLockedRequest
apiKey	string

Returns

Promise<any>

Defined in

api/defi_api.ts:481

---

getStakeProducts

▸ getStakeProducts<R>(): Promise<{ products: STACKING_PRODUCT[] ; raw_data: R }>

Type parameters

Name
R

Returns

Promise<{ products: STACKING_PRODUCT[] ; raw_data: R }>

Defined in

api/defi_api.ts:707

---

getStakeSummary

▸ getStakeSummary<R>(request, apiKey): Promise<RESULT_INFO | { list: StakeInfoOrigin[] ; raw_data: R ; totalClaimableRewards: string ; totalLastDayPendingRewards: string ; totalNum: number ; totalStaked: string ; totalStakedRewards: string }>

Type parameters

Name
R

Parameters

Name	Type
request	Object
request.accountId	number
request.end?	number
request.hashes?	string
request.limit?	number
request.offset?	number
request.start?	number
request.statuses?	string
request.tokenId	number
apiKey	string

Returns

Promise<RESULT_INFO | { list: StakeInfoOrigin[] ; raw_data: R ; totalClaimableRewards: string ; totalLastDayPendingRewards: string ; totalNum: number ; totalStaked: string ; totalStakedRewards: string }>

Defined in

api/defi_api.ts:726

---

getStakeTransactions

▸ getStakeTransactions<R>(request, apiKey): Promise<{ list: STACKING_TRANSACTIONS[] ; raw_data: R ; totalNum: number }>

Type parameters

Name
R

Parameters

Name	Type
request	Object
request.accountId	number
request.end?	number
request.hashes?	string
request.limit?	number
request.offset?	number
request.start?	number
request.tokenId	number
request.types?	string
apiKey	string

Returns

Promise<{ list: STACKING_TRANSACTIONS[] ; raw_data: R ; totalNum: number }>

Defined in

api/defi_api.ts:766

---

makeReq

▸ Protected makeReq(): Request

Returns

Request

Inherited from

BaseAPI.makeReq

Defined in

api/base_api.ts:182

---

orderDefi

▸ orderDefi<R>(request, privateKey, apiKey): Promise<RESULT_INFO | Omit<any, "resultInfo"> & { raw_data: Omit<any, "resultInfo"> }>

Type parameters

Name
R

Parameters

Name	Type
request	DefiOrderRequest
privateKey	string
apiKey	string

Returns

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

Defined in

api/defi_api.ts:180

---

orderDual

▸ orderDual(request, privateKey, apiKey): Promise<RESULT_INFO | Omit<any, "resultInfo"> & { raw_data: Omit<any, "resultInfo"> }>

Parameters

Name	Type
request	DualOrderRequest
privateKey	string
apiKey	string

Returns

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

Defined in

api/defi_api.ts:446

---

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"> }

Inherited from

BaseAPI.returnTxHash

Defined in

api/base_api.ts:82

---

sendStake

▸ sendStake(request, privateKey, apiKey): Promise<any>

Parameters

Name	Type
request	Object
request.accountId	number
request.timestamp	number
request.token	TokenVolumeV3
privateKey	string
apiKey	string

Returns

Promise<any>

Defined in

api/defi_api.ts:676

---

sendStakeClaim

▸ sendStakeClaim(req, options?): Promise<any>

Parameters

Name	Type
req	OriginStakeClaimRequestV3WithPatch
options?	Object
options.accountId?	number
options.counterFactualInfo?	any

Returns

Promise<any>

Defined in

api/defi_api.ts:512

---

sendStakeRedeem

▸ sendStakeRedeem(request, privateKey, apiKey): Promise<any>

Parameters

Name	Type
request	Object
request.accountId	number
request.hash	string
request.token	TokenVolumeV3
privateKey	string
apiKey	string

Returns

Promise<any>

Defined in

api/defi_api.ts:646

---

setBaseUrl

▸ setBaseUrl(baseUrl): void

Parameters

Name	Type
baseUrl	string

Returns

void

Inherited from

BaseAPI.setBaseUrl

Defined in

api/base_api.ts:178

---

setChainId

▸ setChainId(chainId): void

Parameters

Name	Type
chainId	ChainId

Returns

void

Inherited from

BaseAPI.setChainId

Defined in

api/base_api.ts:170

This site is open source. Improve this page.