alby

package
v1.24.7 Latest Latest
Warning

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

Go to latest
Published: Nov 14, 2026 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

View Source
const ALBY_ACCOUNT_APP_NAME = "getalby.com"
View Source
const OAuthStateBytes = 32

Variables

This section is empty.

Functions

func GenerateOAuthState added in v1.24.7

func GenerateOAuthState() (string, error)

func NewAlbyOAuthService

func NewAlbyOAuthService(db *gorm.DB, cfg config.Config, keys keys.Keys, eventPublisher events.EventPublisher) *albyOAuthService

func NewAlbyService added in v1.19.0

func NewAlbyService() *albyService

Types

type AlbyAuthUrlResponse added in v1.24.7

type AlbyAuthUrlResponse struct {
	Url string `json:"url"`
}

type AlbyInfo added in v1.8.0

type AlbyInfo struct {
	Hub              AlbyInfoHub        `json:"hub"`
	Status           string             `json:"status"`
	Healthy          bool               `json:"healthy"`
	AccountAvailable bool               `json:"accountAvailable"` // false if country is blocked (can still use Alby Hub without an Alby Account)
	Incidents        []AlbyInfoIncident `json:"incidents"`
}

type AlbyInfoHub added in v1.8.0

type AlbyInfoHub struct {
	LatestVersion      string `json:"latestVersion"`
	LatestReleaseNotes string `json:"latestReleaseNotes"`
	SwapProvider       string `json:"swapProvider"`
}

type AlbyInfoIncident added in v1.13.0

type AlbyInfoIncident struct {
	Name    string `json:"name"`
	Started string `json:"started"`
	Status  string `json:"status"`
	Impact  string `json:"impact"`
	Url     string `json:"url"`
}

type AlbyLinkAccountRequest added in v1.1.0

type AlbyLinkAccountRequest struct {
	Budget  uint64 `json:"budget"`
	Renewal string `json:"renewal"`
}

type AlbyMe

type AlbyMe struct {
	Identifier       string             `json:"identifier"`
	NPub             string             `json:"nostr_pubkey"`
	LightningAddress string             `json:"lightning_address"`
	Email            string             `json:"email"`
	Name             string             `json:"name"`
	Avatar           string             `json:"avatar"`
	KeysendPubkey    string             `json:"keysend_pubkey"`
	SharedNode       bool               `json:"shared_node"`
	Hub              AlbyMeHub          `json:"hub"`
	Subscription     AlbyMeSubscription `json:"subscription"`
}

type AlbyMeHub added in v1.1.0

type AlbyMeHub struct {
	Name   string                 `json:"name"`
	Config map[string]interface{} `json:"config"`
}

type AlbyMeSubscription added in v1.11.0

type AlbyMeSubscription struct {
	PlanCode string `json:"plan_code"`
}

type AlbyOAuthService

type AlbyOAuthService interface {
	events.EventSubscriber
	GetLSPChannelOffer(ctx context.Context) (*LSPChannelOffer, error)
	GetLSPInfo(ctx context.Context, lsp, network string) (*LSPInfo, error)
	CreateLSPOrder(ctx context.Context, lsp, network string, lspChannelRequest *LSPChannelRequest) (*LSPChannelResponse, error)
	GetAuthUrl(state string, verifier string) string
	GetUserIdentifier() (string, error)
	GetLightningAddress() (string, error)
	IsConnected(ctx context.Context) bool
	LinkAccount(ctx context.Context, lnClient lnclient.LNClient, budgetSat uint64, renewal string) error
	CallbackHandler(ctx context.Context, code string, verifier string) error
	GetMe(ctx context.Context) (*AlbyMe, error)
	UnlinkAccount(ctx context.Context) error
	RequestAutoChannel(ctx context.Context, lnClient lnclient.LNClient, isPublic bool) (*AutoChannelResponse, error)
	GetVssAuthToken(ctx context.Context, nodeIdentifier string) (string, error)
	RemoveOAuthAccessToken() error
	CreateLightningAddress(ctx context.Context, address string, appId uint) (*CreateLightningAddressResponse, error)
	DeleteLightningAddress(ctx context.Context, address string) error
	GetStories(ctx context.Context) ([]Story, error)
}

type AlbyService added in v1.19.0

type AlbyService interface {
	GetInfo(ctx context.Context) (*AlbyInfo, error)
	GetBitcoinRate(ctx context.Context, currency string) (*BitcoinRate, error)
	GetCurrencies(ctx context.Context) ([]Currency, error)
	GetChannelPeerSuggestions(ctx context.Context) ([]ChannelPeerSuggestion, error)
}

type AutoChannelRequest added in v1.3.0

type AutoChannelRequest struct {
	IsPublic bool `json:"isPublic"`
}

type AutoChannelResponse added in v1.3.0

type AutoChannelResponse struct {
	Invoice        string `json:"invoice"`
	ChannelSize    uint64 `json:"channelSize"` // deprecated
	ChannelSizeSat uint64 `json:"channelSizeSat"`
	Fee            uint64 `json:"fee"` // deprecated
	FeeSat         uint64 `json:"feeSat"`
}

