RPC errors proposal #156

roman-khimov · 2022-09-13T15:08:21Z

Based on neo-project/neo-modules#728, but differs a bit from it:

reduced set of groups
unified missing block/header error
improved compatibility for -301 and -302

Based on neo-project/neo-modules#728, but differs a bit from it: * reduced set of groups * unified missing block/header error * improved compatibility for -301 and -302

ixje

I really like supporting this. Many times the error responses are too general to figure out what is actually wrong and one has to debug it running their own node.

nep-Y.mediawiki

Co-authored-by: Erik van den Brink <git@erikvandenbrink.com>

roman-khimov · 2022-12-09T11:09:01Z

📯 📯 📯 @erikzhang, @shargon, @vncoelho, @devhawk, anyone else 🥁 🥁 🥁

I think we need to move on with this, it's important for dApp development.

shargon

Good proposal to improve the user experience

devhawk · 2023-01-18T22:17:04Z

Good proposal to improve the user experience

Agreed. When do we merge this?

steven1227 · 2023-01-20T08:24:19Z

We need this.

These can autoresolve height to hash, so height-related error code is applicable as well. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

Oracle response can have invalid signature. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

Blocks contain transactions, therefore any transaction-related error codes can be applicable too. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

Proof verification is relevant only for the nodes that store not only the latest chain state. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

roman-khimov · 2023-08-14T15:07:09Z

Minor adjustments (no new codes) made based on implementation experience from nspcc-dev/neo-go#3063.

According to proposal: neo-project/proposals#156 Close nspcc-dev#2248 Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

While our server no longer uses these codes (-100, -400) they still can come from C# servers and while we consider them deprecated we better at least have some definition of them until C# implements our proposal: neo-project/proposals#156 Also adding description of deprecated RPC error codes in ROADMAP.md. Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

This change makes code incompatible with C# node, because currently no error is returned on invalid proof. According to proposal: neo-project/proposals#156 Also adding `verifyProof` descpiption in docs/rpc.md. Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

Behaviour change. `terminatesession` returns ErrUnknownSession in case of impossibility of finding session, previously there was no-error response with `false` result. `traverseIterator`returns ErrUnknownSession in case of impossibility of finding session, previously there was no-error response with default result; `traverseIterator`returns ErrUnknownIterator, there were no such errors before. Accordingly to proposal: neo-project/proposals#156 Also adding description of `traverseIterator` in docs/rpc.md. Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

AnnaShaleva · 2023-08-18T08:26:16Z

Just for the record: we've successfully adopted this standard to the NeoGo RPC server in nspcc-dev/neo-go#3063. It works fine in tests and we'll integrate these new error codes into NeoFS as soon as 0.102.0 is released. There's a couple of issues that will be fixed by the usage of new RPC errors standard.

nep-23.mediawiki

README.mediawiki

roman-khimov · 2024-03-17T18:54:33Z

While this hasn't been merged yet, two suggestions related to new attributes:

