Type Alias GetLeaderScheduleApi

Type declaration

• getLeaderSchedule:function

  • getLeaderSchedule<TIdentity extends Address>(
        slot: bigint,
        config: Readonly<{ commitment?: Commitment }> & Readonly<
            { identity: Address },
        >,
    ): null | Readonly<{ [TAddress in Address]?: bigint[] }>

  • Fetch the leader schedule for the epoch that corresponds to the provided slot. If unspecified, the leader schedule for the current epoch is fetched

    When a slot is provided, the leader schedule for the epoch that corresponds to the provided slot is returned, and this can be null if the slot corresponds to an epoch that does not exist.

    The RPC request payload provides a null value for slot when the slot is not specified but the request wishes to include config.

    Type Parameters

    • TIdentity extends Address

    Parameters

    • slot: bigint
    • config: Readonly<{ commitment?: Commitment }> & Readonly<{ identity: Address }>

    Returns null | Readonly<{ [TAddress in Address]?: bigint[] }>
  • getLeaderSchedule(
        slot: bigint,
        config?: Readonly<{ commitment?: Commitment }>,
    ): null | GetLeaderScheduleApiResponseWithAllIdentities

  • Parameters

    • slot: bigint
    • Optionalconfig: Readonly<{ commitment?: Commitment }>

    Returns null | GetLeaderScheduleApiResponseWithAllIdentities

  • getLeaderSchedule<TIdentity extends Address>(
        slot: null,
        config: Readonly<{ commitment?: Commitment }> & Readonly<
            { identity: Address },
        >,
    ): Readonly<{ [TAddress in Address]?: bigint[] }>

  • Type Parameters

    • TIdentity extends Address

    Parameters

    • slot: null
    • config: Readonly<{ commitment?: Commitment }> & Readonly<{ identity: Address }>

    Returns Readonly<{ [TAddress in Address]?: bigint[] }>

  • getLeaderSchedule(
        slot: null,
        config?: Readonly<{ commitment?: Commitment }>,
    ): GetLeaderScheduleApiResponseWithAllIdentities

  • Parameters

    • slot: null
    • Optionalconfig: Readonly<{ commitment?: Commitment }>

    Returns GetLeaderScheduleApiResponseWithAllIdentities