bark

package
v1.23.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 12, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewBarkService

func NewBarkService(ctx context.Context, eventPublisher events.EventPublisher, workDir, mnemonic string, config Config) (lnclient.LNClient, error)

Types

type BarkService

type BarkService struct {
	// contains filtered or unexported fields
}

func (*BarkService) CancelHoldInvoice

func (bs *BarkService) CancelHoldInvoice(ctx context.Context, paymentHash string) error

func (*BarkService) CloseChannel

func (bs *BarkService) CloseChannel(ctx context.Context, closeChannelRequest *lnclient.CloseChannelRequest) error

func (*BarkService) ConnectPeer

func (bs *BarkService) ConnectPeer(ctx context.Context, connectPeerRequest *lnclient.ConnectPeerRequest) error

func (*BarkService) DisconnectPeer

func (bs *BarkService) DisconnectPeer(ctx context.Context, peerId string) error

func (*BarkService) ExecuteCustomNodeCommand

func (bs *BarkService) ExecuteCustomNodeCommand(ctx context.Context, command *lnclient.CustomNodeCommandRequest) (*lnclient.CustomNodeCommandResponse, error)

func (*BarkService) GetBalances

func (bs *BarkService) GetBalances(ctx context.Context, includeInactiveChannels bool) (*lnclient.BalancesResponse, error)

func (*BarkService) GetCustomNodeCommandDefinitions

func (bs *BarkService) GetCustomNodeCommandDefinitions() []lnclient.CustomNodeCommandDef

func (*BarkService) GetInfo

func (bs *BarkService) GetInfo(ctx context.Context) (*lnclient.NodeInfo, error)

func (*BarkService) GetLogOutput

func (bs *BarkService) GetLogOutput(ctx context.Context, maxLen int) ([]byte, error)

func (*BarkService) GetNetworkGraph

func (bs *BarkService) GetNetworkGraph(ctx context.Context, nodeIds []string) (lnclient.NetworkGraphResponse, error)

func (*BarkService) GetNewOnchainAddress

func (bs *BarkService) GetNewOnchainAddress(ctx context.Context) (string, error)

func (*BarkService) GetNodeConnectionInfo

func (bs *BarkService) GetNodeConnectionInfo(ctx context.Context) (*lnclient.NodeConnectionInfo, error)

func (*BarkService) GetNodeStatus

func (bs *BarkService) GetNodeStatus(ctx context.Context) (*lnclient.NodeStatus, error)

func (*BarkService) GetOnchainBalance

func (bs *BarkService) GetOnchainBalance(ctx context.Context) (*lnclient.OnchainBalanceResponse, error)

func (*BarkService) GetPubkey

func (bs *BarkService) GetPubkey() string

func (*BarkService) GetStorageDir

func (bs *BarkService) GetStorageDir() (string, error)

func (*BarkService) GetSupportedNIP47Methods

func (bs *BarkService) GetSupportedNIP47Methods() []string

func (*BarkService) GetSupportedNIP47NotificationTypes

func (bs *BarkService) GetSupportedNIP47NotificationTypes() []string

func (*BarkService) ListChannels

func (bs *BarkService) ListChannels(ctx context.Context) ([]lnclient.Channel, error)

func (*BarkService) ListOnchainTransactions

func (bs *BarkService) ListOnchainTransactions(ctx context.Context) ([]lnclient.OnchainTransaction, error)

func (*BarkService) ListPeers

func (bs *BarkService) ListPeers(ctx context.Context) ([]lnclient.PeerDetails, error)

func (*BarkService) LookupInvoice

func (bs *BarkService) LookupInvoice(ctx context.Context, paymentHash string) (*lnclient.Transaction, error)

func (*BarkService) MakeHoldInvoice

func (bs *BarkService) MakeHoldInvoice(ctx context.Context, amountMsat int64, description string, descriptionHash string, expiry int64, paymentHash string, minCltvExpiryDelta *uint64) (*lnclient.Transaction, error)

func (*BarkService) MakeInvoice

func (bs *BarkService) MakeInvoice(ctx context.Context, amountMsat int64, description string, descriptionHash string, expiry int64, throughNodePubkey *string) (*lnclient.Transaction, error)

func (*BarkService) MakeOffer

func (bs *BarkService) MakeOffer(ctx context.Context, description string) (string, error)

func (*BarkService) OpenChannel

func (bs *BarkService) OpenChannel(ctx context.Context, openChannelRequest *lnclient.OpenChannelRequest) (*lnclient.OpenChannelResponse, error)

func (*BarkService) RedeemOnchainFunds

func (bs *BarkService) RedeemOnchainFunds(ctx context.Context, toAddress string, amountSat uint64, feeRate *uint64, sendAll bool) (string, error)

func (*BarkService) ResetRouter

func (bs *BarkService) ResetRouter(key string) error

func (*BarkService) SendKeysend

func (bs *BarkService) SendKeysend(amountMsat uint64, destination string, customRecords []lnclient.TLVRecord, preimage string) (*lnclient.PayKeysendResponse, error)

func (*BarkService) SendPaymentSync

func (bs *BarkService) SendPaymentSync(invoice string, amountMsat *uint64) (*lnclient.PayInvoiceResponse, error)

func (*BarkService) SettleHoldInvoice

func (bs *BarkService) SettleHoldInvoice(ctx context.Context, preimage string) error

func (*BarkService) Shutdown

func (bs *BarkService) Shutdown() error

func (*BarkService) SignMessage

func (bs *BarkService) SignMessage(ctx context.Context, message string) (string, error)

func (*BarkService) UpdateChannel

func (bs *BarkService) UpdateChannel(ctx context.Context, updateChannelRequest *lnclient.UpdateChannelRequest) error

func (*BarkService) UpdateLastWalletSyncRequest

func (bs *BarkService) UpdateLastWalletSyncRequest()

type Config

type Config struct {
	// Network is the bitcoin network name (e.g. "signet", "bitcoin").
	Network string
	// ServerAddress is the Ark server URL.
	ServerAddress string
	// EsploraAddress is the Esplora server URL used for chain data.
	EsploraAddress string
	// ServerAccessToken is an optional access token required by some Ark
	// servers (currently used to gate mainnet access ahead of a public launch).
	ServerAccessToken string
	// LogLevel is the logrus level (as an int string, e.g. "3" for Info) used
	// for bark's own internal logs. Defaults to Info if empty/unparseable.
	LogLevel string
	// LogToFile controls whether bark's logs are also written to a dedicated
	// bark.log file alongside the other backend logs.
	LogToFile bool
}

Config holds the user-configurable settings for connecting to an Ark server.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL