-
Notifications
You must be signed in to change notification settings - Fork 18
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
React Native Lib Readme Init #210
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 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,3 +1,60 @@ | ||
# `@solana-mobile/seedvaultlib` | ||
|
||
A React Native wrapper of the Seed Vault SDK. | ||
|
||
# Usage | ||
|
||
### Check if Seed Vault is Available | ||
We first need to check if the seed vault service is available on the device. Currently only Saga implementes a seed vault. | ||
```javascript | ||
cosnt allowSimulated = false; // use true to allow simulated seed vault (for dev/testing) | ||
const seedVaultAvailable = await SolanaMobileSeedVaultLib.isSeedVaultAvailable(allowSimulated); | ||
if (!seedVaultAvailable) { | ||
// seed vault is not available, we cant use it | ||
} | ||
``` | ||
|
||
### Add Listeners | ||
|
||
Before interacting with Seed Vault, you should first register callbacks from the Seed Vault service using the `useSeedVault` hook. | ||
```javascript | ||
|
||
var seedVaultEventListener = (event) => { | ||
// event is SeedVaultEvent type | ||
// handle event here | ||
}; | ||
|
||
var seedVaultContentChangeListener = (contentChangeEvent) => { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we should document what event types there are |
||
// contentChangeEvent is SeedVaultContentChange type | ||
// handle content change here | ||
}; | ||
|
||
useSeedVault(seedVaultEventListener, seedVaultContentChangeListener); | ||
``` | ||
|
||
### Authorize a Seed | ||
Before our app can urequest signatures form seed vault, we must first request authorization for our app to use a seed from the user. | ||
```javascript | ||
NativeModules.SeedVaultLib.authorizeNewSeed(); | ||
``` | ||
|
||
### Retreive a list of Authorized Seeds | ||
To retreive a list of all the seeds our app has been authorized to use, call `getAuthorizedSeeds()`. | ||
```javascript | ||
const authorizedSeeds = await NativeModules.SolanaMobileSeedVaultLib.getAuthorizedSeeds(); | ||
``` | ||
|
||
### Get Accounts for a given seed | ||
Once we have obtained an authorized seed, we can get a list of all the accounts (public keys) assocaited with that seed | ||
```javascript | ||
const seed = authorizedSeeds[0]; | ||
const accounts = await NativeModules.SolanaMobileSeedVaultLib.getAccounts(seed.authToken); | ||
``` | ||
|
||
### Sign a Payload | ||
Once we have obtained an accont, we can request signatures from seed vault for that account: | ||
```javascript | ||
NativeModules.SolanaMobileSeedVaultLib.signMessage(seed.authToken, accounts[0].derivationPath, messageBytes); | ||
NativeModules.SolanaMobileSeedVaultLib.signTransaction(seed.authToken, accounts[0].derivationPath, transactionByteArray); | ||
``` | ||
|
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.
use
const
instead ofvar