Skip to content

Add docs for @tetherto/wdk-react-native-core

Viet Tan Tran requested to merge github/fork/gatteo/docs/react-native-core into develop

Created by: gatteo

Summary

Adds full documentation for @tetherto/wdk-react-native-core (v1.0.0-beta.3), the hooks-based React Native integration layer for WDK. Replaces all references to the deprecated wdk-react-native-provider.

Changes

File Action
tools/react-native-core/README.md New - Landing page with features, quick start, bundle configuration (custom + pre-built), architecture
tools/react-native-core/api-reference.md New - Complete API reference with table of contents: WdkAppProvider, useWdkApp (discriminated union WdkAppState), useWalletManager, useAccount (with estimateFee, extension), useAddresses, useBalance, useBalancesForWallet, useRefreshBalance, BaseAsset, types, utilities
start-building/react-native-quickstart.md Updated - Rewrote Option 2 with Sepolia testnet config (works out of the box), bundle setup with wdk-worklet-bundler, hints for Indexer API keys / module selection / biometrics on simulator, link to API reference
ui-kits/react-native-ui-kit/get-started.md Updated - Integration example uses useWdkApp state pattern + useBalance(accountIndex, asset) signature
skills/wdk/SKILL.md Updated - wdk-react-native-provider → wdk-react-native-core in package table
SUMMARY.md Updated - Added nav entry under Tools
overview/changelog.md Updated - Added March 7 entry for react-native-core docs
sdk/core-module/configuration.md Fix - Fixed broken middleware configuration section (missing code block closing tags)

Key API changes documented (beta.2 → beta.3)

  • useWdkApp() returns { state: WdkAppState, retry } with discriminated union (INITIALIZING, NO_WALLET, LOCKED, READY, ERROR)
  • useAccount() always returns an object (never null), adds isLoading, error, estimateFee, UseAccountResponse-based return types
  • useBalance() signature changed to (accountIndex, asset, options?) - network derived from asset
  • useWalletManager() updated createTemporaryWallet(walletId, mnemonic?), added advanced crypto methods
  • WdkAppProvider adds requireBiometrics prop
  • Removed AppStatus/InitializationStatus enums (no longer exported)

Test plan

  • Preview - React Native Core appears in Tools nav with API Reference sub-page
  • All hooks documented with params, return types, and code examples
  • Quickstart Option 2 works end-to-end with Sepolia testnet config
  • No remaining references to wdk-react-native-provider except deprecation notes
  • All cross-links resolve correctly
  • Middleware configuration section in sdk/core-module/configuration.md renders correctly

Merge request reports