-
Notifications
You must be signed in to change notification settings - Fork 2
Documentation cleanup #426
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
fb25670
Cleaned up the main README
esplinr a952d66
Moved note on WebAssembly into the docs folder
esplinr cec71b0
Cleaned up the note about WebAssembly
esplinr c02e60d
yarn to npm and other cleanup
esplinr b295f47
Clean up examples README
esplinr 3498689
Removing yarn.lock so we consistently use npm
esplinr 339d504
Merge branch 'master' into master
esplinr cfeff25
Clarifying the json-rpc per maycon's feedback
esplinr ec0019f
Merge branch 'master' into master
maycon-mello File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Other Topics | ||
|
|
||
| ## Using WebAssembly | ||
|
|
||
| React native doesn't support WebAssembly. Libraries that require WebAssembly need to run in a WebView. This includes some components of the wallet-sdk. Messages are exchanged with the React Native thread through a JSON RPC client / server layer. The Wallet SDK can be used to abstract all the complexity of the WebView communication with the react-native thread. | ||
|
|
||
| The WebView is similar to a REST API, and its entry point is in the wallet-sdk-wasm package. Each module in the package has a service-rpc client to interact with the service.js that is running in the main thread (React Native): | ||
|
|
||
| `@docknetwork/wallet-sdk-wasm/lib/services/[moduleName]/service-rpc` | ||
| interacts with | ||
| `@docknetwork/wallet-sdk-wasm/lib/services/[moduleName]/service.js` | ||
|
|
||
| Notice that the `modules` folder is running in the main thread (react native) and will be using the json rpc client (`@docknetwork/wallet-sdk-core/lib/client`) to interact with `@docknetwork/wallet-sdk-core/lib/service` methods | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| # Wallet sdk examples | ||
| # Wallet SDK Examples | ||
|
|
||
| This repository contains examples for working with the Truvera Wallet SDK. | ||
| https://github.com/docknetwork/wallet-sdk | ||
|
|
||
| https://github.com/docknetwork/wallet-sdk |
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the files
@docknetwork/wallet-sdk-core/lib/clientand@docknetwork/wallet-sdk-core/lib/servicedoesn't exist.The proper path should be:
@docknetwork/wallet-sdk-wasm/lib/services/[moduleName]/service-rpcto interact with@docknetwork/wallet-sdk-wasm/lib/services/[moduleName]/service.jsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated the guidance. Please check to see if I understood correctly.