-
Notifications
You must be signed in to change notification settings - Fork 58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[feature] Use LNC to connect to the LND node #98
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
8dde304
config: support config for LNC connections
positiveblue baec262
lnc: add lnc session package
positiveblue ea2fb83
sqlc: add table+queries for sessions
positiveblue 0e02476
aperturedb: implement lnc sessions store
positiveblue 3d53f20
multi: use `InvoiceClient` in `NewLndChallenger`
positiveblue a04f3b1
challenger: custom context for LightningClient methods
positiveblue 4e81f5d
challenger: move challenger logic to its own package
positiveblue a6ff4a9
challenger: add `LNCChallenger`
positiveblue aa9ca46
aperture: initialize server with the configured authenticator
positiveblue File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,218 @@ | ||
| package aperturedb | ||
|
|
||
| import ( | ||
| "context" | ||
| "database/sql" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/btcsuite/btcd/btcec/v2" | ||
| "github.com/lightninglabs/aperture/aperturedb/sqlc" | ||
| "github.com/lightninglabs/aperture/lnc" | ||
| "github.com/lightningnetwork/lnd/clock" | ||
| ) | ||
|
|
||
| type ( | ||
| NewLNCSession = sqlc.InsertSessionParams | ||
|
|
||
| SetRemoteParams = sqlc.SetRemotePubKeyParams | ||
|
|
||
| SetExpiryParams = sqlc.SetExpiryParams | ||
| ) | ||
|
|
||
| // LNCSessionsDB is an interface that defines the set of operations that can be | ||
| // executed agaist the lnc sessions database. | ||
| type LNCSessionsDB interface { | ||
| // InsertLNCSession inserts a new session into the database. | ||
| InsertSession(ctx context.Context, arg NewLNCSession) error | ||
|
|
||
| // GetLNCSession returns the session tagged with the given passphrase | ||
| // entropy. | ||
| GetSession(ctx context.Context, | ||
| passphraseEntropy []byte) (sqlc.LncSession, error) | ||
|
|
||
| // SetRemotePubKey sets the remote public key for the session. | ||
| SetRemotePubKey(ctx context.Context, | ||
| arg SetRemoteParams) error | ||
|
|
||
| // SetExpiry sets the expiry for the session. | ||
| SetExpiry(ctx context.Context, arg SetExpiryParams) error | ||
| } | ||
|
|
||
| // LNCSessionsDBTxOptions defines the set of db txn options the LNCSessionsDB | ||
| // understands. | ||
| type LNCSessionsDBTxOptions struct { | ||
| // readOnly governs if a read only transaction is needed or not. | ||
| readOnly bool | ||
| } | ||
|
|
||
| // ReadOnly returns true if the transaction should be read only. | ||
| // | ||
| // NOTE: This implements the TxOptions | ||
| func (a *LNCSessionsDBTxOptions) ReadOnly() bool { | ||
| return a.readOnly | ||
| } | ||
|
|
||
| // NewLNCSessionsDBReadTx creates a new read transaction option set. | ||
| func NewLNCSessionsDBReadTx() LNCSessionsDBTxOptions { | ||
| return LNCSessionsDBTxOptions{ | ||
| readOnly: true, | ||
| } | ||
| } | ||
|
|
||
| // BatchedLNCSessionsDB is a version of the LNCSecretsDB that's capable of | ||
| // batched database operations. | ||
| type BatchedLNCSessionsDB interface { | ||
| LNCSessionsDB | ||
|
|
||
| BatchedTx[LNCSessionsDB] | ||
| } | ||
|
|
||
| // LNCSessionsStore represents a storage backend. | ||
| type LNCSessionsStore struct { | ||
| db BatchedLNCSessionsDB | ||
| clock clock.Clock | ||
| } | ||
|
|
||
| // NewSecretsStore creates a new SecretsStore instance given a open | ||
| // BatchedSecretsDB storage backend. | ||
| func NewLNCSessionsStore(db BatchedLNCSessionsDB) *LNCSessionsStore { | ||
| return &LNCSessionsStore{ | ||
| db: db, | ||
| clock: clock.NewDefaultClock(), | ||
| } | ||
| } | ||
|
|
||
| // AddSession adds a new session to the database. | ||
| func (l *LNCSessionsStore) AddSession(ctx context.Context, | ||
| session *lnc.Session) error { | ||
|
|
||
| if session.LocalStaticPrivKey == nil { | ||
| return fmt.Errorf("local static private key is required") | ||
| } | ||
|
|
||
| localPrivKey := session.LocalStaticPrivKey.Serialize() | ||
| createdAt := l.clock.Now().UTC().Truncate(time.Microsecond) | ||
|
|
||
| var writeTxOpts LNCSessionsDBTxOptions | ||
| err := l.db.ExecTx(ctx, &writeTxOpts, func(tx LNCSessionsDB) error { | ||
| params := sqlc.InsertSessionParams{ | ||
| PassphraseWords: session.PassphraseWords, | ||
| PassphraseEntropy: session.PassphraseEntropy, | ||
| LocalStaticPrivKey: localPrivKey, | ||
| MailboxAddr: session.MailboxAddr, | ||
| CreatedAt: createdAt, | ||
| DevServer: session.DevServer, | ||
| } | ||
|
|
||
| return tx.InsertSession(ctx, params) | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to insert new session: %v", err) | ||
| } | ||
|
|
||
| session.CreatedAt = createdAt | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // GetSession returns the session tagged with the given label. | ||
| func (l *LNCSessionsStore) GetSession(ctx context.Context, | ||
| passphraseEntropy []byte) (*lnc.Session, error) { | ||
|
|
||
| var session *lnc.Session | ||
|
|
||
| readTx := NewLNCSessionsDBReadTx() | ||
| err := l.db.ExecTx(ctx, &readTx, func(tx LNCSessionsDB) error { | ||
| dbSession, err := tx.GetSession(ctx, passphraseEntropy) | ||
| switch { | ||
| case err == sql.ErrNoRows: | ||
| return lnc.ErrSessionNotFound | ||
|
|
||
| case err != nil: | ||
| return err | ||
|
|
||
| } | ||
|
|
||
| privKey, _ := btcec.PrivKeyFromBytes( | ||
| dbSession.LocalStaticPrivKey, | ||
| ) | ||
| session = &lnc.Session{ | ||
| PassphraseWords: dbSession.PassphraseWords, | ||
| PassphraseEntropy: dbSession.PassphraseEntropy, | ||
| LocalStaticPrivKey: privKey, | ||
| MailboxAddr: dbSession.MailboxAddr, | ||
| CreatedAt: dbSession.CreatedAt, | ||
| DevServer: dbSession.DevServer, | ||
| } | ||
|
|
||
| if dbSession.RemoteStaticPubKey != nil { | ||
| pubKey, err := btcec.ParsePubKey( | ||
| dbSession.RemoteStaticPubKey, | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to parse remote "+ | ||
| "public key for session(%x): %w", | ||
| dbSession.PassphraseEntropy, err) | ||
| } | ||
|
|
||
| session.RemoteStaticPubKey = pubKey | ||
| } | ||
|
|
||
| if dbSession.Expiry.Valid { | ||
| expiry := dbSession.Expiry.Time | ||
| session.Expiry = &expiry | ||
| } | ||
|
|
||
| return nil | ||
| }) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get session: %w", err) | ||
| } | ||
|
|
||
| return session, nil | ||
| } | ||
|
|
||
| // SetRemotePubKey sets the remote public key for a session. | ||
| func (l *LNCSessionsStore) SetRemotePubKey(ctx context.Context, | ||
| passphraseEntropy, remotePubKey []byte) error { | ||
|
|
||
| var writeTxOpts LNCSessionsDBTxOptions | ||
| err := l.db.ExecTx(ctx, &writeTxOpts, func(tx LNCSessionsDB) error { | ||
| params := SetRemoteParams{ | ||
| PassphraseEntropy: passphraseEntropy, | ||
| RemoteStaticPubKey: remotePubKey, | ||
| } | ||
| return tx.SetRemotePubKey(ctx, params) | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to set remote pub key to "+ | ||
| "session(%x): %w", passphraseEntropy, err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // SetExpiry sets the expiry time for a session. | ||
| func (l *LNCSessionsStore) SetExpiry(ctx context.Context, | ||
| passphraseEntropy []byte, expiry time.Time) error { | ||
|
|
||
| var writeTxOpts LNCSessionsDBTxOptions | ||
| err := l.db.ExecTx(ctx, &writeTxOpts, func(tx LNCSessionsDB) error { | ||
| params := SetExpiryParams{ | ||
| PassphraseEntropy: passphraseEntropy, | ||
| Expiry: sql.NullTime{ | ||
| Time: expiry, | ||
| Valid: true, | ||
| }, | ||
| } | ||
|
|
||
| return tx.SetExpiry(ctx, params) | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to set expiry time to session(%x): "+ | ||
| "%w", passphraseEntropy, err) | ||
| } | ||
|
|
||
| return nil | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non-blocking, but in the future we can insert relevant endpoint/context information here so someone can build a UI/dashboard on top of lnd/aperture to do things like track the amount earned from a given endpoint, etc.
To do this, we'd need to expose the memo as part of the challenger interface, as only much later in the pipeline do we have the full request context information.