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 code | ixofoundation/ixo-signx on GitHub |
| API reference | The SignX SDK README |
Capabilities
| Capability | What it does | Features |
|---|---|---|
| Mobile-to-web authentication | Authentication through QR codes | QR code login for users. Polling for the status of a login |
| Data handling | Encrypted data exchange between client applications and mobile apps | AES-256-CBC encryption of sensitive data. Exchange and processing of encrypted information |
| Multi-transaction processing | Several transactions within a single session | Transaction 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-sdkQuickstart
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 case | What you build |
|---|---|
| User authentication | A QR-based login |
| Data exchange in dApps | Transmission of sensitive information, encrypted |
| Sequences of transactions | A session in which the person approves several transactions in turn |