Install BOS

BoS is a great tool to manage your channels, open new (equal balanced) channels, gain insight into fees and much more.

Install BoS

Step 1: Install NMP

sudo apt install npm

Step 2: Install Balance of Satoshis

sudo npm install -g balanceofsatoshis
sudo apt update
curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -
sudo apt-get install -y nodejs

Step 3: Test tool

Run the following commands and validate the output (not an error):

bos --version
bos utxos

Well done, BoS is successfully installed! 😎

Function list

To run a overview of all BoS functions, run the following command:

bos

A list will appear.

bos 10.10.0 

   USAGE

     bos <command> [options]

   COMMANDS

     accounting <category>               Get an accounting rundown                            
     advertise                           Broadcast advertisement                              
     balance                             Get total tokens                                     
     broadcast <tx>                      Submit a signed transaction to the mempool           
     call [method]                       Make a raw API call and to get a raw API response    
     cert-validity-days                  Number of days until the cert is invalid             
     chain-deposit [amount]              Deposit coins in the on-chain wallet                 
     chainfees                           Get the current chain fee estimates                  
     chart-chain-fees                    Get a chart of chain fee expenses                    
     chart-fees-earned [via_peer]        Get a chart of earned routing fees                   
     chart-fees-paid                     Get a chart of paid routing fees                     
     chart-payments-received             Get a chart of received payments                     
     closed                              Get the status of a channel closings                 
     credentials                         Export local credentials                             
     fees                                Show and adjust outbound fee rates                   
     find <query>                        Find a record                                        
     forwards                            Show recent forwarding earnings                      
     fund <address_amount...>            Make a signed transaction spending on-chain funds    
     gateway                             Request gateway for https://ln-operator.github.io/   
     graph <alias_or_public_key>         List out the connections a node has with other nodes 
     inbound-channel-rules               Enforce rules for inbound channels                   
     inbound-liquidity                   Get inbound liquidity size                           
     increase-inbound-liquidity          Increase node inbound liquidity                      
     increase-outbound-liquidity         Move on-chain funds off-chain                        
     nodes [node]                        List and edit saved nodes                            
     open <peer_public_keys...>          Open channels, optionally using an external wallet   
     open-balanced-channel               Open a dual-funded channel with a node               
     outbound-liquidity                  Get outbound liquidity size                          
     pay <request>                       Pay a payment request, probing first                 
     peers                               Get a list of channel-connected peers                
     price [symbols...]                  Get the price                                        
     probe <to> [amount]                 Check if a payment request is sendable               
     rebalance                           Rebalance funds between peers                        
     reconnect                           Reconnect to disconnected channel partners           
     recover-p2pk <id> <vout>            Recover chain funds sent to the node identity key    
     remove-peer [public_key]            Close out with a channel-connected peer              
     report                              Report about the node                                
     send <to>                           Send funds to a node                                 
     services                            Run a KeySend paid services server                   
     swap-api-key                        Purchase a swap API key or inspect a swap API key    
     swap-in [amount]                    Trade on-chain coins for off-chain via submarine swap
     tags [tag]                          View or adjust the set of tagged nodes               
     telegram                            Post updates to a Telegram bot                       
     transfer <to> [amount]              Send funds to a saved node                           
     unlock <path_to_password_file>      Unlock wallet if locked                              
     use <server_id>                     Use a paid KeySend service from a services provider  
     utxos                               Get a list of utxos                                  
     help <command>                      Display help for a specific command                  

   GLOBAL OPTIONS

     -h, --help         Display help                                      
     -V, --version      Display version                                   
     --no-color         Disable colors                                    
     --quiet            Quiet mode - only displays warn and error messages
     -v, --verbose      Verbose mode - will also output debug messages

If you want to read more information about a function simply type bos followed by help and type the function you want to know more about. In our example below we look at the description of the broadcast function.

umbrel@umbrel:~ $ bos help broadcast

   bos 10.10.0 

   USAGE

     bos broadcast <tx>

   ARGUMENTS

     <tx>      Signed raw transaction      required      

   OPTIONS

     --description <description>      Describe the transaction being sent      optional      
     --node <node_name>               Node to submit transaction on            optional      

   GLOBAL OPTIONS

     -h, --help         Display help                                      
     -V, --version      Display version                                   
     --no-color         Disable colors                                    
     --quiet            Quiet mode - only displays warn and error messages
     -v, --verbose      Verbose mode - will also output debug messages