Skip to content

Conversation

@devacc8
Copy link

@devacc8 devacc8 commented Jan 20, 2026

Summary

Added a comprehensive setup section for OnchainKitProvider to both README files to help developers quickly understand required vs optional configuration.

Changes

  • Added "OnchainKitProvider Setup" section after Quickstart
  • Basic usage example with required props
  • Configuration options table with Required/Optional markers
  • Config object structure documentation
  • Note about API key requirements for Paymaster and Identity features

Why

Developers were having trouble distinguishing required from optional fields, leading to cryptic runtime errors when critical setup steps were skipped.

Configuration Table Preview

Prop Required Description
chain ✅ Yes Target chain
children ✅ Yes Your app components
apiKey Recommended CDP API Key
projectId Optional CDP Project ID
rpcUrl Optional Custom RPC URL
config Optional Appearance and wallet config
miniKit Optional Mini App configuration

Fixes #2563

Added a comprehensive setup section for OnchainKitProvider that:
- Shows basic usage example with required props
- Documents all configuration options in a clear table
- Marks required vs optional fields explicitly
- Explains the config object structure
- Notes which features require an API key

Fixes coinbase#2563
@vercel
Copy link

vercel bot commented Jan 20, 2026

@devacc8 is attempting to deploy a commit to the Coinbase Team on Vercel.

A member of the Team first needs to authorize it.

@cb-heimdall
Copy link

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Request: Clarify required setup steps for OnchainKitProvider in README

2 participants