{"id":43702203,"url":"https://github.com/convergencelabs/convergence-proto","last_synced_at":"2026-02-05T05:09:23.004Z","repository":{"id":36842596,"uuid":"220907822","full_name":"convergencelabs/convergence-proto","owner":"convergencelabs","description":"The Convergence Client-Server Protocol","archived":false,"fork":false,"pushed_at":"2023-07-07T21:04:20.000Z","size":227,"stargazers_count":13,"open_issues_count":1,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-10-24T06:51:32.742Z","etag":null,"topics":["convergence","protocol","protocol-buffers","realtime"],"latest_commit_sha":null,"homepage":"https://convergence.io","language":"Scala","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/convergencelabs.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":"2019-11-11T05:30:13.000Z","updated_at":"2023-07-25T07:39:15.000Z","dependencies_parsed_at":"2022-08-20T17:10:26.595Z","dependency_job_id":null,"html_url":"https://github.com/convergencelabs/convergence-proto","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/convergencelabs/convergence-proto","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/convergencelabs%2Fconvergence-proto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/convergencelabs%2Fconvergence-proto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/convergencelabs%2Fconvergence-proto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/convergencelabs%2Fconvergence-proto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/convergencelabs","download_url":"https://codeload.github.com/convergencelabs/convergence-proto/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/convergencelabs%2Fconvergence-proto/sbom","scorecard":{"id":303710,"data":{"date":"2025-08-11","repo":{"name":"github.com/convergencelabs/convergence-proto","commit":"719ef4194c6cca93a75df3fe273c9c26d1cd55b8"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/js-build.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/convergencelabs/convergence-proto/js-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/js-build.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/convergencelabs/convergence-proto/js-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/scala-build.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/convergencelabs/convergence-proto/scala-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/scala-build.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/convergencelabs/convergence-proto/scala-build.yml/master?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/js-build.yml:1","Warn: no topLevel permission defined: .github/workflows/scala-build.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-g954-5hwp-pp24","Warn: Project is vulnerable to: GHSA-h755-8qp9-cq85","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T21:26:41.649Z","repository_id":36842596,"created_at":"2025-08-17T21:26:41.649Z","updated_at":"2025-08-17T21:26:41.649Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29113198,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T03:44:17.043Z","status":"ssl_error","status_checked_at":"2026-02-05T03:44:12.077Z","response_time":65,"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":["convergence","protocol","protocol-buffers","realtime"],"created_at":"2026-02-05T05:09:22.144Z","updated_at":"2026-02-05T05:09:22.998Z","avatar_url":"https://github.com/convergencelabs.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"Convergence Logo\" height=\"80\" src=\"https://convergence.io/assets/img/convergence-logo.png\" \u003e\n\u003c/div\u003e\n\n# Convergence Protocol\n[![Scala Build](https://github.com/convergencelabs/convergence-proto/actions/workflows/scala-build.yml/badge.svg)](https://github.com/convergencelabs/convergence-proto/actions/workflows/scala-build.yml)\n[![JavaScript Build](https://github.com/convergencelabs/convergence-proto/actions/workflows/js-build.yml/badge.svg)](https://github.com/convergencelabs/convergence-proto/actions/workflows/js-build.yml)\n\n\nThis repository defines the Convergence client-server, realtime, WebSocket protocol.  The protocol is specified using [Google Protocol Buffers](https://developers.google.com/protocol-buffers) version 3 messages. The protocol itself can be found in the [src/main/protobuf](src/main/protobuf) directory. \n\nConvergence supplies a JavaScript client with the server implemented in Scala. Thus this project builds JavaScript and Scala bindings.  The JavaScript bindings are provided by [protobuf.js](https://github.com/protobufjs/protobuf.js). The Scala bindings are provided by [ScalaPB](https://scalapb.github.io/).\n\n# Dependencies\n* [NodeJS](https://nodejs.org/) \u003e= 16.0\n* [protobuf.js](https://github.com/protobufjs/protobuf.js) = 6.11\n* [sbt](https://www.scala-sbt.org/) \u003e= 1.5\n* [ScalaPB](https://scalapb.github.io/) = 0.11.0\n\n# Installation\n\n## JavaScript\nTo use the JavaScript protocol bindings use the following command:\n```shell\nnpm i -D @convergence/convergence-proto\n```\n\n## Scala\nTo use the Scala protocol bindings add the following dependency:\n\n```shell\nlibraryDependencies += \"com.convergencelabs\" %% \"convergence-proto-scala\" % \"1.0.0\"\n```\n\nRun `sbt publishLocal` to publish to a local repository for e.g. the [Convergence Server](https://github.com/convergencelabs/convergence-server) to reference.\n\n# Building\nThere are different build commands for each language binding. They are as follows:\n\n* **JavaScript**: `npm run dist`\n* **Scala**: `sbt compile`\n\n# Protocol\nThe Convergence client-server protocol is intended to be sent over a [WebSocket](https://en.wikipedia.org/wiki/WebSocket) connection between a Convergence client and the Convergence Server. Each message sent between the client and server is an instance of the [ConvergenceMessage](src/main/protobuf/convergenceMessage.proto) protocol buffer message. The rough structure of the message is as follows:\n\n```proto\nmessage ConvergenceMessage {\n  google.protobuf.Int32Value requestId = 1;\n  google.protobuf.Int32Value responseId = 2;\n\n  oneof body {\n    // messages\n  }\n}\n``` \nThe body field will contain a specific message sent or received. WebSockets are an asynchronous, bi-directional streaming communication channel. However, Convergence has several request / response style exchanges. The ConvergenceMessage structure implements a correlation id strategy to enable request / response behavior over WebSockets.\n\nThe best way to understand the protocol is to simply view the `.proto` files in the [src/main/protobuf](src/main/protobuf) directory.\n\n## License\nThe Convergence Protocol is licensed under the [Apache 2.0](LICENSE) license. Refer to the [LICENSE.txt](LICENSE) for the specific terms and conditions of the license.\n\nThe Convergence Protocol is also available under a Commercial License. If you are interested in a non-open source license please contact us at [Convergence Labs](https://convergencelabs.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconvergencelabs%2Fconvergence-proto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconvergencelabs%2Fconvergence-proto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconvergencelabs%2Fconvergence-proto/lists"}