Mobile Coverage points calculator

[michaeldjeffrey]

Many changes to the rewards algorithm are contained in and across many HIPs. The blog post MOBILE Proof of Coverage contains a more thorough explanation of many of them. It is not exhaustive, but a great place to start.

Please comment if...

• You think something can be named more appropriately
• You have tests you'd like to see
• You think something is important and we should try to make it less hidden
• You can provide additional context to some part of how scores are calculated
• Saying hi
• You think more explanation could be provided to someone perusing the code
• You feel like

Example Usage

type RadioId = (PublicKeyBinary, Some(String));

pub async fn coverage_points(
    &mut self,
    radio_id: &RadioId,
) -> anyhow::Result<coverage_point_calculator::CoveragePoints> {
    let pubkey = &radio_id.0;
    let average = self.speedtest_averages.get_average(pubkey).unwrap();
    let speedtests = self.speedtests.get(&radio_id).expect("speedtests").clone();
    let radio_type = self.radio_type(&radio_id);
    let trust_scores = self
        .trust_scores
        .get(&radio_id)
        .expect("trust scores")
        .clone();
    let verified = self.radio_threshold_verified(&radio_id);
    let ranked_coverage = self.coverage_map.hexes(&radio_id);

    let coverage_points = coverage_point_calculator::CoveragePoints::new(
        radio_type,
        RadioThreshold::Verified,
        speedtests,
        location_trust_scores,
        ranked_coverage,
    )?;

    Ok(coverage_points)
}

Fields:

• CoveredHex::base_coverage_points
  • HIP-74
  • reduced cbrs radio coverage points HIP-113
• CoveredHex::assignment_multiplier
  • HIP-103
• CoveredHex::rank
  • HIP-105
• CoveredHex::boosted_multiplier
  • must meet minimum subscriber thresholds HIP-84
  • Wifi Location trust score >0.75 for boosted hex eligibility HIP-93
• CoveragePoints::location_trust_multiplier
  • HIP-98
  • states 30m requirement for boosted hexes HIP-107
  • increase Boosted hex restriction, 30m -> 50m Pull Request
• CoveragePoints::speedtest_multiplier
  • HIP-74
  • added "Good" speedtest tier HIP-98
  • latency is explicitly under limit in HIP https://github.com/helium/oracles/pull/737

Notable Conditions:

• Location
  • If a Radio covers any boosted hexes, LocationTrust scores must meet distance requirements, or be degraded.
  • CBRS Radio's location is always trusted because of GPS.
• Speedtests
  • The latest 6 speedtests will be used.
  • There must be more than 2 speedtests.
• Covered Hexes
  • If a Radio is not BoostedHexStatus::Eligible, boost values are removed before calculations.

[bbalser]

My understanding is the caller will call make_rewardable_radio and then take the output and call calculate_coverage_points. Looking through the code, some of the calculations are done in the first function and some in the second. I don't understand the value of this being 2 steps. Why not just a single function that does everything?

[michaeldjeffrey]

Why not just a single function that does everything?

Having the Radio and CoveragePoints separate was an artifact of the way I started. Now that we're closing in on the end, I agree it makes sense to provide a single function as the interface for calculating coverage points.

In doing so, it also revealed that many of the intermediary structs were no longer needed. They have been removed in lieu of functions that I think better describe the problem.