#client-server #messaging #sdk #ruma #server-api #api-client #linker

mxlink

A library for connecting (linking) to the Matrix Client Server API (for building bots, etc.)

5 stable releases

1.3.0 Sep 22, 2024
1.2.1 Sep 14, 2024
1.2.0 Sep 13, 2024
1.1.0 Sep 13, 2024
1.0.0 Sep 11, 2024

#1786 in Network programming

Download history 435/week @ 2024-09-09 195/week @ 2024-09-16 62/week @ 2024-09-23 45/week @ 2024-09-30 8/week @ 2024-10-07 10/week @ 2024-10-14

246 downloads per month
Used in baibot

LGPL-3.0

99KB
2K SLoC

Matrix Link (mxlink) is a Rust library (a higher-level abstraction on top of matrix-rust-sdk) for building Matrix services (bots, etc.)

It's similar to headjack, but tries to be less opinionated and more featureful.

It finds use in the 🤖 baibot Matrix bot.

✨ Features

  • 🎈 Easy to use API for getting started with matrix-rust-sdk. See the examples directory or baibot

  • 🔒 Encryption

    • (Optional) At-rest encryption of the session file

    • At-rest encryption of the SQLite data store (performed by matrix-rust-sdk itself)

  • 🔄 (Optional) Support for using matrix-rust-sdk's recovery module for backing up and restoring encryption keys (in case of session / SQLite store data loss)

  • 🖴 Helpers for working with Matrix Account Data on a per-room level or globally

  • 🗂 Some convenience functions around Matrix APIs

Dependencies

~24–41MB
~709K SLoC