Skip to content

Update solana installation instructions#474

Open
christiane-certora wants to merge 6 commits into
masterfrom
christiane-solana-installation-updates
Open

Update solana installation instructions#474
christiane-certora wants to merge 6 commits into
masterfrom
christiane-solana-installation-updates

Conversation

@christiane-certora
Copy link
Copy Markdown
Contributor

@christiane-certora christiane-certora commented May 18, 2026

@christiane-certora christiane-certora added the existing feature new documentation for an existing feature label May 18, 2026
Comment thread docs/solana/installation.md Outdated
`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`

It is useful to have Rust versions 1.75, 1.79, and 1.81 or above installed.
It is useful to have Rust versions 1.75, 1.79, and 1.85 or above installed.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Are the old versions there actually still useful?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's rather state "tested on 1.85" and we should just keep the block below as:

 rustup toolchain install 1.85

with the big code box because it gives the user a nice copy button
Copy link
Copy Markdown
Contributor

@johspaeth johspaeth left a comment

Choose a reason for hiding this comment

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

While we are here, we should adjust/update some smaller other issues as well. Wdyt?

Comment thread docs/solana/installation.md Outdated
rustup toolchain install 1.85
```

2. Install `certora-sbf` cargo sub-command
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's also add a link to the sources: https://github.com/Certora/cargo-certora-sbf

Comment thread docs/solana/installation.md Outdated
2. Install `certora-sbf` cargo sub-command

`cargo +1.81 install cargo-certora-sbf`
`cargo +1.85 install cargo-certora-sbf`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In the README of https://github.com/Certora/cargo-certora-sbf we don't state a version, I think we should keep it in sync?

Comment thread docs/solana/installation.md Outdated
Comment on lines +26 to +27
Note that a minimal version of Rust required to install `certora-sbf` is
v1.81.
v1.85.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is confusing, above we state 1.79 and 1.75 but then we say 1.81 is actually required for cargo-certora-sbf. I think in versions before we simply didn't have cargo-certora-sbf at all and had been manually compiling with the compiler flags added in the project directly.

Nevertheless, I would remove this line as it's more confusing then it adds value.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think the certora-sbf readme is helpful for understanding this:

Rust version >= 1.81 to compile cargo-certora-sbf itself
(optional) Solana CLI version >= 1.18
(optional) Rust version v1.75. This version corresponds to Rust bundled with Solana v1.18.
(optional) Rust version v1.79. This version corresponds to Rust bundled with Solana v2.1

so it seems this is about needing the new one (now 1.85) to be able to install the sbf, but it may still use the others somehow? wdyt?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

reading that readme part also makes me wonder if we should have that optional solana CLI step here too?

Comment thread docs/solana/installation.md Outdated
`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`

It is useful to have Rust versions 1.75, 1.79, and 1.81 or above installed.
It is useful to have Rust versions 1.75, 1.79, and 1.85 or above installed.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's rather state "tested on 1.85" and we should just keep the block below as:

 rustup toolchain install 1.85

Comment thread docs/solana/installation.md Outdated
Co-authored-by: Johannes Späth <johspaeth@users.noreply.github.com>
`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`

It is useful to have Rust versions 1.75, 1.79, and 1.81 or above installed.
Rust 1.85 or above is recommended when using `cvlr-solana` ≥ 0.5. Version 1.75 or 1.79 can be used when analyzing programs that use `cvlr-solana` versions below or equal to 0.4. Use 1.75 when the target program is bundled with Solana v1.18 and version 1.79 when targeting Solana v2.1. Install whichever version correspond to the Solana release you target:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
Rust 1.85 or above is recommended when using `cvlr-solana` ≥ 0.5. Version 1.75 or 1.79 can be used when analyzing programs that use `cvlr-solana` versions below or equal to 0.4. Use 1.75 when the target program is bundled with Solana v1.18 and version 1.79 when targeting Solana v2.1. Install whichever version correspond to the Solana release you target:
Rust 1.85 or above is recommended when using `cvlr-solana` ≥ 0.5. Version 1.75 or 1.79 can be used when analyzing programs that use `cvlr-solana` versions below or equal to 0.4. Use 1.75 when the target program is bundled with Solana v1.18 and version 1.79 when targeting Solana v2.1. Install whichever version correspond to the Solana release you target, plus a recent version (>= 1.85) for building `certora-sbf` in the next step:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

existing feature new documentation for an existing feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants