Skip to content

[doc] Add hint about getmempoolentry to getrawmempool help. #10310

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.

Sign up for GitHub

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

Jump to bottom
Merged
maflcko merged 1 commit into from
May 8, 2017
Merged

[doc] Add hint about getmempoolentry to getrawmempool help. #10310

maflcko merged 1 commit into from
May 8, 2017

Conversation

@kallewoof
Copy link
Contributor

@kallewoof kallewoof commented May 2, 2017 •
edited
Loading

Lots of people seem to be unaware that getmempoolentry even exists (myself included, before today; see #10300 & #10304), so adding a hint to getrawmempool seems warranted.

I was tempted to start adding "See also: ..." strings to all RPC commands but wasn't sure that was generally desired.

@kallewoof kallewoof force-pushed the doc-getrawmempool-getmempoolentry branch from 81a1a54 to 41bc5ba Compare May 2, 2017 01:38
@junderw
Copy link
Contributor

junderw commented May 2, 2017

utACK 41bc5ba

TIL

@jonasschnelli
Copy link
Contributor

jonasschnelli commented May 2, 2017

Yes. Adding a hint makes sense.
Though I'm not sure if we should add it below the RPC/curl info. What speaks against mentioning getmempoolentry in the description?

@instagibbs
Copy link
Member

instagibbs commented May 2, 2017 •
edited
Loading

agreed @jonasschnelli I think just putting that in the main body of help is best.

I might stop reading by the examples...

@jnewbery
Copy link
Contributor

jnewbery commented May 2, 2017

I agree with the others. The hint should be further up, between the main text and the arguments listing.

Otherwise utACK

@dabura667 dabura667 mentioned this pull request May 4, 2017
Closed
@kallewoof kallewoof force-pushed the doc-getrawmempool-getmempoolentry branch from 41bc5ba to 06eb5a7 Compare May 4, 2017 12:09
@kallewoof
Copy link
Contributor Author

kallewoof commented May 4, 2017 •
edited
Loading

Moved hint to below description. Should it be a part of it (i.e. no space)? Below is current output:

$ ./bitcoin-cli -regtest help getrawmempool
getrawmempool ( verbose )

Returns all transaction ids in memory pool as a json array of string transaction ids.

Hint: use getmempoolentry to fetch a specific transaction from the mempool.

Arguments:
1. verbose (boolean, optional, default=false) True for a json object, false for array of transaction ids

Result: (for verbose = false):
[                     (json array of string)
  "transactionid"     (string) The transaction id
  ,...
]

Result: (for verbose = true):
{                           (json object)
  "transactionid" : {       (json object)
[omitted]
}

Examples:
> bitcoin-cli getrawmempool true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawmempool", "params": [true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/

$

@instagibbs
Copy link
Member

instagibbs commented May 4, 2017

utACK

@paveljanik
Copy link
Contributor

paveljanik commented May 5, 2017

ACK 06eb5a7

@kallewoof kallewoof force-pushed the doc-getrawmempool-getmempoolentry branch from 06eb5a7 to 3a0a5bc Compare May 6, 2017 03:51
@kallewoof
Copy link
Contributor Author

kallewoof commented May 6, 2017

Apologies; re-committed verified, same as 06eb5a7.

@sdaftuar
Copy link
Member

sdaftuar commented May 8, 2017

utACK

@paveljanik
Copy link
Contributor

paveljanik commented May 8, 2017

reACK 3a0a5bc

@maflcko maflcko merged commit 3a0a5bc into bitcoin:master May 8, 2017
maflcko pushed a commit that referenced this pull request May 8, 2017
Merge #10310: [doc] Add hint about getmempoolentry to getrawmempool h…
f4b15e2 
…elp.

3a0a5bc [doc] Add hint about getmempoolentry to getrawmempool help. (Karl-Johan Alm)

Tree-SHA512: 8327d7d7ad93296525fbf95b7a824e3525bde84653999f125afd845823eb39e3a03cd39725962ed949aa2b9ad207ecad6d287294fa321ff1a4d7fbd5a4b8560b
@kallewoof kallewoof deleted the doc-getrawmempool-getmempoolentry branch May 9, 2017 00:12
luke-jr pushed a commit to luke-jr/bitcoin that referenced this pull request Jun 5, 2017
@kallewoof @luke-jr
[doc] Add hint about getmempoolentry to getrawmempool help.
ff274d3 
Github-Pull: bitcoin#10310
Rebased-From: 3a0a5bc
codablock pushed a commit to codablock/dash that referenced this pull request Jan 26, 2018
@codablock
Merge bitcoin#10310: [doc] Add hint about getmempoolentry to getrawme…
12770be 
…mpool help.

3a0a5bc [doc] Add hint about getmempoolentry to getrawmempool help. (Karl-Johan Alm)

Tree-SHA512: 8327d7d7ad93296525fbf95b7a824e3525bde84653999f125afd845823eb39e3a03cd39725962ed949aa2b9ad207ecad6d287294fa321ff1a4d7fbd5a4b8560b
andvgal pushed a commit to energicryptocurrency/gen2-energi that referenced this pull request Jan 6, 2019
@andvgal
Merge bitcoin#10310: [doc] Add hint about getmempoolentry to getrawme…
0b89963 
…mpool help.

3a0a5bc [doc] Add hint about getmempoolentry to getrawmempool help. (Karl-Johan Alm)

Tree-SHA512: 8327d7d7ad93296525fbf95b7a824e3525bde84653999f125afd845823eb39e3a03cd39725962ed949aa2b9ad207ecad6d287294fa321ff1a4d7fbd5a4b8560b
lateminer pushed a commit to lateminer/bitcoin that referenced this pull request Jan 11, 2019
@kallewoof
[doc] Add hint about getmempoolentry to getrawmempool help.
32e354b 
Github-Pull: bitcoin#10310
Rebased-From: 3a0a5bc
CryptoCentric pushed a commit to absolute-community/absolute that referenced this pull request Feb 27, 2019
@CryptoCentric
Merge bitcoin#10310: [doc] Add hint about getmempoolentry to getrawme…
6b9ad94 
…mpool help.

3a0a5bc [doc] Add hint about getmempoolentry to getrawmempool help. (Karl-Johan Alm)

Tree-SHA512: 8327d7d7ad93296525fbf95b7a824e3525bde84653999f125afd845823eb39e3a03cd39725962ed949aa2b9ad207ecad6d287294fa321ff1a4d7fbd5a4b8560b
Mengerian pushed a commit to Mengerian/bitcoin-abc that referenced this pull request Jul 2, 2019
Merge #10310: [doc] Add hint about getmempoolentry to getrawmempool h…
ddf1476 
…elp.

Summary:
3a0a5bc [doc] Add hint about getmempoolentry to getrawmempool help. (Karl-Johan Alm)

Tree-SHA512: 8327d7d7ad93296525fbf95b7a824e3525bde84653999f125afd845823eb39e3a03cd39725962ed949aa2b9ad207ecad6d287294fa321ff1a4d7fbd5a4b8560b

Backport of Core PR10310
bitcoin/bitcoin#10310

Test Plan:
  make check
  ./bitcoind
  ./bitcoin-cli help getrawmempool
`Hint: use getmempoolentry to fetch a specific transaction from the mempool.` should be visible in the help text

Reviewers: deadalnix, Fabien, jasonbcox, markblundeberg, O1 Bitcoin ABC, #bitcoin_abc

Reviewed By: jasonbcox, O1 Bitcoin ABC, #bitcoin_abc

Differential Revision: https://reviews.bitcoinabc.org/D3467
jonspock pushed a commit to jonspock/devault that referenced this pull request Aug 27, 2019
@jonspock
Merge #10310: [doc] Add hint about getmempoolentry to getrawmempool h…
6b9304c 
…elp.

Summary:
3a0a5bc [doc] Add hint about getmempoolentry to getrawmempool help. (Karl-Johan Alm)

Tree-SHA512: 8327d7d7ad93296525fbf95b7a824e3525bde84653999f125afd845823eb39e3a03cd39725962ed949aa2b9ad207ecad6d287294fa321ff1a4d7fbd5a4b8560b

Backport of Core PR10310
bitcoin/bitcoin#10310

Test Plan:
  make check
  ./bitcoind
  ./bitcoin-cli help getrawmempool
`Hint: use getmempoolentry to fetch a specific transaction from the mempool.` should be visible in the help text

Reviewers: deadalnix, Fabien, jasonbcox, markblundeberg, O1 Bitcoin ABC, #bitcoin_abc

Reviewed By: jasonbcox, O1 Bitcoin ABC, #bitcoin_abc

Differential Revision: https://reviews.bitcoinabc.org/D3467
jonspock pushed a commit to devaultcrypto/devault that referenced this pull request Aug 28, 2019
@jonspock
Merge #10310: [doc] Add hint about getmempoolentry to getrawmempool h…
a0cf40c 
…elp.

Summary:
3a0a5bc [doc] Add hint about getmempoolentry to getrawmempool help. (Karl-Johan Alm)

Tree-SHA512: 8327d7d7ad93296525fbf95b7a824e3525bde84653999f125afd845823eb39e3a03cd39725962ed949aa2b9ad207ecad6d287294fa321ff1a4d7fbd5a4b8560b

Backport of Core PR10310
bitcoin/bitcoin#10310

Test Plan:
  make check
  ./bitcoind
  ./bitcoin-cli help getrawmempool
`Hint: use getmempoolentry to fetch a specific transaction from the mempool.` should be visible in the help text

Reviewers: deadalnix, Fabien, jasonbcox, markblundeberg, O1 Bitcoin ABC, #bitcoin_abc

Reviewed By: jasonbcox, O1 Bitcoin ABC, #bitcoin_abc

Differential Revision: https://reviews.bitcoinabc.org/D3467
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

Docs RPC/REST/ZMQ

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@kallewoof @junderw @jonasschnelli @instagibbs @jnewbery @paveljanik @sdaftuar @fanquake @maflcko