Class FarmsApiCasting

Converts raw farm object and event responses into the SDK's normalized farm types.

V1 casters read direct parsedJson or legacy object fields. V2 event casters read the payload under parsedJson.pos0. Numeric strings are converted to bigint for balances and fixed-point multipliers, or to number for millisecond timestamps.

Example

import { Casting, type SuiObjectView } from "aftermath-ts-sdk";

declare const response: SuiObjectView;
const position = Casting.farms.partialStakedPositionObjectFromSuiObjectResponseV2(
	 response,
);

Index

Constructors

constructor

Methods

addedRewardEventFromOnChainV1 addedRewardEventFromOnChainV2 createdVaultEventFromOnChainV1 createdVaultEventFromOnChainV2 depositedPrincipalEventFromOnChainV1 depositedPrincipalEventFromOnChainV2 destroyedStakedPositionEventFromOnChainV1 destroyedStakedPositionEventFromOnChainV2 harvestedRewardsEventFromOnChainV1 harvestedRewardsEventFromOnChainV2 increasedEmissionsEventFromOnChainV1 initializedRewardEventFromOnChainV1 initializedRewardEventFromOnChainV2 joinedEventFromOnChainV1 joinedEventFromOnChainV2 lockedEventFromOnChainV1 lockedEventFromOnChainV2 partialStakedPositionObjectFromSuiObjectResponseV1 partialStakedPositionObjectFromSuiObjectResponseV2 splitEventFromOnChainV1 splitEventFromOnChainV2 stakedEventFromOnChainV1 stakedEventFromOnChainV2 stakedRelaxedEventFromOnChainV1 stakingPoolOneTimeAdminCapObjectFromSuiObjectResponseV1 stakingPoolOneTimeAdminCapObjectFromSuiObjectResponseV2 stakingPoolOwnerCapObjectFromSuiObjectResponseV1 stakingPoolOwnerCapObjectFromSuiObjectResponseV2 unlockedEventFromOnChainV1 unlockedEventFromOnChainV2 updatedEmissionsEventFromOnChainV2 withdrewPrincipalEventFromOnChainV1 withdrewPrincipalEventFromOnChainV2

Constructors

constructor

new FarmsApiCasting(): FarmsApiCasting

Returns FarmsApiCasting

Methods

`Static`addedRewardEventFromOnChainV1

addedRewardEventFromOnChainV1(
eventOnChain: FarmsAddedRewardEventOnChainV1,
): FarmsAddedRewardEvent
Casts a V1 direct AddedRewardEvent payload to the normalized event type.
Parameters
- eventOnChain: FarmsAddedRewardEventOnChainV1
Returns FarmsAddedRewardEvent
- Defined in packages/farms/api/farmsApiCasting.ts:277

`Static`addedRewardEventFromOnChainV2

addedRewardEventFromOnChainV2(
eventOnChain: FarmsAddedRewardEventOnChainV2,
): FarmsAddedRewardEvent
Casts a V2 AddedRewardEvent whose payload is wrapped under pos0.
Parameters
- eventOnChain: FarmsAddedRewardEventOnChainV2
Returns FarmsAddedRewardEvent
- Defined in packages/farms/api/farmsApiCasting.ts:292

`Static`createdVaultEventFromOnChainV1

createdVaultEventFromOnChainV1(
eventOnChain: FarmsCreatedVaultEventOnChainV1,
): FarmsCreatedVaultEvent
Casts a V1 direct pool-created event and converts its numeric fields.
Parameters
- eventOnChain: FarmsCreatedVaultEventOnChainV1
Returns FarmsCreatedVaultEvent
- Defined in packages/farms/api/farmsApiCasting.ts:307

`Static`createdVaultEventFromOnChainV2

createdVaultEventFromOnChainV2(
eventOnChain: FarmsCreatedVaultEventOnChainV2,
): FarmsCreatedVaultEvent
Casts a V2 wrapped pool-created event and converts its numeric fields.
Parameters
- eventOnChain: FarmsCreatedVaultEventOnChainV2
Returns FarmsCreatedVaultEvent
- Defined in packages/farms/api/farmsApiCasting.ts:325

