Function MimirApiAxiosParamCreator

  • MimirApi - axios parameter creator

    Parameters

    Returns {
        mimir: ((height?, options?) => Promise<RequestArgs>);
        mimirAdmin: ((height?, options?) => Promise<RequestArgs>);
        mimirKey: ((key, height?, options?) => Promise<RequestArgs>);
        mimirNode: ((address, height?, options?) => Promise<RequestArgs>);
        mimirNodes: ((height?, options?) => Promise<RequestArgs>);
    }

    • mimir: ((height?, options?) => Promise<RequestArgs>)

      Returns current active mimir configuration.

      Throws

        • (height?, options?): Promise<RequestArgs>
        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • mimirAdmin: ((height?, options?) => Promise<RequestArgs>)

      Returns current admin mimir configuration.

      Throws

        • (height?, options?): Promise<RequestArgs>
        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • mimirKey: ((key, height?, options?) => Promise<RequestArgs>)

      Returns current active mimir configuration for the provided key.

      Throws

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

    • mimirNode: ((address, height?, options?) => Promise<RequestArgs>)

      Returns current node mimir configuration for the provided node address.

      Throws

        • (address, height?, options?): Promise<RequestArgs>
        • Parameters

          • address: string
          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • mimirNodes: ((height?, options?) => Promise<RequestArgs>)

      Returns current node mimir votes.

      Throws

        • (height?, options?): Promise<RequestArgs>
        • Parameters

          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    Export

Generated using TypeDoc