rpcclient: Export symbols needed for custom commands #1457

JeremyRand · 2019-07-24T07:25:17Z

I'm not particularly familiar with the btcsuite codebase yet, so hopefully I didn't break anything with this patch. (I assume I'll notice quickly if Travis complains.)

2b1eed8 Switch to new rpcclient based on latest upstream Conformal (JeremyRand) Pull request description: Namecoin's fork of Conformal's RPC client library is ancient and unmaintained; switching to upstream eliminates a major source of potential bugs (and known bugs, e.g. the ConsensusJ and Electrum compatibility bugs that we had to patch). Fixes #9 TODO: - [ ] Wait for Conformal to merge btcsuite/btcd#1457 - [ ] Wait for Conformal to merge btcsuite/btcd#1460 - [x] Push `name_show` support for `ncjson` and `ncrpcclient` - [x] Implement cookie authentication - [x] Test cookie authentication ACKs for commit 2b1eed: Tree-SHA512: 157780613661af240d83a78d66386c66fcfeed0700088d263a20389c45b200db1b651ea985f345de2ac2f250bdafcc4cd5901579e9f5a97ddc13e77e7a7bcf39

octobocto · 2019-12-06T10:48:32Z

What is the motivation for this change though? As far as I can tell, it isn't used anywhere

torkelrogstad · 2019-12-06T12:25:11Z

A use case is implementing a RPC for an unreleased version of Core/btcd, or simply to add a RPC locally which isn't available in rpcclient yet. Concept ACK, would be nice with some documentation around how to add a custom comand.

JeremyRand · 2019-12-09T02:17:52Z

would be nice with some documentation around how to add a custom comand.

@torkelrogstad Namecoin is adding custom commands in these repos:

Should be pretty easy to figure out how to do it based on the code in those two repos. If desired, I could add links to those two repos to the readme or something.

torkelrogstad · 2019-12-09T09:04:48Z

I think linking to code in a different repo is not really something we should do here. A simple demonstration of how to add a RPC would be more than enough, should be 20 lines of code or so?

torkelrogstad · 2019-12-09T09:05:05Z

Also, this PR needs a rebase

JeremyRand · 2019-12-17T03:06:39Z

I think linking to code in a different repo is not really something we should do here. A simple demonstration of how to add a RPC would be more than enough, should be 20 lines of code or so?

@torkelrogstad No objection from me. I probably won't be able to get to it until early January though. (Ditto for the rebase.)

JeremyRand · 2020-01-05T22:42:19Z

Rebased. @torkelrogstad Should the sample code for using a custom command go in the rpcclient/examples folder, or is there a better place for it? Should that sample code use a fictional RPC method, a real altcoin RPC method (I'd probably do Namecoin's name_show), or is there some other approach for demonstrating it?

torkelrogstad · 2020-01-06T08:06:14Z

I think rpcclient/examples makes sense, and also doing a real example (that people could run if they have a local Namecoin node) would be cool

jakesylvestre · 2020-03-04T13:14:48Z

@jcvernaleo (as per #1530)

low priority
enhancement

Probably needs some work as per @torkelrogstad

JeremyRand · 2020-05-19T19:18:48Z

Rebased and added example. @torkelrogstad How does it look now? (I'm not 100% sure about the CI failure, but at first glance it looks unrelated to this PR.)

torkelrogstad

Couple of comments on the wording in the README, other than that this looks good to me. Also looks like there's a CI failure

torkelrogstad · 2020-05-20T07:14:41Z

rpcclient/examples/customcommand/README.md

+```bash
+$ cd $GOPATH/src/github.com/btcsuite/btcd/rpcclient/examples/customcommand
+$ go run *.go
+```


This example assumes that the user is using Go modules, which is no longer the default with newer Go versions. I'd suggest replacing 9-13 with:

The first step is to clone the btcd repo:

$ git clone github.com/btcsuite/btcd $ cd btcd

And then replace 23-28 with:

Finally, run the example:

$ go run rpcclient/examples/customcommand/main.go

This Readme is copied nearly verbatim from the bitcoincorehttp example's Readme; for consistency I prefer not to make the requested changes as part of this PR (but I'd be fine with those changes as a separate PR that covers both examples' Readmes).

I agree with the changes suggested here, but I'm happy to take care of it in a separate PR.

JeremyRand · 2020-05-21T06:24:37Z

Triggering a CI rebuild to see if the failure was a fluke...

JeremyRand · 2020-05-25T19:57:11Z

Triggering a CI rebuild to see if the failure was a fluke...

Yes, CI appears to have succeeded this time.

coveralls · 2020-12-21T04:29:44Z

Pull Request Test Coverage Report for Build 993591029

0 of 322 (0.0%) changed or added relevant lines in 9 files are covered.
3 unchanged lines in 1 file lost coverage.
Overall coverage decreased (-0.008%) to 52.892%

Changes Missing Coverage	Changed/Added Lines	%
rpcclient/rawrequest.go	2	0.0%
rpcclient/extensions.go	18	0.0%
rpcclient/notify.go	18	0.0%
rpcclient/net.go	20	0.0%
rpcclient/infrastructure.go	23	0.0%
rpcclient/mining.go	24	0.0%
rpcclient/rawtransactions.go	27	0.0%
rpcclient/chain.go	56	0.0%
rpcclient/wallet.go	134	0.0%

Files with Coverage Reduction	New Missed Lines	%
btcec/signature.go	3	92.76%

Totals
Change from base Build 896856960:	-0.008%
Covered Lines:	21015
Relevant Lines:	39732

💛 - Coveralls

JeremyRand · 2020-12-21T04:30:07Z

Rebased to fix merge conflicts. Would be great if this can be reviewed and/or merged.

torkelrogstad

rpcclient/examples/customcommand/main.go needs to be formatted with gofmt

torkelrogstad · 2020-12-27T13:28:26Z

rpcclient/infrastructure.go

-func (c *Client) sendCmdAndWait(cmd interface{}) (interface{}, error) {
+func (c *Client) SendCmdAndWait(cmd interface{}) (interface{}, error) {
 	// Marshal the command to JSON-RPC, send it to the connected server, and
 	// wait for a response on the returned channel.
-	return receiveFuture(c.sendCmd(cmd))
+	return ReceiveFuture(c.SendCmd(cmd))


What do you think of deleting this method? It is only used a single place. It can be replaced by inling the contents here. That way there's one less public symbol exported, which is nice.

Whoops, making that one public was unintentional; seems I was a tad sloppy while rebasing. Reverted it to private; thanks for catching that.

rpcclient/examples/customcommand/main.go

JeremyRand · 2021-02-11T10:15:22Z

rpcclient/examples/customcommand/main.go needs to be formatted with gofmt

@torkelrogstad Thanks for catching that; fixed.

This facilitates using custom commands with rpcclient. See btcsuite#1083

JeremyRand · 2021-06-17T02:59:33Z

Rebased again. Would be awesome if we can get this reviewed and merged.

jcvernaleo · 2021-06-17T12:01:36Z

Thanks @JeremyRand I don't have time to review this morning but I added it to the milestone for the next release so it is at the top of the list.

jcvernaleo

One minor thing from me then looks good.

jcvernaleo · 2021-06-22T13:39:48Z

rpcclient/examples/customcommand/README.md

@@ -0,0 +1,32 @@
+Namecoin Core Custom Command Example


I'm fine with leaving the other parts of the readme as is and then update with a future PR, but I think we should fix the name at least so it isn't Namecoin

Let's do this in a separate PR. I think just using "Custom Command Example" is appropriate.

onyb

This PR needs some very minor cosmetic changes, but let's do that in a different PR.

rpcclient/examples/customcommand/main.go

onyb · 2021-06-25T20:11:04Z

rpcclient/examples/customcommand/README.md

@@ -0,0 +1,32 @@
+Namecoin Core Custom Command Example


Let's do this in a separate PR. I think just using "Custom Command Example" is appropriate.

onyb · 2021-06-25T20:12:52Z

rpcclient/examples/customcommand/README.md

+```bash
+$ cd $GOPATH/src/github.com/btcsuite/btcd/rpcclient/examples/customcommand
+$ go run *.go
+```


I agree with the changes suggested here, but I'm happy to take care of it in a separate PR.

jcvernaleo

I think this is good to go.
OK

JeremyRand · 2021-09-02T05:54:10Z

Any chance we can get this merged? AFAICT there are no remaining blockers (unless I missed something?).

onyb · 2021-09-02T06:40:27Z

Squashed and merged. Thanks @JeremyRand for the PR. 🙌

jcvernaleo · 2021-09-02T12:19:20Z

@JeremyRand my apologies. I see that I approved this a while ago but forgot to actually merge it. Sorry about that. Thanks for the reminder.

* rpcclient: Export sendCmd and response This facilitates using custom commands with rpcclient. See btcsuite#1083 * rpcclient: Export receiveFuture This facilitates using custom commands with rpcclient. See btcsuite#1083 * rpcclient: Add customcommand example * rpcclient: remove "Namecoin" from customcommand readme heading

JeremyRand mentioned this pull request Jul 30, 2019

Switch to rpcclient based on current upstream Conformal namecoin/ncdns#103

Merged

5 tasks

JeremyRand force-pushed the public-sendcmd branch from 9bb754a to 13cd083 Compare January 5, 2020 22:36

jcvernaleo added enhancement low priority labels Mar 4, 2020

JeremyRand force-pushed the public-sendcmd branch from 13cd083 to 3b83c84 Compare May 19, 2020 19:13

torkelrogstad reviewed May 20, 2020

View reviewed changes

JeremyRand closed this May 21, 2020

JeremyRand reopened this May 21, 2020

JeremyRand force-pushed the public-sendcmd branch from 3b83c84 to 98c8f0c Compare December 21, 2020 04:23

torkelrogstad reviewed Dec 27, 2020

View reviewed changes

JeremyRand force-pushed the public-sendcmd branch 4 times, most recently from 56a3124 to 48a1ec7 Compare February 11, 2021 10:14

JeremyRand force-pushed the public-sendcmd branch 2 times, most recently from 960ae63 to 96fed42 Compare June 17, 2021 02:48

JeremyRand added 3 commits June 17, 2021 02:53

rpcclient: Export sendCmd and response

cb382a7

This facilitates using custom commands with rpcclient. See btcsuite#1083

rpcclient: Export receiveFuture

7a41494

This facilitates using custom commands with rpcclient. See btcsuite#1083

rpcclient: Add customcommand example

91ad6db

JeremyRand force-pushed the public-sendcmd branch from 96fed42 to 91ad6db Compare June 17, 2021 02:55

jcvernaleo added this to the 0.22.1 milestone Jun 17, 2021

jcvernaleo removed the low priority label Jun 17, 2021

jcvernaleo requested changes Jun 22, 2021

View reviewed changes

onyb approved these changes Jun 25, 2021

View reviewed changes

rpcclient: remove "Namecoin" from customcommand readme heading

637a90d

jcvernaleo approved these changes Jul 13, 2021

View reviewed changes

onyb merged commit 3e2d846 into btcsuite:master Sep 2, 2021

JeremyRand deleted the public-sendcmd branch October 2, 2021 17:27

ygaberman-px mentioned this pull request Jun 16, 2023

Bump btcd to v0.23.2 paxosglobal/btcd#3

Merged

Navigation Menu

rpcclient: Export symbols needed for custom commands #1457

rpcclient: Export symbols needed for custom commands #1457

Conversation

JeremyRand commented Jul 24, 2019

octobocto commented Dec 6, 2019

torkelrogstad commented Dec 6, 2019

JeremyRand commented Dec 9, 2019

torkelrogstad commented Dec 9, 2019

torkelrogstad commented Dec 9, 2019

JeremyRand commented Dec 17, 2019 • edited

JeremyRand commented Jan 5, 2020

torkelrogstad commented Jan 6, 2020

jakesylvestre commented Mar 4, 2020

JeremyRand commented May 19, 2020

torkelrogstad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JeremyRand commented May 21, 2020

JeremyRand commented May 25, 2020

coveralls commented Dec 21, 2020 • edited

Pull Request Test Coverage Report for Build 993591029

💛 - Coveralls

JeremyRand commented Dec 21, 2020

torkelrogstad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JeremyRand commented Feb 11, 2021

JeremyRand commented Jun 17, 2021

jcvernaleo commented Jun 17, 2021

jcvernaleo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

onyb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcvernaleo left a comment

Choose a reason for hiding this comment

JeremyRand commented Sep 2, 2021

onyb commented Sep 2, 2021

jcvernaleo commented Sep 2, 2021

JeremyRand commented Dec 17, 2019 •

edited

coveralls commented Dec 21, 2020 •

edited