[TKN-683] Add setup.sh script for local Whirlpools build

[calintje]

Added a setup script to streamline development environment setup:

New Setup Script (scripts/setup.sh):

• One-stop installation of all required dependencies (Node.js, Rust, Solana CLI, Anchor)
• Supports both Linux and macOS environments
• Installs specific versions required by the project (clearly defined at the top)
• Designed for fresh environments (cloud VMs, containers, new machines)

Updated Documentation:

• Update "Getting Started" section featuring the automated setup script
• Provides clear instructions for making script executable and running it
• Maintains manual setup option with reference to script for exact versions

[yugure-orca]

Nice QoL improvement!
(1 comment about Rust version)

[yugure-orca]

Could you use 1.78.0 ?

yarn build should build everything. It uses 1.78.0 for contract build. (no need to switch default, we can use Rust 1.85.1 as default because package.json has the following setting)
https://github.com/orca-so/whirlpools/blob/main/programs/whirlpool/package.json#L5

[calintje]

The Rust version in this line is specific to the installation of Anchor v0.29.0, and not the Whirlpools repo.

Background

I encountered an issue with using AVM to install v0.29.0.

Using Anchor's recommendation for installing Anchor:

cargo install --git https://github.com/coral-xyz/anchor avm --force
avm install 0.29.0

yields:

Error: Failed to install 0.29.0, is it a valid version?

So I decided to install Anchor v0.29.0 from source, but that would not compile with the latest version of Rust that comes with the default Rust installation, v1.90.0. Neither did it compile with v1.85.1. I tried multiple versions of Rust, and landed on v1.76 as a compatible version.

Testing your suggestions

That said, as a result of you review comment, I just tried v1.78 as well, and that works too. So, I believe we still need to switch the default right before building Anchor.

Furthermore, I tested the script without switching the default from v1.78.0 to v1.85.1 before trying yarn install and yarn build from the repo's root, and indeed the Whirlpool program builds, but building rust-tx-sender will fail with Error:

error: rustc 1.78.0 is not supported by the following packages:
        [email protected] requires rustc 1.81
        [email protected] requires rustc 1.80.0
        [email protected] requires rustc 1.80.0
        [email protected] requires rustc 1.80.0
        [email protected] requires rustc 1.81

I'm happy to switch to another version of Rust instead of 1.85.1, but I believe we still need to switch the default at least twice.

[calintje]

Follow up
@wjthieme 's suggestion to use cargo install --git https://github.com/coral-xyz/anchor --tag v0.29.0 anchor-cli instead of my code works without switching the Rust version. So the only thing left to do was to add rustup default ${RUST_VERSION_FOR_PROJECT} right before building the project, with the version being v1.84.0, which is the same version that's used by the GitHub workflows.

(The default v1.90.0 seems to not be compatible with WASM compilation)

[wjthieme]

I think you could do something like cargo install --git https://github.com/coral-xyz/anchor --tag v0.29.0 anchor-cli so you don't have to clone, build and link manually

[wjthieme]

I personally hate nvm 🦗. I always just do brew install node@18 or something like that

[calintje]

This script runs on both Linux and Mac. Would you recommend installing Brew for Linux as well?

I went with nvm because it's the first pick in Node's installation documentation. And maybe not super important, but Brew does not fall under Node's 'Recommended (Official)' installations., but under 'Community (Unofficial)' installations.