Signiqo Developer Documentation

1. Introduction

Welcome to the Signiqo Developer Documentation. Signiqo offers a revolutionary way for users to interact with decentralized applications (dApps) by leveraging biometric authentication for cryptographic operations and managing Decentralized Identifiers (DIDs).

Our primary goal is to provide a seamless and secure user experience, abstracting away the complexities typically associated with Web3 interactions, such as managing seed phrases and browser extensions.

This documentation will guide you through integrating the Signiqo SDK into your application, enabling passwordless, biometric-secured logins and transaction signing for your users.

2. Getting Started

This section will help you set up your development environment and install the necessary tools to begin integrating Signiqo.

2.1. Prerequisites

• Node.js (version 16.x or higher recommended)
• npm or yarn package manager
• A Signiqo App ID (obtainable from the Signiqo Developer Portal - Coming Soon)
• Basic understanding of JavaScript/TypeScript and Web3 concepts.

2.2. Installation

To install the Signiqo SDK, use your preferred package manager:

Using npm:

npm install @signiqo/sdk

Using yarn:

yarn add @signiqo/sdk

Once installed, you can import the SDK into your project.

3. SDK Overview

The Signiqo SDK provides a set of functions to easily integrate our core features.

3.1. Authentication (Login)

Signiqo allows users to authenticate using their device's biometric capabilities. The login function initiates this process.

import { login } from '@signiqo/sdk';

async function handleLogin() {
  try {
    const session = await login({ 
      appId: 'YOUR_APP_ID', // Replace with your actual App ID
      // Optional parameters can be added here
    });

    if (session.isAuthenticated) {
      console.log('User authenticated successfully!');
      console.log('User DID:', session.user.did);
      // Store session or user information as needed
    } else {
      console.log('Authentication failed or was cancelled.');
    }
  } catch (error) {
    console.error('Error during login:', error);
  }
}

handleLogin();

The login function returns a session object containing authentication status and user information, including their DID.

3.2. Signing Messages/Transactions

Users can sign messages or transaction payloads using their biometrics. The sign function handles this.

import { sign } from '@signiqo/sdk';

async function handleSignMessage() {
  const messageToSign = "Sign this message to confirm your action.";
  // For EVM transactions, this could be an EIP-712 typed data object or a raw transaction hex
  
  try {
    const signature = await sign(messageToSign, {
      reason: "Confirm your important action", // Displayed to the user
      // chainId: 1, // Optional: specify chain ID for EVM transactions
      // Other signing options
    });

    console.log('Message signed successfully. Signature:', signature);
    // Use the signature to verify on backend or submit to blockchain
  } catch (error) {
    console.error('Error during signing:', error);
  }
}

handleSignMessage();

The sign function takes the payload to be signed and an options object. It returns the cryptographic signature.

3.3. DID Management

Signiqo automatically manages the user's DID. The DID is available as part of the session object after a successful login. Future SDK versions may include more advanced DID management features, such as:

• Retrieving DID Documents.
• Updating DID Document service endpoints.
• Managing Verifiable Credentials associated with the DID (Details to be announced).

For now, the primary interaction with the DID is obtaining it upon authentication and using it as the user's identifier within your dApp.

4. API Reference (Coming Soon)

A detailed API reference for all SDK modules and functions will be available here soon. This will include:

• Function signatures
• Parameter descriptions
• Return types
• Error codes

5. Examples (Coming Soon)

We are preparing comprehensive examples to showcase various integration scenarios:

• Basic Login Flow
• NFT Marketplace Interaction (Listing, Buying)
• DeFi Protocol Interaction (Swapping, Staking)
• DAO Voting

These examples will be provided in popular frameworks like React, Vue, and vanilla JavaScript.

6. Support

If you encounter any issues or have questions while integrating Signiqo, please reach out to us:

• Developer Community (Coming Soon): Join our Discord or forum for community support and discussions.
• Email Support: For specific technical issues, contact devsupport@signiqo.com.
• GitHub Issues: Report bugs or suggest features on our SDK's GitHub repository (link will be provided).

We are committed to helping you build amazing Web3 experiences with Signiqo!