architex/README.md
2021-09-06 14:36:33 +00:00

3.3 KiB

Architex

A Matrix homeserver written in Elixir. Currently, this project is in a very early stage.

Noteworthy contributions

  • lib/architex/state_resolution.ex: Implementation of version 2 of the Matrix state resolution algorithm.
  • lib/architex/state_resolution/authorization.ex: Implementation of authorization rules for the state resolution algorithm.
  • lib/architex/room_server.ex: A GenServer that holds and manages the state of a room.

Dependencies

  • Elixir 1.12.2 compiled for OTP 24
  • Erlang 24.0.3
  • PostgreSQL
  • Libsodium

Generate the server's ed25519 keys by executing ssh-keygen -t ed25519 -f keys/id_ed25519 -N ""

Progress

Here, implemented and some unimplemented features are listed.

Implemented features

Implemented API endpoints

Client-Server API

  • GET /_matrix/client/r0/register/available
  • GET /_matrix/client/r0/account/whoami
  • POST /_matrix/client/r0/logout
  • POST /_matrix/client/r0/logout/all
  • PUT /_matrix/client/r0/directory/room/{roomAlias}
  • GET /_matrix/client/versions
  • GET /_matrix/client/r0/login
  • POST /_matrix/client/r0/login: Only with password flow.
  • POST /_matrix/client/r0/register: Only with dummy flow.
  • POST /_matrix/client/r0/createRoom: Only with optional parameters name, topic and preset.
  • GET /_matrix/client/r0/joined_rooms
  • POST /_matrix/client/r0/rooms/{roomId}/invite
  • POST /_matrix/client/r0/rooms/{roomId}/join: Except with third party invite.
  • POST /_matrix/client/r0/rooms/{roomId}/leave
  • POST /_matrix/client/r0/rooms/{roomId}/kick
  • POST /_matrix/client/r0/rooms/{roomId}/ban
  • POST /_matrix/client/r0/rooms/{roomId}/unban
  • PUT /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}
  • GET /_matrix/client/r0/rooms/{roomId}/messages: Except filtering.
  • GET /_matrix/client/r0/directory/list/room/{roomId}
  • PUT /_matrix/client/r0/directory/list/room/{roomId}

Federation API

  • GET /_matrix/federation/v1/event/{eventId}
  • GET /_matrix/federation/v1/state/{roomId}
  • GET /_matrix/federation/v1/state_ids/{roomId}
  • GET /_matrix/key/v2/server/{keyId}
  • GET /_matrix/federation/v1/query/profile: Except displayname and avatar_url is not implemented.

Major unimplemented features