InzProvider SDK

The InzProvider SDK provides a set of functions to interact with authentication and user profile services.

Installation

To install the InzProvider SDK, simply import it into your project:

npm install inz-sdk

yarn add inz-sdk

Usage/Examples

import InzProvider from "inz-provider-sdk";

// Initialize the provider for the mainnet
const provider = new InzProvider({ isMainnet: true });

// Retrieve signature data from the server
const signatureInfo = await provider.getSignMessageInfo();

// Sign in the user
const signInParams = {
    chain_id: 1,
    nonce: "unique_nonce",
    signature: "user_signature",
    public_address: "user_public_address",
};
const signInResponse = await provider.signIn(signInParams);

// Sign in the user using Google OAuth
const oauthIdToken = "google_oauth_token";
const googleSignInResponse = await provider.signInWithGoogle(oauthIdToken);

// Retrieve user profile data
const accessToken = "user_access_token";
const userProfile = await provider.getProfile(accessToken);

API Reference

getSignMessageInfo()

Retrieves signature data from the server.

Returns

• Promise<SignatureResponse>: A promise that resolves with signature data.
  • sign_msg (string): The message to be signed by the user.
  • nonce (string): A unique string used to prevent replay attacks.

signIn(params: SignInPayload)

Signs in the user.

Parameters

• params: The parameters required for signing in.
  • chain_id: The ID of the blockchain network.
  • nonce: A unique string used to prevent replay attacks.
  • signature: The signature generated by the user to authenticate the sign-in request.
  • public_address: The public address associated with the user's account.

Returns

• Promise<SignInResponse>: A promise that resolves with sign-in response data.\
  • access_token (string): The access token used to authenticate the user's requests.
  • signature (string): The signature generated by the user to authenticate the sign-in request.
  • public_address (string): The public address associated with the user's account.
  • divice_id (string): The unique ID of the user's device.
  • nonce (string): A unique string used to prevent replay attacks.
  • xrip (string): The XRP address associated with the user's account.

signInWithGoogle(oauthIdToken: string)

Signs in the user using Google OAuth.

Parameters

• oauthIdToken: The ID token obtained from Google OAuth.

Returns

• Promise<SignInResponse>: A promise that resolves with sign-in response data.
  • access_token (string): The access token used to authenticate the user's requests.
  • public_address (string): The public address associated with the user's account.
  • divice_id (string): The unique ID of the user's device.

getProfile(token: string)

Retrieves user profile data.

Parameters

• token: The access token for authentication.

Returns

• Promise<ProfileResponse>: A promise that resolves with user profile data.
  • username (string): The username of the user's account.
  • email (string): The email address of the user's account.
  • avatar (string): The URL of the user's avatar.
  • public_address (string): The public addresses associated with the user's account.

Support

For support, please contact https://innovaz.io Support.