IXO SignX SDK

Reference for the IXO SignX SDK: QR code login from a phone, encrypted data exchange, signing several transactions in one session, and how to install it.

The IXO SignX SDK (@ixo/signx-sdk) connects a web application to a person's mobile wallet. The person scans a QR code to log in, and approves transactions on their phone instead of in the browser. The SDK coordinates the client application, the mobile app and the server through the login, the exchange of encrypted data, and a session of several transactions.

Use it when your web app needs people to sign in, or to sign IXO blockchain transactions, from their phone. This page lists what the SDK does and how to install and import it. The full API is in the SDK's README.

Package

Package@ixo/signx-sdk on npm
Source codeixofoundation/ixo-signx on GitHub
API referenceThe SignX SDK README

Capabilities

CapabilityWhat it doesFeatures
Mobile-to-web authenticationAuthentication through QR codesQR code login for users. Polling for the status of a login
Data handlingEncrypted data exchange between client applications and mobile appsAES-256-CBC encryption of sensitive data. Exchange and processing of encrypted information
Multi-transaction processingSeveral transactions within a single sessionTransaction sessions that handle several transactions in sequence. Long polling for the status of each transaction

Installation

The SignX SDK can be installed via npm or yarn:

npm install @ixo/signx-sdk
# or
yarn add @ixo/signx-sdk

Quickstart

Import the SignX SDK into your project:

import { SignX } from '@ixo/signx-sdk';

Initialization, login, data handling and transacting are documented in the SignX SDK README.

Use cases

Use caseWhat you build
User authenticationA QR-based login
Data exchange in dAppsTransmission of sensitive information, encrypted
Sequences of transactionsA session in which the person approves several transactions in turn