@loopring-web/loopring-sdk / Exports / WalletAPI
Class: WalletAPI
Hierarchy
-
↳
WalletAPI
Table of contents
Constructors
Properties
Methods
- genErr
- getAddressByENS
- getApproveTypedData
- getAvailableBroker
- getCounterFactualInfo
- getEnsByAddress
- getGuardianApproveList
- getHebaoConfig
- getHebaoOperationLogs
- getLatestTokenPrices
- getProtectors
- getTokenPrices
- getUserAssets
- getUserTradeAmount
- getWalletType
- lockHebaoWallet
- makeReq
- rejectApproveHash
- rejectHebao
- returnTxHash
- sendMetaTx
- setBaseUrl
- setChainId
- signHebaoApproveWithDataStructureForContract
- signHebaoApproveWithoutDataStructure
- submitApproveSignature
Constructors
constructor
• new WalletAPI(param
, timeout?
)
Parameters
Name | Type | Default value |
---|---|---|
param |
InitParam |
undefined |
timeout |
number |
3000 |
Inherited from
Defined in
Properties
baseUrl
• Protected
baseUrl: string
= ""
Inherited from
Defined in
chainId
• Protected
chainId: ChainId
= ChainId.MAINNET
Inherited from
Defined in
KEY_MESSAGE
▪ Static
KEY_MESSAGE: string
= KEY_MESSAGE
Inherited from
Defined in
Methods
genErr
▸ genErr(err
): RESULT_INFO
Parameters
Name | Type |
---|---|
err |
Error |
Returns
Inherited from
Defined in
getAddressByENS
▸ getAddressByENS<R
, T
>(request
): Promise
<{ address
: undefined
| string
; raw_data
: R
}>
Type parameters
Name | Type |
---|---|
R |
extends unknown |
T |
extends string |
Parameters
Name | Type |
---|---|
request |
GetEnsAddressRequest |
Returns
Promise
<{ address
: undefined
| string
; raw_data
: R
}>
Defined in
getApproveTypedData
▸ Private
getApproveTypedData(chainId
, guardiaContractAddress
, wallet
, validUntil
, newOwner
): Object
Parameters
Name | Type |
---|---|
chainId |
ChainId |
guardiaContractAddress |
any |
wallet |
any |
validUntil |
any |
newOwner |
any |
Returns
Object
Name | Type |
---|---|
domain |
{ chainId : ChainId = chainId; name : string = "GuardianModule"; verifyingContract : any = guardiaContractAddress; version : string = "1.2.0" } |
domain.chainId |
ChainId |
domain.name |
string |
domain.verifyingContract |
any |
domain.version |
string |
message |
{ newOwner : any = newOwner; validUntil : any = validUntil; wallet : any = wallet } |
message.newOwner |
any |
message.validUntil |
any |
message.wallet |
any |
primaryType |
string |
types |
{ EIP712Domain : { name : string = "name"; type : string = "string" }[] ; recover : { name : string = "wallet"; type : string = "address" }[] } |
types.EIP712Domain |
{ name : string = "name"; type : string = "string" }[] |
types.recover |
{ name : string = "wallet"; type : string = "address" }[] |
Defined in
getAvailableBroker
▸ getAvailableBroker(): Promise
<{ broker
: string
}>
Returns
Promise
<{ broker
: string
}>
Inherited from
Defined in
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
Defined in
getEnsByAddress
▸ getEnsByAddress<R
, T
>(request
): Promise
<{ ensName
: undefined
| string
; raw_data
: R
}>
Type parameters
Name | Type |
---|---|
R |
extends unknown |
T |
extends string |
Parameters
Name | Type |
---|---|
request |
GetEnsNameRequest |
Returns
Promise
<{ ensName
: undefined
| string
; raw_data
: R
}>
Defined in
getGuardianApproveList
▸ getGuardianApproveList<R
, T
>(request
): Promise
<{ guardiansArray
: T
[] ; raw_data
: R
}>
Type parameters
Name | Type |
---|---|
R |
extends unknown |
T |
extends Guardian |
Parameters
Name | Type |
---|---|
request |
GetGuardianApproveListRequest |
Returns
Promise
<{ guardiansArray
: T
[] ; raw_data
: R
}>
Defined in
getHebaoConfig
▸ getHebaoConfig(): Promise
<any
>
Returns
Promise
<any
>
Defined in
getHebaoOperationLogs
▸ getHebaoOperationLogs<R
, T
>(request
): Promise
<{ operationArray
: T
[] ; raw_data
: R
}>
Type parameters
Name | Type |
---|---|
R |
extends unknown |
T |
extends HebaoOperationLog |
Parameters
Name | Type |
---|---|
request |
HebaoOperationLogs |
Returns
Promise
<{ operationArray
: T
[] ; raw_data
: R
}>
Defined in
getLatestTokenPrices
▸ getLatestTokenPrices(request?
): Promise
<any
>
Parameters
Name | Type |
---|---|
request? |
getLatestTokenPricesRequest |
Returns
Promise
<any
>
Defined in
getProtectors
▸ getProtectors<R
, T
>(request
, apiKey
): Promise
<{ protectorArray
: T
[] ; raw_data
: R
}>
getProtectors
Type parameters
Name | Type |
---|---|
R |
extends unknown |
T |
extends Protector |
Parameters
Name | Type |
---|---|
request |
GetProtectorRequest |
apiKey |
string |
Returns
Promise
<{ protectorArray
: T
[] ; raw_data
: R
}>
Defined in
getTokenPrices
▸ getTokenPrices(request
): Promise
<any
>
Parameters
Name | Type |
---|---|
request |
GetTokenPricesRequest |
Returns
Promise
<any
>
Defined in
getUserAssets
▸ getUserAssets(request
): Promise
<any
>
Parameters
Name | Type |
---|---|
request |
GetUserAssetsRequest |
Returns
Promise
<any
>
Defined in
getUserTradeAmount
▸ getUserTradeAmount(request
): Promise
<any
>
Parameters
Name | Type |
---|---|
request |
GetUserTradeAmount |
Returns
Promise
<any
>
Defined in
getWalletType
▸ getWalletType<T
>(__namedParameters
): Promise
<{ raw_data
: T
; walletType
: undefined
| WalletType
}>
Type parameters
Name | Type |
---|---|
T |
extends unknown |
Parameters
Name | Type |
---|---|
__namedParameters |
GET_WALLET_TYPE |
Returns
Promise
<{ raw_data
: T
; walletType
: undefined
| WalletType
}>
Defined in
lockHebaoWallet
▸ lockHebaoWallet(__namedParameters
): Promise
<any
>
Parameters
Name | Type |
---|---|
__namedParameters |
LockHebaoHebaoParam |
Returns
Promise
<any
>
Defined in
makeReq
▸ Protected
makeReq(): Request
Returns
Request
Inherited from
Defined in
rejectApproveHash
▸ rejectApproveHash(request
): string
Parameters
Name | Type |
---|---|
request |
Object |
request.approveRecordId |
any |
request.signer |
any |
Returns
string
Defined in
rejectHebao
▸ rejectHebao(req
): Promise
<any
>
Parameters
Name | Type |
---|---|
req |
RejectHebaoRequestV3WithPatch |
Returns
Promise
<any
>
Defined in
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
Defined in
sendMetaTx
▸ sendMetaTx<R
, T
>(request
, apiKey
): Promise
<{ raw_data
: R
}>
Type parameters
Name | Type |
---|---|
R |
extends unknown |
T |
extends unknown |
Parameters
Name | Type |
---|---|
request |
SendMetaTxRequest |
apiKey |
string |
Returns
Promise
<{ raw_data
: R
}>
Defined in
setBaseUrl
▸ setBaseUrl(baseUrl
): void
Parameters
Name | Type |
---|---|
baseUrl |
string |
Returns
void
Inherited from
Defined in
setChainId
▸ setChainId(chainId
): void
Parameters
Name | Type |
---|---|
chainId |
ChainId |
Returns
void
Inherited from
Defined in
signHebaoApproveWithDataStructureForContract
▸ signHebaoApproveWithDataStructureForContract(web3
, owner
, guardian
, chainId
, newOwner?
): Promise
<{ sig
: any
= result.ecdsaSig }>
Parameters
Name | Type | Default value |
---|---|---|
web3 |
default |
undefined |
owner |
string |
undefined |
guardian |
Guardian |
undefined |
chainId |
ChainId |
undefined |
newOwner |
string |
"" |
Returns
Promise
<{ sig
: any
= result.ecdsaSig }>
Defined in
signHebaoApproveWithoutDataStructure
▸ signHebaoApproveWithoutDataStructure(web3
, owner
, guardian
, chainId
, walletType
): Promise
<unknown
>
Parameters
Name | Type |
---|---|
web3 |
default |
owner |
string |
guardian |
Guardian |
chainId |
ChainId |
walletType |
ConnectorNames |
Returns
Promise
<unknown
>
Defined in
submitApproveSignature
▸ submitApproveSignature<R
, T
>(req
): Promise
<{ hash
: undefined
| string
; raw_data
: R
}>
Type parameters
Name | Type |
---|---|
R |
extends unknown |
T |
extends string |
Parameters
Name | Type |
---|---|
req |
SubmitApproveSignatureRequestWithPatch |
Returns
Promise
<{ hash
: undefined
| string
; raw_data
: R
}>