Merge pull request #41 from 0xsequence/refactor/devx_improvements

sidekick improvements + linting

Author: VGabriel45

.env.example

@@ -1,42 +1,53 @@
-# Required env variables
-PORT=3000
-HOST=0.0.0.0
-DATABASE_URL="postgresql://dev:sequence@localhost:5432/sequence_sidekick?schema=public" # Created by docker
-REDIS_HOST=localhost
-REDIS_PORT=6379
-REDIS_PASSWORD=sequence
-PROJECT_ACCESS_KEY= # Take it from Sequence Builder
-SECRET_KEY= # Set your own secret key for Sidekick, use it when making requests to the API
-SEQUENCE_RPC_URL= # Take it from Sequence Builder
-BUILDER_API_SECRET_KEY= # Take it from Sequence Builder
-INDEXER_URL= # Take it from Sequence Builder
+### =====[ Required Configuration ]=====
+
+### Go to https://sequence.build, login or signup, create a project, go to "Embedded Wallet" and copy your own "Project Access Key"
+### We provide this project access key but we recommend using your own, especially for production.
+SEQUENCE_PROJECT_ACCESS_KEY="AQAAAAAAAJbd_5JOcE50AqglZCtvu51YlGI"  
+
+### By default, the signer type is "local", which requires an EVM private key to be set. This will be your backend wallet.
+### Note that Sidekick creates a Sequence Smart Account Wallet for this private key and the backend wallet itself is
+### a Sequence Smart Account Wallet, not an EOA.
+EVM_PRIVATE_KEY="0x" 
 
 # =====[ Optional Configuration ]=====
 
+### By default we use these values if none is provided in .env
+# PORT=7500
+# HOST=0.0.0.0
+# REDIS_HOST=localhost
+# REDIS_PORT=6379
+
+### You can opt to use a database or not but some routes won't be available if you don't have a database.
+# DATABASE_URL="postgres://postgres:postgres@localhost:5432/sidekick" 
+
+### Set your own secret key for Sidekick, use it when making requests to the API.
+### If some bad actor gets access to your API internally, they will still have to know this secret key to write to the API.
+# SIDEKICK_API_SECRET_KEY="secret"
+
+# REDIS_PASSWORD=""
+
+### We recommend setting these two variables, it will enable automatic contract verification on deployment through Sidekick.
 # ETHERSCAN_API_KEY=
 # VERIFY_CONTRACT_ON_DEPLOY=
 
-# DEBUG=true (enables debug logs)
+# DEBUG="true" 
 
-# If using Google KMS
+### If using local signer (EVM private key)
+### Note: This is enabled by default
+# SIGNER_TYPE=local=
+# EVM_PRIVATE_KEY= 
+
+### If using Google KMS
+# SIGNER_TYPE=google_kms
 # PROJECT=
 # LOCATION=
 # KEY_RING=
 # CRYPTO_KEY=
 # CRYPTO_KEY_VERSION=
 
-# If using AWS KMS
+### If using AWS KMS
+# SIGNER_TYPE=aws_kms 
 # AWS_REGION=
 # AWS_ACCESS_KEY_ID=
 # AWS_SECRET_ACCESS_KEY=
-# AWS_KMS_KEY_ID=
-
-# If using local signer (EVM private key)
-# SIGNER_TYPE=local (defaults to this if no SIGNER_TYPE is found in env)
-# EVM_PRIVATE_KEY= (required if SIGNER_TYPE=local)
-
-# If using Google KMS
-# SIGNER_TYPE=google_kms
-
-# If using AWS KMS
-# SIGNER_TYPE=aws_kms
+# AWS_KMS_KEY_ID=

Dockerfile

@@ -1,5 +1,5 @@
 # Use an official Node.js runtime as the base image
-FROM node:18-alpine
+FROM node:24-alpine
 
 # Set the working directory in the container
 WORKDIR /app
@@ -18,9 +18,6 @@ COPY prisma ./prisma/
 # Install dependencies
 RUN pnpm install --frozen-lockfile
 
-# Generate Prisma Client
-RUN pnpm prisma generate
-
 # Copy the rest of the application code
 COPY . .
 
