1.3.13 • Published 3 years ago
@getunid/node-wallet-sdk v1.3.13
Table of contents
Introduction
The NodeJS SDK offers convenience and easy-to-use javascript modules for embedding digital wallet capabilities into your application. It enables you to operate decentralized identifiers and verifiable credentials.
Installation
Add the @unid/node-wallet-sdk
dependency:
npm install --save @unid/node-wallet-sdk
# OR
yarn add @unid/node-wallet-sdk
The NodeJS SDK uses MongoDB as a local repository to store keyRings by default. Please install and setup MongoDB in your application.
Configuration
Configuration should happen as early as possible in your application's lifecycle. Once you have set up a cloud agent in UNiD Studio, you will get values required for configuration.
import { UNiD } from '@unid/node-wallet-sdk'
import { MongoClient } from 'mongodb'
const uri = 'mongodb://username:password@localhost:27017'
const mongoClient = new MongoClient(uri, {
useUnifiedTopology: true,
})
(async () => {
// Connect to your mongodb
await mongoClient.connect()
// Initialize UNiD instance
UNiD.init({
clientId : 'client_id',
clientSecret : 'client_secret',
encryptionKey: 'encryption_key',
envNetwork : 'testnet',
localStorage : mongoClient
})
})()
Values | Description |
---|---|
clientId | It is associated with each cloud agent for a tenant. A string consisting of 64 characters that can be retrieved from UNiD Studio. |
clientSecret | A string consisting of 64 characters that can be retrieved from UNiD Studio. It is paired with the clientId . |
encryptionKey | A string used to encrypt keyRings (digital wallet) with AES-256-CBC algorithm and store them in MongoDB. |
envNetwork | The DPKI network to which the DID refers. |
localStorage | A connection instance to MongoDB that must be initialized and instantiated outside of the UNiD libraries to MongoDB. |
Tutorial
First create new DID in your application.
Create DID
import { UNiD, KeyRingType } from '@unid/node-wallet-sdk'
(async () => {
try{
const DID = await UNiD.createDidDocument(
KeyRingType.Mnemonic,
{ length: 24 }
)
console.log('complete generating a DID:', DID.getIdentifier())
} catch (err) {
console.error('ERROR:', err)
}
})()
For more methods and how to use them, please refer to UNiD Documentation.