Skip to content

Electrum

Explore various methods to install Electrum on your system, including using emerge on Gentoo or Python3 (portable/pip) options. Choose the installation method that suits your preferences and follow the detailed steps provided below.


Install Electrum

echo "net-misc/electrum cli ncurses qt5 qrcode" > /etc/portage/package.use/electrum
emerge --ask electrum dev-libs/libsecp256k1-0.1_pre20201028
wget https://download.electrum.org/4.3.2/Electrum-4.3.2.tar.gz
wget https://download.electrum.org/4.3.2/Electrum-4.3.2.tar.gz.asc
gpg --verify Electrum-4.3.2.tar.gz.asc
tar -xvf Electrum-4.3.2.tar.gz
python3 Electrum-4.3.2/run_electrum
wget https://download.electrum.org/4.3.2/Electrum-4.3.2.tar.gz
wget https://download.electrum.org/4.3.2/Electrum-4.3.2.tar.gz.asc
gpg --verify Electrum-4.3.2.tar.gz.asc
tar -xvf Electrum-4.3.2.tar.gz
python3 Electrum-4.3.2/run_electrum
python3 -m pip install --user Electrum-4.3.2.tar.gz

Help for Electrum from command line

    gui                 Run GUI (default)
    daemon              Run Daemon
    add_hold_invoice    Create a lightning hold invoice for the given payment hash
    add_peer            Connect to a lightning node
    add_request         Create a payment request, using the first unused address of the wallet
    addtransaction      Add a transaction to the wallet history, without broadcasting it
    broadcast           Broadcast a transaction to the network
    bumpfee             Bump the fee for an unconfirmed transaction
    cancel_hold_invoice
                        Cancels lightning hold invoice 'payment_hash'
    changegaplimit      Change the gap limit of the wallet
    check_hold_invoice  Checks the status of a lightning hold invoice 'payment_hash'
    clear_invoices      Remove all invoices
    clear_ln_blacklist
    clear_requests      Remove all payment requests
    close_channel       Close a lightning channel
    close_wallet        Close wallet
    convert_currency    Converts the given amount of currency to another using the configured exchange rate source
    convert_xkey        Convert xtype of a master key
    create              Create a new wallet
    createmultisig      Create multisig 'n of m' address
    createnewaddress    Create a new receiving address, beyond the gap limit of the wallet
    decode_invoice      Decode a lightning invoice
    decrypt             Decrypt a message encrypted with a public key
    delete_invoice      Remove an outgoing payment invoice
    delete_request      Remove an incoming payment request
    deserialize         Deserialize a transaction
    dumpprivkeys        Deprecated
    enable_htlc_settle  command used in regtests
    encrypt             Encrypt a message with a public key
    export_channel_backup
                        Returns an encrypted channel backup
    freeze              Freeze address
    freeze_utxo         Freeze a UTXO so that the wallet will not spend it
    get                 Return item from wallet storage
    get_blinded_path_via
                        Create a blinded path with node_id as introduction point
    get_channel_ctx     return the current commitment transaction of a channel
    get_invoice         Returns an invoice (request for outgoing payment)
    get_request         Returns a payment request
    get_submarine_swap_providers
                        Queries nostr relays for available submarine swap providers
    get_tx_status       Returns some information regarding the tx
    get_watchtower_ctn  Return the local watchtower's ctn of channel
    getaddressbalance   Return the balance of any address
    getaddresshistory   Return the transaction history of any address
    getaddressunspent   Returns the UTXO list of any address
    getbalance          Return the balance of your wallet
    getconfig           Return the current value of a configuration variable
    getfeerate          Return current fee estimate given network conditions (in sat/kvByte)
    getinfo             network info
    getmasterprivate    Get master private key
    getmerkle           Get Merkle branch of a transaction included in a block
    getminacceptablegap
                        Returns the minimum value for gap limit that would be sufficient to discover all known addresses in the wallet
    getmpk              Get master public key
    getopenalias        Retrieve alias
    getprivatekeyforpath
                        Get private key corresponding to derivation path (address index)
    getprivatekeys      Get private keys of addresses
    getpubkeys          Return the public keys for a wallet address
    getseed             Get seed phrase
    getservers          Return the list of known servers (candidates for connecting)
    gettransaction      Retrieve a transaction
    getunusedaddress    Returns the first unused address of the wallet, or None if all addresses are used
    gossip_info         Display statistics about lightninig gossip
    help                Show help about a command
    helpconfig          Returns help about a configuration variable
    import_channel_backup
    importprivkey       Import a private key or a list of private keys
    is_synchronized     return wallet synchronization status
    ismine              Check if address is in wallet
    lightning_history   lightning history
    list_channels       Return the list of Lightning channels in a wallet
    list_invoices       Returns the list of invoices (requests for outgoing payments) saved in the wallet
    list_peers          List lightning peers of your node
    list_requests       Returns the list of incoming payment requests saved in the wallet
    list_wallets        List wallets open in daemon
    listaddresses       List wallet addresses
    listconfig          Returns the list of all configuration variables
    listcontacts        Show your list of contacts
    listunspent         List unspent outputs
    lnpay               Pay a lightning invoice Note: it is *not* safe to try paying the same invoice multiple times with a timeout
    load_wallet         Load the wallet in memory
    make_seed           Create a seed
    nodeid              Return the Lightning Node ID of a wallet
    normal_swap         Normal submarine swap: send on-chain BTC, receive on Lightning
    notify              Watch an address
    onchain_capital_gains
                        Capital gains, using utxo pricing
    onchain_history     Wallet onchain history
    open_channel        Open a lightning channel with a peer
    password            Change wallet password
    payto               Create an on-chain transaction
    paytomany           Create a multi-output transaction
    rebalance_channels  Rebalance channels
    removelocaltx       Remove a 'local' transaction from the wallet, and its dependent transactions
    request_force_close
                        Requests the remote to force close a channel
    reset_liquidity_hints
    restore             Restore a wallet from text
    reverse_swap        Reverse submarine swap: send on Lightning, receive on-chain
    searchcontacts      Search through your wallet contacts, return matching entries
    send_onion_message  Send an onion message with onionmsg_tlv
    serialize           Create a signed raw transaction from a json tx template
    setconfig           Set a configuration variable
    setlabel            Assign a label to an item
    settle_hold_invoice
                        Settles lightning hold invoice with the given preimage
    signmessage         Sign a message with a key
    signtransaction     Sign a transaction with the current wallet
    signtransaction_with_privkey
                        Sign a transaction with private keys passed as parameter
    stop                Stop daemon
    sweep               Sweep private keys
    test_inject_fee_etas
                        Inject fee estimates into the network object, as if they were coming from connected servers
    unfreeze            Unfreeze address
    unfreeze_utxo       Unfreeze a UTXO so that the wallet might spend it
    unlock              Unlock the wallet (store the password in memory)
    unsetconfig         Clear a configuration variable
    validateaddress     Check that an address is valid
    verifymessage       Verify a signature
    version             Return the version of Electrum
    version_info        Return information about dependencies, such as their version and path
    wait_for_sync       Block until the wallet synchronization finishes

options:
  -h, --help            show this help message and exit
  --version             Return the version of Electrum.

global options:
  -v VERBOSITY          Set verbosity (log levels)
  -D, --dir ELECTRUM_PATH
                        electrum directory
  -w, --wallet WALLET_PATH
                        wallet path
  -P, --portable        Use local 'electrum_data' directory
  --mainnet             Use mainnet chain
  --mutinynet           Use mutinynet chain
  --regtest             Use regtest chain
  --signet              Use signet chain
  --simnet              Use simnet chain
  --testnet             Use testnet chain
  --testnet4            Use testnet4 chain
  -o, --offline         Run offline
  --rpcuser RPCUSER     RPC user
  --rpcpassword RPCPASSWORD
                        RPC password
  --forgetconfig        Forget config on exit

Run 'electrum help <command>' to see the help for a command