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.

Sign up for GitHub

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

Handle error string returned in the JSON-RPC response #9

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Handle error string returned in the JSON-RPC response #9

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
221d51b
Handle error string returned in the JSON-RPC response
nkuba May 16, 2023
447e9df
Add more context in unmarshall failure debug message
nkuba May 16, 2023
94663e5
Remove commented code
nkuba May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 37 additions & 6 deletions electrum/network.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ func NewClientSSL(ctx context.Context, addr string, config *tls.Config) (*Client
return c, nil
}

// JSON-RPC 2.0 Error Object
// See: https://www.jsonrpc.org/specificationJSON#error_object
type apiErr struct {
Code int `json:"code"`
Message string `json:"message"`
Expand All @@ -121,10 +123,39 @@ func (e *apiErr) Error() string {
return fmt.Sprintf("errNo: %d, errMsg: %s", e.Code, e.Message)
}

// UnmarshalJSON defines a workaround for servers that respond with error
// that doesn't follow the JSON-RPC 2.0 Error Object format, i.e. electrs/esplora.
// See: https://github.com/Blockstream/esplora/issues/453
func (e *apiErr) UnmarshalJSON(data []byte) error {
var v interface{}
if err := json.Unmarshal(data, &v); err != nil {
return fmt.Errorf("failed to unmarshal error [%s]: %v", data, err)
}

switch v := v.(type) {
case string:
e.Message = v
case map[string]interface{}:
if _, ok := v["code"]; ok {
e.Code = int(v["code"].(float64))
}

if _, ok := v["message"]; ok {
e.Message = fmt.Sprint(v["message"])
}
default:
return fmt.Errorf("unsupported type: %v", v)
}

return nil
}

// JSON-RPC 2.0 Response Object
// See: https://www.jsonrpc.org/specification#response_object
type response struct {
ID uint64 `json:"id"`
Method string `json:"method"`
Error string `json:"error"`
ID uint64 `json:"id"`
Method string `json:"method"`
Error *apiErr `json:"error"`
}

func (s *Client) listen() {
Expand All @@ -150,11 +181,11 @@ func (s *Client) listen() {
err := json.Unmarshal(bytes, msg)
if err != nil {
if DebugMode {
log.Printf("Unmarshal received message failed: %v", err)
log.Printf("unmarshal received message [%s] failed: [%v]", bytes, err)
}
result.err = fmt.Errorf("Unmarshal received message failed: %v", err)
} else if msg.Error != "" {
result.err = errors.New(msg.Error)
} else if msg.Error != nil {
result.err = msg.Error
}

if len(msg.Method) > 0 {
Expand Down