@@ -31,11 +28,11 @@ RUN pnpm run build
 RUN chmod +x scripts/start.sh
 
 # Expose the port the app runs on
-EXPOSE 3000
+EXPOSE 7500
 
 # Set environment variables
 ENV HOST=0.0.0.0
-ENV PORT=3000
+ENV PORT=7500
 
 # Command to run the application
 CMD ["/app/scripts/start.sh"]

README.md

@@ -5,42 +5,49 @@ Sidekick is a companion service, fully open source,that simplifies blockchain in
 When executing any transaction with Sidekick, the caller will not be the EOA of the PRIVATE KEY you're using for Sidekick, but a Sequence Smart Wallet created for your EOA.
 You can get the address by making a GET request to the `/sidekick/wallet-address` endpoint.
 
-## Setup
+## Run remotely with docker
 
-- Copy `.env.example` to `.env`: `cp .env.example .env`
-- Set up your environment variables in `.env`:
+These commands will get you started with the simplest version of Sidekick. It will allow you to test some of the features like deploying a contract, reading from a contract and executing transactions.
 
-## Using Docker (Recommended)
+```
+docker pull ghcr.io/0xsequence/sidekick:latest
+docker run -e EVM_PRIVATE_KEY=your_private_key_here -p 7500:7500 ghcr.io/0xsequence/sidekick:latest
+```
 
-Quickstart locally with Docker with only one command:
-`pnpm docker:start` (Will start Redis, PostgreSQL, and the server)
-`curl http://127.0.0.1:3000` should return {"status":"ok"}
+## Run locally with Docker Compose
 
-Instructions to stop and restart the sidekick with Docker:
-`pnpm docker:stop` (Will stop all the services)
-`pnpm docker:restart` (Will stop and start all the services)
+You can use the docker-compose.yml to run Sidekick with all the features like Redis, PostgreSQL, Grafana, Prometheus, Blackbox Exporter, etc.
 
-### Run the sidekick without Docker, locally for development:
-1. Install dependencies: `pnpm install`
-2. Generate Prisma client: `pnpm prisma generate`
-3. Create database tables: `pnpm prisma migrate dev`
-4. Start Redis: `pnpm start:redis`
-5. Start the server: `pnpm start`
+```
+cp .env.example .env
+```
 
-Instructions to stop Redis:
-`pnpm stop:redis` (Will stop Redis)
+This will start all the services.
+```
+pnpm docker:start
+```
 
-Instructions to start Redis:
-`pnpm start:redis` (Will start Redis)
+## Dev mode
 
-Instructions to test the sidekick:
-`pnpm run test` (Will run the tests)
-`pnpm run test:watch` (Will run the tests in watch mode)
-`pnpm run test:coverage` (Will run the tests and generate a coverage report)
+You can also run Sidekick locally without docker.
+  
+```
+cp .env.example .env
+```
 
-Instructions to run the sidekick in development mode:
-`pnpm run dev` (Will start the server in development mode)
-`pnpm run dev:withRedis` (Will start the server and Redis in development mode)
+Run without a database
+```
+pnpm install
+pnpm dev:withRedis
+```
+
+Run with a database
+```
+pnpm install
+pnpm prisma generate
+pnpm prisma migrate dev
+pnpm dev:withRedis
+```
 
 ## Analytics & Monitoring 📊
 
@@ -78,14 +85,20 @@ Sidekick provides several tools for monitoring, metrics, and alerting. Here's wh
 
 Sidekick provides a DEBUG mode that will give you detailed logs so you can see what's happening under the hood, add DEBUG="true" as an environment variable to your .env file to turn it on.
 
+```
+DEBUG=true
+```
+
 ### Tenderly 🔍
 
 Sidekick is integrated with Tenderly, you can use it to simulate transactions, deployments, or get a transaction simulation URL and debug directly from the Tenderly UI with just one click. For the best results, we recommend that your contracts are verified.
 To use Tenderly, you need to add the following environment variables to your .env file:
 
+```
 TENDERLY_ACCESS_KEY=...
 TENDERLY_ACCOUNT_SLUG=..
 TENDERLY_PROJECT_SLUG=..
+```
 
 ### Contract Verification ✅
 
