fork deployment documentation and simplification

Author: apexearth

README.md

@@ -2,6 +2,8 @@
 
 ### [Design Decisions Notion Document](https://www.notion.so/originprotocol/Subsquid-Design-Decisions-04ef82ae0d6848d1b14de893e9929ce4#d8e8d367069c4a619809e926f72db074)
 
+#### See [docs/](./docs/) for specific tasks.
+
 ## Release Checklist
 
 Ensure we don't miss anything on a release by following this checklist.
@@ -18,7 +20,7 @@ Ensure we don't miss anything on a release by following this checklist.
 - [ ] Hibernate previous version(s)
 - [ ] Delete old versions (keep recently hibernated version as a backup)
 
-If a version has issues in deployment, fix it in the branch and later *cherry-pick* those fixes back to `main`.
+If a version has issues in deployment, fix it in the branch and later _cherry-pick_ those fixes back to `main`.
 
 ## Env Options
 

docs/fork-deployments.md

@@ -0,0 +1,26 @@
+# Fork Deployments
+
+Subsquid deployment status: https://app.subsquid.io/squids
+
+## Guide
+
+1. Get the public RPC URL for your fork.
+2. Modify [squid.yaml](../squid.yaml) by modifying variables in the `Fork Setup Stage 1` section.
+3. Deploy the squid.
+4. Wait for processing to complete.
+5. Modify [squid.yaml](../squid.yaml) by modifying variables in the `Fork Setup Stage 2` section.
+6. Deploy the squid.
+7. Wait for processing to complete.
+
+At this point the squid will be running using the fork.
+
+## FYI
+
+### Fork Time Travelling
+
+- Time travel in Tenderly will interrupt squid processing. It causes gaps to appear in the block height. To fix this you'd have to do some custom deployments navigating around the gaps.
+
+```yaml
+# Use this env variable to skip blocks
+- BLOCK_FROM: 123456789 # block number after the time travel
+```

squid.yaml

@@ -4,6 +4,17 @@ version: 999
 description: 'Origin Protocol 🦑'
 build:
 deploy:
+  env:
+    TS_NODE_BASEURL: './lib'
+    ### Fork Setup Stage 1
+    # ARCHIVE_ONLY: 'true'
+    # BLOCK_TO: 20870360
+    ### Fork Setup Stage 2
+    # DISABLE_ARCHIVE: 'true'
+    # RPC_ENV: RPC_ENDPOINT
+    # RPC_ENDPOINT: https://virtual.mainnet.rpc.tenderly.co/4fc58260-a74c-4d0f-bdca-77e1bbb1e86c
+    ### Time Travel Fix
+    # BLOCK_FROM: 20870360
   addons:
     postgres:
     rpc:
@@ -16,35 +27,17 @@ deploy:
   processor:
     - name: mainnet-processor
       cmd: ['sqd', 'process:mainnet:prod']
-      env:
-        TS_NODE_BASEURL: './lib'
     - name: arbitrum-processor
       cmd: ['sqd', 'process:arbitrum:prod']
-      env:
-        RPC_ARBITRUM_ENV: RPC_ARBITRUM_ONE_HTTP
-        TS_NODE_BASEURL: './lib'
     - name: base-processor
       cmd: ['sqd', 'process:base:prod']
-      env:
-        RPC_BASE_ENV: RPC_BASE_HTTP
-        TS_NODE_BASEURL: './lib'
     - name: oeth-processor
       cmd: ['sqd', 'process:oeth:prod']
-      env:
-        TS_NODE_BASEURL: './lib'
     - name: ogv-processor
       cmd: ['sqd', 'process:ogv:prod']
-      env:
-        RPC_ENV: RPC_ENDPOINT
-        TS_NODE_BASEURL: './lib'
     - name: ousd-processor
       cmd: ['sqd', 'process:ousd:prod']
-      env:
-        RPC_ENV: RPC_ENDPOINT
-        TS_NODE_BASEURL: './lib'
   api:
-    env:
-      TS_NODE_BASEURL: './lib'
     cmd:
       - npx
       - squid-graphql-server