Function NetworkApiAxiosParamCreator

  • NetworkApi - axios parameter creator

    Parameters

    Returns {
        ban: ((address, height?, options?) => Promise<RequestArgs>);
        constants: ((height?, options?) => Promise<RequestArgs>);
        inboundAddresses: ((height?, options?) => Promise<RequestArgs>);
        lastblock: ((height?, options?) => Promise<RequestArgs>);
        lastblockChain: ((chain, height?, options?) => Promise<RequestArgs>);
        network: ((height?, options?) => Promise<RequestArgs>);
        ragnarok: ((height?, options?) => Promise<RequestArgs>);
        version: ((height?, options?) => Promise<RequestArgs>);
    }

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

      Returns the ban status 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>

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

      Returns constant configuration, can be overridden by mimir.

      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>

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

      Returns the set of asgard addresses that should be used for inbound transactions.

      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>

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

      Returns the last block information for all chains.

      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>

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

      Returns the last block information for the provided chain.

      Throws

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

          • chain: string
          • Optional height: number

            optional block height, defaults to current tip

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Returns network overview statistics.

      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>

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

      Returns a boolean indicating whether the chain is in ragnarok.

      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>

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

      Returns the network's current MAYANode version, the network's next MAYANode version, and the querier's MAYANode version.

      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