Interface QueryStakePoolsArgs

The StakePoolProvider.queryStakePools call arguments.

Hierarchy

  • QueryStakePoolsArgs

Properties

apyEpochsBackLimit? epochRewards? epochsLength? filters? fuzzyOptions? pagination sort?

Properties

Optional apyEpochsBackLimit

apyEpochsBackLimit?: number

Used for APY metric computation. It will take 3 epochs back if not specified.

Deprecated

Use epochsLength instead

Optional epochRewards

epochRewards?: boolean

If not true, StakePool.rewardHistory is undefined.

Optional epochsLength

epochsLength?: number

Controls the StakePool.rewardHistory and StakePoolMetrics.lastRos properties of the response.

If undefined, StakePool.rewardHistory contains last LAST_ROS_EPOCHS elements and StakePoolMetrics.lastRos is the ROS in LAST_ROS_EPOCHS epochs of the stake pool; otherwise StakePool.rewardHistory contains the requested history and StakePoolMetrics.ros is the ROS in the requested time interval.

Optional filters

filters?: {
    _condition?: FilterCondition;
    identifier?: MultipleChoiceSearchFilter<Partial<Pick<Cardano.PoolParameters, "id"> & Pick<Cardano.StakePoolMetadata, "name" | "ticker">>>;
    pledgeMet?: boolean;
    status?: Cardano.StakePoolStatus[];
    text?: string;
}

Will fetch all stake pools if not specified.

Type declaration

  • Optional _condition?: FilterCondition

    Defaults to 'and'.

  • Optional identifier?: MultipleChoiceSearchFilter<Partial<Pick<Cardano.PoolParameters, "id"> & Pick<Cardano.StakePoolMetadata, "name" | "ticker">>>

    Will return results for partial matches.

  • Optional pledgeMet?: boolean

    If provided, returns all the pools which live stake meets / do not meets the pledge.

  • Optional status?: Cardano.StakePoolStatus[]

    If provided, returns all the pools in any of the given status.

  • Optional text?: string

    Fuzzy search on text metadata fields. Ignored if shorter than 3 characters. If provided and valid, identifier is ignored.

Optional fuzzyOptions

fuzzyOptions?: {
    distance?: number;
    fieldNormWeight?: number;
    ignoreFieldNorm?: boolean;
    ignoreLocation?: boolean;
    location?: number;
    minMatchCharLength?: number;
    threshold?: number;
    useExtendedSearch?: boolean;
    weights?: { description?: number | undefined; homepage?: number | undefined; name?: number | undefined; poolId?: number | undefined; ticker?: number | undefined; };
}

Overrides default fuzzy options. Ignored in live environments.

Type declaration

  • Optional distance?: number

    Determines how close the match must be to the location.

  • Optional fieldNormWeight?: number

    Determines how much the field length affects scoring.

  • Optional ignoreFieldNorm?: boolean

    When true, the calculation for the relevance score will ignore fieldNormWeight.

  • Optional ignoreLocation?: boolean

    When true, search will ignore location and distance.

  • Optional location?: number

    Determines approximately where in the text is the pattern expected to be found.

  • Optional minMatchCharLength?: number

    Only the matches whose length exceeds this value will be returned.

  • Optional threshold?: number

    Maximum threshold. 0: exact match; 1: match everything.

  • Optional useExtendedSearch?: boolean

    When true, it enables the use of unix-like search commands.

  • Optional weights?: { description?: number | undefined; homepage?: number | undefined; name?: number | undefined; poolId?: number | undefined; ticker?: number | undefined; }

    Weights of metadata fields. Free positive values: they will be normalized internally.

pagination

pagination: PaginationArgs

The configuration for paged result.

Optional sort

sort?: StakePoolSortOptions

Will return all stake pools sorted by name ascending if not specified.

Settings

Member Visibility

Theme

Generated using TypeDoc