loopring_sdk

@loopring-web/loopring-sdk / Exports / UserAPI

Class: UserAPI

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

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

SetReferrer

▸ SetReferrer<R>(request, eddsaKey): Promise<{ raw_data: R ; result: any }>

Type parameters

Name
R

Parameters

Name Type
request SetReferrerRequest
eddsaKey string

Returns

Promise<{ raw_data: R ; result: any }>

Defined in

api/user_api.ts:1280

cancelMultiOrdersByCreditOrderId

▸ cancelMultiOrdersByCreditOrderId<R>(request, PrivateKey, apiKey): Promise<{ raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request CancelMultiOrdersByClientOrderIdRequest
PrivateKey string
apiKey string

Returns

Promise<{ raw_data: R }>

Defined in

api/user_api.ts:282

cancelMultiOrdersByHash

▸ cancelMultiOrdersByHash<R>(request, PrivateKey, apiKey): Promise<{ raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request CancelMultiOrdersByHashRequest
PrivateKey string
apiKey string

Returns

Promise<{ raw_data: R }>

Defined in

api/user_api.ts:248

cancelOrder

▸ cancelOrder<R>(request, PrivateKey, apiKey): Promise<{ raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request CancelOrderRequest
PrivateKey string
apiKey string

Returns

Promise<{ raw_data: R }>

Defined in

api/user_api.ts:210

deleteNFTCollection

▸ deleteNFTCollection<R>(req, chainId, apiKey, eddsaKey): Promise<{ raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
req CollectionDelete
chainId ChainId
apiKey string
eddsaKey string

Returns

Promise<{ raw_data: R }>

Defined in

api/user_api.ts:2567

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

getAssetLookRecords

▸ getAssetLookRecords<R>(request, apiKey): Promise<{ raw_data: R ; userBalances: LoopringMap<UserBalanceInfo> }>

Type parameters

Name
R

Parameters

Name Type
request GetUserBalancesRequest
apiKey string

Returns

Promise<{ raw_data: R ; userBalances: LoopringMap<UserBalanceInfo> }>

Defined in

api/user_api.ts:419

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

getMinimumTokenAmt

▸ getMinimumTokenAmt<R>(request, apiKey): Promise<{ amountMap: LoopringMap<TokenAmount> ; amounts: [TokenAmount, TokenAmount] ; cacheOverdueAt: any ; gasPrice: number ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request GetMinimumTokenAmtRequest
apiKey string

Returns

Promise<{ amountMap: LoopringMap<TokenAmount> ; amounts: [TokenAmount, TokenAmount] ; cacheOverdueAt: any ; gasPrice: number ; raw_data: R }>

Defined in

api/user_api.ts:720

getNFTOffchainFeeAmt

▸ getNFTOffchainFeeAmt<R>(request, apiKey): Promise<{ fees: LoopringMap<OffchainFeeInfo> ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request GetNFTOffchainFeeAmtRequest
apiKey string

Returns

Promise<{ fees: LoopringMap<OffchainFeeInfo> ; raw_data: R }>

Defined in

api/user_api.ts:811

getNextStorageId

▸ getNextStorageId<R>(request, apiKey): Promise<{ offchainId: number ; orderId: number ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request GetNextStorageIdRequest
apiKey string

Returns

Promise<{ offchainId: number ; orderId: number ; raw_data: R }>

Defined in

api/user_api.ts:74

getOffchainFeeAmt

▸ getOffchainFeeAmt<R>(request, apiKey): Promise<{ fees: LoopringMap<OffchainFeeInfo> ; gasPrice: number ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request GetOffchainFeeAmtRequest
apiKey string

Returns

Promise<{ fees: LoopringMap<OffchainFeeInfo> ; gasPrice: number ; raw_data: R }>

Defined in

api/user_api.ts:769

getOrderDetails

▸ getOrderDetails<R>(request, apiKey): Promise<{ orderDetail: OrderDetail ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request GetOrderDetailsRequest
apiKey string

Returns

Promise<{ orderDetail: OrderDetail ; raw_data: R }>

Defined in

api/user_api.ts:103

getOrders

▸ getOrders<R>(request, apiKey): Promise<{ orders: OrderDetail[] ; raw_data: R ; totalNum: number }>

Type parameters

Name
R

Parameters

Name Type
request GetOrdersRequest
apiKey string

Returns

Promise<{ orders: OrderDetail[] ; raw_data: R ; totalNum: number }>

Defined in

api/user_api.ts:128

getUserApiKey

▸ getUserApiKey<R>(request, eddsaKey): Promise<{ apiKey: string ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request GetUserApiKeyRequest
eddsaKey string

Returns

Promise<{ apiKey: string ; raw_data: R }>

Defined in

api/user_api.ts:2994

getUserBalances

▸ getUserBalances<R>(request, apiKey): Promise<{ raw_data: R ; userBalances: LoopringMap<UserBalanceInfo> }>

Type parameters

Name
R

Parameters

Name Type
request GetUserBalancesRequest
apiKey string

Returns

Promise<{ raw_data: R ; userBalances: LoopringMap<UserBalanceInfo> }>

Defined in

api/user_api.ts:383

getUserBills

▸ getUserBills<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userTxs: UserTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserBillsRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userTxs: UserTx[] }>

Defined in

api/user_api.ts:3034

getUserDepositHistory

▸ getUserDepositHistory<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userDepositHistory: UserDepositHistoryTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserDepositHistoryRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userDepositHistory: UserDepositHistoryTx[] }>

Defined in

api/user_api.ts:458

getUserFeeRate

▸ getUserFeeRate<R>(request, apiKey): Promise<{ raw_data: R ; userFreeRateMap: LoopringMap<UserFeeRateInfo> }>

Type parameters

Name
R

Parameters

Name Type
request GetUserFeeRateRequest
apiKey string

Returns

Promise<{ raw_data: R ; userFreeRateMap: LoopringMap<UserFeeRateInfo> }>

Defined in

api/user_api.ts:646

getUserLegacyCollection

▸ getUserLegacyCollection<R>(request, apiKey): Promise<any>

Type parameters

Name
R

Parameters

Name Type
request GetUserLegacyCollectionRequest
apiKey string

Returns

Promise<any>

Defined in

api/user_api.ts:945

getUserNFTBalances

▸ getUserNFTBalances<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userNFTBalances: UserNFTBalanceInfo<NFT_IMAGE_SIZES>[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTBalancesRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userNFTBalances: UserNFTBalanceInfo<NFT_IMAGE_SIZES>[] }>

Defined in

api/user_api.ts:1317

getUserNFTBalancesByCollection

▸ getUserNFTBalancesByCollection<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userNFTBalances: UserNFTBalanceInfo<NFT_IMAGE_SIZES>[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTBalancesByCollectionRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userNFTBalances: UserNFTBalanceInfo<NFT_IMAGE_SIZES>[] }>

Defined in

api/user_api.ts:1377

getUserNFTCollection

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

Parameters

Name Type
request GetUserNFTCollectionRequest
apiKey string

Returns

Promise<any>

Defined in

api/user_api.ts:983

getUserNFTDepositHistory

▸ getUserNFTDepositHistory<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userNFTDepositHistory: UserNFTDepositHistoryTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTDepositHistoryRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userNFTDepositHistory: UserNFTDepositHistoryTx[] }>

Defined in

api/user_api.ts:1054

getUserNFTLegacyBalance

▸ getUserNFTLegacyBalance<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userNFTBalances: UserNFTBalanceInfo<NFT_IMAGE_SIZES>[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTLegacyBalanceRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userNFTBalances: UserNFTBalanceInfo<NFT_IMAGE_SIZES>[] }>

Defined in

api/user_api.ts:1437

getUserNFTLegacyTokenAddress

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

Parameters

Name Type
request Object
request.accountId number
apiKey string

Returns

Promise<any>

Defined in

api/user_api.ts:1021

getUserNFTMintHistory

▸ getUserNFTMintHistory<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userNFTMints: UserNFTMintHistoryTx[] }>

Get user NFTAction Mint list.

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTMintHistoryRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userNFTMints: UserNFTMintHistoryTx[] }>

Defined in

api/user_api.ts:1155

getUserNFTTradeHistory

▸ getUserNFTTradeHistory<R>(request, apiKey): Promise<RESULT_INFO | { raw_data: R ; totalNum: number ; trades: UserNFTTradeHistory[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTTradeRequest
apiKey string

Returns

Promise<RESULT_INFO | { raw_data: R ; totalNum: number ; trades: UserNFTTradeHistory[] }>

Defined in

api/user_api.ts:1246

getUserNFTTransactionHistory

▸ getUserNFTTransactionHistory<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userNFTTxs: UserNFTTxsHistory[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTTxsRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userNFTTxs: UserNFTTxsHistory[] }>

Defined in

api/user_api.ts:1187

getUserNFTTransferHistory

▸ getUserNFTTransferHistory<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userNFTTransfers: UserNFTTransferHistoryTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTTransferHistoryRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userNFTTransfers: UserNFTTransferHistoryTx[] }>

Defined in

api/user_api.ts:1120

getUserNFTWithdrawalHistory

▸ getUserNFTWithdrawalHistory<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userNFTWithdrawalHistory: UserNFTWithdrawalHistoryTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserNFTWithdrawalHistoryRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userNFTWithdrawalHistory: UserNFTWithdrawalHistoryTx[] }>

Defined in

api/user_api.ts:1087

getUserOnchainWithdrawalHistory

▸ getUserOnchainWithdrawalHistory<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userOnchainWithdrawalHistory: UserOnchainWithdrawalHistoryTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserOnchainWithdrawalHistoryRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userOnchainWithdrawalHistory: UserOnchainWithdrawalHistoryTx[] }>

Defined in

api/user_api.ts:491

getUserOrderFeeRate

▸ getUserOrderFeeRate<R>(request, apiKey): Promise<{ feeRate: FeeRateInfo ; gasPrice: number ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request GetUserOrderFeeRateRequest
apiKey string

Returns

Promise<{ feeRate: FeeRateInfo ; gasPrice: number ; raw_data: R }>

Defined in

api/user_api.ts:686

getUserOwenCollection

▸ getUserOwenCollection<R>(request, apiKey): Promise<any>

Type parameters

Name
R

Parameters

Name Type
request GetUserOwnerCollectionRequest
apiKey string

Returns

Promise<any>

Defined in

api/user_api.ts:907

getUserPwdResetTxs

▸ getUserPwdResetTxs<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userPwdResetTxs: UserRegTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserPwdResetTxsRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userPwdResetTxs: UserRegTx[] }>

Defined in

api/user_api.ts:349

getUserRegTxs

▸ getUserRegTxs<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userRegTxs: UserRegTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserRegTxsRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userRegTxs: UserRegTx[] }>

Defined in

api/user_api.ts:316

getUserTrades

▸ getUserTrades<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userTrades: MarketTradeInfo[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserTradesRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userTrades: MarketTradeInfo[] }>

Defined in

api/user_api.ts:597

getUserTransferList

▸ getUserTransferList<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userTransfers: UserTransferRecord[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserTransferListRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userTransfers: UserTransferRecord[] }>

Defined in

api/user_api.ts:524

getUserTxs

▸ getUserTxs<R>(request, apiKey): Promise<{ raw_data: R ; totalNum: number ; userTxs: UserTx[] }>

Type parameters

Name
R

Parameters

Name Type
request GetUserTxsRequest
apiKey string

Returns

Promise<{ raw_data: R ; totalNum: number ; userTxs: UserTx[] }>

Defined in

api/user_api.ts:557

getUserVIPAssets

▸ getUserVIPAssets<R>(request): Promise<{ raw_data: { data: R } ; vipAsset: R }>

Type parameters

Name
R

Parameters

Name Type
request getUserVIPAssetsRequest

Returns

Promise<{ raw_data: { data: R } ; vipAsset: R }>

Defined in

api/user_api.ts:1496

getUserVIPInfo

▸ getUserVIPInfo<R>(request, apiKey): Promise<{ raw_data: R ; vipInfo: { createdAt: number ; org: any ; validTo: string ; vipTag: any } }>

Type parameters

Name
R

Parameters

Name Type
request GetUserVIPInfoRequest
apiKey string

Returns

Promise<{ raw_data: R ; vipInfo: { createdAt: number ; org: any ; validTo: string ; vipTag: any } }>

Defined in

api/user_api.ts:1518

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

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

submitDeployCollection

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

Type parameters

Name Type
T extends TX_HASH_API

Parameters

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

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:2756

submitDeployNFT

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

Type parameters

Name Type
T extends TX_HASH_API

Parameters

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

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:2008

submitEditNFTCollection

▸ submitEditNFTCollection<R>(req, chainId, apiKey, eddsaKey): Promise<RESULT_INFO | { contractAddress: string ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
req Omit<CollectionBasicMeta, "owner" | "nftFactory"> & { accountId: number ; collectionId: string }
chainId ChainId
apiKey string
eddsaKey string

Returns

Promise<RESULT_INFO | { contractAddress: string ; raw_data: R }>

Defined in

api/user_api.ts:2636

submitForceWithdrawals

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

Type parameters

Name Type
T extends TX_HASH_API

Parameters

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

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:1870

submitInternalTransfer

▸ submitInternalTransfer<T>(req, options?): Promise<RESULT_INFO | AxiosResponse<any> | TX_HASH_RESULT<T>>

Type parameters

Name Type
T extends TX_HASH_API

Parameters

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

Returns

Promise<RESULT_INFO | AxiosResponse<any> | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:1748

submitNFTCollection

▸ submitNFTCollection<R>(req, chainId, apiKey, eddsaKey): Promise<RESULT_INFO | { contractAddress: string ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
req CollectionBasicMeta
chainId ChainId
apiKey string
eddsaKey string

Returns

Promise<RESULT_INFO | { contractAddress: string ; raw_data: R }>

Defined in

api/user_api.ts:2527

submitNFTInTransfer

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

Type parameters

Name Type
T extends TX_HASH_API

Parameters

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

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:2144

submitNFTLegacyCollection

▸ submitNFTLegacyCollection<R>(req, chainId, apiKey, eddsaKey): Promise<RESULT_INFO | { raw_data: R ; result: boolean }>

Type parameters

Name
R

Parameters

Name Type
req CollectionLegacyMeta
chainId ChainId
apiKey string
eddsaKey string

Returns

Promise<RESULT_INFO | { raw_data: R ; result: boolean }>

Defined in

api/user_api.ts:2596

submitNFTMint

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

Type parameters

Name Type
T extends TX_HASH_API

Parameters

Name Type
req OriginNFTMINTRequestV3WithPatch
options? Object
options._noEcdsa? boolean
options.accountId? number
options.counterFactualInfo? any

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:2390

submitNFTTrade

▸ submitNFTTrade<T>(req): Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Type parameters

Name Type
T extends TX_HASH_API

Parameters

Name Type
req OriginNFTTradeRequestV3WithPatch

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:875

submitNFTValidateOrder

▸ submitNFTValidateOrder<T>(req): Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Type parameters

Name Type
T extends TX_HASH_API

Parameters

Name Type
req OriginNFTValidateOrderRequestV3WithPatch

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:849

submitNFTWithdraw

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

Type parameters

Name Type
T extends TX_HASH_API

Parameters

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

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:2266

submitOffchainWithdraw

▸ submitOffchainWithdraw<T>(req, options?): Promise<RESULT_INFO | AxiosResponse<any> | TX_HASH_RESULT<T>>

Type parameters

Name Type
T extends TX_HASH_API

Parameters

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

Returns

Promise<RESULT_INFO | AxiosResponse<any> | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:1628

submitOrder

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

Parameters

Name Type
orderRequest SubmitOrderRequestV3
privateKey string
apiKey string

Returns

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

Defined in

api/user_api.ts:166

submitUpdateNFTGroup

▸ submitUpdateNFTGroup<R>(req, chainId, apiKey, eddsaKey): Promise<RESULT_INFO | { raw_data: R ; result: boolean }>

Type parameters

Name
R

Parameters

Name Type
req UpdateNFTGroupRequest
chainId ChainId
apiKey string
eddsaKey string

Returns

Promise<RESULT_INFO | { raw_data: R ; result: boolean }>

Defined in

api/user_api.ts:2715

submitUpdateNFTLegacyCollection

▸ submitUpdateNFTLegacyCollection<R>(req, chainId, apiKey, eddsaKey): Promise<RESULT_INFO | { raw_data: R ; result: boolean }>

Type parameters

Name
R

Parameters

Name Type
req UpdateNFTLegacyCollectionRequest
chainId ChainId
apiKey string
eddsaKey string

Returns

Promise<RESULT_INFO | { raw_data: R ; result: boolean }>

Defined in

api/user_api.ts:2677

unLockAccount

▸ unLockAccount<R>(__namedParameters, publicKey?): Promise<RESULT_INFO | AxiosResponse<any> | { apiKey: string ; eddsaKey: { counterFactualInfo: CounterFactualInfo ; formatedPx: string ; formatedPy: string ; keyPair: object ; sk: string } ; raw_data: R }>

Type parameters

Name
R

Parameters

Name Type Default value
__namedParameters Object undefined
__namedParameters.keyPair KeyPairParams undefined
__namedParameters.request GetUserApiKeyRequest undefined
publicKey undefined | { x: string ; y: string } undefined

Returns

Promise<RESULT_INFO | AxiosResponse<any> | { apiKey: string ; eddsaKey: { counterFactualInfo: CounterFactualInfo ; formatedPx: string ; formatedPy: string ; keyPair: object ; sk: string } ; raw_data: R }>

Defined in

api/user_api.ts:1557

updateAccount

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

Type parameters

Name Type
T extends TX_HASH_API

Parameters

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

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/user_api.ts:2890

updateUserApiKey

▸ updateUserApiKey<R>(request, apiKey, eddsaKey): Promise<{ raw_data: R }>

Type parameters

Name
R

Parameters

Name Type
request UpdateUserApiKeyRequest
apiKey string
eddsaKey string

Returns

Promise<{ raw_data: R }>

Defined in

api/user_api.ts:36

This site is open source. Improve this page.