Class SuiFrens

Provides high-level SuiFrens reads, event queries, fee calculations, and unsigned transaction builders.

Read and event methods use the configured Aftermath API host. Transaction methods require the optional AftermathApi provider and return unsigned Transaction objects for the caller's wallet to sign and execute.

Hierarchy (View Summary)

Caller
- SuiFrens

Constructors

constructor

new SuiFrens(config?: CallerConfig, api?: AftermathApi): SuiFrens
Creates a SuiFrens facade without making a request.
Parameters
- Optionalconfig: CallerConfig
  Optional network, API host, endpoint, or access-token configuration.
- Optionalapi: AftermathApi
  Optional AftermathApi required by transaction builders.
Returns SuiFrens
Overrides Caller.constructor
- Defined in packages/suiFrens/suiFrens.ts:80

Properties

`Optional` `Readonly`api

api?: AftermathApi

Optional AftermathApi required by transaction builders.

config

config: CallerConfig

The mutable configuration used for subsequent requests.

`Static` `Readonly`constants

constants: {
    mixingFeeCoinType: string;
    protocolFees: {
        minMixStaked: bigint;
        mint: bigint;
        mixOwned: bigint;
        mixStakedPercentage: number;
    };
    suifrenFees: { mint: bigint };
} = ...

Fixed SuiFrens coin, protocol-fee, and mint-fee values. Balances are in MIST.

Type Declaration

mixingFeeCoinType: string

Coin type used to pay SuiFrens mixing fees.
protocolFees: {
    minMixStaked: bigint;
    mint: bigint;
    mixOwned: bigint;
    mixStakedPercentage: number;
}

Protocol fees and the staked-parent fee percentage.
- minMixStaked: bigint
  
  Minimum extra fee per staked parent: 0.25 SUI, or 250_000_000 MIST.
- mint: bigint
  
  Mint protocol fee: 0.25 SUI, or 250_000_000 MIST.
- mixOwned: bigint
  
  Mix fee when both parents are owned: 0.25 SUI, or 250_000_000 MIST.
- mixStakedPercentage: number
  
  Fraction of a staked parent's mixFee added to the internal fee.
suifrenFees: { mint: bigint }

SuiFren-specific fee values.
- mint: bigint
  
  SuiFren mint fee: 8 SUI, or 8_000_000_000 MIST.

Methods

getAllStakedSuiFrens

getAllStakedSuiFrens(
    inputs: {
        attributes: Partial<SuiFrenAttributes>;
        sortBy?: SuiFrensSortOption;
    } & DynamicFieldsInputs,
): Promise<DynamicFieldObjectsWithCursor<StakedSuiFren>>
Fetches a paginated page of staked SuiFrens filtered by attributes.

attributes is serialized into the endpoint query string. cursor and limit are passed as dynamic-field pagination inputs, and nextCursor is null when the source has no later page. sortBy is serialized as the sort query parameter.
Parameters
- inputs: { attributes: Partial<SuiFrenAttributes>; sortBy?: SuiFrensSortOption } & DynamicFieldsInputs
  Attribute filters, optional sort, cursor, and page limit.
Returns Promise<DynamicFieldObjectsWithCursor<StakedSuiFren>>
Staked wrappers and the endpoint's nullable next cursor.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:227

getCapyLabsApp

getCapyLabsApp(): Promise<CapyLabsAppObject>
Fetches the configured CapyLabs application object.

Returns Promise<CapyLabsAppObject>
Current CapyLabs application values.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:276

getHarvestFeesEvents

getHarvestFeesEvents(
inputs: EventsInputs,
): Promise<EventsWithCursor<HarvestSuiFrenFeesEvent>>
Fetches paginated fee-harvest events.

The cursor and limit use EventsInputs; the returned nextCursor is null when no later event page exists.
Parameters
- inputs: EventsInputs
  Event cursor and page limit.
Returns Promise<EventsWithCursor<HarvestSuiFrenFeesEvent>>
Harvest events with a nullable cursor.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:308

getHarvestFeesTransaction

getHarvestFeesTransaction(
inputs: ApiHarvestSuiFrenFeesBody,
): Promise<Transaction>
Builds an unsigned transaction that harvests fees from staked positions.

The returned transaction sets walletAddress as sender and transfers the harvested coin to that address after processing every position.
Parameters
- inputs: ApiHarvestSuiFrenFeesBody
  Non-empty staked-position ID list and wallet address.
Returns Promise<Transaction>
An unsigned Sui Transaction.

Throws
Error when no AftermathApi is available or the list is empty.
- Defined in packages/suiFrens/suiFrens.ts:379

getMixEvents

getMixEvents(inputs: EventsInputs): Promise<EventsWithCursor<MixSuiFrensEvent>>
Fetches paginated SuiFren mix events.
Parameters
- inputs: EventsInputs
  Event cursor and page limit.
Returns Promise<EventsWithCursor<MixSuiFrensEvent>>
Mix events with a nullable cursor.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:322

