GeneralApi

public protocol GeneralApi : BaseApi

Undocumented

  • getInfo() Default implementation

    Get info.

    Default Implementation

    Declaration

    Swift

    func getInfo() -> Single<String>

    Return Value

    Info.

    Show on GitHub
  • getChainProperties() Default implementation

    Get properties associated with the chain.

    Default Implementation

    Declaration

    Swift

    func getChainProperties() -> Single<ChainProperties>

    Return Value

    ChainProperties with chain id and immutable chain parameters.

    Show on GitHub
  • getGlobalProperties() Default implementation

    Get global properties. This object contains all of the properties, of the blockchain that are fixed, or that change only once per maintenance interval, such as the current list of miners, block interval, etc.

    Default Implementation

    Declaration

    Swift

    func getGlobalProperties() -> Single<GlobalProperties>

    Return Value

    GlobalProperties.

    Show on GitHub
  • getConfiguration() Default implementation

    Get compile-time constants.

    Default Implementation

    Declaration

    Swift

    func getConfiguration() -> Single<Config>

    Return Value

    Config with configured constants.

    Show on GitHub
  • getChainId() Default implementation

    Get the chain id.

    Default Implementation

    Declaration

    Swift

    func getChainId() -> Single<String>

    Return Value

    Chain id identifying blockchain network.

    Show on GitHub
  • getDynamicGlobalProperties() Default implementation

    Retrieve the dynamic properties. The returned object contains information, that changes every block interval, such as the head block number, the next miner, etc.

    Default Implementation

    Declaration

    Swift

    func getDynamicGlobalProperties() -> Single<DynamicGlobalProps>

    Return Value

    DynamicGlobalProps.

    Show on GitHub
  • getTime(toMaintenance:) Default implementation

    Get remaining time to next maintenance interval from given time.

    Default Implementation

    Declaration

    Swift

    func getTime(toMaintenance time: Date) -> Single<MinerRewardInput>

    Parameters

    time

    Reference time.

    Return Value

    Remaining time to next maintenance interval, along with some additional data

    Show on GitHub