rfq+rfqmsg: add structured price oracle error codes #1766
Conversation
This file contains hidden or 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
jtobin
added
error handling
RFQ
jtobin
force-pushed
the
oracle-error-codes
branch
from
0a5e9ab to
6bdb36a
Compare
Pull Request Test Coverage Report for Build 19893520905Details
💛 - Coveralls |
ffranr
reviewed
Aug 25, 2025
GeorgeTsagk
reviewed
Sep 16, 2025
ffranr
reviewed
Sep 16, 2025
Contributor
ffranr
left a comment
ffranr
left a comment
There was a problem hiding this comment.
I've taken another look through this.
IMO needs commit squash and then we can review the set of commits which will be merged.
jtobin
force-pushed
the
oracle-error-codes
branch
from
5eaf8a9 to
a164c40
Compare
GeorgeTsagk
force-pushed
the
0-8-0-staging
branch
from
965998d to
83a4116
Compare
jtobin
force-pushed
the
oracle-error-codes
branch
from
a164c40 to
e78d038
Compare
darioAnongba
force-pushed
the
0-8-0-staging
branch
from
2b3ac4f to
035a840
Compare
jtobin
force-pushed
the
oracle-error-codes
branch
from
e78d038 to
e8e57ec
Compare
|
@GeorgeTsagk: review reminder |
jtobin
force-pushed
the
oracle-error-codes
branch
from
e8e57ec to
a36f4bc
Compare
Adds the 'UnspecifiedRejectCode' and 'UnavailableRejectCode' consts to represent the two protocol-defined rejection error codes of 0 and 1, respectively. The 'NewRejectErr' utility produces a RejectErr with the UnspecifiedRejectCode code, but pairs it with a custom error message.
Defines an OracleErrorCode type representing error codes returned by a price oracle, and updates proto definitions accordingly.
jtobin
force-pushed
the
oracle-error-codes
branch
from
a36f4bc to
a2daeee
Compare
Marshalls oracle error codes received over-the-wire into OracleErrorCode values, which are returned in oracle error responses.
Adds a 'customRejectErr' function that handles errors resulting from a price oracle query, producing a quote reject message. The changes in the next commit will augment this function to disambiguate between public/private errors.
jtobin
force-pushed
the
oracle-error-codes
branch
from
a2daeee to
966f761
Compare
Adds a flag (defaulting to false) that indicates that the error returned by a price oracle should be considered public, and can be safely forwarded to peers. Updates proto definitions accordingly.
ffranr
reviewed
Dec 8, 2025
Comment on lines
+79
to
+88
| const ( | ||
| // UnspecifiedRejectCode indicates that a request-for-quote was | ||
| // rejected, without necessarily providing any further detail as to | ||
| // why. | ||
| UnspecifiedRejectCode uint8 = iota | ||
|
|
||
| // UnavailableRejectCode indicates that a request-for-quote was | ||
| // rejected as a price oracle was unavailable. | ||
| UnavailableRejectCode | ||
| ) |
Contributor
There was a problem hiding this comment.
It’s better, in my view, not to use iota. Reordering the const fields becomes a silent breaking change, and it’s easy to miss in review, especially as more error types are added.
Contributor
There was a problem hiding this comment.
Should we turn this set of const values into a RejectCode enum type? We could then use it in RejectErr instead of a plain uint8. But I can see that just adding the const values is a win for now. So I wont block approve on this.
Contributor
There was a problem hiding this comment.
Maybe we should make the name more specific than UnavailableRejectCode. Something like PriceOracleUnavailableRejectCode might be clearer. It’s long, but many things could be unavailable, so the extra clarity feels worthwhile.
Comment on lines
+100
to
+108
| const ( | ||
| // UnspecifiedOracleErrorCode represents the case where the oracle has | ||
| // declined to give a more specific reason for the error. | ||
| UnspecifiedOracleErrorCode OracleErrorCode = iota | ||
|
|
||
| // UnsupportedAssetOracleErrorCode represents the case in which an | ||
| // oracle does not provide quotes for the requested asset. | ||
| UnsupportedAssetOracleErrorCode | ||
| ) |
Comment on lines
+241
to
+243
| // public is a flag indicating that the error can be forwarded to peers. | ||
| bool public = 2; | ||
|
|
Contributor
There was a problem hiding this comment.
I don’t think the price oracle should decide whether a tapd node forwards an error to its peer. That decision belongs entirely to tapd in my view. So IMO the price oracle shouldn’t signal whether an error is “public” or not.
We want to be able to query price oracle services operated by third parties.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Adds some structure to price oracle error codes, along with some custom handling for them. In particular, a code of '1' now corresponds to an 'unsupported asset' error, which, considered a 'public' error, is forwarded in the customizable message field of the reject messages sent to peers. An error with any other code continues, at present, to be treated as an unspecified error.
Resolves #1749, #1326.
(This is a refinement over the closed #1751, which forwarded errors indiscriminately.)