type BitcoinRate added in v1.14.0

type BitcoinRate struct {
	Code      string  `json:"code"`
	Symbol    string  `json:"symbol"`
	Rate      string  `json:"rate"`
	RateFloat float64 `json:"rate_float"`
	RateCents int64   `json:"rate_cents"`
}

type ChannelPeerSuggestion

type ChannelPeerSuggestion struct {
	Network                    string  `json:"network"`
	PaymentMethod              string  `json:"paymentMethod"`
	Pubkey                     string  `json:"pubkey"`
	Host                       string  `json:"host"`
	MinimumChannelSize         uint64  `json:"minimumChannelSize"` // deprecated
	MinimumChannelSizeSat      uint64  `json:"minimumChannelSizeSat"`
	MaximumChannelSize         uint64  `json:"maximumChannelSize"` // deprecated
	MaximumChannelSizeSat      uint64  `json:"maximumChannelSizeSat"`
	MaximumChannelExpiryBlocks *uint32 `json:"maximumChannelExpiryBlocks"`
	Name                       string  `json:"name"`
	Image                      string  `json:"image"`
	Identifier                 string  `json:"identifier"`
	ContactUrl                 string  `json:"contactUrl"`
	Type                       string  `json:"type"`
	Terms                      string  `json:"terms"`
	Description                string  `json:"description"`
	Note                       string  `json:"note"`
	PublicChannelsAllowed      bool    `json:"publicChannelsAllowed"`
	NodeAddress                string  `json:"nodeAddress"`
	FeeTotalSat1m              *uint32 `json:"feeTotalSat1m"`
	FeeTotalSat2m              *uint32 `json:"feeTotalSat2m"`
	FeeTotalSat3m              *uint32 `json:"feeTotalSat3m"`
}

type CreateLightningAddressResponse added in v1.18.0

type CreateLightningAddressResponse struct {
	Address     string `json:"address"`
	FullAddress string `json:"full_address"`
}

type Currency added in v1.22.0

type Currency struct {
	IsoCode  string `json:"iso_code"`
	Symbol   string `json:"symbol"`
	Name     string `json:"name"`
	Priority int    `json:"priority"`
}

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message"`
}

type LSPChannelOffer added in v1.19.0

type LSPChannelOffer struct {
	LspName              string `json:"lspName"`
	LspContactUrl        string `json:"lspContactUrl"`
	LspBalanceSat        uint64 `json:"lspBalanceSat"`
	FeeTotalSat          uint64 `json:"feeTotalSat"`
	FeeTotalUsd          uint64 `json:"feeTotalUsd"` // in cents
	CurrentPaymentMethod string `json:"currentPaymentMethod"`
	Terms                string `json:"terms"`
	LspDescription       string `json:"lspDescription"`
}

type LSPChannelPayment added in v1.20.0

type LSPChannelPayment struct {
	Bolt11 LSPChannelPaymentBolt11 `json:"bolt11"`
}

type LSPChannelPaymentBolt11 added in v1.20.0

type LSPChannelPaymentBolt11 struct {
	Invoice     string `json:"invoice"`
	FeeTotalSat string `json:"fee_total_sat"`
}

type LSPChannelRequest added in v1.20.0

type LSPChannelRequest struct {
	PublicKey                    string `json:"public_key"`
	LSPBalanceSat                string `json:"lsp_balance_sat"`
	ClientBalanceSat             string `json:"client_balance_sat"`
	RequiredChannelConfirmations uint64 `json:"required_channel_confirmations"`
	FundingConfirmsWithinBlocks  uint64 `json:"funding_confirms_within_blocks"`
	ChannelExpiryBlocks          uint64 `json:"channel_expiry_blocks"`
	Token                        string `json:"token"`
	RefundOnchainAddress         string `json:"refund_onchain_address"`
	AnnounceChannel              bool   `json:"announce_channel"`
}

type LSPChannelResponse added in v1.20.0

type LSPChannelResponse struct {
	Payment *LSPChannelPayment `json:"payment"`
}

type LSPInfo added in v1.20.0

type LSPInfo struct {
	Pubkey                          string
	Address                         string
	Port                            uint16
	MaxChannelExpiryBlocks          uint64
	MinRequiredChannelConfirmations uint64
	MinFundingConfirmsWithinBlocks  uint64
}

type Story added in v1.23.0

type Story struct {
	ID      int       `json:"id"`
	Title   string    `json:"title"`
	Avatar  string    `json:"avatar"`
	VideoID string    `json:"videoId,omitempty"`
	Cta     *StoryCta `json:"cta,omitempty"`
}

type StoryCta added in v1.23.0

type StoryCta struct {
	Label        string `json:"label"`
	URL          string `json:"url"`
	OpenInNewTab bool   `json:"openInNewTab"`
}

Jump to

Keyboard shortcuts

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