Class SubaccountAPI

Readonlycontext

liquidateSubaccount

• liquidateSubaccount(
      params: LiquidateSubaccountParams,
  ): Promise<EngineServerExecuteSuccessResult<"liquidate_subaccount">>

  Liquidates a subaccount

  Parameters

  • params: LiquidateSubaccountParams

  Returns Promise<EngineServerExecuteSuccessResult<"liquidate_subaccount">>

linkSigner

• linkSigner(
      params: LinkSignerParams,
  ): Promise<EngineServerExecuteSuccessResult<"link_signer">>

  Links a signer to a subaccount to allow them to sign transactions on behalf of the subaccount

  Parameters

  • params: LinkSignerParams

  Returns Promise<EngineServerExecuteSuccessResult<"link_signer">>

getSubaccountSummary

• getSubaccountSummary(
      params: Subaccount,
  ): Promise<GetEngineSubaccountSummaryResponse>

  Gets the subaccount state according to the offchain engine

  Parameters

  • params: Subaccount

  Returns Promise<GetEngineSubaccountSummaryResponse>

getEngineEstimatedSubaccountSummary

• getEngineEstimatedSubaccountSummary(
      params: GetEngineEstimatedSubaccountSummaryParams,
  ): Promise<GetEngineSubaccountSummaryResponse>

  Gets the estimated subaccount state from offchain engine after a series of proposed txs

  Parameters

  • params: GetEngineEstimatedSubaccountSummaryParams

  Returns Promise<GetEngineSubaccountSummaryResponse>

getIsolatedPositions

• getIsolatedPositions(
      params: Subaccount,
  ): Promise<GetEngineIsolatedPositionsResponse>

  Gets the isolated positions for a subaccount

  Parameters

  • params: Subaccount

  Returns Promise<GetEngineIsolatedPositionsResponse>

getSubaccountFeeRates

• getSubaccountFeeRates(
      params: Subaccount,
  ): Promise<GetEngineSubaccountFeeRatesResponse>

  Queries engine to get subaccount fee rates

  Parameters

  • params: Subaccount

  Returns Promise<GetEngineSubaccountFeeRatesResponse>

getSubaccountLinkedSignerWithRateLimit

• getSubaccountLinkedSignerWithRateLimit(
      params: GetIndexerLinkedSignerParams,
  ): Promise<GetIndexerLinkedSignerResponse>

  Retrieves the current signer and link signer rate limit from the indexer

  Parameters

  • params: GetIndexerLinkedSignerParams

  Returns Promise<GetIndexerLinkedSignerResponse>

getReferralCode

• getReferralCode(
      params: GetIndexerReferralCodeParams,
  ): Promise<GetIndexerReferralCodeResponse>

  Retrieves referral code for an address

  Parameters

  • params: GetIndexerReferralCodeParams

  Returns Promise<GetIndexerReferralCodeResponse>