api

Nov 20, 2025

Changes in this version

type API

+ SetBitcoinDisplayFormat func(format string) error

+ UpdateSettings func(updateSettingsRequest *UpdateSettingsRequest) error

type CreateAppResponse

+ RelayUrls []string

type InfoResponse

+ BitcoinDisplayFormat string

+ Relays []InfoResponseRelay

+ type InfoResponseRelay struct

+ Online bool

+ Url string

type UpdateAppRequest

+ UpdateExpiresAt bool

type UpdateSettingsRequest

+ BitcoinDisplayFormat string

Sep 24, 2025

Changes in this version

type LSPOrderRequest

+ LSPIdentifier string

type UnlockRequest

+ Permission string

Aug 29, 2025

Changes in this version

type Swap

+ UsedXpub bool

Aug 28, 2025

Changes in this version

type API

+ GetForwards func() (*GetForwardsResponse, error)

+ GetLSPChannelOffer func(ctx context.Context) (*alby.LSPChannelOffer, error)

+ GetSwapInInfo func() (*SwapInfoResponse, error)

+ GetSwapOutInfo func() (*SwapInfoResponse, error)

+ Transfer func(ctx context.Context, fromAppId *uint, toAppId *uint, amountMsat uint64) error

type Channel

+ ForwardingFeeProportionalMillionths uint32

+ type GetForwardsResponse struct

+ NumForwards uint64

+ OutboundAmountForwardedMsat uint64

+ TotalFeeEarnedMsat uint64

type InitiateSwapRequest

+ UseExactReceiveAmount bool

type ListAppsFilters

+ SubWallets *bool

type SendEventRequest

+ Properties interface{}

+ type SwapInfoResponse struct

+ AlbyServiceFee float64

+ BoltzNetworkFee uint64

+ BoltzServiceFee float64

+ MaxAmount uint64

+ MinAmount uint64

+ type TransferRequest struct

+ AmountSat uint64

+ FromAppId *uint

+ ToAppId *uint

Jul 31, 2025

Changes in this version

+ type ListAppsFilters struct

+ AppStoreAppId string

+ Name string

+ Unused bool

type ListAppsResponse

+ TotalCount uint64

Jul 14, 2025

Changes in this version

type App

+ LastUsedAt *time.Time

Jul 12, 2025

Changes in this version

type API

+ CreateLightningAddress func(ctx context.Context, ...) error

+ DeleteLightningAddress func(ctx context.Context, appId uint) error

+ DisableAutoSwap func() error

+ EnableAutoSwapOut func(ctx context.Context, autoSwapRequest *EnableAutoSwapRequest) error

+ GetAutoSwapConfig func() (*GetAutoSwapConfigResponse, error)

+ GetSwapInFees func() (*SwapFeesResponse, error)

+ GetSwapMnemonic func() string

+ GetSwapOutFees func() (*SwapFeesResponse, error)

+ InitiateSwapIn func(ctx context.Context, initiateSwapInRequest *InitiateSwapRequest) (*swaps.SwapResponse, error)

+ InitiateSwapOut func(ctx context.Context, initiateSwapOutRequest *InitiateSwapRequest) (*swaps.SwapResponse, error)

+ ListSwaps func() (*ListSwapsResponse, error)

+ LookupSwap func(swapId string) (*LookupSwapResponse, error)

+ MakeOffer func(ctx context.Context, description string) (string, error)

+ RebalanceChannel func(ctx context.Context, rebalanceChannelRequest *RebalanceChannelRequest) (*RebalanceChannelResponse, error)

+ RefundSwap func(refundSwapRequest *RefundSwapRequest) error

+ SendEvent func(event string)

+ SetNodeAlias func(nodeAlias string) error

+ type CreateLightningAddressRequest struct

+ Address string

+ AppId uint

+ type EnableAutoSwapRequest struct

+ BalanceThreshold uint64

+ Destination string

+ SwapAmount uint64

+ type GetAutoSwapConfigResponse struct

+ BalanceThreshold uint64

+ Destination string

+ Enabled bool

+ SwapAmount uint64

+ Type string

type InfoResponse

