ordinals/ord

Bad RPC error messages on init

Open

#3,064 opened on Jan 29, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (1,479 forks)github user discovery
good first issue

Repository metrics

Stars
 (3,955 stars)
PR merge metrics
 (Avg merge 15d 21h) (5 merged PRs in 30d)

Description

When doing for example ord index update or ord wallet inscriptions while my Bitcoin Core node is turned off, I get this:

$ ord wallet inscriptions
error: cookie file `/Users/torkel/Library/Application Support/Bitcoin/.cookie` does not exist

The inexperienced user would most likely not realize that this error message means "your node is turned off, and therefore there exists no way to authenticate with it. Please turn if on and try again".

An obvious improvement would be to add a simple prefix to the error message, something like could not initialize RPC: <msg>. Perhaps we could even add something like the node is turned off, or you misconfigured the node connection settings?

Contributor guide

Research direction
Find the source of the cookie file error message in the codebase, likely in an RPC initialization module, and prepend a clarifying prefix like 'could not initialize RPC: '.
Tech stack
rust
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80