{"id":20367547,"url":"https://github.com/earthstar-project/meadowcap-js","last_synced_at":"2025-04-12T05:29:14.375Z","repository":{"id":197782465,"uuid":"681487156","full_name":"earthstar-project/meadowcap-js","owner":"earthstar-project","description":"A capability system for Willow.","archived":false,"fork":false,"pushed_at":"2024-07-04T06:46:49.000Z","size":430,"stargazers_count":30,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-11T06:27:10.766Z","etag":null,"topics":["capabilities","p2p","willow"],"latest_commit_sha":null,"homepage":"https://willowprotocol.org/specs/meadowcap/index.html#meadowcap","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/earthstar-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["sgwilym"],"open_collective":"earthstar"}},"created_at":"2023-08-22T06:04:20.000Z","updated_at":"2025-03-01T02:42:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"c0de1d49-081c-457a-b2f2-c07eac00d7ef","html_url":"https://github.com/earthstar-project/meadowcap-js","commit_stats":{"total_commits":51,"total_committers":1,"mean_commits":51.0,"dds":0.0,"last_synced_commit":"4245837c326bdde366157fd1c68f42f7da97a3cc"},"previous_names":["earthstar-project/meadowcap-js"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/earthstar-project%2Fmeadowcap-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/earthstar-project%2Fmeadowcap-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/earthstar-project%2Fmeadowcap-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/earthstar-project%2Fmeadowcap-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/earthstar-project","download_url":"https://codeload.github.com/earthstar-project/meadowcap-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248522586,"owners_count":21118331,"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":["capabilities","p2p","willow"],"created_at":"2024-11-15T00:33:08.108Z","updated_at":"2025-04-12T05:29:14.344Z","avatar_url":"https://github.com/earthstar-project.png","language":"TypeScript","funding_links":["https://github.com/sponsors/sgwilym","https://opencollective.com/earthstar"],"categories":[],"sub_categories":[],"readme":"![](meadowcap.png)\n\n# meadowcap-js\n\nA TypeScript implementation of a capability system for use with the\n[Willow protocol](https://willowprotocol.org), according to the\n[Meadowcap specification](https://willowprotocol.org/specs/meadowcap).\n\nIn Willow, a **namespace** is a self-contained data space with three dimensions:\ntime, path, and subspace. A namespace's individual _entries_ correspond to\npoints within this three dimensional space.\n\n_Meadowcap_ enforces boundaries on who gets to read and write what data in a\nWillow namespace. Read or write access can be bestowed, delegated to others, or\nfurther restricted within a given three dimensional area.\n\nThese boundaries are mediated by _capabilities_. A capability is an unforgeable\ntoken bestowing read or write access for some data to a particular person,\nissued by the owner of that data. These capabilities are cryptographically\nsigned and verified using generic _signature schemes_ (e.g. ed25519) provided by\nyou.\n\nMeadowcap distinguishes between two types of namespace:\n\n- _Communal namespaces_, where authority is derived from ownership of a given\n  _subspace_ key pair. This is a horizontal model where all members of a\n  namespace have equal authority, and no-one has authority to all data in the\n  namespace.\n- _Owned namespace_, where authority is derived from the ownership a given\n  _namespace_ keypair. This is a top-down model where the owner of the namespace\n  keypair has total control over all data in the namespace, including data\n  written by those who have had capabilities delegated to them.\n\nWhether a namespace is communal or not is determined by a function provided by\nyou. For example, making namespaces communal if their public key ends with a `0`\nbit.\n\nMeadowcap will switch between using a (provided) subspace signature scheme or a\nnamespace signature scheme depending on whether the namespace is communal or\nowned, respectively. Most of the time these schemes will be the same, but you\ncan provide a trivial subspace scheme to effectively deactivate Willow's\nsubspaces altogether, for example.\n\nThis system is meant to be used in tandem with Willow, and **must** be\nconfigured to use many of the same parameters (e.g. namespace signature scheme,\npayload digest encoder) as its parent Willow instance. These parameters can be\nprovided via a `MeadowcapParams` object to construct a `Meadowcap` instance,\nwhich will then give you access to lots of useful methods and hopefully not have\nto think about those parameters anymore.\n\n## Usage\n\nThis module is published on JSR. See the\n[@earthstar/meadowcap page](https://jsr.io/@earthstar) for installation\ninstructions\n\nComplete API documentation can be found\n[here](https://jsr.io/@earthstar/meadowcap/doc).\n\n## Development\n\nDeno is used as the development runtime.\n\nTests can be run with `deno task test`.\n\n---\n\nThis project was funded through the NGI Assure Fund, a fund established by NLnet\nwith financial support from the European Commission's Next Generation Internet\nprogramme, under the aegis of DG Communications Networks, Content and Technology\nunder grant agreement № 957073.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fearthstar-project%2Fmeadowcap-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fearthstar-project%2Fmeadowcap-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fearthstar-project%2Fmeadowcap-js/lists"}