{"id":19336564,"url":"https://github.com/subsquid/archive-registry","last_synced_at":"2025-09-25T14:31:30.155Z","repository":{"id":38241844,"uuid":"448053133","full_name":"subsquid/archive-registry","owner":"subsquid","description":"A community-owned registry of Squid archives","archived":false,"fork":false,"pushed_at":"2024-07-17T15:14:07.000Z","size":4877,"stargazers_count":14,"open_issues_count":1,"forks_count":12,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-01-09T05:14:01.644Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/subsquid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-14T17:32:30.000Z","updated_at":"2024-07-31T22:02:12.000Z","dependencies_parsed_at":"2024-11-17T15:10:44.826Z","dependency_job_id":"d3aba673-c590-4d8e-bbe3-f9414d21f872","html_url":"https://github.com/subsquid/archive-registry","commit_stats":{"total_commits":151,"total_committers":11,"mean_commits":"13.727272727272727","dds":0.5894039735099338,"last_synced_commit":"634004f7114d24af0f770e6b53dcb2878976a917"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subsquid%2Farchive-registry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subsquid%2Farchive-registry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subsquid%2Farchive-registry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subsquid%2Farchive-registry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/subsquid","download_url":"https://codeload.github.com/subsquid/archive-registry/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234207618,"owners_count":18796285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T03:11:39.850Z","updated_at":"2025-09-25T14:31:29.612Z","avatar_url":"https://github.com/subsquid.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Squid Archive Registry\n\n\u003e [!CAUTION]\n\u003e Archive Registry is now deprecated:\n\u003e  - `squid-archive-registry` executable is replaced by [`sqd gateways ls`](https://docs.subsquid.io/squid-cli/gateways/) and [Subsquid Network documentation](https://docs.subsquid.io/subsquid-network/reference/) pages.\n\u003e  - `lookupArchive()` calls should be replaced by direct gateway URLs.\n\nA community-owned registry of Squid archives in a json format. \n\n## Usage of `@subsquid/archive-registry`\n\nThe registry is available as an npm package `@subsquid/archive-registry`. It can be used to conveniently access registry files and e.g. lookup a Squid Archive or EVM Squid Archive by network name.\n\n### Listing the available networks\n\nUse the included `squid-archive-registry` executable to list supported networks:\n\n```bash\n$ squid-archive-registry --help\nUsage: run [options]\n\nDisplay list of available archives\n\nOptions:\n  -t --type \u003ctype\u003e  Network type (choices: \"evm\", \"substrate\")\n  -h, --help        display help for command\n```\n\n### Substrate archives\n\nThe first argument is the name of the network. The second argument is set of lookup filters of type `LookupOptionsSubstrate`.\n\n```typescript\nimport { lookupArchive } from '@subsquid/archive-registry'\n\nconst processor = new SubstrateProcessor()\n  .setDataSource({\n    archive: lookupArchive(\"kusama\"), \n  });\n```\n\nMore accurate way to choose from Substrate networks is to specify `type` parameter inside options for the function. By default `type` is set to `Substrate`.\n\n```typescript\nconst processor = new SubstrateProcessor()\n  .setDataSource({\n    archive: lookupArchive(\"kusama\", { type: \"Substrate\" }), \n  });\n```\n\n`LookupOptionsSubstrate` supports additional filtering by genesis hash, archive version (semver range) and docker image names (of archive and archive gateway). \n\nThere is also a convenience method to get network information by its name:\n```typescript\n  // ...\n  .setDataSource({\n    archive: lookupArchive(\"kusama\", { genesis: \"0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe\" }), \n  });\n```\n\n### EVM archives\n\nSimilar to Substrate archive: first argument is the name of the network, second one is a set of lookup filters of type `LookupOptionsEVM`.\n\n```typescript\nimport { lookupArchive } from '@subsquid/archive-registry'\n\nconst processor = new EvmBatchProcessor()\n  .setDataSource({\n    archive: lookupArchive(\"avalanche\"), \n  });\n```\n\n`LookupOptionsEVM` supports additional filtering by release type:\n\nThere is also a convenience method to get network information by its name:\n```typescript\n  // ...\n  .setDataSource({\n    archive: lookupArchive(\"avalanche\", { type: \"EVM\", release: \"FireSquid\" }), \n  });\n```\n\n## What is a Squid Archive?\n\nSquid Archive provides easy access to the historical on-chain data with little modifications. It is essential for [Substrate Squid pipelines](https://github.com/subsquid/squid-substrate-template) or [EVM Squid pipelines](https://github.com/subsquid/squid-evm-template). It can also be used on its own as a [GraphQL-based](https://graphql.org/) block explorer with powerful filtering and search capabilities over historical events and transactions.\n\n## How to use an Archive?\n\nThe primary use case of a Squid Archive is to serve data to a [Substrate Squid Processor](https://github.com/subsquid/squid-sdk/tree/master/substrate/substrate-processor) or [EVM Squid Processor](https://github.com/subsquid/evm-processor).\n\nThe urls are not supposed to be accessed with a browser. To explore the endpoint with an interactive and human-friendly console, use `explorerUrl` field in `archives.json` (only for substrate archives). \n\nFor example, for exploring Kusama historical data, one can inspect `archives.json` and local Kusama explorer at  `https://kusama.explorer.subsquid.io/graphql`. One can open the GraphQL playground by navigating to this url and use the pane on right hand side to filter (`where:`) and pick the fields of interest.\n\nFor example, the following query will return details on the last 10 transfers:\n\n```gql\nquery RecentBalancesTransfers {\n  events(orderBy: block_height_DESC, where: {name_eq: \"Balances.Transfer\"}, limit: 10) {\n    args\n    name\n    call {\n      name\n      args\n    }\n    block {\n      timestamp\n      height\n    }\n  }\n}\n\n```\n\n## How to contribute\n\nTo contribute a new archive, make a PR updating `archives.json` or `archives-evm.json` specifying the network name and the url. Further, one has to regenerate types in `src/chains.ts` by running `npm run gen-types`. This will update the list of supported chain names and makes it easier to developers to discover which lookups will succeed at compile time.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubsquid%2Farchive-registry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsubsquid%2Farchive-registry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubsquid%2Farchive-registry/lists"}