https://github.com/matrix-org/lb

MSC3079 Low Bandwidth library for servers and clients
https://github.com/matrix-org/lb

Last synced: about 1 year ago
JSON representation

MSC3079 Low Bandwidth library for servers and clients

• Host: GitHub
• URL: https://github.com/matrix-org/lb
• Owner: matrix-org
• License: apache-2.0
• Created: 2021-05-07T11:59:00.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2022-08-25T09:50:36.000Z (almost 4 years ago)
• Last Synced: 2025-03-24T13:36:16.226Z (over 1 year ago)
• Language: Go
• Homepage:
• Size: 132 KB
• Stars: 25
• Watchers: 4
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Low Bandwidth Matrix

[![Go Reference](https://pkg.go.dev/badge/github.com/matrix-org/lb.svg)](https://pkg.go.dev/github.com/matrix-org/lb)

This repository implements [MSC3079](https://github.com/matrix-org/matrix-doc/pull/3079) in Go.

It also provides several command line tools to get up to speed with existing low bandwidth enabled servers.

### Mobile implementations

See [mobile](/mobile) for Android/iOS bindings.

### Command Line Tools

 - [jc](/cmd/jc): This tool can be used to convert JSON <--> CBOR.

 - [coap](/cmd/coap): This tool can be used to send a single CoAP request/response, similar to `curl`.

 - [proxy](/cmd/proxy): This tool can be used to add low bandwidth support to any Matrix homeserver.

These can be tied together to interact with low-bandwidth enabled Matrix servers. For example:

```bash

# convert inline JSON to CBOR then pipe into coap to localhost:8008 then convert the CBOR response back to JSON and print to stdout

./jc -out "-" '{"auth":{"type":"m.login.dummy"},"username":"foo","password":"barbarbar"}' \

| ./coap -X POST -d '-' -H "Content-Type: application/cbor" -k  https://localhost:8008/_matrix/client/r0/register \

| ./jc -c2j -out '-' '-'

```