treat NVB violation (not yet valid transaction) as -510 Expired (annotation can be extended)
add one more code for Conflicts (when transaction can't be accepted because of conflict), -511/-503 don't really fit for it, -500 can be OK with additional data and yet -513 can be even better for debugging

mempool.ErrInsufficientFunds is used when sender doesn't have enough balance to pay the submitted transaction fees (-511 code according to neo-project/proposals#156). mempool.ErrConflict is used when sender is not able to pay the overall transactions fee sum in the pool (generic -500 error according to the proposal). This bugfix is kind of breaking change for those users who relied on the old -511 code previously returning "insufficient funds" error. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

This is not the way intended in neo-project/proposals#156. -511 covers _both_ cases because users hardly can distinguish one from another, it's just that our mempool implementation has error codes for both.. Signed-off-by: Roman Khimov <roman@nspcc.ru>

superboyiii · 2024-03-29T07:41:15Z

I think it's good to go. Adding a implement link will be better.

Signed-off-by: Roman Khimov <roman@nspcc.ru>

roman-khimov · 2024-04-02T20:12:18Z

Updated, added implementation links.

superboyiii · 2024-04-03T02:21:28Z

LGTM
@shargon @cschuchardt88 @AnnaShaleva @vncoelho @roman-khimov @Jim8y
neo-project/neo-modules#815 is already merged.

add RPC error proposal

7eb6c30

Based on neo-project/neo-modules#728, but differs a bit from it: * reduced set of groups * unified missing block/header error * improved compatibility for -301 and -302

ixje reviewed Sep 14, 2022

View reviewed changes

roman-khimov and others added 6 commits September 14, 2022 11:14

nep-Y: correct group description

26ef0ad

Co-authored-by: Erik van den Brink <git@erikvandenbrink.com>

nep-Y: typo fix

a564897

Co-authored-by: Erik van den Brink <git@erikvandenbrink.com>

nep-Y: unify -104 wording

580f42a

Co-authored-by: Erik van den Brink <git@erikvandenbrink.com>

nep-Y: UTF-8 for code/message

e819938

nep-Y: clarify "other codes"

f96d96c

nep-Y: the most specific

b20970e

shargon previously approved these changes Dec 12, 2022

View reviewed changes

cthulhu-rider mentioned this pull request Mar 17, 2023

Rely on Neo status codes when they appear nspcc-dev/neofs-node#2285

Closed

roman-khimov mentioned this pull request Jul 20, 2023

RPC: add error codes and response errors nspcc-dev/neo-go#3063

Merged

AnnaShaleva mentioned this pull request Aug 7, 2023

api: fix wait_for_transaction_receipt for neo-go nodes CityOfZion/neo-mamba#273

Merged

AnnaShaleva added 4 commits August 14, 2023 18:04

NEP-Y: extend list of getblock and getblockheader return error codes

a840f72

These can autoresolve height to hash, so height-related error code is applicable as well. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

NEP-Y: extend list of submitoracleresponse return error codes

9981ae7

Oracle response can have invalid signature. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

NEP-Y: extend list of submitblock return error codes

c691b94

Blocks contain transactions, therefore any transaction-related error codes can be applicable too. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

NEP-Y: extend list of verifyproof return error codes

606601b

Proof verification is relevant only for the nodes that store not only the latest chain state. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>

roman-khimov dismissed shargon’s stale review via 606601b August 14, 2023 15:04

tatiana-nspcc added a commit to tatiana-nspcc/neo-go that referenced this pull request Aug 16, 2023

neorpc: add error codes and response errors

42e9bce

According to proposal: neo-project/proposals#156 Close nspcc-dev#2248 Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

tatiana-nspcc added a commit to tatiana-nspcc/neo-go that referenced this pull request Aug 16, 2023

neorpc: add error codes and response errors

50847a9

According to proposal: neo-project/proposals#156 Close nspcc-dev#2248 Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

tatiana-nspcc added a commit to tatiana-nspcc/neo-go that referenced this pull request Aug 16, 2023

docs: add proposal regarding response error codes

561462f

According to proposal: neo-project/proposals#156 Close nspcc-dev#2248 Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

tatiana-nspcc added a commit to tatiana-nspcc/neo-go that referenced this pull request Aug 16, 2023

neorpc: add error codes and response errors

31ceb56

According to proposal: neo-project/proposals#156 Close nspcc-dev#2248 Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

tatiana-nspcc added a commit to tatiana-nspcc/neo-go that referenced this pull request Aug 16, 2023

docs: add proposal regarding response error codes

3178c8f

According to proposal: neo-project/proposals#156 Close nspcc-dev#2248 Signed-off-by: Tatiana Nesterenko <tatiana@nspcc.io>

shargon dismissed their stale review via 962237a February 8, 2024 14:39

AnnaShaleva reviewed Feb 8, 2024

View reviewed changes

nep-23.mediawiki Outdated Show resolved Hide resolved

shargon reviewed Feb 8, 2024

View reviewed changes

README.mediawiki Outdated Show resolved Hide resolved

Update README.mediawiki

e2023b7

shargon previously approved these changes Feb 8, 2024

View reviewed changes

roman-khimov commented Feb 8, 2024

View reviewed changes

README.mediawiki Outdated Show resolved Hide resolved

roman-khimov mentioned this pull request Feb 21, 2024

Reconsider status responses nspcc-dev/neofs-node#2744

Open

AnnaShaleva mentioned this pull request Mar 11, 2024

Draft NEP 25: Extended types for NEP-14 #160

Open

roman-khimov mentioned this pull request Mar 12, 2024

Draft NEP 26 and Draft NEP 27: New NEPs describing onNEPXXPayment callbacks #169

Merged

This was referenced Mar 18, 2024

rpcsrv: fix RPC error codes proposal compatibility nspcc-dev/neo-go#3360

Merged

RpcServer: return RpcError.InsufficientNetworkFee error where appropriate neo-project/neo-modules#889

Open

This was referenced Mar 18, 2024

rpcsrv: fix insufficient funds use nspcc-dev/neo-go#3361

Merged

Add Royalty standard #155

Merged

roman-khimov added 4 commits April 2, 2024 23:01

README: fix link to the document

9f35539

Signed-off-by: Roman Khimov <roman@nspcc.ru>

nep-23: add implementation links

8bcce5d

Signed-off-by: Roman Khimov <roman@nspcc.ru>

nep-23: extend -510 to cover NVB

804dd0a

Signed-off-by: Roman Khimov <roman@nspcc.ru>

nep-23: add -513 for Conflicts

16cfb05

Signed-off-by: Roman Khimov <roman@nspcc.ru>

roman-khimov dismissed shargon’s stale review via 16cfb05 April 2, 2024 20:12

superboyiii approved these changes Apr 3, 2024

View reviewed changes

Jim8y approved these changes Apr 3, 2024

View reviewed changes

AnnaShaleva approved these changes Apr 3, 2024

View reviewed changes

vncoelho approved these changes Apr 3, 2024

View reviewed changes

shargon approved these changes Apr 4, 2024

View reviewed changes

shargon merged commit c60434e into neo-project:master Apr 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RPC errors proposal #156

RPC errors proposal #156

roman-khimov commented Sep 13, 2022

ixje left a comment

roman-khimov commented Dec 9, 2022

shargon left a comment

devhawk commented Jan 18, 2023

steven1227 commented Jan 20, 2023

roman-khimov commented Aug 14, 2023

AnnaShaleva commented Aug 18, 2023 •

edited

Loading

roman-khimov commented Mar 17, 2024

superboyiii commented Mar 29, 2024

roman-khimov commented Apr 2, 2024

superboyiii commented Apr 3, 2024 •

edited

Loading

RPC errors proposal #156

RPC errors proposal #156

Conversation

roman-khimov commented Sep 13, 2022

ixje left a comment

Choose a reason for hiding this comment

roman-khimov commented Dec 9, 2022

shargon left a comment

Choose a reason for hiding this comment

devhawk commented Jan 18, 2023

steven1227 commented Jan 20, 2023

roman-khimov commented Aug 14, 2023

AnnaShaleva commented Aug 18, 2023 • edited Loading

roman-khimov commented Mar 17, 2024

superboyiii commented Mar 29, 2024

roman-khimov commented Apr 2, 2024

superboyiii commented Apr 3, 2024 • edited Loading

AnnaShaleva commented Aug 18, 2023 •

edited

Loading

superboyiii commented Apr 3, 2024 •

edited

Loading