BoostCLI 0.5.0

Command line tool to send and receive Podcasting 2.0 Value

BoostCLI

Requirements

• Python 3.7+
• setuptools (tested with 57.4.0)
• A Raspiblitz Node (LNPay Support Coming)

Quick Start

$ pip install BoostCLI
$ boostcli boost http://mp3s.nashownotes.com/pc20rss.xml

Raspiblitz

$ pip install BoostCLI
$ boostcli --macaroon /mnt/hdd/app-data/lnd/data/chain/bitcoin/mainnet/admin.macaroon --tlscert /mnt/hdd/app-data/lnd/tls.cert boost http://mp3s.nashownotes.com/pc20rss.xml

Demo

Not Quick Start

Terminal #1

Open a Tunnel from this computer to your Raspiblitz Node. Replace 192.168.1.100 with the IP Address of your node.

ssh -NL 10009:127.0.0.1:10009 admin@192.168.1.100

Enter your password when prompted and leave the terminal open. Switch to a new terminal to continue the quick start.

Terminal #2

Get Macaroon and TLS Certificate

Get the readonly.macaroon and tls.cert from your node

• SSH into Node, replace 192.168.1.100 with the IP Address of your node.

  ssh admin@192.168.1.100 
  

• In Raspiblitz CONNECT -> EXPORT -> scp and following the instructions

Install Dependencies

This should be done in the directory that contains this project.

python3 -m venv venv && source venv/bin/activate # Optional but Recommended
pip install -e .

Read the docs

boostcli --help
boostcli boosts --help

Run Command

$ boostcli --macaroon /mnt/hdd/app-data/lnd/data/chain/bitcoin/mainnet/admin.macaroon --tlscert /mnt/hdd/app-data/lnd/tls.cert boost http://mp3s.nashownotes.com/pc20rss.xml

Virtual Environment Explained

Using a Python Virtual Environment is optional but highly recommended and is standard practice with development. The basic idea is you create a virtual environment for each project and install all the dependencies into it. The Virtual Environment only needs to be created once but must be activated every time a new terminal is opened.

Create Virtual Environment

python3 -m venv venv

Activate Environment

source venv/bin/activate

Deactivate Environment

deactivate

Sending a Boostagram with lncli

PUBKEY="03ecb3ee55ba6324d40bea174de096dc9134cb35d990235723b37ae9b5c49f4f53"
VALUE=69
MVALUE=$(expr $VALUE \* 1000)
SENDER_NAME="Dude named Ben"
MESSAGE="Test Message from lncli!"
RECEIVER_NAME="Podcaster"
APP_NAME="lncli"
DATA="{\"action\":\"boost\",\"value_msat_total\":\"$MVALUE\",\"app_name\":\"$APP_NAME\",\"sender_name\": \"$SENDER_NAME\",\"name\":\"$RECEIVER_NAME\",\"message\":\"$MESSAGE\"}"
RECORD=`echo $DATA |  od -A n -t x1 | sed -z 's/[ \n]*//g'`
lncli sendpayment --dest=$PUBKEY --amt=$VALUE --keysend --data 7629169=$RECORD

Receive Boostagrams with lncli

for x in $(lncli listinvoices | jq '.invoices[].htlcs[0].custom_records."7629169"'); do echo $x | sed 's/"//g' | xxd -r -p; done