cli

Documentation

Index

• func Run()
• type Cli
  • func (c *Cli) AuthLnurl(lnurl string) error
  • func (c *Cli) Backup() error
  • func (c *Cli) BuyBitcoin(providerText string) error
  • func (c *Cli) CheckMessage(message, pubkey, signature string) error
  • func (c *Cli) CloseLspChannels() error
  • func (c *Cli) ConfigureNode(closeToAddress *string) error
  • func (c *Cli) Connect(inviteCode *string) error
  • func (c *Cli) ConnectLsp(lspId string) error
  • func (c *Cli) Disconnect() error
  • func (c *Cli) ExecuteDevCommand(command string) error
  • func (c *Cli) FetchReverseSwapFees(sendAmountSat *uint64) error
  • func (c *Cli) InProgressReverseSwaps() error
  • func (c *Cli) InProgressSwap() error
  • func (c *Cli) ListLsps() error
  • func (c *Cli) ListPayments(filters *[]string, fromTimestamp, toTimestamp *int64, includeFailures *bool, ...) error
  • func (c *Cli) ListRefundables() error
  • func (c *Cli) Log(logEntry breez_sdk.LogEntry)
  • func (c *Cli) LspInfo() error
  • func (c *Cli) MaxReverseSwapAmount() error
  • func (c *Cli) NodeCredentials() error
  • func (c *Cli) NodeInfo() error
  • func (c *Cli) OnEvent(breezEvent breez_sdk.BreezEvent)
  • func (c *Cli) OpenChannelFee(amountMsat *uint64, expiry *uint32) error
  • func (c *Cli) ParseInput(s string) error
  • func (c *Cli) PayLnurl(lnurl string) error
  • func (c *Cli) PaymentByHash(paymentHash string) error
  • func (c *Cli) PrepareRedeemOnchainFunds(toAddress string, satPerVByte uint32) error
  • func (c *Cli) PrepareRefund(swapAddress, toAddress string, satPerVByte uint32) error
  • func (c *Cli) PrettyPrint(i interface{})
  • func (c *Cli) PrintSuccess(str string)
  • func (c *Cli) Prompt(prompt string, a ...any) (string, error)
  • func (c *Cli) PromptNil(prompt string, a ...any) (*string, error)
  • func (c *Cli) PromptUint64(prompt string, a ...any) (uint64, error)
  • func (c *Cli) ReceiveOnchain() error
  • func (c *Cli) ReceivePayment(amountMsat uint64, description string) error
  • func (c *Cli) RecommendedFees() error
  • func (c *Cli) RedeemOnchainFunds(toAddress string, satPerVByte uint32) error
  • func (c *Cli) Refund(swapAddress, toAddress string, satPerVByte uint32) error
  • func (c *Cli) RegisterWebhook(url string) error
  • func (c *Cli) ReportPaymentFailure(paymentHash string, comment *string) error
  • func (c *Cli) RescanSwaps() error
  • func (c *Cli) SendOnchain(amountSat uint64, address string, satPerVByte uint32) error
  • func (c *Cli) SendPayment(bolt11 string, amountMsat *uint64) error
  • func (c *Cli) SendSpontaneousPayment(nodeId string, amountMsat uint64) error
  • func (c *Cli) ServiceCheckCheck() error
  • func (c *Cli) SetApiKey(apiKey string) error
  • func (c *Cli) SetPaymentMetadata(paymentHash, metadata string) error
  • func (c *Cli) SignMessage(message string) error
  • func (c *Cli) StaticBackup() error
  • func (c *Cli) Sync() error
  • func (c *Cli) WithdrawLnurl(lnurl string) error
• type Config

Functions

func Run

func Run()

Types

type Cli

type Cli struct {
	*grumble.App
	// contains filtered or unexported fields
}

func (*Cli) AuthLnurl

func (c *Cli) AuthLnurl(lnurl string) error

func (*Cli) Backup

func (c *Cli) Backup() error

func (*Cli) BuyBitcoin

func (c *Cli) BuyBitcoin(providerText string) error

func (*Cli) CheckMessage

func (c *Cli) CheckMessage(message, pubkey, signature string) error

func (*Cli) CloseLspChannels

func (c *Cli) CloseLspChannels() error

func (*Cli) ConfigureNode

func (c *Cli) ConfigureNode(closeToAddress *string) error

func (*Cli) Connect

func (c *Cli) Connect(inviteCode *string) error

func (*Cli) ConnectLsp

func (c *Cli) ConnectLsp(lspId string) error

func (*Cli) Disconnect

func (c *Cli) Disconnect() error

