feat(rpc): Re-organize RPC errors #2038

doitian · 2020-04-23T07:41:52Z

This PR reworks on the RPC errors:

Use JSONRPC error code to differentiate different errors. Also prefix the error code in the message to be search engine friendly.
Make error message simple and easy to understand. The dump of the error is added as the data instead.
Avoid reusing the same error message for different reasons.

Breaking Changes

The error object date field is always absent before, now it can be a string which contains the detailed error information.
The code in error object is always -3 for all the CKB internal errors, now it can have different values to differentiate different errors. Check the file rpc/src/error.rs.
The error messages have been updated to improve readability.

JSON-RPC Errors

See JSON-RPC spec.

General Errors

┌ CKBInternalError (-1)

Errors in this category are considered to never happen or only happen when the system resources are exhausted.

┌ RPCModuleIsDisabled (-4)

Not all RPC modules are enabled by default. Please edit rpc.modules in the configuration file ckb.toml.

Alert

`send_alert`

┌ AlertFailedToVerifySignatures (-1000)

Some signatures are invalid.

┌ P2PFailedToBroadcast (-101)

Alert is saved locally but has failed to broadcast to the P2P network.

┌ InvalidParams (-32602)

Expected params[0].notice_until in the future.

Chain

`get_block_by_number`

┌ ChainIndexIsInconsistent (-201)

The index is inconsistent. It says a block hash is in the main chain, but cannot read it from database.

┌ DatabaseIsCorrupt (-202)

The data read from database is dirty. Please report it as a bug.

`get_header_by_number`

┌ ChainIndexIsInconsistent (-201)

The index is inconsistent. It says a block hash is in the main chain, but cannot read it from database.

`get_cells_by_lock_hash`

┌ InvalidParams (-32602)

Expected from <= to in params[0].
Expected to - from <= 100.

┌ ChainIndexIsInconsistent (-201)

The index is inconsistent. It says a block hash is in the main chain, but cannot read it from database.

Experiment

`dry_run_transaction`

┌ TransactionFailedToResolve (-301)

Failed to resolve the referenced cells and headers used in the transaction, as inputs or dependencies.

┌ TransactionFailedToVerify (-302)

Failed to verify the transaction.

`calculate_dao_maximum_withdraw`

┌ DAOError (-5)

The given out point is not a valid cell for DAO computation.

┌ CKBInternalError (-1)

Mathematics overflow.

Network

`set_ban`

┌ InvalidParams (-32602)

Expected params[0] to be a valid IP address.
Expected params[1] to be in the list [insert, delete].

Pool

`send_transaction`

┌ PoolRejectedTransactionByOutputsValidator (-1102)

The transaction is rejected by the validator specified by params[1]. If you really want to send transactions with advanced scripts, please set params[1] to "passthrough".

┌ PoolRejectedTransactionByIllTransactionChecker (-1103)

Pool rejects some transactions which seem contain invalid VM instructions. See the issue link in the error message for details.

┌ PoolRejectedTransactionByMinFeeRate (-1104)

The transaction fee rate must >= tx_pool.min_fee_rate in ckb.toml.

┌ PoolRejectedTransactionByMaxAncestorsCountLimit (-1105)

The ancestors count must <= tx_pool.max_ancestors_count in ckb.toml.

┌ PoolIsFull (-1106)

Pool is full.

┌ PoolRejectedDuplicatedTransaction (-1107)

The transaction is already in the pool.

┌ TransactionFailedToResolve (-301)

Failed to resolve the referenced cells and headers used in the transaction, as inputs or dependencies.

┌ TransactionFailedToVerify (-302)

Failed to verify the transaction.

doitian · 2020-05-05T23:58:48Z

Will fix the CI error today

doitian · 2020-05-12T09:47:47Z

@quake @yangby-cryptape fixed clippy, please review again.

doitian · 2020-06-22T07:34:12Z

bors try

doitian · 2020-06-22T07:34:36Z

Rebased, please review.

doitian · 2020-06-29T03:51:43Z

Rebased to resolve the alert module conflict b83b004
Added a new commit 1067c6a

doitian · 2020-06-30T02:27:22Z

bors r=quake,zhangsoledad

