{"id":13794054,"url":"https://github.com/firstbatchxyz/HollowDB","last_synced_at":"2025-05-12T20:31:29.710Z","repository":{"id":104267161,"uuid":"606800919","full_name":"firstbatchxyz/hollowdb","owner":"firstbatchxyz","description":"A privacy-preserving key-value database on Arweave.","archived":false,"fork":false,"pushed_at":"2024-05-24T15:07:04.000Z","size":9061,"stargazers_count":63,"open_issues_count":1,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-03T17:44:01.726Z","etag":null,"topics":["arweave","arweave-blockchain","circom","firstbatch","hollowdb","key-value","key-value-database","key-value-store","smartweave","warp","zero-knowledge"],"latest_commit_sha":null,"homepage":"https://hollowdb.xyz/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/firstbatchxyz.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2023-02-26T15:57:33.000Z","updated_at":"2025-03-06T16:53:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"707e78ad-d58f-4e88-aee6-78b7305f5a36","html_url":"https://github.com/firstbatchxyz/hollowdb","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firstbatchxyz%2Fhollowdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firstbatchxyz%2Fhollowdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firstbatchxyz%2Fhollowdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firstbatchxyz%2Fhollowdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/firstbatchxyz","download_url":"https://codeload.github.com/firstbatchxyz/hollowdb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253816755,"owners_count":21968877,"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":["arweave","arweave-blockchain","circom","firstbatch","hollowdb","key-value","key-value-database","key-value-store","smartweave","warp","zero-knowledge"],"created_at":"2024-08-03T23:00:35.155Z","updated_at":"2025-05-12T20:31:24.672Z","avatar_url":"https://github.com/firstbatchxyz.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/firstbatchxyz/hollowdb/master/logo.svg\" alt=\"logo\" width=\"142\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ch1 align=\"center\"\u003e\n    HollowDB\n  \u003c/h1\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ci\u003eHollowDB is a decentralized privacy-preserving key-value database on Arweave network, powered by Warp Contracts.\u003c/i\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://opensource.org/licenses/MIT\" target=\"_blank\"\u003e\n        \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/badge/license-MIT-7CB9E8.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/hollowdb\" target=\"_blank\"\u003e\n        \u003cimg alt=\"NPM\" src=\"https://img.shields.io/npm/v/hollowdb?logo=npm\u0026color=CB3837\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://docs.hollowdb.xyz\" target=\"_blank\"\u003e\n        \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/badge/docs-hollowdb-3884FF.svg?logo=gitbook\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"./.github/workflows/test.yml\" target=\"_blank\"\u003e\n        \u003cimg alt=\"Workflow: Tests\" src=\"https://github.com/firstbatchxyz/hollowdb/actions/workflows/test.yml/badge.svg?branch=master\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://discord.gg/2wuU9ym6fq\" target=\"_blank\"\u003e\n        \u003cimg alt=\"Discord\" src=\"https://dcbadge.vercel.app/api/server/2wuU9ym6fq?style=flat\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n## Installation\n\nTo install HollowDB:\n\n```bash\nyarn add hollowdb     # yarn\nnpm install hollowdb  # npm\npnpm add hollowdb     # pnpm\n```\n\nDepending on your use-cases, we have several optional dependencies:\n\n- You can use [hollowdb-prover](https://www.npmjs.com/package/hollowdb-prover) as a simple utility that generates zero-knowledge proofs that are verifiable by HollowDB.\n- You can use LMDB cache within your Warp instance via [warp-contracts-lmdb](https://www.npmjs.com/package/warp-contracts-lmdb).\n- You can use Redis cache within your warp instance via [warp-contracts-redis](https://www.npmjs.com/package/warp-contracts-redis) together with [ioredis](https://www.npmjs.com/package/ioredis).\n- When you are evaluating a contract that uses ZK proofs, you should also use [warp-contracts-plugin-snarkjs](https://www.npmjs.com/package/warp-contracts-plugin-snarkjs) and [warp-contracts-plugin-ethers](https://www.npmjs.com/package/warp-contracts-plugin-ethers).\n\n## Usage\n\nYou can read the full documentation of HollowDB at \u003chttps://docs.hollowdb.xyz\u003e.\n\n\u003e [!NOTE]\n\u003e\n\u003e If you are interested in customizing the smart contract of HollowDB and extending its SDKs, refer to this [README](./src/contracts/README.md).\n\n## Examples\n\nCheck out the [examples](./examples/) folder for a few examples of HollowDB usage:\n\n- **Simple**: a single JS file that demonstrates getting \u0026 setting a key.\n- **Micro**: a Vercel Micro backend that can serves HollowDB as API endpoints, useful when you want to use HollowDB from another language.\n\n## Testing\n\nYou can run all tests via:\n\n```sh\npnpm test\n```\n\nTests operate on a local Arweave instance using [arlocal](https://www.npmjs.com/package/arlocal). They will run for all cache types (LMDB, Redis, LevelDB). You will need to have a Redis server running for some of the tests to pass, the URL shall be specified [here](./tests/constants/index.ts).\n\n## Styling\n\nYou can check the formatting of the code or lint everything with the following commands:\n\n```sh\npnpm format # prettier\npnpm lint   # eslint\n```\n","funding_links":[],"categories":["Apps 🕯️"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirstbatchxyz%2FHollowDB","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffirstbatchxyz%2FHollowDB","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirstbatchxyz%2FHollowDB/lists"}