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

README.md

@@ -42,19 +42,27 @@ This monorepo contains all the code needed to build, deploy and interact with th
 
 ### Getting Started
 
-These instructions are for setting up a development environment on a Mac. If you are using a different operating system, you will need to adjust the instructions accordingly.
-
-* Install NodeJS and gcc-12 using `brew install node gcc@12`.
-* Add gcc-12 headers to your cpath using `export CPATH="/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include"`.
-* Install Rust lang using `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`.
-* Install the Solana CLI using `curl -sSfL https://release.solana.com/v1.17.22/install | sh`.
-* Add the Solana CLI to your path using `export PATH="/Users/$(whoami)/.local/share/solana/install/active_release/bin:$PATH"`.
-* Install Anchor version manager using `cargo install --git https://github.com/coral-xyz/anchor avm --locked --force`.
-* Install the latest Anchor version using `avm install 0.29.0 && avm use 0.29.0`.
-* Clone this repository using `git clone https://github.com/orca-so/whirlpools`.
-* Install the dependencies using `yarn`.
-* Set up a Solana wallet if you don't have one already (see below).
-* Run one of the commands below to get started such as `yarn build`.
+#### Automated Setup Script
+
+For a complete development environment setup, use the provided setup script:
+
+```bash
+chmod +x scripts/setup.sh
+./scripts/setup.sh
+```
+
+This script installs all required dependencies and builds the project. It's designed for fresh environments (cloud VMs, containers, new machines) and doesn't check for existing versions. The script also serves as a reference for understanding which dependencies are needed at each stage.
+
+#### Manual Setup
+
+If you prefer manual installation or already have some dependencies:
+
+* Install system dependencies (build tools, Node.js, Rust, Solana CLI, Anchor)
+  * Reference `scripts/setup.sh` for the exact versions and installation steps
+* Clone this repository: `git clone https://github.com/orca-so/whirlpools`
+* Install JavaScript dependencies: `yarn`
+* Build the project: `yarn build`
+* Set up a Solana wallet if needed (see below)
 
 #### Setting up a Solana wallet
 

scripts/setup.sh

@@ -0,0 +1,87 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# =============================================================================
+# DEPENDENCY VERSIONS
+# =============================================================================
+NVM_VERSION="v0.40.3"
+NODE_VERSION="22"
+YARN_VERSION="4.6.0"
+SOLANA_VERSION="v1.17.25"
+ANCHOR_VERSION="v0.29.0"
+RUST_VERSION_FOR_ANCHOR="1.76.0"    # Required for building Anchor v0.29.0
+RUST_VERSION_FOR_PROJECT="1.85.1"   # Required for building Whirlpools project
+
+# Resolve repo root from this script's directory
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)"
+REPO_ROOT="$(cd -- "$SCRIPT_DIR/.." >/dev/null 2>&1 && pwd)"
+echo "=== Repo root: $REPO_ROOT ==="
+
+echo "=== Detecting system ==="
+UNAME_OUT="$(uname -s)"
+case "${UNAME_OUT}" in
+    Linux*)     OS=Linux;;
+    Darwin*)    OS=Mac;;
+    *)          OS="UNKNOWN:${UNAME_OUT}"
+esac
+echo "Detected: $OS"
+
+if [[ "$OS" == "Linux" ]]; then
+    echo "=== Updating system packages (Linux) ==="
+    sudo apt-get update && sudo apt-get upgrade -y
+    sudo apt-get install -y build-essential pkg-config libssl-dev curl git
+elif [[ "$OS" == "Mac" ]]; then
+    echo "=== Installing Xcode Command Line Tools ==="
+    xcode-select --install || true
+
+    echo "=== Installing Homebrew and dependencies ==="
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" || true
+    eval "$(/opt/homebrew/bin/brew shellenv)" 2>/dev/null || eval "$(/usr/local/bin/brew shellenv)" 2>/dev/null || true
+    brew update
+    brew upgrade
+    brew install pkg-config openssl git
+fi
+
+echo "=== Installing NVM (Node Version Manager) ==="
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/${NVM_VERSION}/install.sh | bash
+export NVM_DIR="$HOME/.nvm"
+source "$NVM_DIR/nvm.sh"
+
+echo "=== Installing Node.js ${NODE_VERSION} and Yarn (via Corepack) ==="
+nvm install ${NODE_VERSION}
+nvm use ${NODE_VERSION}
+corepack enable
+corepack prepare yarn@${YARN_VERSION} --activate
+
+echo "=== Installing Rust via rustup ==="
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+source "$HOME/.cargo/env"
+rustc -V
+
+echo "=== Installing Solana CLI ==="
+sh -c "$(curl -sSfL https://release.anza.xyz/${SOLANA_VERSION}/install)"
+source "$HOME/.profile" || true
+solana -V
+
+echo "=== Installing Anchor (${ANCHOR_VERSION}) ==="
+rustup default ${RUST_VERSION_FOR_ANCHOR}
+ANCHOR_TMP_DIR="$(mktemp -d)"
+git clone https://github.com/coral-xyz/anchor "$ANCHOR_TMP_DIR/anchor"
+cd "$ANCHOR_TMP_DIR/anchor"
+git checkout ${ANCHOR_VERSION}
+cd cli
+cargo build --release
+mkdir -p "$HOME/.cargo/bin"
+cp ../target/release/anchor "$HOME/.cargo/bin/anchor-${ANCHOR_VERSION}"
+ln -sfn "$HOME/.cargo/bin/anchor-${ANCHOR_VERSION}" "$HOME/.cargo/bin/anchor"
+export PATH="$HOME/.cargo/bin:$PATH"
+cd "$REPO_ROOT"
+rm -rf "$ANCHOR_TMP_DIR"
+
+echo "=== Building local Whirlpools repo ==="
+rustup default ${RUST_VERSION_FOR_PROJECT}
+cd "$REPO_ROOT"
+yarn install
+yarn build
+
+echo "=== Setup complete ==="