Class SpotQueryAPI

Hierarchy (view full)

BaseSpotAPI
- SpotQueryAPI

Index

Constructors

Properties

Methods

getTokenContractForProduct getMaxWithdrawable getTokenWalletBalance getTokenAllowance

Constructors

constructor

new SpotQueryAPI(context): SpotQueryAPI
Parameters
- context: VertexClientContext
Returns SpotQueryAPI
Inherited from BaseSpotAPI.constructor
- Defined in apis/base.ts:12

Properties

`Readonly`context

context: VertexClientContext

Methods

getTokenContractForProduct

getTokenContractForProduct(params): Promise<IERC20>
Retrieves the ERC20 token contract for a spot product
Parameters
- params: ProductIdOrTokenAddress
Returns Promise<IERC20>
Inherited from BaseSpotAPI.getTokenContractForProduct
- Defined in apis/spot/BaseSpotAPI.ts:9

getMaxWithdrawable

getMaxWithdrawable(params): Promise<BigNumber>
Gets the estimated max withdrawable amount for a product
Parameters
- params: GetEngineMaxWithdrawableParams
Returns Promise<BigNumber>
- Defined in apis/spot/SpotQueryAPI.ts:11

getTokenWalletBalance

getTokenWalletBalance(__namedParameters): Promise<bigint>
Helper to get current token balance in the user's wallet (i.e. not in a Vertex subaccount)
Parameters
- __namedParameters: TokenQueryParams
Returns Promise<bigint>
- Defined in apis/spot/SpotQueryAPI.ts:18

getTokenAllowance

getTokenAllowance(__namedParameters): Promise<BigNumber>
Helper to get current token allowance
Parameters
- __namedParameters: TokenQueryParams
Returns Promise<BigNumber>
- Defined in apis/spot/SpotQueryAPI.ts:29