{"id":22203293,"url":"https://github.com/hldb/welo","last_synced_at":"2025-07-27T05:32:05.967Z","repository":{"id":47393715,"uuid":"516091316","full_name":"hldb/welo","owner":"hldb","description":"peer-to-peer, collaborative states using Merkle-CRDTs","archived":false,"fork":false,"pushed_at":"2024-05-07T18:58:19.000Z","size":6836,"stargazers_count":32,"open_issues_count":20,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-14T14:12:12.742Z","etag":null,"topics":["ipfs","ipld","merkle-crdt","p2p","peer-to-peer"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hldb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2022-07-20T18:21:03.000Z","updated_at":"2024-08-23T01:47:04.000Z","dependencies_parsed_at":"2024-01-20T23:30:46.606Z","dependency_job_id":"61919fd6-d8eb-476f-91fc-1484466acb49","html_url":"https://github.com/hldb/welo","commit_stats":{"total_commits":321,"total_committers":3,"mean_commits":107.0,"dds":"0.10280373831775702","last_synced_commit":"50b438b9602f60a471d6214794aac6f8e1981ef6"},"previous_names":["cypsela/opal"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hldb%2Fwelo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hldb%2Fwelo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hldb%2Fwelo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hldb%2Fwelo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hldb","download_url":"https://codeload.github.com/hldb/welo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227765512,"owners_count":17816614,"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":["ipfs","ipld","merkle-crdt","p2p","peer-to-peer"],"created_at":"2024-12-02T16:46:35.932Z","updated_at":"2024-12-02T16:46:36.769Z","avatar_url":"https://github.com/hldb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm](https://img.shields.io/npm/v/welo?style=flat-square)](https://www.npmjs.com/package/welo)\n[![Codecov](https://img.shields.io/codecov/c/github/hldb/welo?style=flat-square)](https://app.codecov.io/gh/hldb/welo)\n![node-current](https://img.shields.io/node/v/welo?style=flat-square)\n[![NPM](https://img.shields.io/npm/l/welo?color=green\u0026style=flat-square)](./LICENSE)\n[![Matrix](https://img.shields.io/badge/chat-%23hldb%3Amatrix.org-blue?style=flat-square)](https://matrix.to/#/#hldb:matrix.org)\n\n\u003cimg src=\"https://user-images.githubusercontent.com/36933094/215352217-b9c5aca3-bfdc-46e4-9b42-504e7992fef8.png\" alt=\"welo opal painting\" width=\"400\"/\u003e\n\n# welo\n\npeer-to-peer, collaborative states using Merkle-CRDTs\n\n[HLDB](https://github.com/hldb) implementation in Typescript\n\n## Project Status\n\n```\nI am currently working on https://github.com/tabcat/dd-tree which will be the core structure for the database.\nIt has not been simple but I am making small progress daily.\nIt is the hardest part of the project from a technical standpoint and I want to have a solid solution that will last.\nTo track this project's progress see this issue: https://github.com/hldb/welo/issues/102\n```\n-[tabcat](https://github.com/tabcat)\n\n## Install\n\n```bash\nnpm install welo\n```\n\n## Usage\n\n```typescript\nimport { createHelia } from 'helia'\nimport { createWelo } from 'welo'\n\n/** look at Helia for more configuration */\nconst ipfs = await createHelia()\n\n/** see more config options in the API docs */\nconst welo = await createWelo({ ipfs })\n\n/** create a manifest for a keyvalue database */\nconst manifest = await welo.determine({\n  name: 'this is the databases name',\n  type: 'keyvalue'\n})\n\n/** open the keyvalue database */\nconst keyvalue = await welo.open(manifest)\n\n/** The keyvalue API docs are not uploaded yet */\n\nconst entryCID = await keyvalue.put('key', 'value')\nconst value = await keyvalue.get('key')\nconst entryCID = await keyvalue.del('key')\n```\n\nCheck out the [tests](./test) for more usage examples for now.\n\n## API\n\nCheck out the [API Docs](https://hldb.github.io/welo)\n\n## Examples\n\n[TodoMVC](https://github.com/hldb/todomvc)\n\n## License\n\nThis project is [dual licensed](./LICENSE) under [APACHE-2.0](./LICENSE-APACHE) and [MIT](./LICENSE-MIT).\n\n## Funding\n\nThanks to [Protocol Labs](https://protocol.io) for funding this project through this [grant](https://github.com/tabcat/rough-opal).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhldb%2Fwelo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhldb%2Fwelo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhldb%2Fwelo/lists"}