Add example to index all orders (#42)

cowprotocol · Sep 22, 2023 · e605df6 · e605df6
1 parent 65b8b12
commit e605df6
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/.env.example b/.env.example
@@ -23,4 +23,26 @@ SLACK_WEBHOOK_URL=
 NOTIFICATIONS_ENABLED=false
 
 # Sentry
-SENTRY_DSN=
+SENTRY_DSN=
+
+
+###########################
+# Recompute Local State
+###########################
+## Mainnet
+# NETWORK=1
+# BLOCK_NUMBER=17883049
+# PAGE_SIZE=5000
+# CONTRACT_ADDRESS=0xfdaFc9d1902f4e0b84f65F49f244b32b31013b74
+
+## Gnosis Chain
+# NETWORK=100
+# BLOCK_NUMBER=29389123
+# PAGE_SIZE=5000
+# CONTRACT_ADDRESS=0xfdaFc9d1902f4e0b84f65F49f244b32b31013b74
+
+## Goerli
+# NETWORK=5
+# BLOCK_NUMBER=9493135
+# PAGE_SIZE=5000
+# CONTRACT_ADDRESS=0xfdaFc9d1902f4e0b84f65F49f244b32b31013b74
diff --git a/README.md b/README.md
@@ -33,6 +33,17 @@ To run the state rebuilder locally, use the previous command in [Local testing](
 - `PAGE_SIZE`: The page size for `eth_getLogs` (defaults to `5000` to support Infura)
 - `CONTRACT_ADDRESS`: The address of the `ComposableCoW` contract.
 
+Example:
+
+```ini
+# Index all Composable CoW orders from block 17883049 (deployment of Composable CoW in Mainnet)
+NETWORK=1
+BLOCK_NUMBER=17883049
+PAGE_SIZE=5000
+CONTRACT_ADDRESS=0xfdaFc9d1902f4e0b84f65F49f244b32b31013b74
+
+```
+
 Other environment variables such as the RPC node URL and notifications MUST be set as well.
 
 ### Deployment