{"id":18258194,"url":"https://github.com/cheqd/did-registrar","last_synced_at":"2025-04-04T18:31:36.253Z","repository":{"id":61785161,"uuid":"552725009","full_name":"cheqd/did-registrar","owner":"cheqd","description":"Universal Registrar driver for did:cheqd DID Method","archived":false,"fork":false,"pushed_at":"2024-10-21T17:29:59.000Z","size":951,"stargazers_count":4,"open_issues_count":9,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-25T06:29:32.889Z","etag":null,"topics":["did-registrar","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://did-registrar.cheqd.net","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cheqd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-17T06:10:28.000Z","updated_at":"2024-09-23T12:37:54.000Z","dependencies_parsed_at":"2023-11-21T05:39:15.680Z","dependency_job_id":"319076ba-cc5c-4c32-8fcf-fb1ba04e745b","html_url":"https://github.com/cheqd/did-registrar","commit_stats":{"total_commits":178,"total_committers":10,"mean_commits":17.8,"dds":0.5674157303370786,"last_synced_commit":"038ffb4c53618ef329ab1bd76fdb58532c6a47ec"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":"cheqd/.github","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheqd%2Fdid-registrar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheqd%2Fdid-registrar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheqd%2Fdid-registrar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheqd%2Fdid-registrar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cheqd","download_url":"https://codeload.github.com/cheqd/did-registrar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247006601,"owners_count":20868033,"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":["did-registrar","hacktoberfest"],"created_at":"2024-11-05T10:29:34.341Z","updated_at":"2025-04-04T18:31:36.241Z","avatar_url":"https://github.com/cheqd.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Universal Registrar Driver for did:cheqd\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/did-registrar?color=green\u0026label=stable%20release\u0026style=flat-square)](https://github.com/cheqd/did-registrar/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/cheqd/did-registrar?color=green\u0026style=flat-square) [![GitHub license](https://img.shields.io/github/license/cheqd/did-registrar?color=blue\u0026style=flat-square)](https://github.com/cheqd/did-registrar/blob/main/LICENSE)\n\n[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cheqd/did-registrar?include_prereleases\u0026label=dev%20release\u0026style=flat-square)](https://github.com/cheqd/did-registrar/releases/) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/cheqd/did-registrar/latest?style=flat-square) [![GitHub contributors](https://img.shields.io/github/contributors/cheqd/did-registrar?label=contributors%20%E2%9D%A4%EF%B8%8F\u0026style=flat-square)](https://github.com/cheqd/did-registrar/graphs/contributors)\n\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/did-registrar/dispatch.yml?label=workflows\u0026style=flat-square)](https://github.com/cheqd/did-registrar/actions/workflows/dispatch.yml) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/did-registrar/codeql.yml?label=CodeQL\u0026style=flat-square)](https://github.com/cheqd/did-registrar/actions/workflows/codeql.yml) ![GitHub repo size](https://img.shields.io/github/repo-size/cheqd/did-registrar?style=flat-square)\n\n## ℹ️ Overview\n\nThe purpose of this service is to provide a [Universal Registrar driver](https://identity.foundation/did-registration/#abstract) for the `did:cheqd` DID method. Universal Registrar is a project to provide simple REST APIs for DID creation, update, and deactivation.\n\n## 📖 Endpoints\n\n- POST `/create`\n- POST `/update`\n- POST `/deactivate`\n- POST `/{did}/create-resource`\n- POST `/createResource`\n- POST `/updateResource`\n- GET `/key-pair`\n- GET `/did-document`\n- GET `/properties`\n- GET `/methods`\n- GET `/traits`\n\n## 🧑‍💻🛠 Developer Guide\n\n### Setup\n\n#### Environment variable configuration\n\nEnvironment variables needed for the Registrar are\n\n1. `FEE_PAYER_TESTNET_MNEMONIC` : The cosmos payer mnemonic for the Cheqd Mainnet\n2. `FEE_PAYER_MAINNET_MNEMONIC` : The cosmos payer mnemonic for the Cheqd Tesnet, By default it's the Testnet Faucet\n3. `LOCAL_STORE_TTL` (default: `600`): The time in seconds for the registrar to store data in cache\n4. `PORT` (default: `3000`): The port number\n\n\nClone the repository\n\n```bash\ngit clone git@github.com:cheqd/did-registrar.git\ncd did-registrar\n```\n\n***\n\n### Running a DID Registrar Using Docker\n\nBuild Docker container image using Dockerfile:\n\n```bash\ndocker build --target cheqd-did-registrar . --tag did-registrar:local\n```\n\nRun the Docker container (modify according to your own build tags and other desired parameters):\n\n```bash\ndocker run -it did-registrar:local\n```\n\n***\n\n### Running a DID Registrar Locally\n\n```bash\nnpm install\nnpm run build\nnpm start \n```\n\n### 🛠 Testing\n\nThis repository contains the playwright tests for unit and integration testing.\nAdd any additional tests in the `tests` directory.\n\nYou must set up these two env vars before running test:\n\n1. `TEST_PRIVATE_KEY` : Private key for signing the requests\n2. `TEST_PUBLIC_KEY` : Corresponding public key\n\nThen execute the tests\n\n```bash\nnpm run test\n# if tests faile because of parallelism, run\nnpm run test -- --workers=1\n```\n\n## 🐞 Bug reports \u0026 🤔 feature requests\n\nIf you notice anything not behaving how you expected, or would like to make a suggestion / request for a new feature, please create a [**new issue**](https://github.com/cheqd/did-registrar/issues/new/choose) and let us know.\n\n## 💬 Community\n\nOur [**Discord server**](http://cheqd.link/discord-github) is the primary chat channel for our open-source community, software developers, and node operators.\n\nPlease reach out to us there for discussions, help, and feedback on the project.\n\n## 🙋 Find us elsewhere\n\n[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge\\\u0026logo=telegram\\\u0026logoColor=white)](https://t.me/cheqd) [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge\\\u0026logo=discord\\\u0026logoColor=white)](http://cheqd.link/discord-github) [![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge\\\u0026logo=twitter\\\u0026logoColor=white)](https://twitter.com/intent/follow?screen_name=cheqd_io) [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge\\\u0026logo=linkedin\\\u0026logoColor=white)](http://cheqd.link/linkedin) [![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge\\\u0026logo=medium\\\u0026logoColor=white)](https://blog.cheqd.io) [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge\\\u0026logo=youtube\\\u0026logoColor=white)](https://www.youtube.com/channel/UCBUGvvH6t3BAYo5u41hJPzw/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheqd%2Fdid-registrar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheqd%2Fdid-registrar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheqd%2Fdid-registrar/lists"}