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.

Sign up for GitHub

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

Jump to bottom

Fix typos in documentation for Secp256k1 native program #33796

Merged
merged 1 commit into from
Oct 23, 2023
Merged

Fix typos in documentation for Secp256k1 native program #33796

merged 1 commit into from
Oct 23, 2023

Conversation

nickguo
Copy link
Contributor

@nickguo nickguo commented Oct 20, 2023 •
edited
Loading

Problem

There are typos in the native program documentation for Secp256k1 signature verification, please see screenshot

Screenshot 2023-10-20 at 2 07 09 PM

Summary of Changes

Fix the doc typos, no code changes

Fixes #

@mergify mergify bot added community Community contribution need:merge-assist labels Oct 20, 2023
@mergify mergify bot requested a review from a team October 20, 2023 21:13
@nickguo nickguo force-pushed the fix_secp256k1_documentation branch from 9bbddeb to fc12c95 Compare October 20, 2023 21:16
joncinque
joncinque reviewed Oct 23, 2023
View reviewed changes
Copy link
Contributor

@joncinque joncinque left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this up! I can't comment further down, but I think the pseudo-code on line 149 also needs to be changed to:

ref_eth_pubkey = instructions[secp_pubkey_instruction_index].data[secp_pubkey_offset..secp_pubkey_offset + 20]

What do you think?

@nickguo nickguo force-pushed the fix_secp256k1_documentation branch from fc12c95 to 92d0449 Compare October 23, 2023 22:26
@nickguo nickguo force-pushed the fix_secp256k1_documentation branch from 92d0449 to 2950e09 Compare October 23, 2023 22:28
@nickguo
Copy link
Contributor Author

nickguo commented Oct 23, 2023

@joncinque Yes you're right! thanks for catching that 🙏 Fixed from + 32 to + 20.

Also, there was another typo where secp_signature_instruction_index was defined twice. Corrected the wrong definition to be secp_pubkey_instruction_index.

@nickguo nickguo requested a review from joncinque October 23, 2023 22:33
joncinque
joncinque approved these changes Oct 23, 2023
View reviewed changes
Copy link
Contributor

@joncinque joncinque left a comment

Choose a reason for hiding this comment

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

Great work, thanks so much!