2038: feat(rpc): Re-organize RPC errors r=quake,zhangsoledad a=doitian This PR reworks on the RPC errors: * Use JSONRPC error code to differentiate different errors. Also prefix the error code in the message to be search engine friendly. * Make error message simple and easy to understand. The dump of the error is added as the data instead. * Avoid reusing the same error message for different reasons. ## Breaking Changes * The error object `date` field is always absent before, now it can be a string which contains the detailed error information. * The `code` in error object is always -3 for all the CKB internal errors, now it can have different values to differentiate different errors. Check the file `rpc/src/error.rs`. * The error messages have been updated to improve readability. ## JSON-RPC Errors See [JSON-RPC spec](https://www.jsonrpc.org/specification#error_object). ## General Errors ┌ `CKBInternalError (-1)` Errors in this category are considered to never happen or only happen when the system resources are exhausted. ┌ `RPCModuleIsDisabled (-4)` Not all RPC modules are enabled by default. Please edit `rpc.modules` in the configuration file `ckb.toml`. ## Alert ### `send_alert` ┌ `AlertFailedToVerifySignatures (-1000)` Some signatures are invalid. ┌ `P2PFailedToBroadcast (-101)` Alert is saved locally but has failed to broadcast to the P2P network. ┌ `InvalidParams (-32602)` * Expected `params[0].notice_until` in the future. ## Chain ### `get_block_by_number` ┌ `ChainIndexIsInconsistent (-201)` The index is inconsistent. It says a block hash is in the main chain, but cannot read it from database. ┌ `DatabaseIsCorrupt (-202)` The data read from database is dirty. Please report it as a bug. ### `get_header_by_number` ┌ `ChainIndexIsInconsistent (-201)` The index is inconsistent. It says a block hash is in the main chain, but cannot read it from database. ### `get_cells_by_lock_hash` ┌ `InvalidParams (-32602)` * Expected `from <= to` in `params[0]`. * Expected `to - from <= 100`. ┌ `ChainIndexIsInconsistent (-201)` The index is inconsistent. It says a block hash is in the main chain, but cannot read it from database. ## Experiment ### `dry_run_transaction` ┌ `TransactionFailedToResolve (-301)` Failed to resolve the referenced cells and headers used in the transaction, as inputs or dependencies. ┌ `TransactionFailedToVerify (-302)` Failed to verify the transaction. ### `calculate_dao_maximum_withdraw` ┌ `DAOError (-5)` The given out point is not a valid cell for DAO computation. ┌ `CKBInternalError (-1)` Mathematics overflow. ## Network ### `set_ban` ┌ `InvalidParams (-32602)` * Expected `params[0]` to be a valid IP address. * Expected `params[1]` to be in the list [insert, delete]. ## Pool ### `send_transaction` ┌ `PoolRejectedTransactionByOutputsValidator (-1102)` The transaction is rejected by the validator specified by `params[1]`. If you really want to send transactions with advanced scripts, please set `params[1]` to "passthrough". ┌ `PoolRejectedTransactionByIllTransactionChecker (-1103)` Pool rejects some transactions which seem contain invalid VM instructions. See the issue link in the error message for details. ┌ `PoolRejectedTransactionByMinFeeRate (-1104)` The transaction fee rate must >= `tx_pool.min_fee_rate` in `ckb.toml`. ┌ `PoolRejectedTransactionByMaxAncestorsCountLimit (-1105)` The ancestors count must <= `tx_pool.max_ancestors_count` in `ckb.toml`. ┌ `PoolIsFull (-1106)` Pool is full. ┌ `PoolRejectedDuplicatedTransaction (-1107)` The transaction is already in the pool. ┌ TransactionFailedToResolve (-301) Failed to resolve the referenced cells and headers used in the transaction, as inputs or dependencies. ┌ TransactionFailedToVerify (-302) Failed to verify the transaction. Co-authored-by: ian <ian@nervos.org>

bors · 2020-06-30T03:12:14Z

Build failed:

continuous-integration/travis-ci/push

The error is renamed in 0a8bf97

doitian · 2020-06-30T09:21:05Z

Fix the expected error message in integration test 08ee29a

The error is renamed in 0a8bf97

doitian · 2020-07-06T01:55:16Z

bors try

bors · 2020-07-06T02:44:58Z

try

Build succeeded:

continuous-integration/travis-ci/push

doitian · 2020-07-15T09:52:39Z

bors r=quake,yangby-cryptape

bors · 2020-07-15T11:00:36Z

Build succeeded:

continuous-integration/travis-ci/push

doitian requested review from a team and xxuejie April 23, 2020 07:41

doitian marked this pull request as draft April 23, 2020 08:07

doitian removed the request for review from xxuejie April 23, 2020 08:07

doitian added this to 👀 Awaiting review in CKB - Pull Requests Apr 27, 2020

doitian moved this from 👀 Awaiting review to 🚧 In progress in CKB - Pull Requests Apr 27, 2020

doitian changed the title ~~feat(rpc): Organize RPC errors~~ feat(rpc): Re-organize RPC errors Apr 30, 2020

