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

Clarify missing nonce use #2067

Closed
wants to merge 1 commit into from
Closed

Conversation

aryzing
Copy link

@aryzing aryzing commented Aug 30, 2024

Description

The way possible_next_nonce is calculated wasn't explicitly defined, previously using the term "derived", making it harder to understand whether missing nonces should be inspected when creating new transaction or trying to get existing transactions unstuck.

The changes include more explicit language, as well as minor changes more aligned with how Nakamoto works (no more mention of microblcks).

Type of Change

  • New feature
  • Bug fix
  • API reference/documentation update
  • Other

Does this introduce a breaking change?

No, just docs were updated

Are documentation updates required?

It would be nice if the API docs were updated too, since the reason I came here (and asked on Discord) was because the API docs didn't seem to be clear enough

Checklist

  • Code is commented where needed
  • Unit test coverage for new or modified code paths
  • npm run test passes
  • Changelog is updated
  • Tag 1 of @rafaelcr or @zone117x for review

@CLAassistant
Copy link

CLAassistant commented Aug 30, 2024

CLA assistant check
All committers have signed the CLA.

@ryanwaits ryanwaits self-assigned this Aug 30, 2024
@ryanwaits
Copy link
Contributor

@aryzing Thanks for the PR! These docs have been moved to our dedicated docs repository - I'll migrate your suggested changes there.

PR: hirosystems/docs#799

@ryanwaits ryanwaits closed this Nov 1, 2024
@ryanwaits ryanwaits removed their request for review November 1, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants