{"id":26930343,"url":"https://github.com/zkitter/zkitter-js","last_synced_at":"2025-10-07T12:44:06.396Z","repository":{"id":155008748,"uuid":"595337771","full_name":"zkitter/zkitter-js","owner":"zkitter","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-25T14:49:26.000Z","size":4260,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-28T18:09:03.614Z","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/zkitter.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-01-30T21:55:08.000Z","updated_at":"2023-10-26T07:14:15.000Z","dependencies_parsed_at":"2023-06-26T20:52:33.145Z","dependency_job_id":null,"html_url":"https://github.com/zkitter/zkitter-js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zkitter/zkitter-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitter-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitter-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitter-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitter-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zkitter","download_url":"https://codeload.github.com/zkitter/zkitter-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkitter%2Fzkitter-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278778960,"owners_count":26044256,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-04-02T06:19:02.071Z","updated_at":"2025-10-07T12:44:06.378Z","avatar_url":"https://github.com/zkitter.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZkitterJS\n\nJavascript implementation of a standalone Zkitter node\n\n## CLI Usage\n\nTo install CLI:\n\n```sh\nnpm i -g zkitter-js\n```\n\nTo sync:\n\n```sh\n# either https or wss provider will work\nzkitter init -a wss://arb-mainnet.g.alchemy.com/v2/[api-key]\nzkitter sync\nzkitter timeline --limit=5\n```\n\nCLI options:\n\n```\nOptions:\n  -V, --version       output the version number\n  -h, --help          display help for command\n\nCommands:\n  init [options]      initialize zkitter\n  status              display status\n  timeline [options]  display timeline\n  sync [options]      sync with arbitrum and group\n  fetch [options]     fetch historical data (30 days max) from waku\n  whois \u003caddress\u003e     sync with arbitrum and group\n  up                  start zkitter and subscribe to all global events\n  write [options]     publish a post\n  list [options]      list all groups or users\n  help [command]      display help for command\n```\n\n## NPM Usage\n\n```ts\nimport { Zkitter } from 'zkitter-js';\nconst zkitter = await Zkitter.initialize({\n  arbitrumHttpProvider: 'https://...',\n});\n\n// Sync with arbitrum registrar\nawait zkitter.syncUsers();\n\n// Sync with zk groups on zkitter\nawait zkitter.syncGroup();\n\n// Get all historical messages (30 days) from Waku store\nawait zkitter.queryAll();\n\n// Subscribe to all future messages from everyone\nawait zkitter.subscribe();\n```\n\n## Development\n\n```sh\n# node v16\nnpm install\n\n# build a dev cli to build/cli.js\nnpm run dev\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkitter%2Fzkitter-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzkitter%2Fzkitter-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkitter%2Fzkitter-js/lists"}