func (*Cli) ExecuteDevCommand

func (c *Cli) ExecuteDevCommand(command string) error

func (*Cli) FetchReverseSwapFees

func (c *Cli) FetchReverseSwapFees(sendAmountSat *uint64) error

func (*Cli) InProgressReverseSwaps

func (c *Cli) InProgressReverseSwaps() error

func (*Cli) InProgressSwap

func (c *Cli) InProgressSwap() error

func (*Cli) ListLsps

func (c *Cli) ListLsps() error

func (*Cli) ListPayments

func (c *Cli) ListPayments(filters *[]string, fromTimestamp, toTimestamp *int64, includeFailures *bool, offset, limit *uint32) error

func (*Cli) ListRefundables

func (c *Cli) ListRefundables() error

func (*Cli) Log

func (c *Cli) Log(logEntry breez_sdk.LogEntry)

func (*Cli) LspInfo

func (c *Cli) LspInfo() error

func (*Cli) MaxReverseSwapAmount

func (c *Cli) MaxReverseSwapAmount() error

func (*Cli) NodeCredentials

func (c *Cli) NodeCredentials() error

func (*Cli) NodeInfo

func (c *Cli) NodeInfo() error

func (*Cli) OnEvent

func (c *Cli) OnEvent(breezEvent breez_sdk.BreezEvent)

func (*Cli) OpenChannelFee

func (c *Cli) OpenChannelFee(amountMsat *uint64, expiry *uint32) error

func (*Cli) ParseInput

func (c *Cli) ParseInput(s string) error

func (*Cli) PayLnurl

func (c *Cli) PayLnurl(lnurl string) error

func (*Cli) PaymentByHash

func (c *Cli) PaymentByHash(paymentHash string) error

func (*Cli) PrepareRedeemOnchainFunds

func (c *Cli) PrepareRedeemOnchainFunds(toAddress string, satPerVByte uint32) error

func (*Cli) PrepareRefund

func (c *Cli) PrepareRefund(swapAddress, toAddress string, satPerVByte uint32) error

func (*Cli) PrettyPrint

func (c *Cli) PrettyPrint(i interface{})

func (*Cli) PrintSuccess

func (c *Cli) PrintSuccess(str string)

func (*Cli) Prompt

func (c *Cli) Prompt(prompt string, a ...any) (string, error)

func (*Cli) PromptNil

func (c *Cli) PromptNil(prompt string, a ...any) (*string, error)

func (*Cli) PromptUint64

func (c *Cli) PromptUint64(prompt string, a ...any) (uint64, error)

func (*Cli) ReceiveOnchain

func (c *Cli) ReceiveOnchain() error

func (*Cli) ReceivePayment

func (c *Cli) ReceivePayment(amountMsat uint64, description string) error

func (*Cli) RecommendedFees

func (c *Cli) RecommendedFees() error

func (*Cli) RedeemOnchainFunds

func (c *Cli) RedeemOnchainFunds(toAddress string, satPerVByte uint32) error

func (*Cli) Refund

func (c *Cli) Refund(swapAddress, toAddress string, satPerVByte uint32) error

func (*Cli) RegisterWebhook

func (c *Cli) RegisterWebhook(url string) error

func (*Cli) ReportPaymentFailure

func (c *Cli) ReportPaymentFailure(paymentHash string, comment *string) error

func (*Cli) RescanSwaps

func (c *Cli) RescanSwaps() error

func (*Cli) SendOnchain

func (c *Cli) SendOnchain(amountSat uint64, address string, satPerVByte uint32) error

func (*Cli) SendPayment

func (c *Cli) SendPayment(bolt11 string, amountMsat *uint64) error

func (*Cli) SendSpontaneousPayment

func (c *Cli) SendSpontaneousPayment(nodeId string, amountMsat uint64) error

func (*Cli) ServiceCheckCheck

func (c *Cli) ServiceCheckCheck() error

func (*Cli) SetApiKey

func (c *Cli) SetApiKey(apiKey string) error

func (*Cli) SetPaymentMetadata

func (c *Cli) SetPaymentMetadata(paymentHash, metadata string) error

func (*Cli) SignMessage

func (c *Cli) SignMessage(message string) error

func (*Cli) StaticBackup

func (c *Cli) StaticBackup() error

func (*Cli) Sync

func (c *Cli) Sync() error

func (*Cli) WithdrawLnurl

func (c *Cli) WithdrawLnurl(lnurl string) error

type Config

type Config struct {
	ApiKey   string `json:"api_key"`
	LogLevel string `json:"log_level"`
}