Codespace sturdy giggle 654jvwrrpqjf444p

uniform-load-squid/.contract-addrs

@@ -0,0 +1,4 @@
+export MULTICALL_CONTRACT_ADDR=0xcA11bde05977b3631167028862bE2a173976CA11
+export WORKER_REGISTRATION_CONTRACT_ADDR=0x7Bf0B1ee9767eAc70A857cEbb24b83115093477F
+export NETWORK_CONTROLLER_CONTRACT_ADDR=0x938026fefC5F2b6d7c1bCC7098A3Fd1A81C2AECF
+export GATEWAY_REGISTRY_CONTRACT_ADDR=0x01D7D0CC06cDdD744a9E06C9bc5249DA6da3e848

uniform-load-squid/.env

@@ -0,0 +1 @@
+SUBSQUID_NETWORK_GATEWAY=http://localhost:19174

uniform-load-squid/.gitignore

@@ -0,0 +1,4 @@
+/node_modules
+/lib
+/query-gateway/keys/*.key
+/query-gateway/allocations.db

uniform-load-squid/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Subsquid Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

uniform-load-squid/README.md

@@ -0,0 +1,231 @@
+w<p align="center">
+<picture>
+    <source srcset="https://uploads-ssl.webflow.com/63b5a9958fccedcf67d716ac/64662df3a5a568fd99e3600c_Squid_Pose_1_White-transparent-slim%201.png" media="(prefers-color-scheme: dark)">
+    <img src="https://uploads-ssl.webflow.com/63b5a9958fccedcf67d716ac/64662df3a5a568fd99e3600c_Squid_Pose_1_White-transparent-slim%201.png" alt="Subsquid Logo">
+</picture>
+</p>
+
+[![docs.rs](https://docs.rs/leptos/badge.svg)](https://docs.subsquid.io/)
+[![Discord](https://img.shields.io/discord/1031524867910148188?color=%237289DA&label=discord)](https://discord.gg/subsquid)
+
+[Website](https://subsquid.io) | [Docs](https://docs.subsquid.io/) | [Discord](https://discord.gg/subsquid)
+
+[Subsquid Network Docs](https://docs.subsquid.io/subsquid-network/)
+
+# Network Test One: Uniform Load
+
+Some tests of Subsquid Network Phase Two testnet require that all workers regularly serve some queries. You can help the team create this type of uniform load by running this squid.
+
+Note: you'll need to have at least 10 tSQD to complete this quest. Obtain them by doing other quests first.
+
+> [!TIP]
+> If you locked any of your tSQD before, check if you can unlock any at the [gateways page](https://app.subsquid.io/profile/gateways?testnet).
+
+### I. Install dependencies: Node.js, Docker, Git.
+
+<details>
+<summary>On Windows</summary>
+
+1. Enable [Hyper-V](https://learn.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v).
+2. Install [Docker for Windows](https://docs.docker.com/desktop/install/windows-install/).
+3. Install NodeJS LTS using the [official installer](https://nodejs.org/en/download).
+4. Install [Git for Windows](https://git-scm.com/download/win).
+
+In all installs it is OK to leave all the options at their default values. You will need a terminal to complete this tutorial - [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) bash is the preferred option.
+
+</details>
+<details>
+<summary>On Mac</summary>
+
+1. Install [Docker for Mac](https://docs.docker.com/desktop/install/mac-install/).
+2. Install Git using the [installer](https://sourceforge.net/projects/git-osx-installer/) or by [other means](https://git-scm.com/download/mac).
+3. Install NodeJS LTS using the [official installer](https://nodejs.org/en/download).
+
+We recommend configuring NodeJS to install global packages to a folder owned by an unprivileged account. Create the folder by running
+```bash
+mkdir ~/global-node-packages
+```
+then configure NodeJS to use it
+```bash
+npm config set prefix ~/global-node-packages
+```
+Make sure that the folder `~/global-node-packages/bin` is in `PATH`. That allows running globally installed NodeJS executables from any terminal. Here is a one-liner that detects your shell and takes care of setting `PATH`:
+```
+CURSHELL=`ps -hp $$ | awk '{print $5}'`; case `basename $CURSHELL` in 'bash') DEST="$HOME/.bash_profile";; 'zsh') DEST="$HOME/.zshenv";; esac; echo 'export PATH="${HOME}/global-node-packages/bin:$PATH"' >> "$DEST"
+```
+Alternatively you can add the following line to `~/.zshenv` (if you are using zsh) or `~/.bash_profile` (if you are using bash) manually:
+```
+export PATH="${HOME}/global-node-packages/bin:$PATH"
+```
+
+Re-open the terminal to apply the changes.
+
+</details>
+<details>
+<summary>On Linux</summary>
+
+Install [NodeJS (v16 or newer)](https://nodejs.org/en/download/package-manager), Git and Docker using your distro's package manager.
+
+We recommend configuring NodeJS to install global packages to a folder owned by an unprivileged account. Create the folder by running
+```bash
+mkdir ~/global-node-packages
+```
+then configure NodeJS to use it
+```bash
+npm config set prefix ~/global-node-packages
+```
+Make sure that any executables globally installed by NodeJS are in `PATH`. That allows running them from any terminal. Open the `~/.bashrc` file in a text editor and add the following line at the end:
+```
+export PATH="${HOME}/global-node-packages/bin:$PATH"
+```
+Re-open the terminal to apply the changes.
+
+</details>
+
+### II. Install Subsquid CLI
+
+Open a terminal and run
+```bash
+npm install --global @subsquid/cli@latest
+```
+This adds the [`sqd` command](https://docs.subsquid.io/squid-cli/). Verify that the installation was successful by running
+```bash
+sqd --version
+```
+A healthy response should look similar to
+```
+@subsquid/cli/2.8.0 linux-x64 node-v20.5.1
+```
+
+### III. Run the squid
+
+1. Open a terminal, navigate to any folder for which you have write permissions and run the following commands to retrieve the squid, enter its folder and install dependencies:
+   ```bash
+   sqd init uniform-load-squid -t https://github.com/subsquid-quests/network-test-one-uniform-load-squid
+   ```
+   ```bash
+   cd uniform-load-squid
+   ```
+   ```bash
+   npm ci
+   ```
+
+> [!IMPORTANT]
+> If you're on Windows, the terminal opens in `C:\Windows\system32` by default. Do not download your squid there, navigate someplace else.
+
+2. Press "Get Key" button in the quest card to obtain the `networkTestOneUniformLoad.key` key file. Save it to the `./query-gateway/keys` subfolder of the squid folder. The file will be used to identify your local query gateway when locking tSQD to allocate bandwidth and as it operates.
+
+3. Get the peer ID of your future gateway by running:
+   ```bash
+   sqd get-peer-id
+   ```
+
+4. Register your future gateway using [this page](https://app.subsquid.io/profile/gateways/add?testnet).
+   - Use the peer ID you obtained in the previous step.
+   - Leave the "Publicly available" switch disabled.
+
+5. Lock 10 tSQD by selecting your gateway on [this page](https://app.subsquid.io/profile/gateways?testnet), clicking "Get CU" and submitting the form. Once done, you will begin getting computation units (*CUs*) once every epoch (~15 minutes).
+
+   The "Lock blocks duration" field lets you tune the length of time during which you'll be able to query the network, measured in blocks of Arbitrum Sepolia's L1 (that is, Ethereum Sepolia). The minumum is five hours, but you can opt to lock for longer if you intend to work on the quest over multiple days.
+
+   | Time              | Blocks |
+   |:-----------------:|:------:|
+   | 5 hours (minimum) | 1500   |
+   | 24 hours          | 7200   |
+   | 72 hours          | 21600  |
+
+   Be aware that you'll need to unlock your tokens manually after the end of this period. The tokens you get back will be used in subsequent quests.
+
+   If the locking period expires before you finish your work, simply unlock your tokens, then lock them again.
+
+6. Wait for about 15 minutes. This is the time it takes for Subsquid Network to enter a new epoch, at the beginning of which CUs will be allocated towards your gateway.
+
+7. Start the query gateway with
+   ```bash
+   sqd up
+   ```
+
+   If you'd like to check if the locking was successful, you can inspect the logs of the query gateway container with `docker logs <query_gateway_container_name>`. After one-two minutes required for the node startup it should contain some lines like this one:
+   ```
+   [2024-01-31T14:55:06Z INFO  query_gateway::chain_updates] allocated CU: 48300 spent CU: 0
+   ```
+
+> [!TIP]
+>   If you get an error message about `unknown shorthand flag: 'd' in -d`, that means that you're using an old version of `docker` that does not support the `compose` command yet. Update Docker or edit the `commands.json` file as follows:
+>   ```diff
+>            "up": {
+>            "deps": ["check-key"],
+>            "description": "Start a PG database",
+>   -        "cmd": ["docker", "compose", "up", "-d"]
+>   +        "cmd": ["docker-compose", "up", "-d"]
+>          },
+>          "down": {
+>            "description": "Drop a PG database",
+>   -        "cmd": ["docker", "compose", "down"]
+>   +        "cmd": ["docker-compose", "down"]
+>          },
+>   ```
+
+8. Build the squid code
+   ```bash
+   sqd build
+   ```
+
+9. Start your squid with
+   ```bash
+   sqd run .
+   ```
+   The command should output lines like these:
+   ```
+   [eth-processor] {"level":2,"time":1705681499120,"ns":"sqd:commands","msg":"PROCESS:ETH"}
+   [moonbeam-processor] {"level":2,"time":1705681499148,"ns":"sqd:commands","msg":"PROCESS:MOONBEAM"}
+   [base-processor] {"level":2,"time":1705681499155,"ns":"sqd:commands","msg":"PROCESS:BASE"}
+   [bsc-processor] {"level":2,"time":1705681499163,"ns":"sqd:commands","msg":"PROCESS:BSC"}
+   [eth-processor] 01:24:59 INFO  sqd:processor processing blocks from 955722
+   [base-processor] 01:24:59 INFO  sqd:processor processing blocks from 1208926
+   [moonbeam-processor] 01:24:59 INFO  sqd:processor processing blocks from 166845
+   [bsc-processor] 01:24:59 INFO  sqd:processor processing blocks from 16996735
+   [eth-processor] 01:24:59 INFO  sqd:processor using archive data source
+   [eth-processor] 01:24:59 INFO  sqd:processor prometheus metrics are served at port 34253
+   [base-processor] 01:24:59 INFO  sqd:processor using archive data source
+   [base-processor] 01:24:59 INFO  sqd:processor prometheus metrics are served at port 40205
+   [moonbeam-processor] 01:24:59 INFO  sqd:processor using archive data source
+   [moonbeam-processor] 01:24:59 INFO  sqd:processor prometheus metrics are served at port 33691
+   [bsc-processor] 01:24:59 INFO  sqd:processor using archive data source
+   [bsc-processor] 01:24:59 INFO  sqd:processor prometheus metrics are served at port 41199
+   [moonbeam-processor] 01:25:00 INFO  sqd:processor:mapping Got 0 burn txs and 0 USDT transfers
+   [moonbeam-processor] 01:25:00 INFO  sqd:processor 171971 / 5325985, rate: 3823 blocks/sec, mapping: 2729 blocks/sec, 1364 items/sec, eta: 23m
+   [base-processor] 01:25:00 INFO  sqd:processor:mapping Got 0 burn txs and 0 USDT transfers
+   [base-processor] 01:25:00 INFO  sqd:processor 1477379 / 9442733, rate: 175758 blocks/sec, mapping: 8032 blocks/sec, 1339 items/sec, eta: 45s
+   [base-processor] 01:25:02 INFO  sqd:processor:mapping Got 1 burn txs and 0 USDT transfers
+   ```
+
+   The squid should download enough data in 3-4 hours.
+
+> [!TIP]
+> Do not worry if the squid fails: any progress it made is saved. Simply restart it if it happens.
+
+When done, stop the squid processor with Ctrl-C, then stop and remove the query gateway container with
+```bash
+sqd down
+```
+
+10. After the locking period ends, go to the [gateways page](https://app.subsquid.io/profile/gateways/) and unlock your tSQD - you will need them for other quests.
+
+# Quest Info
+
+| Category         | Skill Level                          | Time required (minutes) | Max Participants | Reward                              | Status |
+| ---------------- | ------------------------------------ | ----------------------- | ---------------- | ----------------------------------- | ------ |
+| Squid Deployment | $\textcolor{green}{\textsf{Simple}}$ | ~250                    | -                | $\textcolor{red}{\textsf{75tSQD}}$  | open   |
+
+# Acceptance critera
+
+Sync this squid using the key from the quest card. The syncing progress is tracked by the amount of data the squid has retrieved from [Subsquid Network](https://docs.subsquid.io/subsquid-network).
+
+# About this squid
+
+This [squid](https://docs.subsquid.io/) retrieves native token burns on ETH, BSC, Base and Moonbeam. It does not keep any data, as it's sole purpose is to stress test the network.
+
+Data ingester ("processor") code is defined for all networks in `src/testConfig.ts`. The executable `src/main.ts` chooses the settings to use based on its sole command line argument. The scripts file `commands.json` contains commands for running each processor (`process:eth`, `process:bsc`, `process:base` and `process:moonbeam`). You can also use `sqd run` to run all the services at once; the list of services is kept in the [squid manifest](https://docs.subsquid.io/cloud/reference/manifest/) at `squid.yaml`.
+
+The squid uses Phase Two [Subsquid Network](https://docs.subsquid.io/subsquid-network) as its primary data source.

uniform-load-squid/commands.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://cdn.subsquid.io/schemas/commands.json",
+  "commands": {
+    "clean": {
+      "description": "delete all build artifacts",
+      "cmd": ["npx", "--yes", "rimraf", "lib"]
+    },
+    "build": {
+      "description": "Build the squid project",
+      "deps": ["clean"],
+      "cmd": ["tsc"]
+    },
+    "check-key": {
+      "cmd": ["node", "scripts/checkKey.js", "query-gateway/keys/networkTestOneUniformLoad.key"],
+      "hidden": true
+    },
+    "get-peer-id": {
+      "deps": ["check-key"],
+      "description": "Get a peer ID given the public key",
+      "cmd": ["node", "scripts/getPeerIdFromGatewayKey.js", "query-gateway/keys/networkTestOneUniformLoad.key"]
+    },
+    "up": {
+      "deps": ["check-key"],
+      "description": "Start a Subsquid network gateway",
+      "cmd": ["docker", "compose", "up", "-d"]
+    },
+    "down": {
+      "description": "Stop a Subsquid network gateway",
+      "cmd": ["docker", "compose", "down"]
+    },
+    "process:eth": {
+      "description": "Load .env and start the ETH squid processor",
+      "cmd": ["node", "--require=dotenv/config", "lib/main.js", "eth"]
+    },
+    "process:bsc": {
+      "description": "Load .env and start the BSC squid processor",
+      "cmd": ["node", "--require=dotenv/config", "lib/main.js", "bsc"]
+    },
+    "process:base": {
+      "description": "Load .env and start the Base squid processor",
+      "cmd": ["node", "--require=dotenv/config", "lib/main.js", "base"]
+    },
+    "process:moonbeam": {
+      "description": "Load .env and start the Base squid processor",
+      "cmd": ["node", "--require=dotenv/config", "lib/main.js", "moonbeam"]
+    },
+    "check-updates": {
+      "cmd": ["npx", "--yes", "npm-check-updates", "--filter=/subsquid/", "--upgrade"],
+      "hidden": true
+    },
+    "bump": {
+      "description": "Bump @subsquid packages to the latest versions",
+      "deps": ["check-updates"],
+      "cmd": ["npm", "i", "-f"]
+    }
+  }
+}

uniform-load-squid/docker-compose.yml

@@ -0,0 +1,21 @@
+version: "3.8"
+
+services:
+  query_gateway:
+    image: subsquid/query-gateway:0.2.8
+    environment:
+      HTTP_LISTEN_ADDR: 0.0.0.0:8000
+      BOOT_NODES: >
+        12D3KooWSRvKpvNbsrGbLXGFZV7GYdcrYNh4W2nipwHHMYikzV58 /dns4/testnet.subsquid.io/tcp/22345,
+        12D3KooWQC9tPzj2ShLn39RFHS5SGbvbP2pEd7bJ61kSW2LwxGSB /dns4/testnet.subsquid.io/tcp/22346,
+        12D3KooWQER7HEpwsvqSzqzaiV36d3Bn6DZrnwEunnzS76pgZkMU /dns4/testnet.subsquid.io/tcp/32345
+      RPC_URL: https://sepolia-rollup.arbitrum.io/rpc
+      CONFIG_PATH: /app/data/config/gateway-config.yml
+      KEY_PATH: /app/data/keys/networkTestOneUniformLoad.key
+      ALLOCATIONS_DB_PATH: /app/data/allocations.db
+    env_file:
+      - .contract-addrs
+    volumes:
+      - ./query-gateway:/app/data
+    ports:
+      - "19174:8000"