+ MempoolUrl string

+ NodeAlias string

+ type InitiateSwapRequest struct

+ Destination string

+ SwapAmount uint64

+ type ListSwapsResponse struct

+ Swaps []Swap

+ type LookupSwapResponse = Swap

+ type MakeOfferRequest struct

+ Description string

type PayInvoiceRequest

+ Metadata Metadata

+ type RebalanceChannelRequest struct

+ AmountSat uint64

+ ReceiveThroughNodePubkey string

+ type RebalanceChannelResponse struct

+ TotalFeeSat uint64

type RedeemOnchainFundsRequest

+ FeeRate *uint64

+ type RefundSwapRequest struct

+ Address string

+ SwapId string

+ type SendEventRequest struct

+ Event string

+ type SetNodeAliasRequest struct

+ NodeAlias string

+ type Swap struct

+ AutoSwap bool

+ BoltzPubkey string

+ ClaimTxId string

+ CreatedAt string

+ DestinationAddress string

+ Id string

+ Invoice string

+ LockupAddress string

+ LockupTxId string

+ PaymentHash string

+ ReceiveAmount uint64

+ RefundAddress string

+ SendAmount uint64

+ State string

+ Type string

+ UpdatedAt string

+ type SwapFeesResponse struct

+ AlbyServiceFee float64

+ BoltzNetworkFee uint64

+ BoltzServiceFee float64

May 15, 2025

Changes in this version

type API

+ DisableAutoSwaps func() error

+ EnableAutoSwaps func(ctx context.Context, autoSwapsRequest *EnableAutoSwapsRequest) error

+ GetAutoSwapsConfig func() (*GetAutoSwapsConfigResponse, error)

+ ListOnchainTransactions func(ctx context.Context) ([]lnclient.OnchainTransaction, error)

+ type EnableAutoSwapsRequest struct

+ BalanceThreshold uint64

+ Destination string

+ SwapAmount uint64

+ type GetAutoSwapsConfigResponse struct

+ AlbyServiceFee float64

+ BalanceThreshold uint64

+ BoltzNetworkFee uint64

+ BoltzServiceFee float64

+ Destination string

+ Enabled bool

+ SwapAmount uint64

type InfoResponse

+ Relay string

Apr 2, 2025

Changes in this version

type HealthAlarmKind

+ const HealthAlarmKindVssNoSubscription

Mar 11, 2025

Changes in this version

type App

+ UniqueWalletPubkey bool

+ WalletPubkey string

type CreateAppRequest

+ UnlockPassword string

type ListTransactionsResponse

+ TotalCount uint64

+ Transactions []Transaction

type Transaction

+ UpdatedAt string

Feb 14, 2025

Changes in this version

type InfoResponse

+ StartupState string

Feb 6, 2025

Changes in this version

+ const HealthAlarmKindAlbyService

+ const HealthAlarmKindChannelsOffline

+ const HealthAlarmKindNodeNotReady

+ const HealthAlarmKindNostrRelayOffline

type API

+ ExecuteCustomNodeCommand func(ctx context.Context, command string) (interface{}, error)

+ GetCustomNodeCommands func() (*CustomNodeCommandsResponse, error)

+ Health func(ctx context.Context) (*HealthResponse, error)

+ SetCurrency func(currency string) error

type CreateAppResponse

+ Lud16 string

+ RelayUrl string

+ WalletPubkey string

+ type CustomNodeCommandArgDef struct

+ Description string

+ Name string

+ type CustomNodeCommandDef struct

+ Args []CustomNodeCommandArgDef

+ Description string

+ Name string

+ type CustomNodeCommandsResponse struct

+ Commands []CustomNodeCommandDef

+ type ExecuteCustomNodeCommandRequest struct

+ Command string

+ type HealthAlarm struct

+ Kind HealthAlarmKind

+ RawDetails any

+ func NewHealthAlarm(kind HealthAlarmKind, rawDetails any) HealthAlarm

+ type HealthAlarmKind string

+ type HealthResponse struct

+ Alarms []HealthAlarm

type InfoResponse

+ Currency string

type Transaction

+ FailureReason string

