General improvements - to be discussed in retro

[vacekj]

Metrics

key metrics to track:

• lines of code - should go down significantly across all of our repositories (I estimate a 30% reduction is possible)

• bundle size

• Core web vitals. ac: all green
  ^ track these for every PR, a-la vercel stats in nextjs

• local dev server startup time. ac: under 5s

• build time. ac: under 30s on CI

• test time. ac: under 1min per project on CI

• for indexer - time to index all chains, events/sec

record and celebrate wins, maintain quantitative improvements

Wins

• Image resizing with Pinata + CloudFront CDN = super fast IPFS data loading! Images for OSS round brought down from 120+MB to 5MB = 95% reduction, 24 times smaller.

General

• CI caching
• prune old branches
• prune old tasks and pull requests, tickets
• Use turbo for testing and linting on CI
• use one github action, only run pnpm once for the whole workspace
• Ensure that errors are communicated to the user in a meaningful fashion (maybe global error handling?) - vis Pinata billing issue resolving in a 404 => confusion.
• enable eslint-plugin-turbo to catch undeclared env vars
• Set up development tasks for all packages, such that turbo dev will start up RM, GE and Builder, each setup to communicate with each other by default
• Put shared env vars into 1password if secret, into .example if public
• update onboarding instructions (how quickly you can onboard a team member ~ how good your codebase is)
• implement Permit2 for supported erc20s
• handle all error states. communicate meaningfully to the user. always include the next step.
• Isolate data fetching outside of contexts into simple hooks in common package using swr.
• Replace imperative and repetitive contract interaction code with Wagmi hooks (ViewRoundResults.tsx:224, round.ts:545)
• replace home-grown hooks and contexts with native wagmi replacements where possible.
• standardize jest configs and use the actual jest package (currently we use a mixture of jest and craco)
• validate env variables when starting the apps in dev mode and during build, display an error banner in the UI during dev mode
• fully deprecate and delete the old js api, spin down instances, delete dbs etc.
• Run fleek deploy only after tests and build pass in CI
• lerna + yarn => turborepo + pnpm (validated by vercel and other big players)
• format hook for beforecommit - incl. contracts (Sol) (run it globally from the root of the monorepo)
• remove tests from before push hook, as we are bypassing them anyway, and leave just tsc, which is much faster. tests are ran in CI, or when testing locally in watch mode anyway
• finally merge the esbuild branch into round-manager, and also into other packages
• adopt swr for data fetching and extract hooks
• have a static landing page
• only run lint-staged once from the root and just have separate configs for each package
• extract and share code between packages
• extract eslint config to a shared package
• Enable turborepo for all packages

Type safety

• Typings are all over the place - single source of truth under common/types that is a zod or yup schema, typeof schema, used for both validation and type checking. figure out how to use this across repos, needed in both grants-stack, allo-indexer, allo-indexer-client

ABI management and contract interaction

• wait for wagmi to release v1 and switch to viem, then switch with them. ac: ethers removed as dependency everywhere
• use wagmi-cli with hardhat plugins. need to use git submodules for this since separate repos. ac: no manual contract interaction or abis

Performance

• analyze bundle and take quick wins
• upgrade packages and throw out unnecessary ones
• use webp via cloudfront
• trim what the put on IPFS
• implement resizing using pinata

Testing

• test out using foundry for testing instead of hardhat.
• https://swc.rs/docs/usage/jest for all jest tests

Deployment

• radically redo/simplify deployment scripts. favour one configurable script instead of 20 that are 80% the same
• remove reorg protection
• generally remove any code that is not strictly necessary to deploy a working setup

[vacekj]

re env variables validation:

• https://github.com/af/envalid
• need to keep .env.example in sync with the validation schema - drop a ### visible ### note about this at the top of the .env.example AND in the validation schema to keep those two in sync.