idOS JavaScript SDK

⚖️ Legalities

By downloading, installing, or implementing any of the idOS’ SDKs, you acknowledge that you have read and understood idOS’ Privacy Policy and Transparency Document.

• https://www.idos.network/legal/privacy-policy
• https://www.idos.network/legal/transparency-document

SDKs

Folder	Contents
📁 consumer	idOS JavaScript SDK for consumers
📁 issuer	idOS JavaScript SDK for issuers
📁 client	idOS JavaScript SDK for browser environments

Auxiliary Applications

Folder	Contents
📁 dashboard-for-dapps	Dashboard for dApp developers to access data that users shared with them. Deployed at https://dashboard-for-dapps.idos.network/.
📁 idos-data-dashboard	Interface for users to visualize and manage their idOS profile. Deployed at https://dashboard.idos.network/.
📁 idos-enclave	A secure browser context for password input, key derivation, encryption, and decryption.

Installation

Get client NPM packages and consumer NPM packages and its dependencies with pnpm or the equivalent of your package manager of choice:

pnpm add @idos-network/client @idos-network/consumer ethers near-api-js

10,000 foot view

import { createIDOSClient, type idOSClient } from "@idos-network/client";

// Connect your user's wallet however you do it today, for example:
const provider = new ethers.BrowserProvider(window.ethereum);
await provider.send("eth_requestAccounts", []);
const signer = await provider.getSigner();

// Initialize the SDK
let idOSClient = createIDOSClient({
  enclaveOptions: { container: "#idOS-container" },
});
idOSClient = await idOSClient.withUserSigner(signer);

// Overview of user's credentials
const credentials = await idOSClient.getAllCredentials();
console.log(credentials);
// [{ id: "4f4d...", issuer: "Fractal ID", type: "KYC"}, ...]

More details on https://github.com/idos-network/idos-sdk-js/blob/main/docs

Support

Please follow the process outlined here: https://github.com/idos-network/.github/blob/main/profile/README.md