doc: Add RPC interface guidelines #10281
Merged
Conversation
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
kallewoof
reviewed
Apr 26, 2017
|
|
||
| - *Exception*: Some RPC calls can take both an `int` and `bool`, most notably when a bool was switched | ||
| to a multi-value, or due to other historical reasons. **Always** have false map to 0 and | ||
| true to 1 in this case. |
There was a problem hiding this comment.
This is not the case right now. At the moment, 0 maps to false and !0 maps to true. See e.g. getrawtransaction's verbose argument handling.
There was a problem hiding this comment.
EH, I have that the wrong way around, thanks.
There was a problem hiding this comment.
Or not. What I meant here is:
false=0
true=1
E.g, the C++ mapping, not the bash mapping. As far as I know, we follow that everywhere?
If this wording is confusing, can you suggest another way.
There was a problem hiding this comment.
I read it as "interpret 0 as false and 1 as true, and anything else is [??]".
I.e. if a user passes 2 or -1 to the new RPC command which maps as you said, how will it treat values beyond [0, 1]?
Am I misunderstanding?
There was a problem hiding this comment.
I don't say anything about values besides 0 and 1 on purpose. Those may either map to 1, or to something else entirely (referring to "when bool has switched to multi-value"), or cause a failure.
There was a problem hiding this comment.
Ohh I was reading this backwards. You're talking about when a bool becomes an int, and I about when an int is interpreted as a bool. I'll think on wording to make this obvious.
There was a problem hiding this comment.
Re-reading this, I think I was simply not reading it properly. I think it looks fine as is.
doc/developer-notes.md
Outdated
|
|
||
| - Set okSafeMode in the RPC command table to a sensible value: safe mode is when the | ||
| block chain is regarded to be in a confused state, and the client deems it unsafe to | ||
| do anything irreversible such as send. Anything that just queries should be permitted. |
There was a problem hiding this comment.
Thanks for this! I vaguely presumed this was the case but never found anything explicitly stating it.
|
Great addition. |
fanquake
reviewed
Apr 26, 2017
doc/developer-notes.md
Outdated
| - *Rationale*: If not, the call can not be used with name-based arguments. | ||
|
|
||
| - Set okSafeMode in the RPC command table to a sensible value: safe mode is when the | ||
| block chain is regarded to be in a confused state, and the client deems it unsafe to |
laanwj
force-pushed
the
2017_04_rpc_if_guidelines
branch
from
32fd23f
to
359f71d
Compare
|
Looks good. ACK 359f71d0fb243fa49884132c0fb0c24118d77842 |
|
ACK |
laanwj
force-pushed
the
2017_04_rpc_if_guidelines
branch
from
359f71d
to
c26655e
Compare
laanwj
added a commit
that referenced
this pull request
May 2, 2017
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 10, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 10, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 11, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 11, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 12, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 14, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 14, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 14, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 14, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 15, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
PastaPastaPasta
pushed a commit
to PastaPastaPasta/dash
that referenced
this pull request
Jun 19, 2019
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
barrystyle
pushed a commit
to PACGlobalOfficial/PAC
that referenced
this pull request
Jan 22, 2020
c26655e doc: Add RPC interface guidelines (Wladimir J. van der Laan) Tree-SHA512: e4cf1625d136fef9fe24361b6507c7e7ec2e676fb9727bbdcd4320aace6d0b49ce707592cb93a67b427168a1f373542e94bcea418b4e1c0cb1e9430af7412c8f
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Could be useful. Anything that I forgot?