@joncinque joncinque merged commit 8954689 into solana-labs:master Oct 23, 2023
5 checks passed
nickfrosty pushed a commit to nickfrosty/solana that referenced this pull request Nov 15, 2023
@nickguo @nickfrosty
Fix typos in documentation for Secp256k1 native program (solana-labs#…
a155738 
…33796)
willhickey pushed a commit that referenced this pull request Dec 11, 2023
@nickfrosty @brooksprumo
@dependabot @jacobcreech @nickguo @AshwinSekar @kevinheavey @kaplanmaxe @hugo-syn @apfitzge @norwnd
[docs] docs migration (#34096)
676e80c 
* feat: moved common docs to  repo

* refactor: removed sidebar items

* refactor: removed unused images

* fix: terminology link

* fix: introduction links

* fix: developing links

* refactor: fixed assorted links

* fix: added back the home index

* refactor: home page links

* refactor: primary links

* fix: links

* fix: updated existing redirects

* feat: added new redirects

* refactor: moved cli index file to cli folder

* feat: turned breadcrumbs on

* feat: auto generated cli sidebar

* refactor: page titles

* feat: added usage and wallets categories

* refactor: moved wallet-guide/cli

* style: page titles

* refactor: renamed file to install

* style: page title

* refactor: relocated file to cli/usage/index.md

* style: page title

* refactor: relocat detailed usage generator for cli commands

* refactor: relocated clie usage files

* refactor: relocated paper wallet file

* refactor: relocated file system wallet doc

* feat: added hardware wallet category

* refactor: relocated hardware wallet overview

* refactor: relocated ledger wallet doc

* style: clie wallet titles

* refactor(revert): relocated cli usage doc

* refactor: relocated to examples

* style: cli examples category title

* style: usage doc title

* refactor: relocated cli intro doc

* style: category title

* refactor: renamed file

* refactor: renamed file

* fix: cli links

* refactor: relocated file

* refactor: relocated files

* fix: more cli links

* refactor: sidebar order

* fix: final cli links?

* refactor: proposals

* refactor: split sidebars

* refactor: removed unused icons

* refactor: relocated file

* refactor: relocated file

* refactor: relocated file

* refactor: relocated file

* feat: added architecture page

* refactor: reloacted filed

* refactor: adjusted header links

* style: sidebar labels

* feat: clusters sidebar details

* style: sidebar label

* refactor: relocate file

* refactor: relocated files

* refactor: relocated files

* refactor: relocated files

* style: validator sidebar

* style: sidebar styles

* refactor: internal links

* style: sidebar order

* fix: internal links

* feat: master sidebar

* refactor: removed unneeded h2

* fix: link redirects

* refactor: relocated pages

* style: runtime links

* refactor: simplified runtime redirects

* fix: internal redirect

* refactor: moved proposals to dropdown

* docs: Removes accounts-on-ramdisk section (#33655)

* RPC: update websocket docs (#33460)

* [rpc]: update websocket docs

* rename rewards to showRewards

* add remaining optional fields for slotsUpdates

* update block subscription showRewards

* Change getHealth to compare optimistically confirmed slots (#33651)

The current getHealth mechanism checks a local accounts hash slot vs.
those of other nodes as specified by --known-validator. This is a
very coarse comparison given that the default for this value is 100
slots. More so, any nodes using a value larger than the default
(ie --incremental-snapshot-interval 500) will likely see getHealth
return status behind at some point.

Change the underlying mechanism of how health is computed. Instead of
using the accounts hash slots published in gossip, use the latest
optimistically confirmed slot from the cluster. Even when a node is
behind, it is able to observe cluster optimistically confirmed by slots
by viewing votes published in gossip.

Thus, the latest cluster optimistically confirmed slot can be compared
against the latest optimistically confirmed bank from replay to
determine health. This new comparison is much more granular, and not
needing to depend on individual known validators is also a plus.

* build(deps): bump @babel/traverse from 7.19.6 to 7.23.2 in /docs (#33726)

Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.19.6 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: move rpc info to rpc docs (#33723)

docs: link fixes

docs: link fixes

docs: link fixes

* Fix typos in documentation for Secp256k1 native program (#33796)

* docs: outline requirement of stake in order to vote (#33842)

* docs: outline requirement of stake in order to vote

* pr feedback: move stake section up

* chore: fix some typos (#33833)

* fix spelling of "retrieved"
* fix spelling of "should"
* fix spelling of "comparisons"

* docs: updating apt install to apt upgrade (#33920)

* Fix some typo in the documentation (#34058)

Co-authored-by: Andrew Fitzgerald <[email protected]>

* fix: internal links

* refactor: removed rpc api docs

* refactor: removed rpc sidebar

* fix: updated remaining rpc api links

* refactor: removed final rpc /api route

* refactor: removed dangling component files

* refactor: changed copyright

* fix: dangling ordered list

* refactor: wording around solana docs

* feat: home page content

* refactor: updated docs url

* Link to latest version of the off-chain message signing proposal in the docs (#34329)

* docs: (cli) minor updates to deploy-a-program.md (#34307)

* docs: (cli) minor updates to deploy-a-program.md

* address review comments

* remove unnecessary impl details from the docs about deploy command upgrade flow

* clarify program redeploy section

---------

Co-authored-by: norwnd <norwnd>

* refactor: removed GA

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Brooks <[email protected]>
Co-authored-by: Joe C <[email protected]>
Co-authored-by: steviez <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jacob Creech <[email protected]>
Co-authored-by: Nick Guo <[email protected]>
Co-authored-by: Ashwin Sekar <[email protected]>
Co-authored-by: Kevin Heavey <[email protected]>
Co-authored-by: Max Kaplan <[email protected]>
Co-authored-by: hugo-syn <[email protected]>
Co-authored-by: Andrew Fitzgerald <[email protected]>
Co-authored-by: norwnd <[email protected]>
@willhickey willhickey mentioned this pull request Mar 28, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joncinque joncinque joncinque approved these changes

Assignees
No one assigned
Labels
community Community contribution need:merge-assist
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nickguo @joncinque