Class SpotQueryAPI

Hierarchy (view full)

BaseSpotAPI
- SpotQueryAPI

Index

Constructors

Properties

Methods

getTokenContractForProduct getMaxWithdrawable getMaxMintVlpAmount getTokenWalletBalance getTokenAllowance

Constructors

constructor

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

Properties

`Readonly`context

context: VertexClientContext

Methods

getTokenContractForProduct

getTokenContractForProduct(params): Promise<ContractInstance<readonly [{}, {}, {}, {}, {}, {}, {}, {}]>>
Retrieves the ERC20 token contract for a spot product
Parameters
- params: ProductIdOrTokenAddress
Returns Promise<ContractInstance<readonly [{}, {}, {}, {}, {}, {}, {}, {}]>>
Inherited from BaseSpotAPI.getTokenContractForProduct
- Defined in packages/client/src/apis/spot/BaseSpotAPI.ts:11

getMaxWithdrawable

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

getMaxMintVlpAmount

getMaxMintVlpAmount(params): Promise<BigNumber>
Queries engine to determine maximum quote amount for minting VLP.
Parameters
- params: GetEngineMaxMintVlpAmountParams
Returns Promise<BigNumber>
- Defined in packages/client/src/apis/spot/SpotQueryAPI.ts:27

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 packages/client/src/apis/spot/SpotQueryAPI.ts:34

getTokenAllowance

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