loopring_sdk

@loopring-web/loopring-sdk / Exports / WalletAPI

Class: WalletAPI

Hierarchy

• BaseAPI

  ↳ WalletAPI

Table of contents

Constructors

• constructor

Properties

• baseUrl
• chainId
• KEY_MESSAGE

Methods

• encodeAddressesPacked
• genErr
• getAddressByENS
• getApproveRecoverTypedData
• getApproveRecoverV2TypedData
• getAvailableBroker
• getContractType
• getCounterFactualInfo
• getEnsByAddress
• getGuardianApproveList
• getHebaoConfig
• getHebaoOperationLogs
• getLatestTokenPrices
• getProtectors
• getTokenPrices
• getUserAssets
• getUserTradeAmount
• getWalletModules
• getWalletType
• lockHebaoWallet
• makeReq
• rejectApproveHash
• rejectHebao
• returnTxHash
• sendMetaTx
• setBaseUrl
• setChainId
• signHebaoApproveWithDataStructureForContract
• signHebaoApproveWithoutDataStructure
• submitApproveSignature

Constructors

constructor

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

encodeAddressesPacked

▸ encodeAddressesPacked(addrs): Buffer

Parameters

Name	Type
addrs	string[]

Returns

Buffer

Defined in

api/wallet_api.ts:301

---

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

---

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

api/wallet_api.ts:425

---

getApproveRecoverTypedData

▸ Private getApproveRecoverTypedData(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

api/wallet_api.ts:96

---

getApproveRecoverV2TypedData

▸ getApproveRecoverV2TypedData(chainId, guardiaContractAddress, wallet, validUntil, newOwner, newGuardians): Object

Parameters

Name	Type
chainId	ChainId
guardiaContractAddress	any
wallet	any
validUntil	any
newOwner	any
newGuardians	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	{ newGuardians: any = newGuardians; newOwner: any = newOwner; validUntil: any = validUntil; wallet: any = wallet }
message.newGuardians	any
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

api/wallet_api.ts:132

---

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

---

getContractType

▸ getContractType<T>(__namedParameters): Promise<{ contractType: undefined | T ; raw_data: T }>

Type parameters

Name	Type
T	ContractType

Parameters

Name	Type
__namedParameters	GET_WALLET_TYPE

Returns

Promise<{ contractType: undefined | T ; raw_data: T }>

Defined in

api/wallet_api.ts:483

---

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

---

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

api/wallet_api.ts:542

---

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

api/wallet_api.ts:652

---

getHebaoConfig

▸ getHebaoConfig(): Promise<any>

Returns

Promise<any>

Defined in

api/wallet_api.ts:615

---

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

api/wallet_api.ts:732

---

getLatestTokenPrices

▸ getLatestTokenPrices(request?): Promise<any>

Parameters

Name	Type
request?	getLatestTokenPricesRequest

Returns

Promise<any>

Defined in

api/wallet_api.ts:820

---

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

api/wallet_api.ts:695

---

getTokenPrices

▸ getTokenPrices(request): Promise<any>

Parameters

Name	Type
request	GetTokenPricesRequest

Returns

Promise<any>

Defined in

api/wallet_api.ts:784

---

getUserAssets

▸ getUserAssets(request): Promise<any>

Parameters

Name	Type
request	GetUserAssetsRequest

Returns

Promise<any>

Defined in

api/wallet_api.ts:41

---

getUserTradeAmount

▸ getUserTradeAmount(request): Promise<any>

Parameters

Name	Type
request	GetUserTradeAmount

Returns

Promise<any>

Defined in

api/wallet_api.ts:762

---

getWalletModules

▸ getWalletModules<T>(__namedParameters): Promise<{ raw_data: T ; walletModule: undefined | T }>

Type parameters

Name	Type
T	ModuleType

Parameters

Name	Type
__namedParameters	GET_WALLET_TYPE

Returns

Promise<{ raw_data: T ; walletModule: undefined | T }>

Defined in

api/wallet_api.ts:513

---

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

api/wallet_api.ts:452

---

lockHebaoWallet

▸ lockHebaoWallet(__namedParameters): Promise<any>

Parameters

Name	Type
__namedParameters	LockHebaoHebaoParam

Returns

Promise<any>

Defined in

api/wallet_api.ts:569

---

makeReq

▸ Protected makeReq(): Request

Returns

Request

Inherited from

BaseAPI.makeReq

Defined in

api/base_api.ts:182

---

rejectApproveHash

▸ rejectApproveHash(request): string

Parameters

Name	Type
request	Object
request.approveRecordId	any
request.signer	any

Returns

string

Defined in

api/wallet_api.ts:172

---

rejectHebao

▸ rejectHebao(req): Promise<any>

Parameters

Name	Type
req	RejectHebaoRequestV3WithPatch

Returns

Promise<any>

Defined in

api/wallet_api.ts:192

---

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

---

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

api/wallet_api.ts:630

---

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

---

signHebaoApproveWithDataStructureForContract

▸ signHebaoApproveWithDataStructureForContract(web3, owner, guardian, chainId, newOwner?, newGuardians?, masterCopy?, forwarderModuleAddress?): Promise<{ sig: any = result.ecdsaSig }>

Parameters

Name	Type	Default value
web3	default	undefined
owner	string	undefined
guardian	Guardian	undefined
chainId	ChainId	undefined
newOwner	string	""
newGuardians	any	undefined
masterCopy	undefined | string	undefined
forwarderModuleAddress	undefined | string	undefined

Returns

Promise<{ sig: any = result.ecdsaSig }>

Defined in

api/wallet_api.ts:254

---

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

api/wallet_api.ts:236

---

submitApproveSignature

▸ submitApproveSignature<T>(req, guardians?, isContract1XAddress?, masterCopy?, forwarderModuleAddress?): Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Type parameters

Name	Type
T	extends TX_HASH_API

Parameters

Name	Type	Default value
req	SubmitApproveSignatureRequestWithPatch	undefined
guardians	string[]	[]
isContract1XAddress?	boolean	undefined
masterCopy?	string	undefined
forwarderModuleAddress	string	""

Returns

Promise<RESULT_INFO | TX_HASH_RESULT<T>>

Defined in

api/wallet_api.ts:310

This site is open source. Improve this page.