+ type UpdateSettingsRequest struct

+ Currency string

Jan 7, 2025

Changes in this version

type API

+ SetAutoUnlockPassword func(unlockPassword string) error

+ type AutoUnlockRequest struct

+ UnlockPassword string

type Channel

+ FundingTxVout uint32

type InfoResponse

+ AutoUnlockPasswordEnabled bool

+ AutoUnlockPasswordSupported bool

Dec 17, 2024

Changes in this version

type API

+ MigrateNodeStorage func(ctx context.Context, to string) error

type InfoResponse

+ VssSupported bool

+ type MigrateNodeStorageRequest struct

+ To string

+ type PayInvoiceRequest struct

+ Amount *uint64

Dec 5, 2024

Changes in this version

type App

+ AppPubkey string

type InfoResponse

+ LdkVssEnabled bool

type UpdateAppRequest

+ Isolated bool

Nov 1, 2024

Changes in this version

type API

+ TopupIsolatedApp func(ctx context.Context, app *db.App, amountMsat uint64) error

+ type TopupIsolatedAppRequest struct

+ AmountSat uint64

Sep 22, 2024

Changes in this version

type Transaction

+ State string

Sep 4, 2024

Changes in this version

type App

+ Metadata Metadata

type CreateAppRequest

+ Metadata Metadata

type InfoResponse

+ StartupError string

+ StartupErrorTime time.Time

type RedeemOnchainFundsRequest

+ Amount uint64

+ SendAll bool

type UpdateAppRequest

+ Metadata Metadata

Aug 24, 2024

Changes in this version

type CreateAppResponse

+ Id uint

type UpdateAppRequest

+ Name string

Aug 12, 2024

Changes in this version

type API

+ GetMnemonic func(unlockPassword string) (*MnemonicResponse, error)

+ type Boostagram struct

+ Action string

+ AppName string

+ Episode string

+ FeedId string

+ ItemId string

+ Message string

+ Name string

+ Podcast string

+ SenderId string

+ SenderName string

+ Time string

+ Timestamp int64

+ URL string

+ ValueMsatTotal int64

type Channel

+ IsOutbound bool

type InfoResponse

+ EnableAdvancedSetup bool

+ type Metadata = map[string]interface

+ type MnemonicRequest struct

+ UnlockPassword string

+ type MnemonicResponse struct

+ Mnemonic string

type Transaction

+ Boostagram *Boostagram

type UnlockRequest

+ TokenExpiryDays *uint64

Jul 31, 2024

Changes in this version

+ type Channel struct

+ Active bool

+ Confirmations *uint32

+ ConfirmationsRequired *uint32

+ CounterpartyUnspendablePunishmentReserve uint64

+ Error *string

+ ForwardingFeeBaseMsat uint32

+ FundingTxId string

+ Id string

+ InternalChannel interface{}

+ LocalBalance int64

+ LocalSpendableBalance int64

+ Public bool

+ RemoteBalance int64

+ RemotePubkey string

+ Status string

+ UnspendablePunishmentReserve uint64

Jul 25, 2024

Changes in this version

type API

+ RequestLSPOrder func(ctx context.Context, request *LSPOrderRequest) (*LSPOrderResponse, error)

+ type LSPOrderRequest struct

+ Amount uint64

+ LSPType string

+ LSPUrl string

+ Public bool

+ type LSPOrderResponse struct

+ Fee uint64

+ IncomingLiquidity uint64

+ Invoice string

+ InvoiceAmount uint64

+ OutgoingLiquidity uint64

Jul 19, 2024

Changes in this version

type App

+ Balance uint64

+ ID uint

+ Isolated bool

+ MaxAmountSat uint64

type CreateAppRequest

+ Isolated bool

+ MaxAmountSat uint64

+ type Transaction struct

+ Amount uint64

+ AppId *uint

+ CreatedAt string

+ Description string

+ DescriptionHash string

+ FeesPaid uint64

+ Invoice string

+ Metadata interface{}

+ PaymentHash string

+ Preimage *string

+ SettledAt *string

+ Type string

type UpdateAppRequest