doitian added b:rpc Break RPC interface breaking change The feature breaks consensus, database, message schema or RPC interface. labels Apr 30, 2020

doitian marked this pull request as ready for review April 30, 2020 02:12

doitian requested review from a team, yangby-cryptape and quake and removed request for a team April 30, 2020 02:12

doitian mentioned this pull request Apr 30, 2020

feat(rpc): Improve error messages from send transaction RPC #2049

Merged

yangby-cryptape previously approved these changes May 1, 2020

View reviewed changes

doitian added the s:waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. label May 6, 2020

doitian dismissed yangby-cryptape’s stale review via 6f2fbdc May 12, 2020 03:27

CKB - Pull Requests automation moved this from 🚧 In progress to 👀 Awaiting review May 12, 2020

quake previously approved these changes May 26, 2020

View reviewed changes

doitian dismissed quake’s stale review via 5149e50 June 22, 2020 07:33

doitian requested a review from zhangsoledad as a code owner June 22, 2020 07:33

bors bot added a commit that referenced this pull request Jun 22, 2020

Try #2038:

e310339

doitian requested review from quake and yangby-cryptape June 22, 2020 07:34

quake previously approved these changes Jun 22, 2020

View reviewed changes

doitian dismissed quake’s stale review via 1067c6a June 29, 2020 03:49

CKB - Pull Requests automation moved this from ✅ Reviewer approved to 👀 Awaiting review Jun 29, 2020

doitian requested review from quake and zhangsoledad June 29, 2020 03:49

quake previously approved these changes Jun 29, 2020

View reviewed changes

CKB - Pull Requests automation moved this from 👀 Awaiting review to ✅ Reviewer approved Jun 29, 2020

zhangsoledad previously approved these changes Jun 29, 2020

View reviewed changes

feat(rpc): fix expected error message in integration test

08ee29a

The error is renamed in 0a8bf97

doitian dismissed stale reviews from zhangsoledad and quake via 08ee29a June 30, 2020 09:20

doitian requested a review from keroro520 as a code owner June 30, 2020 09:20

CKB - Pull Requests automation moved this from ✅ Reviewer approved to 👀 Awaiting review Jun 30, 2020

doitian requested review from quake and zhangsoledad June 30, 2020 09:20

quake approved these changes Jun 30, 2020

View reviewed changes

bors bot added a commit that referenced this pull request Jul 6, 2020

Try #2038:

8d0c3d0

CKB - Pull Requests automation moved this from 👀 Awaiting review to ✅ Reviewer approved Jul 15, 2020

yangby-cryptape approved these changes Jul 15, 2020

View reviewed changes

bors bot merged commit 6492e3f into nervosnetwork:develop Jul 15, 2020

CKB - Pull Requests automation moved this from ✅ Reviewer approved to Done Jul 15, 2020

doitian deleted the better-rpc-error branch September 11, 2020 07:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(rpc): Re-organize RPC errors #2038

feat(rpc): Re-organize RPC errors #2038

doitian commented Apr 23, 2020 •

edited

Loading

doitian commented May 5, 2020

doitian commented May 12, 2020

doitian commented Jun 22, 2020

doitian commented Jun 22, 2020

doitian commented Jun 29, 2020

doitian commented Jun 30, 2020

bors bot commented Jun 30, 2020

doitian commented Jun 30, 2020

doitian commented Jul 6, 2020

bors bot commented Jul 6, 2020

doitian commented Jul 15, 2020

bors bot commented Jul 15, 2020

feat(rpc): Re-organize RPC errors #2038

feat(rpc): Re-organize RPC errors #2038

Conversation

doitian commented Apr 23, 2020 • edited Loading

Breaking Changes

JSON-RPC Errors

General Errors

Alert

send_alert

Chain

get_block_by_number

get_header_by_number

get_cells_by_lock_hash

Experiment

dry_run_transaction

calculate_dao_maximum_withdraw

Network

set_ban

Pool

send_transaction

doitian commented May 5, 2020

doitian commented May 12, 2020

doitian commented Jun 22, 2020

doitian commented Jun 22, 2020

doitian commented Jun 29, 2020

doitian commented Jun 30, 2020

bors bot commented Jun 30, 2020

doitian commented Jun 30, 2020

doitian commented Jul 6, 2020

bors bot commented Jul 6, 2020

try

doitian commented Jul 15, 2020

bors bot commented Jul 15, 2020

doitian commented Apr 23, 2020 •

edited

Loading

`send_alert`

`get_block_by_number`

`get_header_by_number`

`get_cells_by_lock_hash`

`dry_run_transaction`

`calculate_dao_maximum_withdraw`

`set_ban`

`send_transaction`