ThreeIdProvider is a JavaScript SDK that allows developers to create and manage 3ID identities on the Ceramic network. It exposes a DID Provider interface which exposes JOSE signing and decryption though a JOSN-RPC interface. ThreeIdProvider can be used in combination with js-did.

Install 3id-did-provider in your npm project:

$ npm install 3id-did-provider

Import the 3id-did-provider module

const ThreeIdProvider = require('3id-did-provider')

Import using the dist build in your html code

<script type="text/javascript" src="../dist/threeid-provider.js"></script>

the getPermission configuration parameter is always required when creating an instance of ThreeIdProvider. It is used to give an application permission to decrypt and sign data. What this function should do is to present a dialog to the user in the wallet UI, asking for permission to access the given paths.

The function is called with one parameter which is the request object. It looks like this:

{
  type: 'authenticate',
  origin: 'https://my.app.origin',
  payload: {
    paths: ['/path/1', '/path/2']
  }
}

In the above example the app with origin https://my.app.origin is requesting access to /path/1 and /path/2. If the user consents to this the function should just return the paths array, otherwise an empty array. Note that an array containing only some of the requested paths may also be returned.

To create an instance with an auth method you can pass two params to the create function as shown below. If the auth method doesn't have a 3ID associated with it yet a new 3ID will be created.

const authSecret = new Uint8Array([ ... ]) // Entropy used to authenticate
const authId = 'myAuthenticationMethod' // a name of the auth method

const threeId = await ThreeIdProvider.create({ getPermission, authSecret, authId })

To create a wallet with a seed you can simply pass it as an option to the constructor. This will create an instance of the ThreeIdProvider that derives all it's keys from this seed. Be careful, if this seed is lost the DID and all of it's data will be lost as well.

const seed = '0xabc123...' // a hex encoded seed

const threeId = await ThreeIdProvider.create({ getPermission, seed })

An instance of the DID provider from ThreeIdProvider can be passed directly to js-did.

const provider = threeId.getDidProvider()
const did = new DID({ provider })

@oed

Kind: global class

• Keychain
  • new Keychain()
  • .list() ⇒ Array.<string>
  • .add(authId, authSecret)
  • .remove(authId)
  • .status() ⇒ KeychainStatus
  • .commit()

The Keychain enables adding and removing of authentication methods.

List all current authentication methods.

Kind: instance method of Keychain
Returns: Array.<string> - A list of authIds.

Add a new authentication method (adds to staging).

Kind: instance method of Keychain

Remove an authentication method (adds to staging).

Kind: instance method of Keychain

Show the staging status of the keychain. Since removing auth methods will rotate the keys of the 3ID its a good idea to remove multiple auth methods at once if desired. Therefore we introduce a commit pattern to do multiple updates to the keychain at once.

Kind: instance method of Keychain
Returns: KeychainStatus - Object that states the staging status of the keychain

Commit the staged changes to the keychain.

Kind: instance method of Keychain

Kind: global class

• Permissions
  • new Permissions()
  • .request(origin, paths) ⇒ Array.<String>
  • .has(origin, paths) ⇒ Boolean
  • .get(origin) ⇒ Array.<String>
  • .set(origin, paths)

The Permissions class exposes methods to read and update the given permissions

Request permission for given paths for a given origin.

Kind: instance method of Permissions
Returns: Array.<String> - The paths that where granted permission for

Determine if permission has been given for paths for a given origin.

Kind: instance method of Permissions
Returns: Boolean - True if permission has previously been given

Get the paths which the given origin has permission for.

Kind: instance method of Permissions
Returns: Array.<String> - The permissioned paths

Set the paths which the given origin should have permission for.

Kind: instance method of Permissions

Kind: global class

• ThreeIdProvider
  • new ThreeIdProvider()
  • instance
    • .keychain
    • .permissions
    • .id
    • .getDidProvider() ⇒ DidProvider
    • .resetIDX()
  • static
    • .create(config) ⇒ ThreeIdProvider

Use ThreeIdProvider.create() to create an ThreeIdProvider instance

Kind: instance property of ThreeIdProvider
Properties

Kind: instance property of ThreeIdProvider
Properties

Kind: instance property of ThreeIdProvider
Properties

Get the DIDProvider

Kind: instance method of ThreeIdProvider
Returns: DidProvider - The DIDProvider for this ThreeIdProvider instance

Reset the IDX doc structure to a default (mostly empty) state.

Kind: instance method of ThreeIdProvider

Creates an instance of ThreeIdProvider

Kind: static method of ThreeIdProvider
Returns: ThreeIdProvider - An ThreeIdProvider instance