coinbase / coinbase/onchainkit

Documentation Request: Add guidance on error surfaces and user-facing messaging for common OnchainKit failures

Open
#2,570 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
1k
Forks
520
Avg merge
32m
Merged PRs (30d)
2

Description

### Is your documentation request related to a problem? Please describe.

OnchainKit exposes multiple user-facing failure modes (wallet not connected, wrong network, rejected signature, insufficient funds, RPC errors). However, there is no centralized guidance on how these errors are surfaced or how apps should translate them into clear, user-friendly messages

Developers often ask:
- which errors are expected vs exceptional
- which errors should be shown directly to users
- how to map low-level errors to friendly UI copy
- how to keep messaging consistent across components and hooks

### Proposed Solution

- Add a documentation section (e.g., “Error Handling & UX Guidelines”).
- Categorize common errors (connection, network, user rejection, balance, RPC).
- Provide recommended user-facing message examples for each category.
- Include guidance on when to retry vs prompt user action.
- Reference existing components/hooks where applicable.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.