Class SpotAPI

Readonlycontext

getTokenContractForProduct

• getTokenContractForProduct(
      params: ProductIdOrTokenAddress,
  ): Promise<ContractInstance<readonly [{}, {}, {}, {}, {}, {}, {}, {}]>>

  Retrieves the ERC20 token contract for a spot product

  Parameters

  • params: ProductIdOrTokenAddress

  Returns Promise<ContractInstance<readonly [{}, {}, {}, {}, {}, {}, {}, {}]>>

deposit

• deposit(params: DepositCollateralParams): Promise<`0x${string}`>

  Parameters

  • params: DepositCollateralParams

  Returns Promise<`0x${string}`>

withdraw

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

  Parameters

  • params: WithdrawCollateralParams

  Returns Promise<EngineServerExecuteSuccessResult<"withdraw_collateral">>

approveAllowance

• approveAllowance(params: ApproveAllowanceParams): Promise<`0x${string}`>

  Parameters

  • params: ApproveAllowanceParams

  Returns Promise<`0x${string}`>

transferQuote

• transferQuote(
      params: TransferQuoteParams,
  ): Promise<EngineServerExecuteSuccessResult<"transfer_quote">>

  Transfers quote between subaccounts under the same wallet.

  Parameters

  • params: TransferQuoteParams

  Returns Promise<EngineServerExecuteSuccessResult<"transfer_quote">>

mintVlp

• mintVlp(
      params: MintVlpParams,
  ): Promise<EngineServerExecuteSuccessResult<"mint_vlp">>

  Parameters

  • params: MintVlpParams

  Returns Promise<EngineServerExecuteSuccessResult<"mint_vlp">>

burnVlp

• burnVlp(
      params: BurnVlpParams,
  ): Promise<EngineServerExecuteSuccessResult<"burn_vlp">>

  Parameters

  • params: BurnVlpParams

  Returns Promise<EngineServerExecuteSuccessResult<"burn_vlp">>

_mintMockERC20

• _mintMockERC20(params: MintMockERC20Params): Promise<`0x${string}`>

  Parameters

  • params: MintMockERC20Params

  Returns Promise<`0x${string}`>

getMaxWithdrawable

• getMaxWithdrawable(params: GetEngineMaxWithdrawableParams): Promise<BigNumber>

  Gets the estimated max withdrawable amount for a product

  Parameters

  • params: GetEngineMaxWithdrawableParams

  Returns Promise<BigNumber>

getMaxMintVlpAmount

• getMaxMintVlpAmount(params: GetEngineMaxMintVlpAmountParams): Promise<BigNumber>

  Queries engine to determine maximum quote amount for minting VLP.

  Parameters

  • params: GetEngineMaxMintVlpAmountParams

  Returns Promise<BigNumber>

getTokenWalletBalance

• getTokenWalletBalance(__namedParameters: TokenQueryParams): Promise<bigint>

  Helper to get current token balance in the user's wallet (i.e. not in a Nado subaccount)

  Parameters

  • __namedParameters: TokenQueryParams

  Returns Promise<bigint>

getTokenAllowance

• getTokenAllowance(__namedParameters: TokenQueryParams): Promise<BigNumber>

  Helper to get current token allowance

  Parameters

  • __namedParameters: TokenQueryParams

  Returns Promise<BigNumber>