getMixTransaction

getMixTransaction(inputs: ApiMixSuiFrensBody): Promise<Transaction>
Builds an unsigned mix transaction for two SuiFrens.

The low-level builder selects the Move branch from the two optional parent mixFee values, adds baseFee to the calculated internal fee, selects the required SUI coin, and sets walletAddress as sender. The caller must sign and execute the returned transaction.
Parameters
- inputs: ApiMixSuiFrensBody
  Parent IDs and optional staked fees, base fee, SuiFren type, wallet, and sponsorship flag.
Returns Promise<Transaction>
An unsigned Sui Transaction.

Throws
Error when no AftermathApi is available.

Throws
Errors from coin selection, the provider, or the Sui transaction builder.
- Defined in packages/suiFrens/suiFrens.ts:365

getOwnedAccessories

getOwnedAccessories(
inputs: ApiOwnedSuiFrenAccessoriesBody,
): Promise<SuiFrenAccessoryObject[]>
Fetches accessories owned by a wallet.
Parameters
- inputs: ApiOwnedSuiFrenAccessoriesBody
  The wallet address whose accessory objects are listed.
Returns Promise<SuiFrenAccessoryObject[]>
Owned accessory objects.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:287

getOwnedStakedSuiFrens

getOwnedStakedSuiFrens(
inputs: ApiOwnedStakedSuiFrensBody,
): Promise<StakedSuiFren[]>
Fetches staked SuiFrens owned by a wallet.
Parameters
- inputs: ApiOwnedStakedSuiFrensBody
  The wallet address whose owned positions are listed.
Returns Promise<StakedSuiFren[]>
Staked wrappers with isOwned: true.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:206

getOwnedSuiFrens

getOwnedSuiFrens(inputs: ApiOwnedSuiFrensBody): Promise<SuiFren[]>
Fetches SuiFrens owned by a wallet.
Parameters
- inputs: ApiOwnedSuiFrensBody
  The wallet address whose owned objects are listed.
Returns Promise<SuiFren[]>
Owned wrappers with isOwned: true.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:188

getStakedSuiFrens

getStakedSuiFrens(
inputs: { stakedSuiFrenIds: string[] },
): Promise<StakedSuiFren[]>
Fetches staked SuiFrens by their metadata object IDs.
Parameters
- inputs: { stakedSuiFrenIds: string[] }
  Staked SuiFren metadata object IDs.
Returns Promise<StakedSuiFren[]>
Staked wrappers without owned-position data.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:259

getStakeEvents

getStakeEvents(
inputs: EventsInputs,
): Promise<EventsWithCursor<StakeSuiFrenEvent>>
Fetches paginated SuiFren stake events.
Parameters
- inputs: EventsInputs
  Event cursor and page limit.
Returns Promise<EventsWithCursor<StakeSuiFrenEvent>>
Stake events with a nullable cursor.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:333

getStats

getStats(): Promise<SuiFrenStats>
Fetches aggregate SuiFrens statistics.

The response includes vault totals and mix-event totals calculated over the previous 24 hours.

Returns Promise<SuiFrenStats>
Current totals, 24-hour fee volume, and 24-hour mix count.

Throws
AftermathTransportError when the stats request fails.
- Defined in packages/suiFrens/suiFrens.ts:396

getSuiFren

getSuiFren(inputs: { suiFrenObjectId: string }): Promise<SuiFren>
Fetches one SuiFren by object ID.
Parameters
- inputs: { suiFrenObjectId: string }
  The SuiFren object ID.
Returns Promise<SuiFren>
The first matching SuiFren wrapper, or undefined when the API returns no object.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:160

getSuiFrens

getSuiFrens(inputs: { suiFrenObjectIds: string[] }): Promise<SuiFren[]>
Fetches SuiFrens by object IDs and wraps the results as non-owned objects.
Parameters
- inputs: { suiFrenObjectIds: string[] }
  On-chain SuiFren object IDs.
Returns Promise<SuiFren[]>
The returned SuiFren wrappers in API response order.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:174

getUnstakeEvents

getUnstakeEvents(
inputs: EventsInputs,
): Promise<EventsWithCursor<UnstakeSuiFrenEvent>>
Fetches paginated SuiFren unstake events.
Parameters
- inputs: EventsInputs
  Event cursor and page limit.
Returns Promise<EventsWithCursor<UnstakeSuiFrenEvent>>
Unstake events with a nullable cursor.

Throws
AftermathTransportError when the request or response fails.
- Defined in packages/suiFrens/suiFrens.ts:344

`Static`apiBaseUrlForNetwork

apiBaseUrlForNetwork(network: SuiNetwork): string
Returns the canonical Aftermath API host for a Sui network.

To target a custom or local host, pass baseUrl in CallerConfig to the constructor instead.
Parameters
- network: SuiNetwork
  The Sui network whose host to return.