+ MaxAmountSat uint64

Jul 5, 2024

Changes in this version

+ const LogTypeApp

+ const LogTypeNode

+ func NewAPI(svc service.Service, gormDB *gorm.DB, config config.Config, keys keys.Keys, ...) *api

+ type API interface

+ ChangeUnlockPassword func(changeUnlockPasswordRequest *ChangeUnlockPasswordRequest) error

+ CloseChannel func(ctx context.Context, peerId, channelId string, force bool) (*CloseChannelResponse, error)

+ ConnectPeer func(ctx context.Context, connectPeerRequest *ConnectPeerRequest) error

+ CreateApp func(createAppRequest *CreateAppRequest) (*CreateAppResponse, error)

+ CreateBackup func(unlockPassword string, w io.Writer) error

+ CreateInvoice func(ctx context.Context, amount int64, description string) (*MakeInvoiceResponse, error)

+ DeleteApp func(userApp *db.App) error

+ DisconnectPeer func(ctx context.Context, peerId string) error

+ GetApp func(userApp *db.App) *App

+ GetBalances func(ctx context.Context) (*BalancesResponse, error)

+ GetChannelPeerSuggestions func(ctx context.Context) ([]alby.ChannelPeerSuggestion, error)

+ GetEncryptedMnemonic func() *EncryptedMnemonicResponse

+ GetInfo func(ctx context.Context) (*InfoResponse, error)

+ GetLogOutput func(ctx context.Context, logType string, getLogRequest *GetLogOutputRequest) (*GetLogOutputResponse, error)

+ GetNetworkGraph func(nodeIds []string) (NetworkGraphResponse, error)

+ GetNewOnchainAddress func(ctx context.Context) (string, error)

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

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

+ GetUnusedOnchainAddress func(ctx context.Context) (string, error)

+ GetWalletCapabilities func(ctx context.Context) (*WalletCapabilitiesResponse, error)

+ ListApps func() ([]App, error)

+ ListChannels func(ctx context.Context) ([]lnclient.Channel, error)

+ ListPeers func(ctx context.Context) ([]lnclient.PeerDetails, error)

+ ListTransactions func(ctx context.Context) (*ListTransactionsResponse, error)

+ LookupInvoice func(ctx context.Context, paymentHash string) (*LookupInvoiceResponse, error)

+ NewInstantChannelInvoice func(ctx context.Context, request *NewInstantChannelInvoiceRequest) (*NewInstantChannelInvoiceResponse, error)

+ OpenChannel func(ctx context.Context, openChannelRequest *OpenChannelRequest) (*OpenChannelResponse, error)

+ RedeemOnchainFunds func(ctx context.Context, toAddress string) (*RedeemOnchainFundsResponse, error)

+ RequestMempoolApi func(endpoint string) (interface{}, error)

+ ResetRouter func(key string) error

+ RestoreBackup func(unlockPassword string, r io.Reader) error

+ SendPayment func(ctx context.Context, invoice string) (*SendPaymentResponse, error)

+ SendPaymentProbes func(ctx context.Context, sendPaymentProbesRequest *SendPaymentProbesRequest) (*SendPaymentProbesResponse, error)

+ SendSpontaneousPaymentProbes func(ctx context.Context, ...) (*SendSpontaneousPaymentProbesResponse, error)

+ SetNextBackupReminder func(backupReminderRequest *BackupReminderRequest) error

+ Setup func(ctx context.Context, setupRequest *SetupRequest) error

+ SignMessage func(ctx context.Context, message string) (*SignMessageResponse, error)

+ Start func(startRequest *StartRequest) error

+ Stop func() error

+ SyncWallet func() error

+ UpdateApp func(userApp *db.App, updateAppRequest *UpdateAppRequest) error

+ UpdateChannel func(ctx context.Context, updateChannelRequest *UpdateChannelRequest) error

+ type App struct

+ BudgetRenewal string

+ BudgetUsage uint64

+ CreatedAt time.Time

+ Description string

+ ExpiresAt *time.Time

+ LastEventAt *time.Time

+ MaxAmount uint64

+ Name string

+ NostrPubkey string

