Self-sdk NPM | npm.io

Self TypeScript SDK

The official Self SDK for TypeScript.

This SDK provides a toolset to interact with the Self network from your TypeScript code.

Installation

$ npm install self-sdk

Usage

Register Application

Before the SDK can be used you must first register an application on the Self Developer Portal. Once registered, the portal will generate credentials for the application that the SDK will use to authenticate against the Self network.

Self provides two isolated networks:

Developer Portal (production network) - Suitable for production services
Developer Portal (sandbox network) - Suitable for testing and experimentation

Examples

Client Setup

async function main() {
  const selfsdk = require("self-sdk");

  const client = await selfsdk.build(
    "<application-id>",
    "<application-secret-key>",
    "random-secret-string",
    "/data",
    { env: "sandbox" },  // optional (defaults to production)
  );

  await client.start()
}

main();

Additionally, you can import the transpiled modules from dist/lib in case you have a modular library:

import authentication from "self-sdk/authentication"

Identity

The identity service provides functionality for looking up identities, devices and public keys.

Get an identity:

let identity = await client.identity().get("<self-id>")

Facts

The fact service can be used to ask for specific attested facts from an identity.

Request a fact:

let phoneNumber = await client.facts().request("<self-id>", [{ fact: "phone_number" }])

Authentication

The authentication service can be used to send an authentication challenge to a users device. The response the user sends will be signed by their identity and can be validated.

let resp = await client.authentication().request("<self-id>")

Documentation

Development

NPM Scripts

npm t: Run test suite
npm start: Run npm run build in watch mode
npm run test:watch: Run test suite in interactive watch mode
npm run test:prod: Run linting and generate coverage
npm run build: Generate bundles and typings, create docs
npm run lint: Lints code
npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)
npm run generate-sources : Generates the valid sources based on a json file (tools/config/sources.json).