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

feat(chain,wallet)!: Transitive ChainPosition #1733

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

evanlinjin
Copy link
Member

Description

Change ChainPosition to be able to represent transitive anchors and unconfirm-without-last-seen values.

As mentioned in #1670 (comment)

Notes to the reviewers

Changelog notice

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

New Features:

  • I've added tests for the new feature
  • I've added docs for the new feature

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

@notmandatory notmandatory added module-blockchain api A breaking API change labels Nov 20, 2024
@notmandatory notmandatory added this to the 1.0.0-beta milestone Nov 20, 2024
Comment on lines 32 to 33
/// It may be possible that the chain data was last seen as confirmed in a conflicting
/// chain.
Copy link
Member

Choose a reason for hiding this comment

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

Would this more clearly describe when this value is Some or None?

Suggested change
/// It may be possible that the chain data was last seen as confirmed in a conflicting
/// chain.
/// If the value is `Some` then this is when the chain data was last seen in a mempool.
/// If `None` then it was only seen as confirmed in a conflicting chain.

Copy link
Member Author

Choose a reason for hiding this comment

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

        /// When the chain data is last seen in the mempool.
        ///
        /// This value will be `None` if the chain data was never seen in the mempool and only seen
        /// in a conflicting chain.

How about this?

Copy link
Member

Choose a reason for hiding this comment

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

Yes this is clear and more concise.

Change `ChainPosition` to be able to represent transitive anchors and
unconfirm-without-last-seen values.
@evanlinjin evanlinjin force-pushed the feature/transitive_chain_position branch from 374097d to 1fb4428 Compare November 22, 2024 03:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api A breaking API change module-blockchain
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants