1 of 1

TypeScript/React Native

⚠️ Deprecated SDK Notice

This SDK is deprecated and will be removed in a future release.

For the purposes of this guide, thezkpass-sdk repository is cloned into the home directory of the current user, retaining its default name. This places thezkpass-sdk repository at ~/zkpass-sdk. As a result, the root directory for the zkpass-client-react-native SDK is set to ~/zkpass-sdk/typescript/react-native/wallet.

Should you choose to clone the zkpass-sdk repository into a different location, ensure that you adjust any referenced paths in the instructions to match your chosen directory structure.

SDK Structures

To find out how the SDK is structured, at the root of the zkPass SDK run the following:

cd ~/zkpass-sdk/typescript/react-native/wallet
tree -L 2

The output should look like this:

├── android
│   ├── app
│   ├── build
│   ├── build.gradle
│   ├── gradle
│   ├── gradle.properties
│   ├── gradlew
│   ├── gradlew.bat
│   └── settings.gradle
├── app.json
├── App.tsx
├── babel.config.js
├── Gemfile
├── index.js
├── ios
│   ├── Podfile
│   ├── reactnativetestapp
│   ├── reactnativetestappTests
│   └── reactnativetestapp.xcodeproj
├── jest.config.js
├── metro.config.js
├── node_modules
├── package.json
├── package-lock.json
├── patches
│   ├── pbkdf2+3.0.8.patch
│   └── react-native-os+1.2.6.patch
├── README.md
├── shim.js
├── src
│   ├── HomePage.tsx
│   ├── constant.ts
│   ├── json-displayer
│   └── styles.ts
├── __tests__
│   └── App.test.tsx
└── tsconfig.json

Here are the descriptions for each sub directory:

android This contains the mobile app for Android device.
ios This contains the mobile app for iOS device.
node_modules This contains all packages that are installed when running npm i. These packages are needed to run the sdk and app.
patches This contains patched packages in node_modules to work in our sdk and app.
src This is the main Wallet Demo App source code.
__tests__ This contains the test for Wallet Demo App.