Skip to content

Latest commit

 

History

History
177 lines (131 loc) · 7.89 KB

README.md

File metadata and controls

177 lines (131 loc) · 7.89 KB
Raw

Cipherchat

Encrypted messaging over the bitcoin lightning network.

image

[email protected]

Netlify Status

Tech Stack

Cipherchat has minimal dependencies with the main packages being as follows:

  • sveltekit
  • typescript
  • tailwindcss
  • lnc-web
  • dexie.js

A large part of the app is the LNC WASM binary which comes bundled with the application.

For a full list of dependencies check out the package.json.

Browser Requirements

Cipherchat requires the following browser features to be enabled in order to run the app. These features are standard across all major browsers. However, it is possible that they can be disabled in the browser settings. If you receive warnings about missing these features they will have to be adjusted to continue.

  • Service Workers
  • Web Assembly
  • Local Storage
  • IndexedDB

PWA

Cipherchat is a Progressive Web App that can be installed on many devices and uses native features.

Self-Hosting

Running Locally

If you only want to use Cipherchat on your local machine you can follow these steps:

  1. git clone the repository
  2. cd into the new directory
  3. run yarn to install the packages
  4. run yarn build to build the application
  5. run yarn preview and the app will be served on localhost:4173

To run in development mode you can skip steps 4 & 5 and instead run yarn dev which will serve the app on localhost:5173. Note that the Service Worker will be unable to register in dev mode if you are using Firefox because that browser does not support modules.

Deploy Globally

If you would like to run a publicly accessible instance of Cipherchat that you can access remotely, I would recommend forking the repository and deploying with either Netlify or Vercel.

Both providers offer a free tier and have close to one-click deployments that are very easy to setup and maintain. They will also give you a domain that you can access without having to purchase one yourself.

Once your instance is deployed you can stay in sync with this master branch and these platforms will auto-deploy new commits.

You can however use any type of server you'd like to deploy Cipherchat ranging from bare-metal to an easily hosted option.

One-Click Installation

I plan on releasing Cipherchat on these plug-and-play node app stores:

  • myNode
  • Start9 Embassy
  • Umbrel

If there are other app stores you would like to see Cipherchat, please let me know!

Want to be inter-operable?

Cipherchat uses established standards from the TLV Record Registry. Users of Cipherchat could have conversations with other lightning apps if they follow the convention below for attaching dest_custom_records to keysend payments.

Cipherchat Keysend Custom Record Scheme
Key Value Additional Info
5482373484 Keysend Preimage Preimage for the invoice.
34349334 Message Content The chat text, image, or a random UUID if 'PAYMENT' type.
34349343 Timestamp When the message was created measured in nanoseconds since the unix epoch.
34349337 Signature The output from signing the: (receiver pubkey + timestamp + message) using the private key counterpart of the public key attached.
34349339 Sender's Pubkey This identifies the node associated with the message.
34349345 Content Type Can be one of: 'TEXT', 'IMAGE', 'PAYMENT'. (Currently images are not yet implemented).

License

GNU Affero General Public License v3.0

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

                                7JJJJJJJJJJJ    7JJJJJJJ^:::
                                ?5YYYYYYYYYY.  .?YYYJJJJ^^^^
                                ?YYYYYYYYYYY????????^^^^^^^:
                                ?YYYYYYYYJYJ????????^^^^^^^:
                                ?555YYYY????????????^^^^^^^^
                                :~^^?JJJ????????!!!!^^^^....
                                    !J??????????^^^^^^^^
                                    .:::~!!!!!!~^^^^....
                                        :^^^^^^^^^^^









            :^^^^^^^                                                    :^^^^^^^
            5#######.                                                   G######B
            5#BBBBBB.                                                   G#BBBB#G
            5#BBBBBB.                                                   P#BBBB#G
        !J??G#BBBBBBY???                                            7J?JBBBBBBBBJ???
        P####BBBBBBB####.                                           G###BBBBBBBB###B
        5#BBBBBBBBBBBBBB7~~~~~~~Y5555555!~~~~~~~~~~!Y555555Y!~~~~~~!G#BBBBBBBBBBBB#B
        5#BBBBBBBBBBBBBBJ???????B#######J??????????JB######BJ??????JB#BBBBBBBBBBBB#B
        5#BBBBBBBBBBBBBBJ???????B#BBBBBBJ???????????B#BBBBBBJ???????B#BBBBBBBBBBBB#B
       .P#BBBBBBBBBBBBBBYJJJJJJJB#BBBBBBYJJJJJJJJJJJB#BBBBBBYJJJJJJJBBBBBBBBBBBBBB#B.
    YBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBG
    5###BBBBBBBBBBBBBBBBP5555555BBBBBBBBBBBBBBBBBBBBBBBBBBBBP5555555BBBBBBBBBBBBBBBB###B
    Y#BBBBBB#####BBBBBBB.       P#BBBBBBBBBB####BBBBBBBBBB#B.       P#BBBBBB####BBBBBB#G
    Y#BBBBBBYJJJB#BBBBBB.       P#BBBBBBBBBBYJJJBBBBBBBBBB#B.       P#BBBBBBYJJJBBBBBB#G
    Y#BBBBBB.   P####BBB        P#BBBBBB###B.   G####BBBBB#B        P#BB###B    G#BBBB#G
^~~~G#BBBBBB7~~~!7!7G#BB7~~~~~~~G#BBBBBB?!7!    ~7!7G#BBBBBB7~~~~~~!G#BB?!!!~~~!B#BBBBBB!~~~
5####BBBBBBB##&#.   5#BB########BBBBBB#B            P#BBBBBB########BB#G    G&###BBBBBBB###B
5#BBBBBBBBBB!^^^7???G#BBBBBBBBBBBBBBBBBBJ???????????B#BBBBBBBBBBBBBBBBBBJ??7~^^~G#BBBBBBBB#B
5#BBBBBBBBBB.   P####BBBBBBBBBBBBBBBBBBB############BBBBBBBBBBBBBBBBBBBB###B    G#BBBBBBBB#B
5#BBBBBBBBBB5YYYB#BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBYYYYBBBBBBBBBB#B
5#BBBBBBBBBB####BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB####BBBBBBBBBBBB
!JJJJJJJG#BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBYJJJJJJ?
~???????G#BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBJ??????7