loopring_sdk

@loopring-web/loopring-sdk / Exports / LuckTokenAPI

Class: LuckTokenAPI

Hierarchy

• BaseAPI

  ↳ LuckTokenAPI

Table of contents

Constructors

• constructor

Properties

• baseUrl
• chainId
• KEY_MESSAGE

Methods

• genErr
• getAvailableBroker
• getCounterFactualInfo
• getLuckTokenAgents
• getLuckTokenAuthorizedSigners
• getLuckTokenBalances
• getLuckTokenClaimHistory
• getLuckTokenClaimedLuckyTokens
• getLuckTokenDetail
• getLuckTokenLuckyTokens
• getLuckTokenSummary
• getLuckTokenWithdrawals
• makeReq
• returnTxHash
• sendLuckTokenClaimLuckyToken
• sendLuckTokenSend
• sendLuckTokenWithdraws
• setBaseUrl
• setChainId

Constructors

constructor

• new LuckTokenAPI(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

---

getLuckTokenAgents

▸ getLuckTokenAgents<R>(): Promise<{ luckTokenAgents: { [key: string]: LuckyTokenInfo; } ; raw_data: R }>

Type parameters

Name
R

Returns

Promise<{ luckTokenAgents: { [key: string]: LuckyTokenInfo; } ; raw_data: R }>

Defined in

api/luckToken_api.ts:22

---

getLuckTokenAuthorizedSigners

▸ getLuckTokenAuthorizedSigners<R>(): Promise<{ luckTokenAgents: { [key: string]: LuckyTokenInfo; } ; raw_data: R }>

Type parameters

Name
R

Returns

Promise<{ luckTokenAgents: { [key: string]: LuckyTokenInfo; } ; raw_data: R }>

Defined in

api/luckToken_api.ts:59

---

getLuckTokenBalances

▸ getLuckTokenBalances<R>(request, apiKey): Promise<{ raw_data: R ; tokenBalance: UserBalanceInfo & { isNft?: boolean ; nftTokenInfo?: NFTTokenInfo }[] ; totalNum: number }>

Type parameters

Name
R

Parameters

Name	Type
request	Object
request.accountId	number
request.isNft?	boolean
request.limit?	number
request.offset?	number
request.tokens?	number[]
apiKey	string

Returns

Promise<{ raw_data: R ; tokenBalance: UserBalanceInfo & { isNft?: boolean ; nftTokenInfo?: NFTTokenInfo }[] ; totalNum: number }>

Defined in

api/luckToken_api.ts:237

---

getLuckTokenClaimHistory

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

Type parameters

Name
R

Parameters

Name	Type
request	Object
request.fromId	number
request.isNft?	boolean
request.limit?	number
apiKey	string

Returns

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

Defined in

api/luckToken_api.ts:95

---

getLuckTokenClaimedLuckyTokens

▸ getLuckTokenClaimedLuckyTokens<R>(request, apiKey): Promise<{ claimedHistory: LuckyTokenItemForReceive & { id: number }[] ; raw_data: R ; totalNum: number }>

Type parameters

Name
R

Parameters

Name	Type
request	Object
request.fromId	number
request.hashes?	string[]
request.isNft?	boolean
request.limit?	number
apiKey	string

Returns

Promise<{ claimedHistory: LuckyTokenItemForReceive & { id: number }[] ; raw_data: R ; totalNum: number }>

Defined in

api/luckToken_api.ts:276

---

getLuckTokenDetail

▸ getLuckTokenDetail<R>(request, apiKey): Promise<{ detail: LuckTokenClaimDetail ; raw_data: R }>

Type parameters

Name
R

Parameters

Name	Type
request	Object
request.accountId?	number
request.fromId?	number
request.hash	string
request.limit?	number
request.showHelper	boolean
apiKey	string

Returns

Promise<{ detail: LuckTokenClaimDetail ; raw_data: R }>

Defined in

api/luckToken_api.ts:170

---

getLuckTokenLuckyTokens

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

Type parameters

Name
R

Parameters

Name	Type
request	Object
request.endTime	number
request.fromId	number
request.hash	string
request.isNft?	boolean
request.limit?	number
request.modes	string
request.official	boolean
request.partitions	string
request.scopes	string
request.senderId	number
request.startTime	number
request.statuses	string
apiKey	string

Returns

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

Defined in

api/luckToken_api.ts:126

---

getLuckTokenSummary

▸ getLuckTokenSummary<R>(apiKey): Promise<{ raw_data: R ; tokenSummaryList: { amount: string ; isNft?: Boolean ; nftTokenInfo?: NFTTokenInfo & Partial<UserNFTBalanceInfo<NFT_IMAGE_SIZES>> ; tokenId: number }[] ; totalNum: number }>

Type parameters

Name
R

Parameters

Name	Type
apiKey	string

Returns

Promise<{ raw_data: R ; tokenSummaryList: { amount: string ; isNft?: Boolean ; nftTokenInfo?: NFTTokenInfo & Partial<UserNFTBalanceInfo<NFT_IMAGE_SIZES>> ; tokenId: number }[] ; totalNum: number }>

Defined in

api/luckToken_api.ts:312

---

getLuckTokenWithdrawals

▸ getLuckTokenWithdrawals<R>(request, apiKey): Promise<{ luckTokenWithdraw: LuckTokenWithdraw[] ; raw_data: R ; totalNum: number }>

Type parameters

Name
R

Parameters

Name	Type
request	Object
request.endTime?	number
request.fromId?	number
request.isNft?	boolean
request.limit?	number
request.offset?	number
request.startTime?	number
request.statuses	LuckyTokenWithdrawStatus[]
request.tokenId?	number
apiKey	string

Returns

Promise<{ luckTokenWithdraw: LuckTokenWithdraw[] ; raw_data: R ; totalNum: number }>

Defined in

api/luckToken_api.ts:200

---

makeReq

▸ Protected makeReq(): Request

Returns

Request

Inherited from

BaseAPI.makeReq

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

Inherited from

BaseAPI.returnTxHash

Defined in

api/base_api.ts:82

---

sendLuckTokenClaimLuckyToken

▸ sendLuckTokenClaimLuckyToken<R>(__namedParameters): Promise<{ raw_data: R }>

Type parameters

Name
R

Parameters

Name	Type
__namedParameters	Object
__namedParameters.apiKey	string
__namedParameters.eddsaKey	string
__namedParameters.request	Object
__namedParameters.request.claimer	string
__namedParameters.request.hash	string
__namedParameters.request.referrer	string

Returns

Promise<{ raw_data: R }>

Defined in

api/luckToken_api.ts:342

---

sendLuckTokenSend

▸ sendLuckTokenSend<R>(req, options?): Promise<RESULT_INFO | TX_HASH_RESULT<R>>

Type parameters

Name	Type
R	{ accountId: number ; hash: string ; isIdempotent: boolean ; status: string ; storageId: number ; tokenId: number }

Parameters

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

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<R>>

Defined in

api/luckToken_api.ts:517

---

sendLuckTokenWithdraws

▸ sendLuckTokenWithdraws<T>(req, options?): Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Type parameters

Name
T

Parameters

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

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/luckToken_api.ts:379

---

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.