Skip to content

idos-network/idos-sdk-js

Repository files navigation

idOS JavaScript SDK

License

SDKs

Folder Contents
📁 consumer-sdk-js idOS JavaScript SDK for consumers
📁 issuer-sdk-js idOS JavaScript SDK for issuers

idos-sdk-js, @core, and @controllers are internal packages.

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.
📁 isle Full-featured standard UI for dApps to include in their application.
📁 passporting-server Backend service for credential passporting between Obliged Entities.

idos-sdk-e2e are the end-to-end tests.

Examples

Folder Contents
📁 consumer-and-issuer Example implementation showing and application that's both the consumer and the issuer
📁 passporting Demo of credential passporting between different Obliged Entities.

Installation

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

pnpm add @idos-network/idos-sdk ethers near-api-js

10,000 foot view

import { idOS } from "@idos-network/idos-sdk";

// 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
const idos = await idOS.init({enclaveOptions: {container: "#idos-container"}});
await idos.setSigner("EVM", signer);

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

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

Support

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