+ Scopes []string

+ UpdatedAt time.Time

+ type BackupReminderRequest struct

+ NextBackupReminder string

+ type BalancesResponse = lnclient.BalancesResponse

+ type BasicBackupRequest struct

+ UnlockPassword string

+ type BasicRestoreWailsRequest struct

+ UnlockPassword string

+ type ChangeUnlockPasswordRequest struct

+ CurrentUnlockPassword string

+ NewUnlockPassword string

+ type CloseChannelResponse = lnclient.CloseChannelResponse

+ type ConnectPeerRequest = lnclient.ConnectPeerRequest

+ type CreateAppRequest struct

+ BudgetRenewal string

+ ExpiresAt string

+ MaxAmount uint64

+ Name string

+ Pubkey string

+ ReturnTo string

+ Scopes []string

+ type CreateAppResponse struct

+ Name string

+ PairingSecret string

+ PairingUri string

+ Pubkey string

+ ReturnTo string

+ type EncryptedMnemonicResponse struct

+ Mnemonic string

+ type GetLogOutputRequest struct

+ MaxLen int

+ type GetLogOutputResponse struct

+ Log string

+ type InfoResponse struct

+ AlbyAccountConnected bool

+ AlbyAuthUrl string

+ AlbyUserIdentifier string

+ BackendType string

+ LatestVersion string

+ Network string

+ NextBackupReminder string

+ OAuthRedirect bool

+ Running bool

+ SetupCompleted bool

+ Unlocked bool

+ Version string

+ type ListAppsResponse struct

+ Apps []App

+ type ListTransactionsResponse = []lnclient.Transaction

+ type LookupInvoiceResponse = lnclient.Transaction

+ type MakeInvoiceRequest struct

+ Amount int64

+ Description string

+ type MakeInvoiceResponse = lnclient.Transaction

+ type NetworkGraphResponse = lnclient.NetworkGraphResponse

+ type NewInstantChannelInvoiceRequest struct

+ Amount uint64

+ LSPType string

+ LSPUrl string

+ Public bool

+ type NewInstantChannelInvoiceResponse struct

+ Fee uint64

+ IncomingLiquidity uint64

+ Invoice string

+ InvoiceAmount uint64

+ OutgoingLiquidity uint64

+ type OnchainBalanceResponse = lnclient.OnchainBalanceResponse

+ type OpenChannelRequest = lnclient.OpenChannelRequest

+ type OpenChannelResponse = lnclient.OpenChannelResponse

+ type RedeemOnchainFundsRequest struct

+ ToAddress string

+ type RedeemOnchainFundsResponse struct

+ TxId string

+ type ResetRouterRequest struct

+ Key string

+ type SendPaymentProbesRequest struct

+ Invoice string

+ type SendPaymentProbesResponse struct

+ Error string

+ type SendPaymentResponse = lnclient.PayInvoiceResponse

+ type SendSpontaneousPaymentProbesRequest struct

+ Amount uint64

+ NodeId string

+ type SendSpontaneousPaymentProbesResponse struct

+ Error string

+ type SetupRequest struct

+ BreezAPIKey string

+ CashuMintUrl string

+ GreenlightInviteCode string

+ LNBackendType string

+ LNDAddress string

+ LNDCertFile string

+ LNDCertHex string

+ LNDMacaroonFile string

+ LNDMacaroonHex string

+ Mnemonic string

+ NextBackupReminder string

+ PhoenixdAddress string

+ PhoenixdAuthorization string

+ UnlockPassword string

+ type SignMessageRequest struct

+ Message string

+ type SignMessageResponse struct

+ Message string

+ Signature string

+ type StartRequest struct

+ UnlockPassword string

+ type UnlockRequest struct

+ UnlockPassword string

+ type UpdateAppRequest struct

+ BudgetRenewal string

+ ExpiresAt string

+ MaxAmount uint64

+ Scopes []string

+ type UpdateChannelRequest = lnclient.UpdateChannelRequest

+ type User struct

+ Email string

+ type WalletCapabilitiesResponse struct

+ Methods []string

+ NotificationTypes []string

+ Scopes []string