Getting Started

Installation

Install the SDK from npm or yarn:

npm install @vechain/react-native-wallet-link

or

yarn add @vechain/react-native-wallet-link

Peer Dependencies

Make sure to also install VeChain’s SDK dependencies:

npm install @vechain/sdk-core @vechain/sdk-network

or

yarn add @vechain/sdk-core @vechain/sdk-network

---

Environment Requirements

• React Native ≥ 0.71

• Node.js ≥ 16

• VeWorld mobile app installed on the user’s device

• Expo (optional but supported)

• Access to VeChain node (Mainnet, Testnet, or custom)

---

Project Setup

1) Wrap your app in VeWorldProvider

To enable wallet functionality globally, wrap your root component with VeWorldProvider:

import React from 'react';
import { VeWorldProvider } from '@vechain/react-native-wallet-link';
import { TESTNET_URL } from '@vechain/sdk-network';
import * as Linking from 'expo-linking';

export default function App() {
  return (
    <VeWorldProvider
      appName="My VeChain App"
      appUrl="https://myvechainapp.com"
      redirectUrl={Linking.createURL('/', { scheme: 'myvechainapp' })}
      node={TESTNET_URL}
      config={{
        onVeWorldConnected: (response) => {
          console.log('Connected to VeWorld:', response);
        },
        onVeWorldDisconnected: () => {
          console.log('Disconnected from VeWorld');
        },
      }}
    >
      {/* Your app components go here */}
    </VeWorldProvider>
  );
}

2) Configure Deep Linking

Your app needs to handle redirects from VeWorld using deep links.

For Expo (recommended):

{
  "expo": {
    "scheme": "myvechainapp",
    "linking": {
      "prefixes": ["myvechainapp://", "https://myvechainapp.com"]
    }
  }
}

For iOS, update Info.plist with your URL scheme. For Android, define intent filters in AndroidManifest.xml.

💡 Tip: Use a unique app scheme to prevent collisions with other apps.

3) Verify Installation

After setup, rebuild your app and run it on a physical device with VeWorld installed. You should now be able to trigger VeWorld from your app and receive connection callbacks.

🧪 Try calling connect(publicKey) from useVeWorldWallet() — VeWorld should open and prompt for connection approval.

---

← Back to Overview · Next → Integration Guide