Class SpotExecuteAPI

Hierarchy (view full)

BaseSpotAPI
- SpotExecuteAPI

Index

Constructors

Properties

Methods

getTokenContractForProduct deposit withdraw approveAllowance transferQuote mintVlp burnVlp _mintMockERC20

Constructors

constructor

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

deposit

deposit(params): Promise<`0x${string}`>
Parameters
- params: DepositCollateralParams
Returns Promise<`0x${string}`>
- Defined in packages/client/src/apis/spot/SpotExecuteAPI.ts:20

withdraw

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

approveAllowance

approveAllowance(params): Promise<`0x${string}`>
Parameters
- params: ApproveAllowanceParams
Returns Promise<`0x${string}`>
- Defined in packages/client/src/apis/spot/SpotExecuteAPI.ts:39

transferQuote

transferQuote(params): Promise<EngineServerExecuteSuccessResult<"transfer_quote">>
Transfers quote between subaccounts under the same wallet.
Parameters
- params: TransferQuoteParams
Returns Promise<EngineServerExecuteSuccessResult<"transfer_quote">>
- Defined in packages/client/src/apis/spot/SpotExecuteAPI.ts:59

mintVlp

mintVlp(params): Promise<EngineServerExecuteSuccessResult<"mint_vlp">>
Parameters
- params: MintVlpParams
Returns Promise<EngineServerExecuteSuccessResult<"mint_vlp">>
- Defined in packages/client/src/apis/spot/SpotExecuteAPI.ts:68

burnVlp

burnVlp(params): Promise<EngineServerExecuteSuccessResult<"burn_vlp">>
Parameters
- params: BurnVlpParams
Returns Promise<EngineServerExecuteSuccessResult<"burn_vlp">>
- Defined in packages/client/src/apis/spot/SpotExecuteAPI.ts:77

_mintMockERC20

_mintMockERC20(params): Promise<`0x${string}`>
Parameters
- params: MintMockERC20Params
Returns Promise<`0x${string}`>
- Defined in packages/client/src/apis/spot/SpotExecuteAPI.ts:86