Skip to content

docs: add React Native integration guide - #95

Merged
truthixify merged 1 commit into
wraith-protocol:developfrom
0dillon:docs/react-native-integration
Jul 27, 2026
Merged

docs: add React Native integration guide#95
truthixify merged 1 commit into
wraith-protocol:developfrom
0dillon:docs/react-native-integration

Conversation

@0dillon

@0dillon 0dillon commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR adds the React Native integration guide for wiring up @wraith-protocol/sdk and @wraith-protocol/sdk-react within mobile applications (both Expo and Bare React Native workflows).

Closes #76

What Changed

  • Added a new integration guide at guides/integrations/react-native.mdx.
  • Documented cryptographic shimming of global.crypto.getRandomValues using expo-crypto (for Expo) and react-native-get-random-values (for Bare React Native workflow).
  • Documented polyfilling Buffer for React Native.
  • Provided a standard wrapper pattern for persistent storage utilizing @react-native-async-storage/async-storage.
  • Added a complete TS/TSX boilerplate component (MainScreen) illustrating connection, stealth payment sending, and incoming payment scanning.
  • Registered the new guide under the "Guides" navigation group in docs.json.

Key Design Decisions

  • Storage Interface: Formulated the AsyncStorage adapter to conform to standard Key-Value storage interfaces (getItem, setItem, removeItem) expected by custom React/React Native SDK initializations.
  • Top-Level Shimming: Placed shims at the very beginning of the entry file (e.g., App.js / index.js) to guarantee secure random bytes are available before any cryptographic SDK packages are imported.

Acceptance Criteria Checklist

  • Snippet CI passes (npm test compiles all MDX code blocks successfully).
  • Clear instruction distinction between Expo vs. Bare workflows.
  • Step-by-step wiring notes for AsyncStorage + expo-crypto.
  • Full, copy-pasteable send + receive TSX code example.
  • Navigation sidebar entry added to docs.json.

Test Output

Ran local snippet checks against all workspace documents:

> npm test

MDX files scanned: 38
Code fences found: 438
Checked snippets: 425
Skipped no-check snippets: 13
Snippet check passed.

@drips-wave

drips-wave Bot commented Jul 24, 2026

Copy link
Copy Markdown

@0dillon Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@truthixify
truthixify merged commit e1a07b6 into wraith-protocol:develop Jul 27, 2026
2 checks passed
@truthixify

Copy link
Copy Markdown
Contributor

Merged. RN guide fills a real gap for mobile devs, thanks.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

React Native integration guide

2 participants