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

Outdated information in documentation #3529

Closed
jackcpku opened this issue Feb 2, 2025 · 1 comment
Closed

Outdated information in documentation #3529

jackcpku opened this issue Feb 2, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@jackcpku
Copy link

jackcpku commented Feb 2, 2025

In this section where fields of Context are explained, the description of bumps is outdated.

pub struct Context<'a, 'b, 'c, 'info, T> {
    /// Currently executing program id.
    pub program_id: &'a Pubkey,
    /// Deserialized accounts.
    pub accounts: &'b mut T,
    /// Remaining accounts given but not deserialized or validated.
    /// Be very careful when using this directly.
    pub remaining_accounts: &'c [AccountInfo<'info>],
    /// Bump seeds found during constraint validation. This is provided as a
    /// convenience so that handlers don't have to recalculate bump seeds or
    /// pass them in as arguments.
    pub bumps: BTreeMap<String, u8>,
}

As of v0.29.0, bumps is no longer a BTreeMap, but a type safe struct (see #2542). The struct is currently defined here

@acheroncrypto acheroncrypto added the documentation Improvements or additions to documentation label Feb 16, 2025
@acheroncrypto
Copy link
Collaborator

Thanks for the report! Updated it in #3561.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants