React Native

1.Add the AuthCore Service SDK to Your React Native App

Run this command:

npm install @particle-network/rn-auth-core
// install react-native-particle-auth to initialize SDK and set custom config.
npm install @particle-network/rn-auth

click here to get the demo source code

2.Configure Android project

Prerequisites

Make sure that your project meets the following requirements:

  • Targets API Level 23 (Marshmallow) or higher

  • Uses Android 6.0 or higher

  • Java 11

Configure project information๏ผŒRefer to here

android {
    ...
    defaultConfig {
        ......
        manifestPlaceholders["PN_PROJECT_ID"] = "your project id"
        manifestPlaceholders["PN_PROJECT_CLIENT_KEY"] = "your project client key"
        manifestPlaceholders["PN_APP_ID"] = "your app id"
    }
   
   //How you quote wallet sdk, you must set it
    dataBinding {
        enabled = true
    }

}

3.Configure iOS project

Prerequisites

  • Install the following:

    • Xcode 14.1 or later.

  • Make sure that your project meets the following requirements:

    • Your project must target these platform versions or later:

      • iOS 14

  • Please note that the current version of our software does not support simulation testing. To perform testing, you will require an actual iPhone device.

3.1 After export iOS project, open your_project_name.xcworkspace under ios folder, here its name is ParticleAuthExample.xcworkspace.

3.2 Create a ParticleNetwork-Info.plist into the root of your Xcode project, and make sure the file is checked under Target Membership.

3.3 Copy the following text into this file:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>PROJECT_UUID</key>
	<string>YOUR_PROJECT_UUID</string>
	<key>PROJECT_CLIENT_KEY</key>
	<string>YOUR_PROJECT_CLIENT_KEY</string>
	<key>PROJECT_APP_UUID</key>
	<string>YOUR_PROJECT_APP_UUID</string>
</dict>
</plist>

3.4 Replace YOUR_PROJECT_UUID, YOUR_PROJECT_CLIENT_KEY, and YOUR_PROJECT_APP_UUID with the new values created in your Dashboard

3.5 Edit Podfile, you should follow Podfile required to edit Podfile.

Usage

You can get the demo source code from here

import * as particleAuthCore from "@particle-network/rn-auth-core";
import * as particleAuth from "@particle-network/rn-auth";

Initialize the SDK

Before using the SDK you have to call init(Required)

// Get your project id and client from dashboard,  
// https://dashboard.particle.network/
ParticleInfo.projectId = ''; // your project id
ParticleInfo.clientKey = ''; // your client key 

const chainInfo = Ethereum;
const env = Env.Production;
particleAuth.init(chainInfo, env);
particleAuthCore.init();

Connect

If loginType is email or phone, you can pass email address or phone number to account.

If loginType is JWT, you must pass JWT token to account. if loginType is email or phone, it will present a login page, if you want to customize the email or phone login page, try below method sendPhoneCode, sendEmailCode, connectWithCode

SocialLoginPrompt: optional, only google, discord and microsoft support it.

If loginType is email or phone, below parameter is optional, other wise, they are useless.

The supportAuthTypes controls which types of social login buttons are displayed at the bottom of the login page.

The loginPageConfig controls the title, description, and image displayed on the login page.

const result = await particleAuthCore.connect(LoginType.Email, null, supportAuthType, SocialLoginPrompt.SelectAccount, {
  projectName: "React Native Example",
  description: "Welcome to login",
  imagePath: "https://connect.particle.network/icons/512.png"
});
if (result.status) {
  const userInfo = result.data as UserInfo;
  console.log('connect', userInfo);
} else {
  const error = result.data as CommonError;
  console.log('connect', error);
}

Connect with Google

const result = await particleAuthCore.connect(LoginType.Google)

Connect with JWT

const result = await particleAuthCore.connectJWT(jwt);

Send email / phone verification code

phone number requires formate E.164, such as +11234567890

const result = await particleAuthCore.sendPhoneCode(phoneNumber);

const result = await particleAuthCore.sendEmailCode(email);

Connect with email / phone verification code

 const result = await particleAuthCore.connectWithCode(
 phone | null, 
 email | null, 
 code);

Disconnect