`Static`harvestedRewardsEventFromOnChainV1

harvestedRewardsEventFromOnChainV1(
eventOnChain: FarmsHarvestedRewardsEventOnChainV1,
): FarmsHarvestedRewardsEvent
Casts a V1 direct reward-harvest event and preserves parallel reward arrays.
Parameters
- eventOnChain: FarmsHarvestedRewardsEventOnChainV1
Returns FarmsHarvestedRewardsEvent
- Defined in packages/farms/api/farmsApiCasting.ts:401

`Static`harvestedRewardsEventFromOnChainV2

harvestedRewardsEventFromOnChainV2(
eventOnChain: FarmsHarvestedRewardsEventOnChainV2,
): FarmsHarvestedRewardsEvent
Casts a V2 wrapped reward-harvest event and preserves parallel reward arrays.
Parameters
- eventOnChain: FarmsHarvestedRewardsEventOnChainV2
Returns FarmsHarvestedRewardsEvent
- Defined in packages/farms/api/farmsApiCasting.ts:418

`Static`increasedEmissionsEventFromOnChainV1

increasedEmissionsEventFromOnChainV1(
eventOnChain: FarmsIncreasedEmissionsEventOnChainV1,
): FarmsIncreasedEmissionsEvent
Casts a V1 direct emission-increase event.
Parameters
- eventOnChain: FarmsIncreasedEmissionsEventOnChainV1
Returns FarmsIncreasedEmissionsEvent
- Defined in packages/farms/api/farmsApiCasting.ts:435

`Static`initializedRewardEventFromOnChainV1

initializedRewardEventFromOnChainV1(
eventOnChain: FarmsInitializedRewardEventOnChainV1,
): FarmsInitializedRewardEvent
Casts a V1 direct reward-initialized event.
Parameters
- eventOnChain: FarmsInitializedRewardEventOnChainV1
Returns FarmsInitializedRewardEvent
- Defined in packages/farms/api/farmsApiCasting.ts:467

`Static`initializedRewardEventFromOnChainV2

initializedRewardEventFromOnChainV2(
eventOnChain: FarmsInitializedRewardEventOnChainV2,
): FarmsInitializedRewardEvent
Casts a V2 wrapped reward-initialized event.
Parameters
- eventOnChain: FarmsInitializedRewardEventOnChainV2
Returns FarmsInitializedRewardEvent
- Defined in packages/farms/api/farmsApiCasting.ts:484

`Static`joinedEventFromOnChainV1

joinedEventFromOnChainV1(
eventOnChain: FarmsJoinedEventOnChainV1,
): FarmsJoinedEvent
Casts a V1 direct position-joined event.
Parameters
- eventOnChain: FarmsJoinedEventOnChainV1
Returns FarmsJoinedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:501

`Static`joinedEventFromOnChainV2

joinedEventFromOnChainV2(
eventOnChain: FarmsJoinedEventOnChainV2,
): FarmsJoinedEvent
Casts a V2 wrapped position-joined event.
Parameters
- eventOnChain: FarmsJoinedEventOnChainV2
Returns FarmsJoinedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:515

`Static`lockedEventFromOnChainV1

lockedEventFromOnChainV1(
eventOnChain: FarmsLockedEventOnChainV1,
): FarmsLockedEvent
Casts a V1 direct position-locked event.
Parameters
- eventOnChain: FarmsLockedEventOnChainV1
Returns FarmsLockedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:529

`Static`lockedEventFromOnChainV2

lockedEventFromOnChainV2(
eventOnChain: FarmsLockedEventOnChainV2,
): FarmsLockedEvent
Casts a V2 wrapped position-locked event.
Parameters
- eventOnChain: FarmsLockedEventOnChainV2
Returns FarmsLockedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:548

`Static`partialStakedPositionObjectFromSuiObjectResponseV1

