{"id":19947374,"url":"https://github.com/firstbatchxyz/hollowdb-client","last_synced_at":"2025-03-06T08:14:54.670Z","repository":{"id":185636585,"uuid":"662700649","full_name":"firstbatchxyz/hollowdb-client","owner":"firstbatchxyz","description":"Simplest way to use HollowDB.","archived":false,"fork":false,"pushed_at":"2024-05-06T10:57:03.000Z","size":7457,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-17T00:06:52.331Z","etag":null,"topics":[],"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-07-05T17:40:07.000Z","updated_at":"2025-01-10T12:41:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"e97d2fa9-fef2-4755-9eb6-d84e69c71242","html_url":"https://github.com/firstbatchxyz/hollowdb-client","commit_stats":null,"previous_names":["firstbatchxyz/hollowdb-client"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firstbatchxyz%2Fhollowdb-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firstbatchxyz%2Fhollowdb-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firstbatchxyz%2Fhollowdb-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firstbatchxyz%2Fhollowdb-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/firstbatchxyz","download_url":"https://codeload.github.com/firstbatchxyz/hollowdb-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242171480,"owners_count":20083557,"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-13T00:35:48.267Z","updated_at":"2025-03-06T08:14:54.641Z","avatar_url":"https://github.com/firstbatchxyz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"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 Client\n  \u003c/h1\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ci\u003eHollowDB client is the simplest way to use HollowDB, a decentralized \u0026 privacy-preserving key-value database.\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-yellow.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/hollowdb-client\" target=\"_blank\"\u003e\n        \u003cimg alt=\"NPM\" src=\"https://img.shields.io/npm/v/hollowdb-client?logo=npm\u0026color=CB3837\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://docs.hollowdb.xyz/hollowdb/hollowdb-as-a-service\" 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-client/actions/workflows/test.yml/badge.svg?branch=master\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/firstbatchxyz/hollowdb\" target=\"_blank\"\u003e\n        \u003cimg alt=\"GitHub: HollowDB\" src=\"https://img.shields.io/badge/github-hollowdb-5C3EFE?logo=github\"\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\nHollowDB client is an NPM package. You can install it as:\n\n```sh\nyarn add hollowdb-client    # yarn\nnpm install hollowdb-client # npm\npnpm add hollowdb-client    # pnpm\n```\n\n## Usage\n\nCreate a new API key and a database at \u003chttps://developer.hollowdb.xyz\u003e. Create a new client by providing your API key and the database name to connect:\n\n```ts\nclient = await HollowClient.new({\n  apiKey: 'your-api-key',\n  db: 'your-database-name',\n});\n```\n\nAfter that, using the client is as simple as it gets:\n\n```ts\n// without zero-knowledge proofs\nawait client.get(KEY);\nawait client.put(KEY, VALUE);\nawait client.update(KEY, VALUE);\nawait client.remove(KEY);\n```\n\nIf you are connecting to a database that has zero-knowledge proof verifications enabled, you will need to provide proofs along with your update \u0026 remove requests.\n\nYou can use our [HollowDB Prover](https://github.com/firstbatchxyz/hollowdb) utility to generate proofs with minimal development effort. Assuming that a proof is generated for the respective request, the proof shall be provided as an additional argument to these functions.\n\n```ts\n// with zero-knowledge proofs\nawait client.get(KEY);\nawait client.put(KEY, VALUE);\nawait client.update(KEY, VALUE, PROOF);\nawait client.remove(KEY, PROOF);\n```\n\n## Testing\n\nTo run tests:\n\n```sh\nyarn test\n```\n\nThe API calls are mocked during the test, so you can run it offline.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirstbatchxyz%2Fhollowdb-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffirstbatchxyz%2Fhollowdb-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirstbatchxyz%2Fhollowdb-client/lists"}