Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align Aggregator trait with spec #744

Merged
merged 1 commit into from
Sep 11, 2023
Merged

Conversation

tgeoghegan
Copy link
Contributor

Vdaf::prepare_preprocess was missing the &Vdaf::AggregationParam argument specified in VDAF. This adds that argument to the trait method and its implementations. While we're at it, to further align with the spec, we add new methods prepare_shares_to_prepare_message and prepare_next, to align with the spec's prep_shares_to_prep and prep_next, as aliases for the existing prepare_preprocess and prepare_step. The existing methods are marked as deprecated.

Resolves #670

`Vdaf::prepare_preprocess` was missing the `&Vdaf::AggregationParam`
argument specified in VDAF. This adds that argument to the trait method
and its implementations. While we're at it, to further align with the
spec, we add new methods `prepare_shares_to_prepare_message` and
`prepare_next`, to align with the spec's `prep_shares_to_prep` and
`prep_next`, as aliases for the existing `prepare_preprocess` and
`prepare_step`. The existing methods are marked as deprecated.

Resolves #670
@tgeoghegan tgeoghegan requested a review from a team as a code owner September 11, 2023 18:51
@tgeoghegan tgeoghegan requested a review from cjpatton September 11, 2023 18:51
/// specification.
///
/// [VDAF]: https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-vdaf-07#section-5.2
#[deprecated(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, since this PR will be part of an effective-major-version bump, we may as well just drop the old methods. Backwards compatibility is not a concern, and if we keep these methods we'll need to keep them until the next effective-major-version bump.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This way it's easier to give people a hint of what to move to. Filed #745 to remove them later.

@tgeoghegan tgeoghegan merged commit e2751fe into main Sep 11, 2023
@tgeoghegan tgeoghegan deleted the timg/prep-preprocess-agg-param branch September 11, 2023 23:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Vdaf::prepare_preprocess lacks Vdaf::AggregationParam argument
2 participants