psf-msg-wallet

This is a command-line interface (CLI) forked from psf-bch-wallet. This fork has all the same commands, but adds additional commands around sending an end-to-end encrypted (E2EE) message to any BCH address, similar to email. It uses a Nostr relay to store the encrypted message, until the receiver can download and decrypt it with their BCH wallet.

In the future, commands will be added for encrypting files using a BCH wallet.

Installation

This software requires node.js v20 or higher. Instructions for installation:

• git clone https://github.com/Permissionless-Software-Foundation/psf-msg-wallet
• cd psf-msg-wallet
• npm install

Usage

Display Help

• node psf-msg-wallet.js help

Wallet Commands

This fork retains all the commands available in psf-bch-wallet. Check that README for additional commands.

Check For New Messages

Check for new messages. If your address has recieved a message signal, the TXID of the message signal will be displayed. You'll need that TXID to download the message for decrypting and reading.

• node psf-msg-wallet.js msg-nostr-check -n wallet1

Arguments

• -n - flag to give your wallet name, to check for message signals sent to your address.

Send E2EE Message

Send an end-to-end encrypted message to a BCH address. The 'subject' is not encrypted, but the message contents are. The receiver will need to have made at least one transaction with their address in order to send them a message. That way, their public key can be retrieved from the blockchain.

• node psf-msg-wallet.js msg-nostr-send -n wallet1 -s test -m "This is an encrypted message" -a bitcoincash:qqfrps47nxdvak55h3x97dqmglcaczegusma02uhqt

Arguments

• -n - flag to specify the wallet paying for the message signal (required).
• -s - An un-encrypted subject line (optional).
• -m - A string of text to send as a message. This will be encrypted with the receivers public key. (required)
• -a - The BCH address of the receiver. (required)

Read E2EE Message

Download an E2EE message from a Nostr relay, and decrypt it using the private key from your wallet.

• node psf-msg-wallet.js msg-nostr-read -n wallet1 -t e7537fbeebb367e09793286f636ec6a4a0b04ba556ec90691b5e0107d18cc5cb

Arguments

• -n - specify the wallet to check for messages (required).
• -t - The TXID of the message signal. This is provided by the msg-check-nostr command.