@@ -98,15 +111,9 @@ For now, this only works for the following contracts:
 
 To turn automatic verification on you need the following environment variables:
 
-VERIFY_CONTRACT_ON_DEPLOY=true
-ETHERSCAN_API_KEY=...
-
-### Public Docker Image on Github Container Registry 🐳
-
-You can pull the latest version of Sidekick from the Github Container Registry:
-
 ```
-docker pull ghcr.io/0xsequence/sidekick:latest
+VERIFY_CONTRACT_ON_DEPLOY=true
+ETHERSCAN_API_KEY=..  .
 ```
 
 Verification for other contract templates will be added soon.

biome.json

@@ -0,0 +1,47 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+	"vcs": {
+		"enabled": false,
+		"clientKind": "git",
+		"useIgnoreFile": false
+	},
+	"files": {
+		"ignoreUnknown": false,
+		"ignore": [
+			"pnpm-lock.yaml",
+			"node_modules",
+			"package.json",
+			"src/lib/generated"
+		]
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "tab",
+		"formatWithErrors": true,
+		"lineWidth": 80,
+		"indentWidth": 2
+	},
+	"organizeImports": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"suspicious": {
+				"noExplicitAny": "warn"
+			},
+			"style": {
+				"noUnusedTemplateLiteral": "warn",
+				"noNonNullAssertion": "off"
+			}
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"semicolons": "asNeeded",
+			"trailingCommas": "none",
+			"quoteStyle": "single"
+		}
+	}
+}

docker-compose.yml

@@ -1,55 +1,53 @@
 services:
   postgres:
     image: postgres:17
-    container_name: sidekick_postgres
+    container_name: sidekick-postgres
     restart: always
     healthcheck:
       test: ["CMD-SHELL", "pg_isready -U dev -d sequence_sidekick"]
       interval: 5s
       timeout: 5s
       retries: 5
     environment:
-      POSTGRES_USER: dev
-      POSTGRES_PASSWORD: sequence
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
       POSTGRES_DB: sequence_sidekick
     ports:
       - "5432:5432"
     volumes:
       - postgres_data:/var/lib/postgresql/data
 
   redis:
-    container_name: sidekick_redis
+    container_name: sidekick-redis
     image: redis:7.2
     restart: always
-    command: redis-server --requirepass ${REDIS_PASSWORD:-sequence}
+    command: redis-server 
     ports:
       - "6380"
     volumes:
       - redis_data:/data
 
   sequence_sidekick:
     build: .
-    container_name: server
+    container_name: sequence-sidekick
     restart: always
     depends_on:
       postgres:
         condition: service_healthy
       redis:
         condition: service_started
     ports:
-      - "${PORT:-3000}:3000"
+      - "${PORT:-7500}:7500"
     environment:
-      - PORT=${PORT:-3000}
+      - PORT=${PORT:-7500}
       - HOST=${HOST:-0.0.0.0}
-      - PROJECT_ACCESS_KEY=${PROJECT_ACCESS_KEY}
-      - SECRET_KEY=${SECRET_KEY}
-      - DATABASE_URL=postgresql://dev:sequence@postgres:5432/sequence_sidekick?schema=public
+      - SEQUENCE_PROJECT_ACCESS_KEY=${SEQUENCE_PROJECT_ACCESS_KEY}
+      - API_SECRET_KEY=${API_SECRET_KEY}
+      - DATABASE_URL=postgresql://postgres:postgres@postgres:5432/sequence_sidekick?schema=public
       - REDIS_HOST=redis
       - REDIS_PORT=${REDIS_PORT:-6379}
       - REDIS_PASSWORD=${REDIS_PASSWORD}
-      - SEQUENCE_RPC_URL=${SEQUENCE_RPC_URL}
       - BUILDER_API_SECRET_KEY=${BUILDER_API_SECRET_KEY}
-      - INDEXER_URL=${INDEXER_URL}
       - SIGNER_TYPE=${SIGNER_TYPE}
       - DEBUG=${DEBUG}
       # AWS KMS configs