Function MimirApiFp

Returns {
    mimir(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>;
    mimirAdmin(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>;
    mimirKey(key, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<number>)>;
    mimirNode(address, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>;
    mimirNodes(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirNodesResponse>)>;
    mimirV2(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>;
    mimirV2IDs(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirV2IDsResponse>)>;
}

• mimir:function

  • mimir(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>

  • Returns current active mimir configuration.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>

    Throws

• mimirAdmin:function

  • mimirAdmin(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>

  • Returns current admin mimir configuration.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>

    Throws

• mimirKey:function

  • mimirKey(key, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<number>)>

  • Returns current active mimir configuration for the provided key.

    Parameters

    • key: string

      the mimir key to lookup
    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<number>)>

    Throws

• mimirNode:function

  • mimirNode(address, height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>

  • Returns current node mimir configuration for the provided node address.

    Parameters

    • address: string
    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>

    Throws

• mimirNodes:function

  • mimirNodes(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirNodesResponse>)>

  • Returns current node mimir votes.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<MimirNodesResponse>)>

    Throws

• mimirV2:function

  • mimirV2(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>

  • Returns current mimir V2 configuration.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<MimirResponse>)>

    Throws

• mimirV2IDs:function

  • mimirV2IDs(height?, options?): Promise<((axios?, basePath?) => AxiosPromise<MimirV2IDsResponse>)>

  • Returns mapping of mimir V2 IDs to name.

    Parameters

    • Optional height: number

      optional block height, defaults to current tip
    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<MimirV2IDsResponse>)>

    Throws