Skip to content
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

Update json-rpc.md #903

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update json-rpc.md #903

wants to merge 1 commit into from

Conversation

rmoreliovlabs
Copy link
Contributor

What

  • Updated some parameters description to add Map as an allowed value for the block reference parameter, for example in the eth_getBalance method.

Why

  • We are refactoring RSKj error handling behavior to align it with Geth's, some of this changes need to be added to the documentation.

Refs

  • (optional: include links to other issues, PRs, tickets, etc)

Updated some parameters description to add Map as an allowed value for the block reference parameter, for example in the eth_getBalance method.
@@ -625,7 +625,8 @@ Returns the balance of the account of given address.
##### Parameters

1. `DATA`, 20 Bytes - address to check for balance.
2. `QUANTITY|TAG` - integer block number, or the string `"latest"`, `"earliest"` or `"pending"`, see the [default block parameter](https://github.com/ethereum/wiki/wiki/JSON-RPC#the-default-block-parameter)
2. `QUANTITY|TAG|MAP` - integer block number, or the string `"latest"`, `"earliest"` or `"pending"`, see the [default block parameter](https://github.com/ethereum/wiki/wiki/JSON-
RPC#the-default-block-parameter), or a map containing a block hash string, under the key `"blockHash"` or a string hexcadecimal number, under the key `"blockNumber"`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
RPC#the-default-block-parameter), or a map containing a block hash string, under the key `"blockHash"` or a string hexcadecimal number, under the key `"blockNumber"`.
RPC#the-default-block-parameter), or a map containing a block hash string, under the key `"blockHash"` or a string hexadecimal number, under the key `"blockNumber"`.

@@ -2110,4 +2114,4 @@ It is recommended to set reasonable values for these limits, considering the net
| `rsk_getRawBlockHeaderByNumber` | YES | Obtains the RLP encoded block header used for SPV, if this is hashed using Keccack256 it gives the block hash. This function takes the block number (in hexa) or the string "latest" "pending" "genesis". |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `rsk_getRawBlockHeaderByNumber` | YES | Obtains the RLP encoded block header used for SPV, if this is hashed using Keccack256 it gives the block hash. This function takes the block number (in hexa) or the string "latest" "pending" "genesis". |
| `rsk_getRawBlockHeaderByNumber` | YES | Obtains the RLP encoded block header used for SPV, if this is hashed using Keccak256, it gives the block hash. This function takes the block number (in hexa) or the string "latest", "pending", "genesis". |

@@ -2110,4 +2114,4 @@ It is recommended to set reasonable values for these limits, considering the net
| `rsk_getRawBlockHeaderByNumber` | YES | Obtains the RLP encoded block header used for SPV, if this is hashed using Keccack256 it gives the block hash. This function takes the block number (in hexa) or the string "latest" "pending" "genesis". |
| `rsk_getRawBlockHeaderByHash` | YES | Obtains the RLP encoded block header used for SPV, if this is hashed using Keccack256 it gives the block hash. This function takes the block hash as parameter. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `rsk_getRawBlockHeaderByHash` | YES | Obtains the RLP encoded block header used for SPV, if this is hashed using Keccack256 it gives the block hash. This function takes the block hash as parameter. |
| `rsk_getRawBlockHeaderByHash` | YES | Obtains the RLP encoded block header used for SPV, if this is hashed using Keccak256 it gives the block hash. This function takes the block hash as parameter. |

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rmoreliovlabs Any update on this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, @owans Sorry for the late reply, we divided the task of updating these details into multiple subtasks, so I'll move my and your changes to the corresponding subtask's PR and close this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants