lnrpc: add new WalletKit sub-RPC server by Roasbeef · Pull Request #2093 · lightningnetwork/lnd

Roasbeef · 2018-10-25T02:35:14Z

In this PR, we add a new sub-RPC server to the existing set of gRPC
servers. This new sub-RPC server is the WalletKit. It's a utility
toolkit that contains method which allow clients to perform common
interactions with a wallet such as getting a new address, or sending a
transaction. It also includes some supplementary actions such as fee
estimation.

One thing to note in the RPC file is that we import the existing
signer.proto file in order to get at some existing proto definitions
which are useful in our use case.

Depends on #2081.

joostjager · 2018-11-05T13:09:57Z

+    The number of satoshis per kilo weight that should be used when crafting
+    this transaction.
+    */
+    int64 sat_per_kw = 1;


In addition to this, we need a maximum total fee as well. We don't know how many inputs are needed, so the fee can potentially become (too) large.

So a max for the request, or a max in the response? Once you know the fee rate, you can use the weight estimator to compute what the final fee will be.

I was thinking a max for the request. How can I use the weight estimator if I don't know how many inputs are needed?

Ah OK, IIRC there're two types of fee estimates we care about:

What should the fee be for a transaction I custom craft myself

What's an estimate for the transaction fee if I instruct the wallet to create a certain number of outputs

This PR as is gives us #1, for #2 there's #1228.

I am suggesting 3. Set a hard cap on the actually paid tx fee if I instruct the wallet to create a certain nof outputs.

Gotcha, will make an issue to track this as this can be added in a new PR (since it also requires wallet modifications).

joostjager · 2018-11-05T13:13:02Z

+    attempt to re-broadcast the transaction on start up, until it enters the
+    chain.
+    */
+    rpc PublishTransaction(Transaction) returns (PublishResponse);


How is this going to work with the rebroadcaster? It needs sign descriptors too.

Suggestion: instead of PublishTransaction, this could be SendInputs which takes sign descriptors.

So just to check in again, I think we're find with PublishTransaction and may follow up with the two-stage craft+sign process?

Yes indeed, we leave it for a follow up.

joostjager · 2018-11-16T09:11:59Z

Need a way to persist the SendOutputs tx before it is published, to make sure we never accidentally pay to the same output again.

joostjager · 2018-12-03T09:23:11Z

+    The number of satoshis per kilo weight that should be used when crafting
+    this transaction.
+    */
+    int64 sat_per_kw = 1;


I was thinking a max for the request. How can I use the weight estimator if I don't know how many inputs are needed?

joostjager · 2018-12-03T09:23:51Z

+    attempt to re-broadcast the transaction on start up, until it enters the
+    chain.
+    */
+    rpc PublishTransaction(Transaction) returns (PublishResponse);


Yes indeed, we leave it for a follow up.

joostjager · 2018-12-03T09:25:30Z

+			KeyLoc: &signrpc.KeyLocator{
+				KeyFamily: int32(keyDesc.Family),
+				KeyIndex:  int32(keyDesc.Index),
+			},


Pubkey bytes need to be returned? It looks like it currently just returns the request values.

joostjager · 2018-12-04T10:48:33Z

