base on A quest to migrate PoolTogether Prize Pool subgraph to Subsquid <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> [](https://docs.subsquid.io/) [](https://discord.gg/subsquid) [Website](https://subsquid.io) | [Docs](https://docs.subsquid.io/) | [Discord](https://discord.gg/subsquid) # PoolTogether V3 Subgraph migration This quest is to migrate the [mainnet deployment](https://github.com/pooltogether/pooltogether-subgraph-v3/blob/master/networks/mainnet.json) of the [PoolTogether Prize Pool subgraph](https://github.com/pooltogether/pooltogether-subgraph-v3/tree/master) to Squid SDK. The resulting squid should match the [GraphQL API](https://v3.docs.pooltogether.com/resources/subgraphs) of the subgraph as close as possible, by migrating `schema.graphql`. The judges reserve the right to request improvements afther the initial review of the submission. Reach out to the [Discord Channel]( https://discord.com/channels/857105545135390731/1155812879770058783) for any tech questions regarding this quest. Use ```template``` squid as a starter. # Quest Info | Category | Skill Level | Time required (hours) | Reward | Status | | ---------------- | ------------------------------------- | --------------------- | ------------------------------------- | ------ | | Squid Deployment | $\textcolor{orange}{\textsf{Medium}}$ | ~5 | $\textcolor{red}{\textsf{2250tSQD}}$ | open | # Acceptance critera Ultimately, the solutions are accepted at the discretion of judges following a manual review. This sections is a rough guide that is in no way binding on our side. Some of the reasons why the solution will not be accepted include: - squid does not start - squid fails to sync fully due to internal errors - [batch handler filters](https://docs.subsquid.io/evm-indexing/configuration/caveats/) are not set up correctly (leads to a late sync failure in [RPC-ingesting](https://docs.subsquid.io/evm-indexing/evm-processor/#rpc-ingestion) squids) - data returned for any query is not consistent with subgraph data You may find [this tool](https://github.com/abernatskiy/compareGraphQL) to be useful for squid to subgraph API comparisons. It is desirable that your solution: - includes a suite of test GraphQL queries that touches every [schema entity](https://docs.subsquid.io/store/postgres/schema-file/entities/) and, if used, every [custom resolver](https://docs.subsquid.io/graphql-api/custom-resolvers/) at least once, with corresponding subgraph queries (listing in README is enough) - has high code quality (readability, simplicity, comments where necessary) - uses [batch processing](https://docs.subsquid.io/basics/batch-processing/) consistently - avoids any "sleeping bugs": logic errors that accidentally happen to not break the data - follows the standard squid startup procedure: ``` git clone <repo_url> cd <repo_url> npm ci sqd up sqd process & sqd serve ``` If it does not, describe your startup procedure in the README. Please test your solutions before submitting. We do allow some corrections, but judges' time is not limitless. To submit, invite the following github accounts to your private repo : [@dariaag](https://github.com/dariaag), [@belopash](https://github.com/belopash), [@abernatskiy](https://github.com/abernatskiy) and [@dzhelezov](https://github.com/dzhelezov). # Rewards tSQD rewards will be delivered via the [quests page](https://app.subsquid.io/quests) of Subsquid Cloud. Make sure you use the same GitHub handle to make a submission and when linking to that page. Winners will be listed at the quest repository README. If you do not wish to be listed please tell us that in an issue in your submission repo. # Useful links - [Quickstart](https://docs.subsquid.io/deploy-squid/quickstart/) - [TheGraph Migration guide](https://docs.subsquid.io/migrate/migrate-subgraph/) - [Cryptopunks Subgraph source code](https://github.com/itsjerryokolo/CryptoPunks) # Setup and Common errors 1. Install Node v16.x or newer [https://nodejs.org/en/download](https://nodejs.org/en/download) 2. Install Docker [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) 3. Install git [https://git-scm.com/book/en/v2/Getting-Started-Installing-Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) 4. Install Squid CLI ```bash npm i -g @subsquid/cli@latest ``` ## How to run a squid: Full startup procedure for newly developed squids: 1. Install dependecies: ```bash npm ci ``` 2. Generate model ```bash sqd codegen ``` 3. Generate types ```bash sqd typegen ``` 4. Build the squid ```bash sqd build ``` 5. Open docker and run: ```bash sqd up ``` 6. Generate migrations: ```bash sqd migration:generate ``` 7. Start processing: ```bash sqd process ``` 8. Start a local GraphQL server in a separate terminal: ```bash sqd serve ``` Types (`./src/abi`), models (`./src/model`) and migrations ('./db') are typically kept within squid repos after they become stable. Then the startup procedure simplifies to ```bash npm ci sqd up sqd process & sqd serve ``` ## Possible Errors: 1. Docker not installed ```bash X db Error × query-gateway Error Error response from daemon: Get "https://registry-1.docker.jo/v2/": uri ting to 127.0.0.1:8888: dial cp 127.0.0.1:8888: connectex: No connection ``` 2. Git not installed ```bash Error: Error: spawn git ENOENT at ChildProcess._handle.onexit (node: internal/child_process: 284:19) at onErrorNT (node: internal/child_process:477:16) at process.processTicksAndRejections (node: internal/process/task_queues:82:21) ``` 3. Dependencies not installed. Run `npm ci` ```bash sqd typegen TYPEGEN Error: spawn squid-evm-typegen ENOENT Code: ENOENT ``` 4. Rate-limiting. Get a private RPC endpoint from [any node provider](https://ethereumnodes.com), then change the `rpcUrl` in `processor.ts` ```bash will pause new requests for 20000ms {"rpcUrl":"https://rpc.ankr.com/eth", "reason" : "HttpError: got 429 from https://rpc.ankr.com/eth"} ``` If necessary, [rate limit your RPC queries](https://docs.subsquid.io/evm-indexing/configuration/initialization/#set-data-source). ## Best practices: 1. Batch saving ```bash let transfers: Transfers[] = []; ... ctx.store.save(transfers); ``` 2. Using map instead of array to avoid duplicate values ```bash let transfers: Map<string, Transfer> = new Map(); ... ctx.store.upsert([...transfers.values()]); ``` 3. Verify log addresses, not only topics. ```bash if (log.topics[0] === erc721.events.Transfer.topic && log.address === CONTRACT_ADDRESS) { ... } ``` ", Assign "at most 3 tags" to the expected json: {"id":"6717","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"