Returns string
The network's HTTPS or local HTTP API host.
Inherited from Caller.apiBaseUrlForNetwork
- Defined in general/utils/caller.ts:151

`Static`calcTotalInternalMixFee

calcTotalInternalMixFee(
inputs: { mixFee1: bigint | undefined; mixFee2: bigint | undefined },
): bigint
Calculates the internal mix fee for two parent SuiFrens.

An undefined parent fee represents an owned, non-staked parent. When both fees are undefined, the method returns the fixed mixOwned fee. For each defined staked fee, it adds the greater of minMixStaked and 10% of that fee. The result excludes baseFee from ApiMixSuiFrensBody.
Parameters
- inputs: { mixFee1: bigint | undefined; mixFee2: bigint | undefined }
  Optional staked-parent fees in the payment coin's smallest unit.
Returns bigint
The internal fee in MIST as a bigint.
- Defined in packages/suiFrens/suiFrens.ts:106

`Static`defaultFullnodeUrl

defaultFullnodeUrl(network: SuiNetwork | undefined): string
Returns the canonical Sui fullnode URL for a network.
Parameters
- network: SuiNetwork | undefined
  The network whose fullnode URL to return. undefined defaults to mainnet.
Returns string
The network's fullnode URL.
Inherited from Caller.defaultFullnodeUrl
- Defined in general/utils/caller.ts:162

`Static`mixFee

mixFee(suiFren: SuiFren | StakedSuiFren | undefined): bigint | undefined
Returns the staked mix fee from a wrapper.

Plain SuiFrens and undefined return undefined.
Parameters
- suiFren: SuiFren | StakedSuiFren | undefined
  Wrapper to inspect, or undefined.
Returns bigint | undefined
The staked fee in the payment coin's smallest unit, or undefined.
- Defined in packages/suiFrens/suiFrens.ts:442

`Static`suiFren

suiFren(suiFren: SuiFren | StakedSuiFren | undefined): SuiFren | undefined
Unwraps a SuiFren from either a plain or staked wrapper.
Parameters
- suiFren: SuiFren | StakedSuiFren | undefined
  Wrapper to unwrap, or undefined.
Returns SuiFren | undefined
The plain SuiFren wrapper, or undefined.
- Defined in packages/suiFrens/suiFrens.ts:414

`Static`suiFrenId

suiFrenId(suiFren: SuiFren | StakedSuiFren | undefined): string | undefined
Returns the underlying SuiFren object ID from either wrapper type.
Parameters
- suiFren: SuiFren | StakedSuiFren | undefined
  Wrapper to inspect, or undefined.
Returns string | undefined
The SuiFren object ID, or undefined.
- Defined in packages/suiFrens/suiFrens.ts:426

Class SuiFrens

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SuiFrens

Properties

Optional Readonlyapi

config

Static Readonlyconstants

Type Declaration

mixingFeeCoinType: string

protocolFees: { minMixStaked: bigint; mint: bigint; mixOwned: bigint; mixStakedPercentage: number;}

minMixStaked: bigint

mint: bigint

mixOwned: bigint

mixStakedPercentage: number

suifrenFees: { mint: bigint }

mint: bigint

Methods

getAllStakedSuiFrens

Parameters

Returns Promise<DynamicFieldObjectsWithCursor<StakedSuiFren>>

Throws

getCapyLabsApp

Returns Promise<CapyLabsAppObject>

Throws

getHarvestFeesEvents

Parameters

Returns Promise<EventsWithCursor<HarvestSuiFrenFeesEvent>>

Throws

getHarvestFeesTransaction

Parameters

Returns Promise<Transaction>

Throws

getMixEvents

Parameters

Returns Promise<EventsWithCursor<MixSuiFrensEvent>>

Throws

getMixTransaction

Parameters

Returns Promise<Transaction>

Throws

Throws

getOwnedAccessories

Parameters

Returns Promise<SuiFrenAccessoryObject[]>

Throws

getOwnedStakedSuiFrens

Parameters

Returns Promise<StakedSuiFren[]>

Throws

getOwnedSuiFrens

Parameters

Returns Promise<SuiFren[]>

Throws

getStakedSuiFrens

Parameters

Returns Promise<StakedSuiFren[]>

Throws

getStakeEvents

Parameters

Returns Promise<EventsWithCursor<StakeSuiFrenEvent>>

Throws

getStats

Returns Promise<SuiFrenStats>

Throws

getSuiFren

Parameters

Returns Promise<SuiFren>

Throws

getSuiFrens

Parameters

Returns Promise<SuiFren[]>

Throws

getUnstakeEvents

`Optional` `Readonly`api

`Static` `Readonly`constants

protocolFees: {
minMixStaked: bigint;
mint: bigint;
mixOwned: bigint;
mixStakedPercentage: number;
}

`Static`apiBaseUrlForNetwork

`Static`calcTotalInternalMixFee

`Static`defaultFullnodeUrl

`Static`mixFee

`Static`suiFren

`Static`suiFrenId