Skip to content

Merge pull request #414 from docknetwork/chore/rename-repo-to-wallet-sdk rename repo to wallet-sdk #51

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Merge pull request #414 from docknetwork/chore/rename-repo-to-wallet-sdk rename repo to wallet-sdk #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions developer-documentation/wallet-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,27 @@
# Wallet SDK
# Truvera Wallet SDK

The [Wallet SDK](https://github.com/docknetwork/wallet-sdk) enables you to build a Verifiable Credentials wallet inside your app and allows your users to receive, store, and manage their DOCK tokens too. This was built for mobile applications with added support for Polkadot-JS.

To use the wallet-sdk, all you need to do is wrap your app in a `WalletSDKProvider` and start building your wallet.

Using [polkadot-js](https://polkadot.js.org/) libraries in React Native is a challenge, due to the lack of WebAssembly support.\
Using [polkadot-js](https://polkadot.js.org/) libraries in React Native is a challenge, due to the lack of WebAssembly support.
The Truvera Wallet SDK handles all the Polkadot Web Assembly in a WebView, sending messages to the React Native thread through a JSON RPC layer.

Truvera Mobile SDK supports:

* Devices that have Android 8.1 or higher and iOS 11 or higher.
* Minimum supported version of Node.js is 20.2.0
- Devices that have Android 8.1 or higher and iOS 11 or higher.
- Minimum supported version of Node.js is 20.2.0

## Installation

```js
yarn add @docknetwork/wallet-sdk-core
yarn add @docknetwork/wallet-sdk-react-native

```

**There are some scripts and additional dependencies required.**\
Please check our [examples](../../examples/) folder for detailed steps.
**There are some scripts and additional dependencies required.**
Please check our [examples](/examples) folder for detailed steps.

## React Native Example

The following example will create a wallet and allow the user to add credentials to it. Displaying the count of documents added to the wallet.\
The following example will create a wallet and allow the user to add credentials to it. Displaying the count of documents added to the wallet.
Notice that the all documents are accessible through the `documents` object.

```js
Expand Down Expand Up @@ -77,14 +73,14 @@ Check the following repository for detailed examples for running the Truvera Wal

[See the examples](https://github.com/docknetwork/wallet-sdk/tree/master/examples)


## Docs

For more details you can check the [getting started guide](https://github.com/docknetwork/wallet-sdk/blob/master/docs/getting-started.md)

[See the Github repository](https://docknetwork.github.io/wallet-sdk/)

## Features

* [Biometric Plugin](https://github.com/docknetwork/wallet-sdk/blob/master/docs/biometric-plugin.md)
* [Ecosystem Tools](https://github.com/docknetwork/wallet-sdk/blob/master/docs/ecosystem-tools.md)
* [Cloud Wallet](https://github.com/docknetwork/wallet-sdk/blob/master/docs/cloud-wallet.md)
- [Biometric Plugin](https://github.com/docknetwork/wallet-sdk/blob/master/docs/biometric-plugin.md)
- [Ecosystem Tools](https://github.com/docknetwork/wallet-sdk/blob/master/docs/ecosystem-tools.md)
- [Cloud Wallet](https://github.com/docknetwork/wallet-sdk/blob/master/docs/cloud-wallet.md)