Skip to content

Commit

Permalink
multi: add RawClientWithMacAuth to every client
Browse files Browse the repository at this point in the history
  • Loading branch information
guggero committed Jul 24, 2024
1 parent 201950e commit a676c76
Show file tree
Hide file tree
Showing 10 changed files with 142 additions and 3 deletions.
15 changes: 15 additions & 0 deletions chainkit_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import (

// ChainKitClient exposes chain functionality.
type ChainKitClient interface {
ServiceClient[chainrpc.ChainKitClient]

// GetBlock returns a block given the corresponding block hash.
GetBlock(ctx context.Context, hash chainhash.Hash) (*wire.MsgBlock,
error)
Expand Down Expand Up @@ -41,6 +43,10 @@ type chainKitClient struct {
wg sync.WaitGroup
}

// A compile time check to ensure that chainKitClient implements the
// ChainKitClient interface.
var _ ChainKitClient = (*chainKitClient)(nil)

func newChainKitClient(conn grpc.ClientConnInterface,
chainMac serializedMacaroon, timeout time.Duration) *chainKitClient {

Expand All @@ -55,6 +61,15 @@ func (s *chainKitClient) WaitForFinished() {
s.wg.Wait()
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (s *chainKitClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
chainrpc.ChainKitClient) {

return s.chainMac.WithMacaroonAuth(parentCtx), s.timeout, s.client
}

// GetBlock returns a block given the corresponding block hash.
func (s *chainKitClient) GetBlock(ctxParent context.Context,
hash chainhash.Hash) (*wire.MsgBlock, error) {
Expand Down
15 changes: 15 additions & 0 deletions chainnotifier_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ func WithReOrgChan(reOrgChan chan struct{}) NotifierOption {

// ChainNotifierClient exposes base lightning functionality.
type ChainNotifierClient interface {
ServiceClient[chainrpc.ChainNotifierClient]

RegisterBlockEpochNtfn(ctx context.Context) (
chan int32, chan error, error)

Expand All @@ -81,6 +83,10 @@ type chainNotifierClient struct {
wg sync.WaitGroup
}

// A compile time check to ensure that chainNotifierClient implements the
// ChainNotifierClient interface.
var _ ChainNotifierClient = (*chainNotifierClient)(nil)

func newChainNotifierClient(conn grpc.ClientConnInterface,
chainMac serializedMacaroon, timeout time.Duration) *chainNotifierClient {

Expand All @@ -95,6 +101,15 @@ func (s *chainNotifierClient) WaitForFinished() {
s.wg.Wait()
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (s *chainNotifierClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
chainrpc.ChainNotifierClient) {

return s.chainMac.WithMacaroonAuth(parentCtx), s.timeout, s.client
}

func (s *chainNotifierClient) RegisterSpendNtfn(ctx context.Context,
outpoint *wire.OutPoint, pkScript []byte, heightHint int32) (
chan *chainntnfs.SpendDetail, chan error, error) {
Expand Down
15 changes: 15 additions & 0 deletions invoices_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ type InvoiceHtlcModifyHandler func(context.Context,

// InvoicesClient exposes invoice functionality.
type InvoicesClient interface {
ServiceClient[invoicesrpc.InvoicesClient]

SubscribeSingleInvoice(ctx context.Context, hash lntypes.Hash) (
<-chan InvoiceUpdate, <-chan error, error)

Expand Down Expand Up @@ -75,6 +77,10 @@ type invoicesClient struct {
wg sync.WaitGroup
}

// A compile time check to ensure that invoicesClient implements the
// InvoicesClient interface.
var _ InvoicesClient = (*invoicesClient)(nil)

func newInvoicesClient(conn grpc.ClientConnInterface,
invoiceMac serializedMacaroon, timeout time.Duration) *invoicesClient {

Expand All @@ -94,6 +100,15 @@ func (s *invoicesClient) WaitForFinished() {
s.wg.Wait()
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (s *invoicesClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
invoicesrpc.InvoicesClient) {

return s.invoiceMac.WithMacaroonAuth(parentCtx), s.timeout, s.client
}

func (s *invoicesClient) SettleInvoice(ctx context.Context,
preimage lntypes.Preimage) error {

Expand Down
15 changes: 15 additions & 0 deletions lightning_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ func WithRemoteReserve(reserve uint64) OpenChannelOption {

// LightningClient exposes base lightning functionality.
type LightningClient interface {
ServiceClient[lnrpc.LightningClient]

PayInvoice(ctx context.Context, invoice string,
maxFee btcutil.Amount,
outgoingChannel *uint64) chan PaymentResult
Expand Down Expand Up @@ -1321,6 +1323,10 @@ type lightningClient struct {
adminMac serializedMacaroon
}

// A compile time check to ensure that lightningClient implements the
// LightningClient interface.
var _ LightningClient = (*lightningClient)(nil)

func newLightningClient(conn grpc.ClientConnInterface, timeout time.Duration,
params *chaincfg.Params, adminMac serializedMacaroon) *lightningClient {

Expand All @@ -1344,6 +1350,15 @@ func (s *lightningClient) WaitForFinished() {
s.wg.Wait()
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (s *lightningClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
lnrpc.LightningClient) {

return s.adminMac.WithMacaroonAuth(parentCtx), s.timeout, s.client
}

// WalletBalance returns a summary of the node's wallet balance.
func (s *lightningClient) WalletBalance(ctx context.Context) (
*WalletBalance, error) {
Expand Down
8 changes: 8 additions & 0 deletions lnd_services.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,14 @@ var (
}
)

// ServiceClient is an interface that all lnd service clients need to implement.
type ServiceClient[T any] interface {
// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
RawClientWithMacAuth(parentCtx context.Context) (context.Context,
time.Duration, T)
}

// LndServicesConfig holds all configuration settings that are needed to connect
// to an lnd node.
type LndServicesConfig struct {
Expand Down
15 changes: 15 additions & 0 deletions router_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ var ErrRouterShuttingDown = errors.New("router shutting down")

// RouterClient exposes payment functionality.
type RouterClient interface {
ServiceClient[routerrpc.RouterClient]

// SendPayment attempts to route a payment to the final destination. The
// call returns a payment update stream and an error stream.
SendPayment(ctx context.Context, request SendPaymentRequest) (
Expand Down Expand Up @@ -401,6 +403,10 @@ type routerClient struct {
wg sync.WaitGroup
}

// A compile time check to ensure that routerClient implements the RouterClient
// interface.
var _ RouterClient = (*routerClient)(nil)

func newRouterClient(conn grpc.ClientConnInterface,
routerKitMac serializedMacaroon, timeout time.Duration) *routerClient {

Expand All @@ -422,6 +428,15 @@ func (r *routerClient) WaitForFinished() {
r.wg.Wait()
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (r *routerClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
routerrpc.RouterClient) {

return r.routerKitMac.WithMacaroonAuth(parentCtx), r.timeout, r.client
}

// SendPayment attempts to route a payment to the final destination. The call
// returns a payment update stream and an error stream.
func (r *routerClient) SendPayment(ctx context.Context,
Expand Down
15 changes: 15 additions & 0 deletions signer_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import (

// SignerClient exposes sign functionality.
type SignerClient interface {
ServiceClient[signrpc.SignerClient]

// SignOutputRaw is a method that can be used to generate a signature
// for a set of inputs/outputs to a transaction. Each request specifies
// details concerning how the outputs should be signed, which keys they
Expand Down Expand Up @@ -190,6 +192,10 @@ type signerClient struct {
timeout time.Duration
}

// A compile time check to ensure that signerClient implements the SignerClient
// interface.
var _ SignerClient = (*signerClient)(nil)

func newSignerClient(conn grpc.ClientConnInterface,
signerMac serializedMacaroon, timeout time.Duration) *signerClient {

Expand All @@ -200,6 +206,15 @@ func newSignerClient(conn grpc.ClientConnInterface,
}
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (s *signerClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
signrpc.SignerClient) {

return s.signerMac.WithMacaroonAuth(parentCtx), s.timeout, s.client
}

func marshallSignDescriptors(
signDescriptors []*SignDescriptor) []*signrpc.SignDescriptor {

Expand Down
15 changes: 15 additions & 0 deletions state_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import (

// StateClient exposes base lightning functionality.
type StateClient interface {
ServiceClient[lnrpc.StateClient]

// SubscribeState subscribes to the current state of the wallet.
SubscribeState(ctx context.Context) (chan WalletState, chan error,
error)
Expand Down Expand Up @@ -96,6 +98,10 @@ type stateClient struct {
wg sync.WaitGroup
}

// A compile time check to ensure that stateClient implements the StateClient
// interface.
var _ StateClient = (*stateClient)(nil)

// newStateClient returns a new stateClient.
func newStateClient(conn grpc.ClientConnInterface,
readonlyMac serializedMacaroon, timeout time.Duration) *stateClient {
Expand All @@ -112,6 +118,15 @@ func (s *stateClient) WaitForFinished() {
s.wg.Wait()
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (s *stateClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
lnrpc.StateClient) {

return s.readonlyMac.WithMacaroonAuth(parentCtx), s.timeout, s.client
}

// SubscribeState subscribes to the current state of the wallet.
func (s *stateClient) SubscribeState(ctx context.Context) (chan WalletState,
chan error, error) {
Expand Down
19 changes: 17 additions & 2 deletions versioner_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import (

// VersionerClient exposes the version of lnd.
type VersionerClient interface {
ServiceClient[verrpc.VersionerClient]

// GetVersion returns the version and build information of the lnd
// daemon.
GetVersion(ctx context.Context) (*verrpc.Version, error)
Expand All @@ -23,6 +25,10 @@ type versionerClient struct {
timeout time.Duration
}

// A compile time check to ensure that versionerClient implements the
// VersionerClient interface.
var _ VersionerClient = (*versionerClient)(nil)

func newVersionerClient(conn grpc.ClientConnInterface,
readonlyMac serializedMacaroon, timeout time.Duration) *versionerClient {

Expand All @@ -33,6 +39,15 @@ func newVersionerClient(conn grpc.ClientConnInterface,
}
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (v *versionerClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
verrpc.VersionerClient) {

return v.readonlyMac.WithMacaroonAuth(parentCtx), v.timeout, v.client
}

// GetVersion returns the version and build information of the lnd
// daemon.
//
Expand All @@ -47,15 +62,15 @@ func (v *versionerClient) GetVersion(ctx context.Context) (*verrpc.Version,
return v.client.GetVersion(rpcCtx, &verrpc.VersionRequest{})
}

// VersionString returns a nice, human readable string of a version returned by
// VersionString returns a nice, human-readable string of a version returned by
// the VersionerClient, including all build tags.
func VersionString(version *verrpc.Version) string {
short := VersionStringShort(version)
enabledTags := strings.Join(version.BuildTags, ",")
return fmt.Sprintf("%s, build tags '%s'", short, enabledTags)
}

// VersionStringShort returns a nice, human readable string of a version
// VersionStringShort returns a nice, human-readable string of a version
// returned by the VersionerClient.
func VersionStringShort(version *verrpc.Version) string {
versionStr := fmt.Sprintf(
Expand Down
13 changes: 12 additions & 1 deletion walletkit_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ func WithUnspentUnconfirmedOnly() ListUnspentOption {

// WalletKitClient exposes wallet functionality.
type WalletKitClient interface {
ServiceClient[walletrpc.WalletKitClient]

// ListUnspent returns a list of all utxos spendable by the wallet with
// a number of confirmations between the specified minimum and maximum.
ListUnspent(ctx context.Context, minConfs, maxConfs int32,
Expand Down Expand Up @@ -214,7 +216,7 @@ type walletKitClient struct {
params *chaincfg.Params
}

// A compile-time constraint to ensure walletKitclient satisfies the
// A compile time check to ensure that walletKitClient implements the
// WalletKitClient interface.
var _ WalletKitClient = (*walletKitClient)(nil)

Expand All @@ -230,6 +232,15 @@ func newWalletKitClient(conn grpc.ClientConnInterface,
}
}

// RawClientWithMacAuth returns a context with the proper macaroon
// authentication, the default RPC timeout, and the raw client.
func (m *walletKitClient) RawClientWithMacAuth(
parentCtx context.Context) (context.Context, time.Duration,
walletrpc.WalletKitClient) {

return m.walletKitMac.WithMacaroonAuth(parentCtx), m.timeout, m.client
}

// ListUnspent returns a list of all utxos spendable by the wallet with a number
// of confirmations between the specified minimum and maximum.
func (m *walletKitClient) ListUnspent(ctx context.Context, minConfs,
Expand Down

0 comments on commit a676c76

Please sign in to comment.