Skip to content

electrum


Install electrum on Gentoo Linux

echo "net-misc/electrum cli ncurses qrcode qt6 " > /etc/portage/package.use/electrum
emerge --ask net-misc/electrum

Run GUI (default)

electrum gui

Run Daemon

electrum daemon

Create a lightning hold invoice for the given payment hash

electrum add_hold_invoice

Connect to a lightning node

electrum add_peer

Create a payment request, using the first unused address of the wallet

electrum add_request

Add a transaction to the wallet history, without broadcasting it

electrum addtransaction

Broadcast a transaction to the network

electrum broadcast

Bump the fee for an unconfirmed transaction

electrum bumpfee

Cancels lightning hold invoice 'payment_hash'

electrum cancel_hold_invoice

Change the gap limit of the wallet

electrum changegaplimit

Checks the status of a lightning hold invoice 'payment_hash'

electrum check_hold_invoice

Remove all invoices

electrum clear_invoices

Clear the lightning node blacklist

electrum clear_ln_blacklist

Remove all payment requests

electrum clear_requests

Close a lightning channel

electrum close_channel

Close wallet

electrum close_wallet

Converts the given amount of currency to another using the configured exchange rate source

electrum convert_currency

Convert xtype of a master key

electrum convert_xkey

Create a new wallet

electrum create

Create multisig 'n of m' address

electrum createmultisig

Create a new receiving address, beyond the gap limit of the wallet

electrum createnewaddress

Decode a lightning invoice

electrum decode_invoice

Decrypt a message encrypted with a public key

electrum decrypt

Remove an outgoing payment invoice

electrum delete_invoice

Remove an incoming payment request

electrum delete_request

Deserialize a transaction

electrum deserialize

Deprecated

electrum dumpprivkeys

command used in regtests

electrum enable_htlc_settle

Encrypt a message with a public key

electrum encrypt

Returns an encrypted channel backup

electrum export_channel_backup

Returns the stored preimage of the given payment_hash if it is known

electrum export_lightning_preimage

Freeze address

electrum freeze

Freeze a UTXO so that the wallet will not spend it

electrum freeze_utxo

Return item from wallet storage

electrum get

Create a blinded path with node_id as introduction point

electrum get_blinded_path_via

return the current commitment transaction of a channel

electrum get_channel_ctx

Returns an invoice (request for outgoing payment)

electrum get_invoice

Returns a payment request

electrum get_request

Queries nostr relays for available submarine swap providers

electrum get_submarine_swap_providers

Returns some information regarding the tx

electrum get_tx_status

Return the local watchtower's ctn of channel

electrum get_watchtower_ctn

Return the balance of any address

electrum getaddressbalance

Return the transaction history of any address

electrum getaddresshistory

Returns the UTXO list of any address

electrum getaddressunspent

Return the balance of your wallet

electrum getbalance

Return the current value of a configuration variable

electrum getconfig

Return current fee estimate given network conditions (in sat/kvByte)

electrum getfeerate

network info

electrum getinfo

Get master private key

electrum getmasterprivate

Get Merkle branch of a transaction included in a block

electrum getmerkle

Returns the minimum value for gap limit that would be sufficient to discover all known addresses in the wallet

electrum getminacceptablegap

Get master public key

electrum getmpk

Retrieve alias

electrum getopenalias

Get private key corresponding to derivation path (address index)

electrum getprivatekeyforpath

Get private keys of addresses

electrum getprivatekeys

Return the public keys for a wallet address

electrum getpubkeys

Get seed phrase

electrum getseed

Return the list of known servers (candidates for connecting)

electrum getservers

Retrieve a transaction

electrum gettransaction

Returns the first unused address of the wallet, or None if all addresses are used

electrum getunusedaddress

Display statistics about lightninig gossip

electrum gossip_info

Show help about a command

electrum help

Returns help about a configuration variable

electrum helpconfig

Import an encrypted channel backup

electrum import_channel_backup

Import a private key or a list of private keys

electrum importprivkey

return wallet synchronization status

electrum is_synchronized

Check if address is in wallet

electrum ismine

lightning history

electrum lightning_history

Return the list of Lightning channels in a wallet

electrum list_channels

Returns the list of invoices (requests for outgoing payments) saved in the wallet

electrum list_invoices

List lightning peers of your node

electrum list_peers

Returns the list of incoming payment requests saved in the wallet

electrum list_requests

List wallets open in daemon

electrum list_wallets

List wallet addresses

electrum listaddresses

Returns the list of all configuration variables

electrum listconfig

Show your list of contacts

electrum listcontacts

List unspent outputs

electrum listunspent

Pay a lightning invoice Note: it is not safe to try paying the same invoice multiple times with a timeout

electrum lnpay

Load the wallet in memory

electrum load_wallet

Create a seed

electrum make_seed

Return the Lightning Node ID of a wallet

electrum nodeid

Normal submarine swap: send on-chain BTC, receive on Lightning

electrum normal_swap

Watch an address

electrum notify

Capital gains, using utxo pricing

electrum onchain_capital_gains

Wallet onchain history

electrum onchain_history

Open a lightning channel with a peer

electrum open_channel

Change wallet password

electrum password

Create an on-chain transaction

electrum payto

Create a multi-output transaction

electrum paytomany

Rebalance channels

electrum rebalance_channels

Remove a 'local' transaction from the wallet, and its dependent transactions

electrum removelocaltx

Requests the remote to force close a channel

electrum request_force_close

Reset lightning liquidity hints

electrum reset_liquidity_hints

Restore a wallet from text

electrum restore

Reverse submarine swap: send on Lightning, receive on-chain

electrum reverse_swap

Search through your wallet contacts, return matching entries

electrum searchcontacts

Send an onion message with onionmsg_tlv

electrum send_onion_message

Create a signed raw transaction from a json tx template

electrum serialize

Set a configuration variable

electrum setconfig

Assign a label to an item

electrum setlabel

Settles lightning hold invoice with the given preimage

electrum settle_hold_invoice

Sign a message with a key

electrum signmessage

Sign a transaction with the current wallet

electrum signtransaction

Sign a transaction with private keys passed as parameter

electrum signtransaction_with_privkey

Stop daemon

electrum stop

Sweep private keys

electrum sweep

Inject fee estimates into the network object, as if they were coming from connected servers

electrum test_inject_fee_etas

Unfreeze address

electrum unfreeze

Unfreeze a UTXO so that the wallet might spend it

electrum unfreeze_utxo

Unlock the wallet (store the password in memory)

electrum unlock

Clear a configuration variable

electrum unsetconfig

Check that an address is valid

electrum validateaddress

Verify a signature

electrum verifymessage

Return the version of Electrum

electrum version

Return information about dependencies, such as their version and path

electrum version_info

Block until the wallet synchronization finishes

electrum wait_for_sync