RocketChat/tsmatrixserverlib

Name: tsmatrixserverlib

Owner: Rocket.Chat

Description: federation support module : low level common methods

Created: 2017-08-07 02:55:39.0

Updated: 2017-10-30 10:05:11.0

Pushed: 2018-03-10 17:46:02.0

Homepage: null

Size: 205

Language: TypeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

tsmatrixserverlib

typescript library for common functions compatible with gomatrixserverlib

JavaScript Library for Federation Server Project

This is a JavaScript invocable set of library methods, in the form of an npm module, supporting chat federation via a matrix.org compatible protocol.

This library is a port of the gomatrixservlib, currently a work-in-progress from matrix.org.

tsmatrixserverlib is written in TypeScript, although calling client can be in JavaScript or TypeScript.

We selected TypeScript over JavaScript because:

1) Golang is strongly typed, TypeScript adds type support to JavaScript; we feel this will make the porting exercise easier 2) tsmatrixserverlib will likely gain complexity over time with multiple contributors, and TypeScript is more suitable for team collaborating on complex project

The is work in progress. We will update this page from time to time.

Understanding the Federation Project

The project aims at replacing Hubot-Freddie bridge with Federation API taking its place.The concept of Federation API is originally derived from Federation API.Understanding the Federation API document is really necessary in order to contribute to Repository.The reference library is gomatrixserverlib.

Tsmatrixserverlib Task-List

• [x] transaction.ts
• [x] timestamp.ts
• [ ] stateresolution.ts
• [ ] signing.ts
• [x] resolve.ts
• [ ] request.ts
• [x] redactevent.ts
• [ ] keys.ts
• [ ] keyring.ts
• [ ] json.ts
• [ ] federationtypes.ts
• [ ] federationclient.ts
• [ ] eventcrypto.ts
• [x] eventcontent.ts
• [ ] eventauth.ts
• [ ] event.ts
• [x] clientevent.ts
• [x] client.ts
• [x] base64.ts

Set up tsmatrixserverlib with TypeScript & JavaScript Unit Tests

t clone https://github.com/RocketChat/tsmatrixserverlib.git
t checkout develop
 run_tests.sh

*Contributions are welcome