IdentityWallet SDK implements the 3ID protocol, which is exposed with the ThreeIdProvider. It also provides additional functionality that can be used within the wallet. 3ID is used for user identity, encryption, and data authorization.

ThreeIdProvider

• ​threeIdProvider.send​

IdentityWallet

• ​new IdentityWallet​

• ​identityWallet.get3idProvider​

• ​identityWallet.linkAddress​

Auth

• ​identityWallet.authenticate​

• ​identityWallet.isAuthenticated​

• ​identityWallet.addAuthMethod​

Signing Verifiable Claims

• ​identityWallet.signClaim​

Encrypt/Decrypt

• ​identityWallet.encrypt​

• ​identityWallet.decrypt​

ThreeIdProvider

threeIdProvider.send(rpcRequest, origin, callback)

Sends a request to the provider that is handled by the IdentityWallet instance the provider was retrieved from.

Kind: instance method of ThreeIdProvider Returns: Promise<Object> - The response to send back to the rpc requester

IdentityWallet

new IdentityWallet(config)

Creates an instance of IdentityWallet

Returns: this - An IdentityWallet instance

identityWallet.get3idProvider()

Get the 3IDProvider

Kind: instance method of IdentityWallet Returns: ThreeIdProvider - The 3IDProvider for this IdentityWallet instance

identityWallet.linkAddress(address, provider)

Link a blockchain address to the identity. Usually the address would be an ethereum address (EOA or EIP1271 compatible contract) and the provider is an JSON-RPC provider that can sign a message with this address using personal_sign.

Kind: instance method of IdentityWallet Returns: Object - The link proof object

Auth

identityWallet.authenticate(spaces, opts)

Authenticate to given spaces

Kind: instance method of IdentityWallet Returns: Object - The public keys for the requested spaces of this identity

identityWallet.isAuthenticated(spaces)

Check if authenticated to given spaces

Kind: instance method of IdentityWallet Returns: Boolean - True if authenticated

identityWallet.addAuthMethod(authSecret)

Add a new authentication method for this identity.

Kind: instance method of IdentityWallet

Sign

identityWallet.signClaim(payload, opts)

Sign a verifiable credential. The format of the credential is did-jwt.

Kind: instance method of IdentityWallet Returns: String - The signed claim encoded as a JWT

Encrypt/Decrypt

identityWallet.encrypt(message, space, opts)

Encrypt a message

Kind: instance method of IdentityWallet Returns: Object - The encrypted object (ciphertext and nonce)

identityWallet.decrypt(encryptedObject, space)

Decrypt a message

Kind: instance method of IdentityWallet Returns: String - The decrypted message