{"id":21919554,"url":"https://github.com/bosonprotocol/chat-sdk","last_synced_at":"2025-04-19T12:33:22.824Z","repository":{"id":132963296,"uuid":"520076136","full_name":"bosonprotocol/chat-sdk","owner":"bosonprotocol","description":"Implementation of XMTP Protocol to facilitate Buyer to Seller Communications in the Boson Protocol dApp https://bosonapp.io/","archived":false,"fork":false,"pushed_at":"2025-04-15T15:39:18.000Z","size":1834,"stargazers_count":4,"open_issues_count":5,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-15T16:48:59.390Z","etag":null,"topics":["bosonprotocol","dcommerce"],"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/bosonprotocol.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-08-01T11:08:37.000Z","updated_at":"2025-01-13T11:19:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"a25b9e03-e351-44e5-b6be-df8647abed52","html_url":"https://github.com/bosonprotocol/chat-sdk","commit_stats":null,"previous_names":[],"tags_count":55,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bosonprotocol%2Fchat-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bosonprotocol%2Fchat-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bosonprotocol%2Fchat-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bosonprotocol%2Fchat-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bosonprotocol","download_url":"https://codeload.github.com/bosonprotocol/chat-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249115399,"owners_count":21215132,"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":["bosonprotocol","dcommerce"],"created_at":"2024-11-28T20:08:38.342Z","updated_at":"2025-04-19T12:33:22.816Z","avatar_url":"https://github.com/bosonprotocol.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![banner](/docs/assets/banner.png)](https://bosonprotocol.io)\n\n\u003ch2 align=\"center\"\u003eChat SDK for Boson Protocol v2\u003c/h2\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003ca href=\"\"\u003e![](https://img.shields.io/badge/license-Apache--2.0-brightgreen?style=flat-square)\u003c/a\u003e\n\u003ca href=\"https://discord.com/invite/QSdtKRaap6\"\u003e![](https://img.shields.io/badge/Chat%20on-Discord-%235766f2?style=flat-square)\u003c/a\u003e\n\u003ca href=\"https://twitter.com/BosonProtocol\"\u003e![](https://img.shields.io/twitter/follow/BosonProtocol?style=social)\u003c/a\u003e\n\n\u003c/div align=\"center\"\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n🛠️ **Tools for building on top of the [Boson Protocol](https://bosonprotocol.io).**\n\n\u003c/div\u003e\n\nJS lib which extends @xmtp/xmtp-js, adding support for chat threads and further message types.\n\n\u003chr\u003e\n\u003ch2\u003eInstall\u003c/h2\u003e\n\u003cpre\u003enpm i @bosonprotocol/chat-sdk\u003c/pre\u003e\n\n\u003chr\u003e\n\u003ch2\u003eUsage\u003c/h2\u003e\n\u003cul\u003e\n    \u003cli\u003eInitialise SDK\u003c/li\u003e\n        \u003cul\u003e\n            \u003cli\u003e\n                \u003cpre\u003eimport { BosonXmtpClient } from \"@bosonprotocol/chat-sdk\";\nconst client = await BosonXmtpClient.initialise(signer, \"test\");\u003c/pre\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n    \u003cli\u003eGet Chat Threads\u003c/li\u003e\n        \u003cul\u003e\n            \u003cli\u003e\n                \u003cpre\u003econst counterparties = [\"0xabc123\", \"0xdef456\", ...];\nconst threads = await client.getThreads(counterparties);\u003c/pre\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n    \u003cli\u003eSend Message\u003c/li\u003e\n        \u003cul\u003e\n            \u003cli\u003e\n                \u003cpre\u003econst messageObj = {\n  threadId: {\n    exchangeId: \"1\",\n    buyerId: \"2\",\n    sellerId: \"3\"\n  },\n  contentType: MessageType.String,\n  version: \"0.0.1\",\n  content: {\n    value: \"Example message\"\n  }\n};\nconst recipient = \"0xabc123...\";\nawait client.encodeAndSendMessage(messageObj, recipient);\u003c/pre\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n    \u003cli\u003eMonitor Chat Thread (i.e. for incoming messages)\u003c/li\u003e\n        \u003cul\u003e\n            \u003cli\u003e\n                \u003cpre\u003efor await (const message of await client.monitorThread(threadId, counterparty)) {\n  console.log(message);\n}\u003c/pre\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n\u003c/ul\u003e\n\n\u003chr\u003e\n\u003ch2\u003eLocal Development\u003c/h2\u003e\n\u003cul\u003e\n    \u003cli\u003eBuild\u003c/li\u003e\n        \u003cul\u003e\n            \u003cli\u003e\n                \u003cpre\u003enpm run build\u003c/pre\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n    \u003cli\u003eTest\u003c/li\u003e\n        \u003cul\u003e\n            \u003cli\u003e\n                \u003cpre\u003enpm run test:all\nnpm run test:unit\nnpm run test:integration\u003c/pre\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n    \u003cli\u003eLint\u003c/li\u003e\n        \u003cul\u003e\n            \u003cli\u003e\n                \u003cpre\u003enpm run lint\nnpm run lint:fix\u003c/pre\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n    \u003cli\u003eFormat\u003c/li\u003e\n        \u003cul\u003e\n            \u003cli\u003e\n                \u003cpre\u003enpm run prettier\u003c/pre\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n\u003c/ul\u003e\n\u003chr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbosonprotocol%2Fchat-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbosonprotocol%2Fchat-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbosonprotocol%2Fchat-sdk/lists"}