HeliumHotspotClient class

Operations on the Hotspots API. https://docs.helium.com/api/blockchain/hotspots

Constructors

HeliumHotspotClient(HeliumClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getCurrentlyElectedHotspots() → Future<HeliumResponse<List<HeliumHotspot>>>

Returns the list of hotspots that are currently elected to the concensus group.

getHotspotActivityCounts(String address, {Set<HeliumTransactionType> filterTypes = const {}}) → Future<HeliumResponse<Map<HeliumTransactionType, int>>>

Counts transactions that indicate activity for a hotspot.

getHotspotForAddress(String address) → Future<HeliumResponse<HeliumHotspot>>

Fetches the hotspot with the given address.

getHotspotsForName(String name) → Future<HeliumResponse<List<HeliumHotspot>>>

Fetches the hotspots which map to the given 3-word animal name.

getRewards(String address, DateTime minTime, DateTime maxTime) → Future<HeliumPagedResponse<List<HeliumHotspotReward>>>

Returns rewards for a given hotspot per reward block the hotspot is in, for a given timeframe.

getRewardTotal(String address, DateTime minTime, DateTime maxTime) → Future<HeliumResponse<HeliumHotspotRewardTotal>>

Returns the total rewards earned for a given hotspot over a given time range.

getWitnessed(String address) → Future<HeliumResponse<List<HeliumHotspot>>>

Retrieves the list of hotspots the given hotspot witnessed over about the last 5 days of blocks.

getWitnesses(String address) → Future<HeliumResponse<List<HeliumHotspot>>>

Retrieves the list of witnesses for a given hotspot over about the last 5 days of blocks.

listHotspotActivity(String address, {Set<HeliumTransactionType> filterTypes = const {}}) → Future<HeliumPagedResponse<List<HeliumTransaction>>>

Lists all blockchain transactions in which the given hotspot was involved.

listHotspotChallenges(String address) → Future<HeliumPagedResponse<List<HeliumTransactionPoCReceiptsV1>>>

Lists the challenge (receipts) in which the given hotspot is a challenger, challengee, or witness.

listHotspotElections(String address) → Future<HeliumPagedResponse<List<HeliumTransactionConsensusGroupV1>>>

Lists the consensus group transactions in which the given hotspot was involved.

listHotspots({Set<HeliumHotspotMode> modeFilter = const {}}) → Future<HeliumPagedResponse<List<HeliumHotspot>>>

Lists known hotspots as registered on the blockchain.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

searchHotspotsByBox(double swlat, double swlon, double nelat, double nelon) → Future<HeliumPagedResponse<List<HeliumHotspot>>>

Fetches the hotspots which are within a given geographic boundary indicated by its south-western and north-eastern coordinates.

searchHotspotsByDistance(double lat, double lon, int distance) → Future<HeliumPagedResponse<List<HeliumHotspot>>>

Fetches the hotspots which are within a given number of metres from the given lat and lon coordinates.

searchHotspotsByH3Index(String h3index) → Future<HeliumPagedResponse<List<HeliumHotspot>>>

Fetches the hotspots which are in the given H3 index.

searchHotspotsForName(String query) → Future<HeliumResponse<List<HeliumHotspot>>>

Fetches the hotspots which mach a search term in the query parameter.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited