Monorepo setup

[PaulRBerg]

TODOs

• Bun workspaces
• CI workflows
• Foundry configs
• Just files
• IDE integration with Hardhat VSCode - see Does not work with nested foundry.toml files in a monroepo NomicFoundation/hardhat-vscode#704
• Make Airdrops tests work - see Unable to run "forge test" in a package that depends upon another package in a monorepo because a library artifact is not found foundry-rs/foundry#11593
• READMEs
• Shell scripts in scripts/bash (de-duplicate them)

Plan and Review

The plan is turn the https://github.com/sablier-labs/lockup repository into this monorepo (to maintain our repo popularity, stars, etc.).

cc @sablier-labs/evm can you please take a look at this, and LMK your feedback?

Make sure to ask Claude Code to walk you through the repo structure and how it's different from the existing repos.

[smol-ninja]

Nice work. I will have a look later this week or next week.

[andreivladbrg]

can you please take a look at this, and LMK your feedback?

i believe it's not a rush with this, right?
don't think i'll manage next week or the one after

[PaulRBerg]

Yeah no rush but it would be great to develop the next protocols (e.g. staking) in this repo

[andreivladbrg]

sharing this, as i used it to compare the protocol files match:

click to see script

#!/usr/bin/env bash
set -euo pipefail

# --- CONFIG ---------------------------------------------------------------
MONO_URL="https://github.com/sablier-labs/evm-monorepo.git"
LOCKUP_URL="https://github.com/sablier-labs/lockup.git"
FLOW_URL="https://github.com/sablier-labs/flow.git"
AIRDROPS_URL="https://github.com/sablier-labs/airdrops.git"

WORKDIR="${WORKDIR:-sablier-compare}"
PROTOCOLS=("lockup" "airdrops" "flow")

# --- COLORS ---------------------------------------------------------------
if [[ -t 1 ]]; then
  RED=$'\033[31m'; GRN=$'\033[32m'; YLW=$'\033[33m'; BLU=$'\033[34m'
  BOLD=$'\033[1m'; RESET=$'\033[0m'
else
  RED=""; GRN=""; YLW=""; BLU=""; BOLD=""; RESET=""
fi

header() { echo -e "\n${BOLD}${BLU}==> $*${RESET}"; }
subheader() { echo -e "${BOLD}${YLW}---- $*${RESET}"; }
ok() { echo -e "${GRN}OK${RESET} $*"; }
warn() { echo -e "${YLW}WARN${RESET} $*"; }

# --- FIXED: relative .sol lister (no GNU realpath required) ---------------
list_sol_relpaths() {
  local base="$1"
  [[ -d "$base" ]] || return 0
  # cd into base and list .sol files as paths relative to base
  ( cd "$base" && find . -type f -name '*.sol' -print | sed 's#^\./##' | LC_ALL=C sort -u )
}

# Compare two files; return 0 if same, 1 if different.
files_equal() {
  local a="$1" b="$2"
  if command -v git >/dev/null 2>&1; then
    git -c core.safecrlf=false diff --no-index --quiet -- "$a" "$b" 2>/dev/null && return 0 || return 1
  else
    cmp -s -- "$a" "$b" && return 0 || return 1
  fi
}

show_diff() {
  local a_label="$1" a="$2" b_label="$3" b="$4"
  if command -v git >/dev/null 2>&1; then
    git -c core.safecrlf=false diff --no-index --unified=3 -- "$a" "$b" | sed "1,2d"
  else
    diff -u --label "$a_label" --label "$b_label" "$a" "$b" || true
  fi
}

# --- SETUP ---------------------------------------------------------------
mkdir -p "$WORKDIR"
cd "$WORKDIR"

header "Cloning repositories"
[[ ! -d evm-monorepo ]] && git clone "$MONO_URL" evm-monorepo || warn "evm-monorepo exists; skipping clone"
[[ ! -d lockup       ]] && git clone "$LOCKUP_URL" lockup       || warn "lockup exists; skipping clone"
[[ ! -d flow         ]] && git clone "$FLOW_URL"   flow         || warn "flow exists; skipping clone"
[[ ! -d airdrops     ]] && git clone "$AIRDROPS_URL" airdrops   || warn "airdrops exists; skipping clone"

header "Checking out staging in standalone repos"
for repo in lockup airdrops flow; do
  pushd "$repo" >/dev/null
  git checkout staging
  popd >/dev/null
done

# --- COMPARISON ----------------------------------------------------------
header "Comparing Solidity sources between monorepo and standalone repos"
ANY_DIFF=0

for proto in "${PROTOCOLS[@]}"; do
  subheader "Protocol: ${proto}"
  MONO_SRC="evm-monorepo/${proto}/src"
  SOLO_SRC="${proto}/src"

  if [[ ! -d "$MONO_SRC" ]] && [[ ! -d "$SOLO_SRC" ]]; then
    warn "Both missing: $MONO_SRC and $SOLO_SRC"
    continue
  fi

  mapfile -t MONO_LIST < <(list_sol_relpaths "$MONO_SRC")
  mapfile -t SOLO_LIST < <(list_sol_relpaths "$SOLO_SRC")

  # Write to temp files for set ops
  TMPDIR="$(mktemp -d)"
  printf "%s\n" "${MONO_LIST[@]}" > "$TMPDIR/mono.txt" || true
  printf "%s\n" "${SOLO_LIST[@]}" > "$TMPDIR/solo.txt" || true

  LC_ALL=C sort -u "$TMPDIR/mono.txt" "$TMPDIR/solo.txt" > "$TMPDIR/union.txt"

  DIFF_COUNT=0
  while IFS= read -r rel; do
    [[ -z "$rel" ]] && continue
    A="$MONO_SRC/$rel"
    B="$SOLO_SRC/$rel"
    if [[ ! -f "$A" ]] && [[ -f "$B" ]]; then
      ANY_DIFF=1; DIFF_COUNT=$((DIFF_COUNT+1))
      echo -e "${RED}MISSING in monorepo:${RESET} $rel"
    elif [[ -f "$A" ]] && [[ ! -f "$B" ]]; then
      ANY_DIFF=1; DIFF_COUNT=$((DIFF_COUNT+1))
      echo -e "${RED}MISSING in standalone:${RESET} $rel"
    elif [[ -f "$A" && -f "$B" ]]; then
      if ! files_equal "$A" "$B"; then
        ANY_DIFF=1; DIFF_COUNT=$((DIFF_COUNT+1))
        echo -e "${RED}DIFF:${RESET} $rel"
        show_diff "monorepo/${proto}/src/$rel" "$A" "${proto}/src/$rel" "$B" | sed 's/^/    /'
      fi
    fi
  done < "$TMPDIR/union.txt"

  if [[ "$DIFF_COUNT" -eq 0 ]]; then
    ok "No differences found for ${proto}"
  fi

  rm -rf "$TMPDIR"
done

echo
if [[ "$ANY_DIFF" -eq 0 ]]; then
  echo -e "${BOLD}${GRN}All Solidity files match between monorepo and standalone repos.${RESET}"
else
  echo -e "${BOLD}${RED}Finished. Differences were found (see above).${RESET}"
  exit 1
fi

https://app.warp.dev/block/jXGOkMu5XaqeuIM8NjRQoE

[PaulRBerg]

@andreivladbrg of course there will be differences between the Solidity files as development hasn't stopped in the upstream repos. We will merge all logic at the end once we agree on the overall setup.

[PaulRBerg]

Unfortunately, Foundry isn't quite ready to support monorepos: foundry-rs/foundry#11617

[smol-ninja]

How did you test the inheritance feature @PaulRBerg? Its scheduled to release in 1.4.0 and is not available in the most recent release (1.3.5)?