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

[Task] Deprecate diff chain updates #703

Closed
10 tasks
cycraig opened this issue Mar 10, 2022 · 0 comments · Fixed by #759
Closed
10 tasks

[Task] Deprecate diff chain updates #703

cycraig opened this issue Mar 10, 2022 · 0 comments · Fixed by #759
Assignees
Labels
Deprecated Feature that will be removed in a later major release. Part of "Deprecated" section in changelog
Milestone

Comments

@cycraig
Copy link
Contributor

cycraig commented Mar 10, 2022

Description

Mark all public functions that work with diff chain resolutions, merges or updates as deprecated. This includes the top-level APIs such as the Account, Client, and Resolver as well as any exposed functions for creating or merging diffs.

We should also always publish full integration chain updates in the Account to prevent anyone from performing diff updates that may not be forwards compatible.

Motivation

The diff chain is at-risk and will likely be removed due to possible technical infeasibility going forward.

To-do list

  • Mark diff chain functions as deprecated.
    • Rust
    • Wasm
  • Change Account to always perform integration chain updates.

Change checklist

Add an x to the boxes that are relevant to your changes, and delete any items that are not.

  • The feature or fix is implemented in Rust and across all bindings whereas possible.
  • The feature or fix has sufficient testing coverage
  • All tests and examples build and run locally as expected
  • Every piece of code has been document according to the documentation guidelines.
  • If conceptual documentation (mdbook) and examples highlighting the feature exist, they are properly updated.
  • If the feature is not currently documented, a documentation task Issue has been opened to address this.
@cycraig cycraig added the Deprecated Feature that will be removed in a later major release. Part of "Deprecated" section in changelog label Mar 10, 2022
@cycraig cycraig added this to the v0.5 Features milestone Mar 10, 2022
@cycraig cycraig self-assigned this Mar 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Deprecated Feature that will be removed in a later major release. Part of "Deprecated" section in changelog
Projects
Development

Successfully merging a pull request may close this issue.

1 participant