Function MimirApiFactory

Returns {
    mimir(height?, options?): AxiosPromise<MimirResponse>;
    mimirAdmin(height?, options?): AxiosPromise<MimirResponse>;
    mimirKey(key, height?, options?): AxiosPromise<number>;
    mimirNode(address, height?, options?): AxiosPromise<MimirResponse>;
    mimirNodes(height?, options?): AxiosPromise<MimirNodesResponse>;
}

• mimir:function

  • mimir(height?, options?): AxiosPromise<MimirResponse>

  • Returns current active mimir configuration.

    Parameters

    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<MimirResponse>

    Throws

• mimirAdmin:function

  • mimirAdmin(height?, options?): AxiosPromise<MimirResponse>

  • Returns current admin mimir configuration.

    Parameters

    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<MimirResponse>

    Throws

• mimirKey:function

  • mimirKey(key, height?, options?): 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: any

      Override http request option.

    Returns AxiosPromise<number>

    Throws

• mimirNode:function

  • mimirNode(address, height?, options?): 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: any

      Override http request option.

    Returns AxiosPromise<MimirResponse>

    Throws

• mimirNodes:function

  • mimirNodes(height?, options?): AxiosPromise<MimirNodesResponse>

  • Returns current node mimir votes.

    Parameters

    • Optional height: number

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

      Override http request option.

    Returns AxiosPromise<MimirNodesResponse>

    Throws