V82

.gitignore

@@ -10,4 +10,6 @@
 
 .env
 .yarn.lock
-.DS_Store
+.DS_Store
+
+*.txt

README.md

@@ -28,17 +28,31 @@ BLOCK_FROM=18421105 sqd process:oeth # Start processing at block 18421105
 BLOCK_TO=18421105 sqd process:oeth   # Process up to block 18421105
 ```
 
-## Frequent Commands
+## Useful Commands
 
 ```shell
-yarn codegen           # Generate Schema code
-sqd typegen            # Generate ABI code
-sqd down               # Bring down squid container
-sqd up                 # Bring up squid container
-sqd process:oeth       # Run OETH processor
-sqd process:ousd       # Run OUSD processor
-sqd process:mainnet      # Run misc processor
-sqd migration:generate # Generate migration (sqd down && sqd up first)
+# Code Generation
+yarn generate          # Generate new migration
+yarn typegen           # Generate ABI code
+
+yarn setup             # Reset database - run prior to starting processing for a fresh start
+
+# Processing Commands
+yarn process:arbitrum  # Run Arbitrum processor
+yarn process:base      # Run Base processor
+yarn process:sonic     # Run Sonic processor
+yarn process:oeth      # Run OETH processor
+yarn process:ousd      # Run OUSD processor
+yarn process:ogv       # Run OGV processor
+yarn process:mainnet   # Run misc mainnet processor
+yarn process:test      # Run test processor
+yarn process           # Run combined processor
+
+# Local GraphQL Server
+yarn serve             # You'll have to rebuild and rerun to see updates here.
+
+# Deployment Tools
+yarn postdeploy v81    # Run post-deployment tasks (processing times log and validations)
 ```
 
 ## Quickstart
@@ -47,99 +61,107 @@ sqd migration:generate # Generate migration (sqd down && sqd up first)
 # 0. Install @subsquid/cli a.k.a. the sqd command globally
 npm i -g @subsquid/cli
 
-# 1. Retrieve the template
-sqd init my_squid_name -t evm
-cd my_squid_name
-
-# 2. Install dependencies
+# 1. Install dependencies
 npm ci
 
-# 3. Start a Postgres database container and detach
-sqd up
+# 2. Start a Postgres database container and setup
+yarn setup
 
-# 4. Build and start the processor
-sqd process:oeth
+# 3. Build and start the processor (choose one)
+yarn process:oeth
+yarn process:ousd
+yarn process:mainnet
+# ... or other available processors
 
-# 5. The command above will block the terminal
-#    being busy with fetching the chain data,
-#    transforming and storing it in the target database.
-#
-#    To start the graphql server open the separate terminal
-#    and run
-sqd serve
+# 4. In a separate terminal, start the GraphQL server
+yarn serve
 ```
 
 A GraphiQL playground will be available at [localhost:4350/graphql](http://localhost:4350/graphql).
 
-## Dev flow
-
-### 1. Define database schema
+## Dev Flow
 
-Start development by defining the schema of the target database via `schema.graphql`.
-Schema definition consists of regular graphql type declarations annotated with custom directives.
-Full description of `schema.graphql` dialect is available [here](https://docs.subsquid.io/basics/schema-file).
+### 1. Make Schema Changes
 
-### 2. Generate TypeORM classes
+- Add or modify GraphQL schema files in `src/**/*.graphql`
+- Run `yarn generate` to:
+  - Combine GraphQL files into schema.graphql
+  - Generate TypeORM entities
+  - Create new database migration
+  - Add new files to git
 
-Mapping developers use TypeORM [EntityManager](https://typeorm.io/#/working-with-entity-manager)
-to interact with target database during data processing. All necessary entity classes are
-generated by the squid framework from `schema.graphql`. This is done by running `yarn codegen`
-command.
+### 2. Add New Events/Contracts
 
-NOTE: We don't directly use the `sqd codegen` command because we generate our schema.graphql file first in
-the `yarn codegen` script.
+- Add ABI JSON files to `./abi/`
+- Run `yarn typegen` to generate TypeScript interfaces
+- Create new processor in `src/processors/` or add to existing one
+- Update `squid.yaml` if adding new processor
 
-### 3. Generate database migrations
-
-All database changes are applied through migration files located at `db/migrations`.
-`squid-typeorm-migration(1)` tool provides several commands to drive the process.
+### 3. Local Development
 
 ```bash
-## drop create the database
-sqd down
-sqd up
+# Start fresh
+yarn setup
+
+# Run processor (choose one)
+yarn process:oeth
+yarn process:ousd
+# ... etc
 
-## replace any old schemas with a new one made from the entities
-sqd migration:generate
+# In another terminal
+yarn serve
 ```
 
-See [docs on database migrations](https://docs.subsquid.io/basics/db-migrations) for more details.
+### 4. Testing Changes
 
-### 4. Import ABI contract and generate interfaces to decode events
+- Use GraphiQL playground at [localhost:4350/graphql](http://localhost:4350/graphql)
+- Check processing times with `yarn log:processing-times`
+- Validate data integrity with generated validation queries
 
-It is necessary to import the respective ABI definition to decode EVM logs. One way to generate a type-safe facade class
-to decode EVM logs is by placing the relevant JSON ABIs to `./abi`, then using `squid-evm-typegen(1)` via an `sqd`
-script:
+### 5. Deployment
+
+#### Development (v999)
 
 ```bash
-sqd typegen
+# Reset dev environment (v999)
+# Only use when you need to reset schema or reload data
+sqd deploy . --update --hard-reset
 ```
 
-See more details on the [`squid-evm-typegen` doc page](https://docs.subsquid.io/evm-indexing/squid-evm-typegen).
+#### Production Deployment
 
-## Project conventions
+1. Create and push a new version branch
 
-Squid tools assume a certain [project layout](https://docs.subsquid.io/basics/squid-structure):
+```bash
+git checkout -b v80  # Replace 80 with your version number
+# Make any final changes if needed
+git push origin v80
+```
+
+2. Wait for the deployment to complete and validate the data
+
+3. Tag for production
+
+```bash
+# Once validated, tag the latest commit for production
+git tag prod-v80  # Replace 80 with your version number
+git push origin prod-v80
+```
 
-- All compiled js files must reside in `lib` and all TypeScript sources in `src`.
-  The layout of `lib` must reflect `src`.
-- All TypeORM classes must be exported by `src/model/index.ts` (`lib/model` module).
-- Database schema must be defined in `schema.graphql`.
-- Database migrations must reside in `db/migrations` and must be plain js files.
-- `sqd(1)` and `squid-*(1)` executables consult `.env` file for environment variables.
+4. Monitor deployment
 
-## Deploy a new version
+- Check processing at https://app.subsquid.io/squids
+- Follow release checklist at the top of this README
+- Keep the version branch for reference, DO NOT DELETE
 
-- Visit [Squid deploy dashboard](https://app.subsquid.io/squids/deploy)
-- Auth with `sqd auth -k sqd_XXX` (key is on squid deploy page)
-- Update `squid.yaml` to set the correct version
-- Run `sqd deploy .`
-- Make branch for new version (eg v9) and push to origin
-- Switch back to main branch
+Note: Local deployment via `sqd deploy .` is possible but not recommended for production releases.
 
-## Reset cloud dev version (v999)
+## Project conventions
 
-Useful if you made a schema change or need to reload data.
+Squid tools assume a certain [project layout](https://docs.subsquid.io/basics/squid-structure):
 
-- Check `squid.yaml` to make sure you're on v999
-- `sqd deploy . --update --hard-reset`
+- All compiled js files must reside in `lib` and all TypeScript sources in `src`
+- The layout of `lib` must reflect `src`
+- All TypeORM classes must be exported by `src/model/index.ts`
+- Database schema is generated from GraphQL files in `src`
+- Database migrations must reside in `db/migrations` and must be plain js files