{"id":25417425,"url":"https://github.com/zcloak-network/zkid-indexer","last_synced_at":"2025-05-05T20:13:18.787Z","repository":{"id":41085454,"uuid":"435721783","full_name":"zCloak-Network/zkID-indexer","owner":"zCloak-Network","description":null,"archived":false,"fork":false,"pushed_at":"2022-08-25T08:14:11.000Z","size":1056,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-05T20:13:16.147Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zCloak-Network.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}},"created_at":"2021-12-07T02:50:05.000Z","updated_at":"2022-04-19T10:03:13.000Z","dependencies_parsed_at":"2022-07-14T08:09:04.229Z","dependency_job_id":null,"html_url":"https://github.com/zCloak-Network/zkID-indexer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zCloak-Network%2FzkID-indexer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zCloak-Network%2FzkID-indexer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zCloak-Network%2FzkID-indexer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zCloak-Network%2FzkID-indexer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zCloak-Network","download_url":"https://codeload.github.com/zCloak-Network/zkID-indexer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252569647,"owners_count":21769517,"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":"2025-02-16T17:58:47.969Z","updated_at":"2025-05-05T20:13:18.770Z","avatar_url":"https://github.com/zCloak-Network.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zkID-indexer\n\nzkID-indexer retrieves each block from the moonbeam network and obtains data for users to query.\n\n## How to start?\n\n### init\n\n```\nyarn install\n```\n\n### configuration\n\nThe configuration file is config.dev.json or config.prod.json in the `src/configs` directory.\n\n- name: zkID-indexer.\n- network: The blockchain network that needs to be scanned, using the rpc method to connect.\n- startBlock: Which block to start with\n- mysql: MySQL configuration\n- contracts: Contract information that needs to be monitored\n  - contractName\n  - contractAddress\n  - abiFile: Contract abi file, please use the format of /abi/ContractName.json, the abi file is placed in the contract/abi folder\n- monitorEvents: Which contracts to monitor for events\n- bot_url: webhook alarm robot\n\n```json\n{\n  \"name\": \"\",\n  \"network\": \"\",\n  \"startBlock\": 0,\n  \"mysql\": {\n    \"host\": \"\",\n    \"port\": 3306,\n    \"database\": \"\",\n    \"username\": \"\",\n    \"password\": \"\"\n  },\n  \"contracts\": [\n    {\n      \"contractName\": \"\",\n      \"contractAddress\": \"\",\n      \"abiFile\": \"\"\n    }\n  ],\n  \"monitorEvents\": [\"\", \"\"],\n  \"bot_url\": \"\"\n}\n```\n\n\n#### Start in production\n\n```\nyarn start\nyarn start:delete-prod\n```\n\n#### Start in the development environment\n\n```bash\nyarn dev\nyarn start:delete-dev\n```\n\n#### Upgrade Side Effects Script\n\nThis version adds the address format of bytes type.（2022.6.13）\n\n| table              | field            |\n| ------------------ | ---------------- |\n| raw_scan_proof     | data_owner_bytes |\n| raw_scan_verifying | data_owner_bytes |\n| raw_scan_canonical | data_owner_bytes |\n| raw_scan_poap      | who_bytes        |\n\nUpdate historical data by running the following scripts.\n\n```bash\nyarn start:update-address-dev\nyarn start:update-address-prod\n\nyarn start:update-block-type-dev\nyarn start:update-block-type-prod\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcloak-network%2Fzkid-indexer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzcloak-network%2Fzkid-indexer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcloak-network%2Fzkid-indexer/lists"}