Class SpotExecuteAPI

Hierarchy (view full)

BaseSpotAPI
- SpotExecuteAPI

Index

Constructors

Properties

Methods

getTokenContractForProduct deposit withdraw approveAllowance _mintMockERC20

Constructors

constructor

new SpotExecuteAPI(context): SpotExecuteAPI
Parameters
- context: VertexClientContext
Returns SpotExecuteAPI
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

deposit

deposit(params): Promise<ContractTransactionResponse>
Parameters
- params: DepositCollateralParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/spot/SpotExecuteAPI.ts:12

withdraw

withdraw(params): Promise<EngineServerExecuteSuccessResult<"withdraw_collateral">>
Parameters
- params: WithdrawCollateralParams
Returns Promise<EngineServerExecuteSuccessResult<"withdraw_collateral">>
- Defined in apis/spot/SpotExecuteAPI.ts:22

approveAllowance

approveAllowance(params): Promise<ContractTransactionResponse>
Parameters
- params: ApproveAllowanceParams
Returns Promise<ContractTransactionResponse>
- Defined in apis/spot/SpotExecuteAPI.ts:31

_mintMockERC20

_mintMockERC20(params): Promise<ContractTransactionResponse>
Parameters
- params: MintMockERC20Params
Returns Promise<ContractTransactionResponse>
- Defined in apis/spot/SpotExecuteAPI.ts:39