{"id":20640509,"url":"https://github.com/kovart/forta-sharding","last_synced_at":"2025-07-17T05:32:00.079Z","repository":{"id":184441151,"uuid":"646811288","full_name":"kovart/forta-sharding","owner":"kovart","description":"🛠️ Helper library for effortless implementation of custom sharding logic in Forta bots.","archived":false,"fork":false,"pushed_at":"2024-02-24T14:28:32.000Z","size":168,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-16T01:21:10.889Z","etag":null,"topics":["forta","helper","library","sharding"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kovart.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-05-29T11:50:37.000Z","updated_at":"2023-10-14T18:50:49.000Z","dependencies_parsed_at":"2024-11-16T15:31:13.034Z","dependency_job_id":"1b2eecfb-b81f-4c1c-96ca-444ecf31a751","html_url":"https://github.com/kovart/forta-sharding","commit_stats":null,"previous_names":["kovart/forta-sharding"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kovart/forta-sharding","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kovart%2Fforta-sharding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kovart%2Fforta-sharding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kovart%2Fforta-sharding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kovart%2Fforta-sharding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kovart","download_url":"https://codeload.github.com/kovart/forta-sharding/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kovart%2Fforta-sharding/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265538509,"owners_count":23784610,"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":["forta","helper","library","sharding"],"created_at":"2024-11-16T15:29:44.221Z","updated_at":"2025-07-17T05:31:59.991Z","avatar_url":"https://github.com/kovart.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Forta Custom Sharding\n\n## Description\n\nHelper library for effortless implementation of custom sharding logic in Forta bots.\n\n## Installation\n\n```bash\n$ npm install forta-sharding\n```\n\n### Usage\nAn example project of how to use the library can be found [here](./example).\n\nFirst of all, you need to specify the number of scanners you need to run.\nThis should be done through the `package.json` configuration by specifying `shards: 1` and `target: NUM_SCANNERS`:\n\n```json\n  \"chainSettings\": {\n    \"default\": {\n      \"shards\": 1,\n      \"target\": 6\n    }\n  }\n```\n\nTo specify the number of duplicate scanners, you need to specify the `redundancy` property when initializing `BotSharding`.\nFor example, with 6 scanners, specifying `redundancy` as 2 would create 3 shards.\n\n```ts\nimport { BotSharding } from 'bot-sharding'; \n\nconst sharding = new BotSharding({\n  redundancy: 2,\n  isDevelopment: process.env.NODE_ENV !== 'production',\n});\n```\n\nThe following example shows how sharding can be implemented using the library:\n\n```ts\nconst handleTransaction: HandleTransaction = async (txEvent: TransactionEvent) =\u003e {\n  const findings: Finding[] = [];\n\n  if (!sharding.isSynced || txEvent.blockNumber % 100 === 0) {\n    await sharding.sync(txEvent.network);\n  }\n  \n  // Non-sharded logic...\n\n  if (txEvent.blockNumber % sharding.getShardCount() !== sharding.getShardIndex()) return findings;\n\n  // Sharded logic...\n};\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkovart%2Fforta-sharding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkovart%2Fforta-sharding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkovart%2Fforta-sharding/lists"}