chore(env): clean up env vars and document setup

Author: bitbeckers

.env.template

@@ -1,14 +1,37 @@
+## SERVICE
+INDEXER_ENVIRONMENT=test
 PORT=4000
-KEY=
-PROOF=
 
-SUPABASE_CACHING_DB_URL=
-SUPABASE_CACHING_ANON_API_KEY=
+### W3UP - https://github.com/storacha/w3up/tree/main/packages/w3up-client#bringing-your-own-agent-and-delegation
+KEY=""
+PROOF=""
 
-SUPABASE_DATA_DB_URL=
-SUPABASE_DATA_ANON_API_KEY=
-SUPABASE_DATA_SERVICE_API_KEY=
+### SUPABASE JS - https://www.npmjs.com/package/@supabase/supabase-js
 
-SENTRY_DSN=
+SUPABASE_CACHING_DB_URL="http://127.0.0.1:54321"
+SUPABASE_CACHING_ANON_API_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0
 
-INDEXER_ENVIRONMENT=test
+SUPABASE_DATA_DB_URL="http://127.0.0.1:64321"
+SUPABASE_DATA_ANON_API_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0
+SUPABASE_DATA_SERVICE_API_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU
+
+### KYSELY
+
+CACHING_DATABASE_URL=postgresql://postgres:[email protected]:54322/postgres
+DATA_DATABASE_URL=postgresql://postgres:[email protected]:64322/postgres
+
+### SENTRY
+SENTRY_ENVIRONMENT=local # local | staging | production
+SENTRY_DSN="" #disabled for local
+SENTRY_AUTH_TOKEN="" #disabled for local
+
+### RPCs - we implement a fallback to the first available RPC
+
+# https://www.alchemy.com/
+ALCHEMY_API_KEY=""
+
+# https://www.infura.io/
+INFURA_API_KEY=""
+
+# https://drpc.org/
+DRPC_API_KEY=""

README.md

@@ -6,8 +6,26 @@ The hypercerts API is the touchpoint for developers to interact with the hyperce
 
 ### Environment variables
 
+#### W3UP
+
 In `env.template` you'll find KEY and PROOF which are [w3up](https://web3.storage/docs/w3up-client/) key and proofs which you need to set up yourself for local otherwise you'll be superadmin 😉
 
+#### Supabase JS
+
+SupabaseJS is used to connect to both the the caching and data service. The local variables are deterministic and provided in the template.
+
+#### Kysely
+
+Kysely is implemented in favor of SupabaseJS as it allows for more flexibility and complexity in queries. To connect to the database you need to set the `CACHING_DATABASE_URL` and `DATA_DATABASE_URL` in the `.env` file. By default, the local variables are set to the local Supabase instance.
+
+#### Sentry
+
+Sentry is used for monitoring and error reporting. You can read more about it [here](https://docs.sentry.io/platforms/javascript/guides/node/configuration/env-vars/). When Sentry is set to `local` it will be disabled by default.
+
+#### RPCs
+
+The API implements a fallback to the first available RPC. You can set the RPCs in the `.env` file.
+
 ### Supabase
 
 * Install Docker
@@ -17,15 +35,15 @@ In `env.template` you'll find KEY and PROOF which are [w3up](https://web3.storag
 
 This will spin up 2 Supabase instances in Docker, one for the indexer service (caching) and one for the data service (static data) which are both exposed by the API.
 
-From both instances, you need to get their respective keys and add them to the env vars. When in doubt you can run `supabase status` to fetch the keys again.
+From both instances, you can get their respective keys and add them to the env vars. When in doubt you can run `supabase status` to fetch the keys again. By default this is not needed for local development.
 
 ### Run the API locally
 
 `pnpm dev`
 
-This will run a live production instance (I'm proud that it's production) by running swc
+This will run a live production instance by running `swc` to compile the code and `nodemon` to restart the server on changes.
 
-You can then find the API at localhost:4000/spec (Swagger instance) and the Graph at localhost:4000/v1/graphql
+You can then find the API at `localhost:4000/spec` (Swagger instance) and the GraphQL at `localhost:4000/v1/graphql`
 
 ## Deployments
 

src/__generated__/routes/routes.ts

@@ -2,10 +2,9 @@ import * as Sentry from '@sentry/node';
 import {assertExists} from "./utils/assertExists.js";
 import { nodeProfilingIntegration } from "@sentry/profiling-node";
 
-const SENTRY_DSN = assertExists(process.env.SENTRY_DSN, "SENTRY_DSN");
 // Ensure to call this before importing any other modules!
 Sentry.init({
-    dsn: SENTRY_DSN,
+    dsn: process.env.SENTRY_DSN,
     integrations: [
         nodeProfilingIntegration(),
     ],