matrix-org / matrix-org/complement-crypto

Add target for matrix-bot-sdk

Open
#55 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
18
Forks
12
Avg merge
2d 12h
Merged PRs (30d)
6

Description

We have an entire ecosystem relying on https://github.com/turt2live/matrix-bot-sdk for cryptography for bots and appservices. It does [NOT](https://github.com/turt2live/matrix-bot-sdk/blob/main/package.json#L55) use JS SDK, instead relying purely on the rust SDK crypto wrapper https://github.com/matrix-org/matrix-rust-sdk-crypto-nodejs

This wrapper is [horribly out-of-date](https://github.com/matrix-org/matrix-rust-sdk-crypto-nodejs/blob/main/Cargo.toml#L27) relying on a commit from nearly 1 year ago. As a result, we lack confidence it doesn't have bugs which can cause UTDs. We should add a new `b` target which will run the bot-sdk, similar to how we have `j` for js-sdk and `r` for rust SDK FFI.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the existing `j` and `r` targets first to understand how SDK targets are defined. Then review matrix-bot-sdk's `package.json` and the crypto wrapper's `Cargo.toml`; done means a new `b` target runs the bot SDK similarly to those existing targets.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, javascript, rust
Domain
build-system, testing-qa
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.