partialStakedPositionObjectFromSuiObjectResponseV1(
data: SuiObjectView,
): PartialFarmsStakedPositionObject
Casts a V1 staked-position object into the partial SDK position shape.
Parameters
- data: SuiObjectView
  Raw Sui object view with V1 legacy fields.
Returns PartialFarmsStakedPositionObject
A partial position with normalized coin type, bigint balances, and reward entries in the source array order.
- Defined in packages/farms/api/farmsApiCasting.ts:93

`Static`partialStakedPositionObjectFromSuiObjectResponseV2

partialStakedPositionObjectFromSuiObjectResponseV2(
data: SuiObjectView,
): PartialFarmsStakedPositionObject
Casts a V2 staked-position object into the partial SDK position shape.
Parameters
- data: SuiObjectView
  Raw Sui object view with V2 vault fields.
Returns PartialFarmsStakedPositionObject
A partial V2 position with normalized coin type, bigint balances, and reward entries in the source array order.
- Defined in packages/farms/api/farmsApiCasting.ts:137

`Static`splitEventFromOnChainV1

splitEventFromOnChainV1(eventOnChain: FarmsSplitEventOnChainV1): FarmsSplitEvent
Casts a V1 direct position-split event.
Parameters
- eventOnChain: FarmsSplitEventOnChainV1
Returns FarmsSplitEvent
- Defined in packages/farms/api/farmsApiCasting.ts:567

`Static`splitEventFromOnChainV2

splitEventFromOnChainV2(eventOnChain: FarmsSplitEventOnChainV2): FarmsSplitEvent
Casts a V2 wrapped position-split event.
Parameters
- eventOnChain: FarmsSplitEventOnChainV2
Returns FarmsSplitEvent
- Defined in packages/farms/api/farmsApiCasting.ts:581

`Static`stakedEventFromOnChainV1

stakedEventFromOnChainV1(
eventOnChain: FarmsStakedEventOnChainV1,
): FarmsStakedEvent
Casts a V1 direct strict-stake event.
Parameters
- eventOnChain: FarmsStakedEventOnChainV1
Returns FarmsStakedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:595

`Static`stakedEventFromOnChainV2

stakedEventFromOnChainV2(
eventOnChain: FarmsStakedEventOnChainV2,
): FarmsStakedEvent
Casts a V2 wrapped strict-stake event.
Parameters
- eventOnChain: FarmsStakedEventOnChainV2
Returns FarmsStakedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:615

`Static`stakedRelaxedEventFromOnChainV1

stakedRelaxedEventFromOnChainV1(
eventOnChain: FarmsStakedRelaxedEventOnChainV1,
): FarmsStakedRelaxedEvent
Casts a V1 direct relaxed-stake event.
Parameters
- eventOnChain: FarmsStakedRelaxedEventOnChainV1
Returns FarmsStakedRelaxedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:635

`Static`stakingPoolOneTimeAdminCapObjectFromSuiObjectResponseV1

stakingPoolOneTimeAdminCapObjectFromSuiObjectResponseV1(
data: SuiObjectView,
): StakingPoolOneTimeAdminCapObject
Casts a V1 staking-pool one-time admin capability object.
Parameters
- data: SuiObjectView
  Raw Sui object view containing afterburner_vault_id.
Returns StakingPoolOneTimeAdminCapObject
The normalized one-time admin capability and its V1 pool ID.
- Defined in packages/farms/api/farmsApiCasting.ts:224

`Static`stakingPoolOneTimeAdminCapObjectFromSuiObjectResponseV2

stakingPoolOneTimeAdminCapObjectFromSuiObjectResponseV2(
data: SuiObjectView,
): StakingPoolOneTimeAdminCapObject
Casts a V2 one-time admin capability from either JSON-RPC or gRPC shape.

The nested cap field is unwrapped before the authority for field is read, so callers receive the same result from both transports.
Parameters
- data: SuiObjectView
  Raw Sui object view containing the nested authority cap.
Returns StakingPoolOneTimeAdminCapObject
The normalized one-time admin capability and its V2 pool ID.
- Defined in packages/farms/api/farmsApiCasting.ts:249

`Static`stakingPoolOwnerCapObjectFromSuiObjectResponseV1

stakingPoolOwnerCapObjectFromSuiObjectResponseV1(
data: SuiObjectView,
): StakingPoolOwnerCapObject
Casts a V1 staking-pool owner capability object.
Parameters
- data: SuiObjectView
  Raw Sui object view containing afterburner_vault_id.
Returns StakingPoolOwnerCapObject
The normalized owner-cap object and its V1 pool ID.
- Defined in packages/farms/api/farmsApiCasting.ts:180

`Static`stakingPoolOwnerCapObjectFromSuiObjectResponseV2

stakingPoolOwnerCapObjectFromSuiObjectResponseV2(
data: SuiObjectView,
): StakingPoolOwnerCapObject
Casts a V2 staking-pool owner capability object.
Parameters
- data: SuiObjectView
  Raw Sui object view containing the authority for field.
Returns StakingPoolOwnerCapObject
The normalized owner-cap object and its V2 pool ID.
- Defined in packages/farms/api/farmsApiCasting.ts:202

`Static`unlockedEventFromOnChainV1

unlockedEventFromOnChainV1(
eventOnChain: FarmsUnlockedEventOnChainV1,
): FarmsUnlockedEvent
Casts a V1 direct position-unlocked event.
Parameters
- eventOnChain: FarmsUnlockedEventOnChainV1
Returns FarmsUnlockedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:653

`Static`unlockedEventFromOnChainV2

unlockedEventFromOnChainV2(
eventOnChain: FarmsUnlockedEventOnChainV2,
): FarmsUnlockedEvent
Casts a V2 wrapped position-unlocked event.
Parameters
- eventOnChain: FarmsUnlockedEventOnChainV2
Returns FarmsUnlockedEvent
- Defined in packages/farms/api/farmsApiCasting.ts:669

`Static`updatedEmissionsEventFromOnChainV2

updatedEmissionsEventFromOnChainV2(
eventOnChain: FarmsUpdatedEmissionsEventOnChainV2,
): FarmsIncreasedEmissionsEvent
Casts a V2 wrapped emission-update event into the normalized increase-event type.
Parameters
- eventOnChain: FarmsUpdatedEmissionsEventOnChainV2
Returns FarmsIncreasedEmissionsEvent
- Defined in packages/farms/api/farmsApiCasting.ts:451

`Static`withdrewPrincipalEventFromOnChainV1

withdrewPrincipalEventFromOnChainV1(
eventOnChain: FarmsWithdrewPrincipalEventOnChainV1,
): FarmsWithdrewPrincipalEvent
Casts a V1 direct principal-withdrawal event.
Parameters
- eventOnChain: FarmsWithdrewPrincipalEventOnChainV1
Returns FarmsWithdrewPrincipalEvent
- Defined in packages/farms/api/farmsApiCasting.ts:685

`Static`withdrewPrincipalEventFromOnChainV2

withdrewPrincipalEventFromOnChainV2(
eventOnChain: FarmsWithdrewPrincipalEventOnChainV2,
): FarmsWithdrewPrincipalEvent
Casts a V2 wrapped principal-withdrawal event.
Parameters
- eventOnChain: FarmsWithdrewPrincipalEventOnChainV2
Returns FarmsWithdrewPrincipalEvent
- Defined in packages/farms/api/farmsApiCasting.ts:701

Class FarmsApiCasting

Example

Index

Constructors

Methods

Constructors

constructor

Returns FarmsApiCasting

Methods

StaticaddedRewardEventFromOnChainV1

Parameters

Returns FarmsAddedRewardEvent

StaticaddedRewardEventFromOnChainV2

Parameters

Returns FarmsAddedRewardEvent

StaticcreatedVaultEventFromOnChainV1

Parameters

Returns FarmsCreatedVaultEvent

StaticcreatedVaultEventFromOnChainV2

Parameters

Returns FarmsCreatedVaultEvent

StaticdepositedPrincipalEventFromOnChainV1

