{"id":34525155,"url":"https://github.com/kiva/protocol-sdk-verifier","last_synced_at":"2026-05-26T18:31:49.739Z","repository":{"id":49234152,"uuid":"302919353","full_name":"kiva/protocol-sdk-verifier","owner":"kiva","description":"Web SDK to embed SSI credential verification capabilities in existing applications.","archived":false,"fork":false,"pushed_at":"2023-01-11T04:34:17.000Z","size":2482,"stargazers_count":0,"open_issues_count":1,"forks_count":4,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-12-25T16:29:16.887Z","etag":null,"topics":["credential","kiva-protocol","sdk","ssi","web-sdk"],"latest_commit_sha":null,"homepage":"","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/kiva.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}},"created_at":"2020-10-10T14:25:50.000Z","updated_at":"2021-10-21T18:53:24.000Z","dependencies_parsed_at":"2023-02-09T01:45:46.094Z","dependency_job_id":null,"html_url":"https://github.com/kiva/protocol-sdk-verifier","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/kiva/protocol-sdk-verifier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fprotocol-sdk-verifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fprotocol-sdk-verifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fprotocol-sdk-verifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fprotocol-sdk-verifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kiva","download_url":"https://codeload.github.com/kiva/protocol-sdk-verifier/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fprotocol-sdk-verifier/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33534562,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"ssl_error","status_checked_at":"2026-05-26T15:22:15.568Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["credential","kiva-protocol","sdk","ssi","web-sdk"],"created_at":"2025-12-24T05:07:39.118Z","updated_at":"2026-05-26T18:31:49.710Z","avatar_url":"https://github.com/kiva.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Protocol Verifier\nWeb SDK to embed SSI credential verification capabilities in existing applications.\n\n![Build Status](https://github.com/kiva/protocol-sdk-verifier/workflows/build-main/badge.svg)\n\n## Before You Start\n\nThis SDK is designed to be flexible enough to accommodate either an Aries agent running locally on your machine, or a cloud agent. If you already have one of these set up, you can skip this section, but if you don't and would still like to try out the platform, keep reading.\n\nAn easy option for making the SDK work out of the box is to set up the Kiva Aries backend locally. You'll need to [install Docker](https://docs.docker.com/get-docker/), but otherwise you should [be able to follow the steps in our `protocol-demo` repo to get an agent running quickly](https://github.com/kiva/protocol-demo#working-with-protocol-using-aries).\n\n## Setting up your config file\n\nThis SDK relies on a configuration file (you can read more about why that's the case, and how the file is used, [here](https://github.com/kiva/protocol-sdk-verifier/tree/master/config)), and for convenience's sake we've created a [sample config that you can use to get started right away](https://github.com/kiva/protocol-sdk-verifier/tree/master/config/get_started.json).\n\nThere's plenty of stuff you can do to customize your UI using the config, which you can read about [here](https://github.com/kiva/protocol-sdk-verifier/tree/master/config), but here are the important points for getting started.\n\n1. Modify `controllerUrlBase` to use the base URL for whatever endpoint you're using for a Cloud agent. By default, we are using `http://localhost:3014`, because that's the default port that the Kiva cloud agent uses when you're using the backend locally.\n2. If you are running a local agent on your machine, you can instead modify the `agent_port` config to point to the localhost port where your agent is running.\n\n## Getting Started\n\nOk, at last: How do you actually run this?\n\nFirst step is to install the NPM dependencies, which you can do from the root directory of this repo by running:\n\n```\nnpm install\n```\n\nIf you plan on contributing to this repo, we ask that you set up the Git hook scripts included in the `./hooks` directory in your local environment. This can be done by running:\n\n```\nnpm run initHooks\n```\n\nOnce that's done, you can build and serve a development version of the application using the `get_started` config file by running:\n\n```\nnpm run start\n```\n\nIf you've ever used the `create-react-apps` NPM package, this should feel pretty familiar.\n\nPlease note that, while the `run start` command uses `get_started.json` by default, you can easily change the configuration file you're using by running the following.\n\n```\nexport CONF_FILE=path/to/your/config.json\n```\n\nTo create an optimized build package, we recommend you run the following command.\n\n```\nnpm run build\n```\n\nTo serve the package locally, you can run\n\n```\nnpm run serve-build\n```\n\n## Creating a Production Bundle for Deployment\n\nThis SDK is designed to support multiple deployments using just one codebase, with environment-specific variables [provided by a configuration file](https://github.com/kiva/protocol-sdk-verifier/tree/master/config).\n\nTo run a deployment for a specific configuration file, you can run this command from the root directory of this repo.\n\n```\nsh ./tools/bundle/create_bundle.sh \u003cYOUR CONFIG\u003e\n```\n\nThis will create a production bundle using `react-scripts` and will populate variables using the file specified by `\u003cYOUR CONFIG\u003e`.\n\nConfiguration files also support custom environments, though at the moment we only support environments with the following names: `dev`, `qa`, `sandbox` and `prod`. (We are currently working on making this support less restrictive.)\n\nIn order to build a bundle for a specific environment, you can run this command.\n\n```\nsh ./tools/bundle/create_bundle.sh \u003cYOUR CONFIG\u003e --\u003cdev/sandbox/prod\u003e\n```\n\nIf no environment is specified, the default is `qa`.\n\n## Tests\n\nThis SDK has some pre-written functional tests that you should feel free to use once you have your cloud/local agent spun up and the application running in development mode (as outlined in the previous section).\n\nYou can get a more in-depth review of the testing framework [here](https://github.com/kiva/protocol-sdk-verifier/tree/master/test), but the TL;DR version is that we use [Cypress](https://docs.cypress.io/guides/overview/why-cypress.html) for testing. The platform is free to use and can be run without creating an account.\n\nTo run these tests, simply run:\n\n```\nnpm run cy:open\n```\n\nand then click which test you'd like to run. The Cypress platform should take care of the rest.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiva%2Fprotocol-sdk-verifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkiva%2Fprotocol-sdk-verifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiva%2Fprotocol-sdk-verifier/lists"}