Class StakedSuiFren

constructor

• new StakedSuiFren(
      info: StakedSuiFrenInfo,
      config?: CallerConfig,
      isOwned?: boolean,
      api?: AftermathApi,
  ): StakedSuiFren

  Creates a staked-SuiFren wrapper without making a request.

  Parameters

  • info: StakedSuiFrenInfo

    SuiFren data, vault metadata, and optional owned position.

  • Optionalconfig: CallerConfig

    Optional network, API host, endpoint, or access-token configuration.

  • isOwned: boolean = false

    Whether the caller's source data marks the position as owned.

  • Optionalapi: AftermathApi

    Optional AftermathApi required by transaction builders.

  Returns StakedSuiFren

Optional Readonlyapi

Readonlyinfo

ReadonlyisOwned

ReadonlysuiFren

clone

• clone(): StakedSuiFren

  Creates another wrapper around the same stake information.

  Unlike SuiFren.clone, this method passes the optional api to the clone.

  Returns StakedSuiFren

  A new wrapper sharing the same info object.

getAccessories

• getAccessories(): Promise<SuiFrenAccessoryObject[]>

  Fetches accessories attached to the underlying SuiFren.

  Returns Promise<SuiFrenAccessoryObject[]>

  The accessory objects attached to the SuiFren.

  Throws

  AftermathTransportError when the configured HTTP request fails.

getAddAccessoryTransaction

• getAddAccessoryTransaction(
      inputs: { accessoryId: string; walletAddress: string },
  ): Promise<Transaction>

  Builds an unsigned transaction that adds an accessory to the underlying SuiFren.

  This method delegates to the underlying SuiFren wrapper.

  Parameters

  • inputs: { accessoryId: string; walletAddress: string }

    Accessory object ID and transaction sender address.

  Returns Promise<Transaction>

  An unsigned accessory transaction.

  Throws

  Error when the delegated wrapper has no AftermathApi instance.

getHarvestFeesTransaction

• getHarvestFeesTransaction(
      inputs: { walletAddress: string },
  ): Promise<Transaction>

  Builds an unsigned transaction that harvests fees from this position.

  The method requires both a position and an isOwned flag. The returned transaction transfers harvested fees to walletAddress.

  Parameters

  • inputs: { walletAddress: string }

    Wallet address that signs the transaction and receives fees.

  Returns Promise<Transaction>

  An unsigned harvest transaction.

  Throws

  Error when no position is present, the wrapper is not marked owned, or no AftermathApi is available.

getRemoveAccessoryTransaction

• getRemoveAccessoryTransaction(
      inputs: { accessoryType: string; walletAddress: string },
  ): Promise<Transaction>

  Builds an unsigned transaction that removes an accessory from this position.

  The method requires a position and an isOwned flag, then selects the staked-position removal Move call.

  Parameters

  • inputs: { accessoryType: string; walletAddress: string }

    Accessory type string and transaction sender address.

  Returns Promise<Transaction>

  An unsigned accessory-removal transaction.

  Throws

  Error when no position is present, the wrapper is not marked owned, or no AftermathApi is available.

getUnstakeTransaction

• getUnstakeTransaction(inputs: { walletAddress: string }): Promise<Transaction>

  Builds an unsigned transaction that unstakes this position.

  The method requires info.position to contain the owned position object ID, derives the underlying SuiFren type, and sets walletAddress as sender. It does not enforce isOwned before building.

  Parameters

  • inputs: { walletAddress: string }

    Wallet address that signs and receives the unstake result.

  Returns Promise<Transaction>

  An unsigned transaction ready for signing and execution.

  Throws

  Error when no position is present or no AftermathApi is available.

mixFee

• mixFee(): bigint

  Returns the current per-mix fee stored in the staked metadata.

  Returns bigint

  The fee in the payment coin's smallest unit.

suiFrenId

• suiFrenId(): string

  Returns the object ID of the underlying SuiFren.

  Returns string

  The underlying SuiFren object ID.