+	switch {
+	case config.MacService == nil:
+		return nil, nil, fmt.Errorf("MacService must be set to " +
+			"create WalletKit RPC server")


It seems walletkit cannot be used with nomacaroons

Roasbeef · 2018-12-05T02:15:19Z

Addressed all lingering comments, PTAL!

cfromknecht · 2018-12-05T02:19:55Z

needs different log tag

cfromknecht · 2018-12-05T02:20:56Z

nit: register -> registered

cfromknecht

couple last things from a prior review that weren't addressed

cfromknecht · 2018-12-06T00:11:38Z

started, stopped, and quit don't do anything, they can be removed

cfromknecht · 2018-12-06T00:11:57Z

Start() can just return nil

cfromknecht · 2018-12-06T00:12:07Z

Stop can just return nil

joostjager · 2018-12-06T06:51:31Z

Didn't you want to add signer permission to the admin macaroon in this pr too?

wpaulino · 2018-12-06T07:17:49Z

Suggested change

log.Infof("Making macaroons for WaleltKit RPC Server at: %v",

log.Infof("Baking macaroons for WalletKit RPC Server at: %v",

😛

In this commit, we add a new sub-RPC server to the existing set of gRPC servers. This new sub-RPC server is the WalletKit. It's a utility toolkit that contains method which allow clients to perform common interactions with a wallet such as getting a new address, or sending a transaction. It also includes some supplementary actions such as fee estimation. One thing to note in the RPC file is that we _import_ the existing signer.proto file in order to get at some existing proto definitions which are useful in our use case.

In this commit, we implement the newly defiend WalletKitServer gRPC service. We use the same template w.r.t build tags as the existing signrpc service.

…verConfigs

In this commit, we extend the admin macaroon with signer capabilities in order to allow it to be used with the new signer sub-server. As a result, users will need to clear out their old macaroons in order to have the new improved admin macaroon generated. In the future, we may want to restructure the way the admin macaroon functions: rather than white listing each of these entities and operations, we can instead add a catch all capability. This capability will instead allow access to any call, as each new call would be modified to permit this capabilities and no others.

Roasbeef · 2018-12-07T00:26:08Z

Final comments addressed!

cfromknecht

LGTM 🎉

joostjager reviewed Oct 29, 2018

View reviewed changes

Comment thread lnrpc/walletrpc/walletkit_server.go

Roasbeef added enhancement Improvements to existing features / behaviour gRPC P2 should be fixed if one has time labels Oct 31, 2018

joostjager reviewed Nov 5, 2018

View reviewed changes

Comment thread lnrpc/walletrpc/walletkit.proto Outdated

joostjager reviewed Nov 5, 2018

View reviewed changes

Roasbeef force-pushed the walletkit-service branch 2 times, most recently from b505b31 to 3c545bd Compare December 1, 2018 01:15

joostjager reviewed Dec 3, 2018

View reviewed changes

joostjager reviewed Dec 4, 2018

View reviewed changes

Roasbeef force-pushed the walletkit-service branch from 7963427 to 9c23d2c Compare December 5, 2018 02:15

cfromknecht reviewed Dec 5, 2018

View reviewed changes

Roasbeef force-pushed the walletkit-service branch from 9c23d2c to 60b597c Compare December 5, 2018 23:58

cfromknecht reviewed Dec 6, 2018

View reviewed changes

wpaulino reviewed Dec 6, 2018

View reviewed changes

Roasbeef added 7 commits December 6, 2018 16:24

lnrpc/walletrpc: implement the WalletKitServer gRPC service

406fd2a

In this commit, we implement the newly defiend WalletKitServer gRPC service. We use the same template w.r.t build tags as the existing signrpc service.

chainregistry: add the keyRing and walletController to chainControl

b492114

config: add a new entry for the WalletKit sub-RPC server to subRpcSer…

14ca3bb

…verConfigs

log: wire up the new WalletKit logger

8446980

lnrpc: remove oneof from signrpc.KeyDescriptor

273dee6

Roasbeef force-pushed the walletkit-service branch from 60b597c to 363b992 Compare December 7, 2018 00:26

cfromknecht approved these changes Dec 7, 2018

View reviewed changes

Roasbeef merged commit eb16427 into lightningnetwork:master Dec 7, 2018

	log.Infof("Making macaroons for WaleltKit RPC Server at: %v",
	log.Infof("Baking macaroons for WalletKit RPC Server at: %v",

Conversation

Roasbeef commented Oct 25, 2018

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Roasbeef Dec 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joostjager commented Nov 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Roasbeef commented Dec 5, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cfromknecht left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joostjager commented Dec 6, 2018

Uh oh!

wpaulino Dec 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Roasbeef commented Dec 7, 2018

Uh oh!

cfromknecht left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Roasbeef Dec 5, 2018 •

edited

Loading

wpaulino Dec 6, 2018 •

edited

Loading