Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions docs/solana/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,34 @@ Begin by following the steps in the {ref}`Certora Prover installation guide <ins

`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


```
rustup toolchain install 1.79
rustup toolchain install 1.75
rustup toolchain install 1.81
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


`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?


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?


3. Test the installation by using `certora-sbf` to download and install Certora
Platform Tools

`cargo certora-sbf --no-build`

4. It is strongly recommended to install VSCode and the rust-analyzer extension.
4. Install [llvm](https://releases.llvm.org/), you can typically install it also via apt or brew.

5. Install [rustfilt](https://github.com/luser/rustfilt)
```
cargo install rustfilt
```

7. It is strongly recommended to install VSCode and the rust-analyzer extension.

----

Expand Down
Loading