aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface UnstakePosition

    A user's queued or completed afSUI-to-SUI unstake position.

    A REQUEST position has no returned SUI fields. A SUI_MINTED position has the returned coin ID and amount.

    interface UnstakePosition {
        afSuiId: string;
        epoch: bigint;
        providedAfSuiAmount: bigint;
        requester: string;
        returnedSuiAmount?: bigint;
        state: UnstakePositionState;
        suiId?: string;
        timestamp: number | undefined;
        txnDigest: string;
    }
    Index
    afSuiId epoch providedAfSuiAmount requester returnedSuiAmount? state suiId? timestamp txnDigest
    afSuiId: string

    Object ID of the afSUI coin burned or converted.

    epoch: bigint

    Epoch associated with the request. Position updates retain the request epoch when a matching completion event arrives.

    providedAfSuiAmount: bigint

    afSUI amount provided, in raw afSUI units.

    requester: string

    Address that requested the unstake.

    returnedSuiAmount?: bigint

    Returned SUI amount in raw SUI units, present after completion.

    state: UnstakePositionState

    Unstake state: REQUEST while queued or SUI_MINTED after SUI is returned.

    suiId?: string

    Object ID of the returned SUI coin, present after completion.

    timestamp: number | undefined

    Event timestamp for the request or completion, when supplied.

    txnDigest: string

    Digest of the transaction that emitted the request or completion event.

    Settings
    Member Visibility

    On This Page
    Properties