Parameters

Returns FarmsDepositedPrincipalEvent

StaticdepositedPrincipalEventFromOnChainV2

Parameters

Returns FarmsDepositedPrincipalEvent

StaticdestroyedStakedPositionEventFromOnChainV1

Parameters

Returns FarmsDestroyedStakedPositionEvent

StaticdestroyedStakedPositionEventFromOnChainV2

Parameters

Returns FarmsDestroyedStakedPositionEvent

StaticharvestedRewardsEventFromOnChainV1

Parameters

Returns FarmsHarvestedRewardsEvent

StaticharvestedRewardsEventFromOnChainV2

Parameters

Returns FarmsHarvestedRewardsEvent

StaticincreasedEmissionsEventFromOnChainV1

Parameters

Returns FarmsIncreasedEmissionsEvent

StaticinitializedRewardEventFromOnChainV1

Parameters

Returns FarmsInitializedRewardEvent

StaticinitializedRewardEventFromOnChainV2

Parameters

Returns FarmsInitializedRewardEvent

StaticjoinedEventFromOnChainV1

Parameters

Returns FarmsJoinedEvent

StaticjoinedEventFromOnChainV2

Parameters

Returns FarmsJoinedEvent

StaticlockedEventFromOnChainV1

Parameters

Returns FarmsLockedEvent

StaticlockedEventFromOnChainV2

Parameters

Returns FarmsLockedEvent

StaticpartialStakedPositionObjectFromSuiObjectResponseV1

Parameters

Returns PartialFarmsStakedPositionObject

StaticpartialStakedPositionObjectFromSuiObjectResponseV2

Parameters

Returns PartialFarmsStakedPositionObject

StaticsplitEventFromOnChainV1

Parameters

Returns FarmsSplitEvent

StaticsplitEventFromOnChainV2

Parameters

Returns FarmsSplitEvent

StaticstakedEventFromOnChainV1

Parameters

Returns FarmsStakedEvent

StaticstakedEventFromOnChainV2

Parameters

Returns FarmsStakedEvent

StaticstakedRelaxedEventFromOnChainV1

Parameters

`Static`addedRewardEventFromOnChainV1

`Static`addedRewardEventFromOnChainV2

`Static`createdVaultEventFromOnChainV1

`Static`createdVaultEventFromOnChainV2

`Static`depositedPrincipalEventFromOnChainV1

`Static`depositedPrincipalEventFromOnChainV2

`Static`destroyedStakedPositionEventFromOnChainV1

`Static`destroyedStakedPositionEventFromOnChainV2

`Static`harvestedRewardsEventFromOnChainV1

`Static`harvestedRewardsEventFromOnChainV2

`Static`increasedEmissionsEventFromOnChainV1

`Static`initializedRewardEventFromOnChainV1

`Static`initializedRewardEventFromOnChainV2

`Static`joinedEventFromOnChainV1

`Static`joinedEventFromOnChainV2

`Static`lockedEventFromOnChainV1

`Static`lockedEventFromOnChainV2

`Static`partialStakedPositionObjectFromSuiObjectResponseV1

`Static`partialStakedPositionObjectFromSuiObjectResponseV2

`Static`splitEventFromOnChainV1

`Static`splitEventFromOnChainV2

`Static`stakedEventFromOnChainV1

`Static`stakedEventFromOnChainV2

`Static`stakedRelaxedEventFromOnChainV1

`Static`stakingPoolOneTimeAdminCapObjectFromSuiObjectResponseV1

`Static`stakingPoolOneTimeAdminCapObjectFromSuiObjectResponseV2

`Static`stakingPoolOwnerCapObjectFromSuiObjectResponseV1

`Static`stakingPoolOwnerCapObjectFromSuiObjectResponseV2

`Static`unlockedEventFromOnChainV1

`Static`unlockedEventFromOnChainV2

`Static`updatedEmissionsEventFromOnChainV2

`Static`withdrewPrincipalEventFromOnChainV1

`Static`withdrewPrincipalEventFromOnChainV2