Class SpotAPI

Readonlycontext

getTokenContractForProduct

• getTokenContractForProduct(params): Promise<IERC20>

• Retrieves the ERC20 token contract for a spot product

  Parameters

  • params: ProductIdOrTokenAddress

  Returns Promise<IERC20>

deposit

• deposit(params): Promise<ContractTransactionResponse>

• Parameters

  • params: DepositCollateralParams

  Returns Promise<ContractTransactionResponse>

withdraw

• withdraw(params): Promise<EngineServerExecuteSuccessResult<"withdraw_collateral">>

• Parameters

  • params: WithdrawCollateralParams

  Returns Promise<EngineServerExecuteSuccessResult<"withdraw_collateral">>

approveAllowance

• approveAllowance(params): Promise<ContractTransactionResponse>

• Parameters

  • params: ApproveAllowanceParams

  Returns Promise<ContractTransactionResponse>

_mintMockERC20

• _mintMockERC20(params): Promise<ContractTransactionResponse>

• Parameters

  • params: MintMockERC20Params

  Returns Promise<ContractTransactionResponse>

getMaxWithdrawable

• getMaxWithdrawable(params): Promise<BigNumber>

• Gets the estimated max withdrawable amount for a product

  Parameters

  • params: GetEngineMaxWithdrawableParams

  Returns Promise<BigNumber>

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>

getTokenAllowance

• getTokenAllowance(__namedParameters): Promise<BigNumber>

• Helper to get current token allowance

  Parameters

  • __namedParameters: TokenQueryParams

  Returns Promise<BigNumber>