const result = await particleAuthCore.disconnect();
if (result.status) {
    console.log(result.data);
} else {
    const error = result.data;
    console.log(error);
}

IsConnected

const result = await particleAuthCore.isConnected();
console.log(result);

Switch chain

const chainInfo: ChainInfo = PolygonMumbai;
const result = await particleAuthCore.switchChain(chainInfo);
console.log(result);

Change master password

const result = await particleAuthCore.changeMasterPassword();
if (result.status) {
    console.log(result.data);
} else {
    const error = result.data;
    console.log(error);
}

Has set payment password

const hasPaymentPassword = await particleAuthCore.hasPaymentPassword();
console.log('hasPaymentPassword', hasPaymentPassword);

Has set master password

const hasMasterPassword = await particleAuthCore.hasMasterPassword();
console.log('hasMasterPassword', hasMasterPassword);

Get user info

const result = await particleAuthCore.getUserInfo();
const userInfo = JSON.parse(result);
console.log(userInfo);

Open account and security

const result = await particleAuthCore.openAccountAndSecurity();
if (result.status) {
    const signature = result.data;
    console.log(signature);
} else {
    const error = result.data;
    console.log(error);
}

EVM Sign

Get address

const address = await evm.getAddress();
console.log('evm address ', address);

Personal sign and personal sign unique

// message requires hexadecimal string or human readable string.
const message = 'Hello world!'; 

const result = await evm.personalSign(message);
const result = await evm.personalSignUnique(message);

if (result.status) {
    const signature = result.data;
    console.log(signature);
} else {
    const error = result.data;
    console.log(error);
}

Sign typed data and sign typed data unique

// typedData requires hexadecimal string or human readable json string.
const typedData: string = 'your typed data v4'

const result = await evm.signTypedData(typedData);
const result = await evm.signTypedDataUnique(typedData);

if (result.status) {
    const signature = result.data;
    console.log(signature);
} else {
    const error = result.data;
    console.log(error);
}

Send transaction

// transaction requires hexadecimal string
const transaction = 'your transaction';

const result = await evm.sendTransaction(transaction);
if (result.status) {
    const signature = result.data;
    console.log(signature);
} else {
    const error = result.data;
    console.log(error);
}

Solana Sign

Get address

const address = await solana.getAddress();
console.log('solana address ', address);

Sign message

// message requires human readable string.
const message = 'Hello world!';
const result = await solana.signMessage(message);
if (result.status) {
    const signature = result.data;
    console.log(signature);
} else {
    const error = result.data;
    console.log(error);
}

Sign transaction

const sender = await solana.getAddress();
console.log('sender: ', sender);
const transaction = await Helper.getSolanaTransaction(sender);
// transaction requires base58 string.
const result = await solana.signTransaction(transaction);
if (result.status) {
    const signature = result.data;
    console.log(signature);
} else {
    const error = result.data;
    console.log(error);
}

Sign all transactions

const sender = await solana.getAddress();
console.log('sender: ', sender);
const transaction1 = await Helper.getSolanaTransaction(sender);
const transaction2 = await Helper.getSplTokenTransaction(sender);
// transaction requires base58 string.
const transactions = [transaction1, transaction2];

const result = await solana.signAllTransactions(transactions);
if (result.status) {
    const signature = result.data;
    console.log(signature);
} else {
    const error = result.data;
    console.log(error);
}

Sign and send transaction

const sender = await solana.getAddress();
console.log('sender: ', sender);
const transaction = await Helper.getSolanaTransaction(sender);
// transaction requires base58 string.
const result = await solana.signAndSendTransaction(transaction);
if (result.status) {
    const signature = result.data;
    console.log(signature);
} else {
    const error = result.data;
    console.log(error);
}

Blind sign enable

This switch will work if the following conditions are met:

1. your account is connected with JWT

2. your account does not set payment password

3. SecurityAccountConfig.promptSettingWhenSign is 0, you can call particleAuth.setSecurityAccountConfig to update its value.

setBlindEnable = async () => {
  particleAuthCore.setBlindEnable(true);
}

getBlindEnable = async () => {
  const result = await particleAuthCore.getBlindEnable();
  console.log('getBlindEnable', result);
  Toast.show({
    type: 'success',
    text1: `getBlindEnable ${result}`,
  });
}

Last updated