Overview

WIP

VESS KIT SDK is a typescript library that makes it easy to work with DID/VC on VESS.

VESS content is stored in Ceramic Network, a decentralized data network, and VESS's private. cloud server. This means that data shared by users is open and available to the public.

Install

Frontend

pnpm add vess-kit-core vess-kit-web 

Backend

pnpm add vess-kit-core vess-kit-node 

Getting started

Initialize

Frontend

import { getVESSKit } from 'vess-kit-web'

const vessKit = getVESSKit()

Backend

import { getVESSKit } from 'vess-kit-node'

const vessKit = getVESSKit()

Connect ComposeDB/Ceramic

Frontend

import { getVESSKit } from 'vess-kit-web'

const isDev:boolean = true
const env = isDev ? 'testnet-clay': 'mainnet'
const address = "0x....."
const provider:Web3Provider = new Web3Provider() //any web3 provider
const vessKit = getVESSKit(isDev)

const { session } = await vess.connect(address, provider, env)

Backend

import { getVESSKit } from 'vess-kit-node'

const isDev:boolean = true
const address = "0x....."
const provider:Web3Provider = new Web3Provider() //any web3 provider
const signer = provider.getSinger()
const vessKit = getVESSKit(isDev)

const didSession = await vessKit.connect(
        address,
        async (message) => {
          const signed = await signer.signMessage(message)
          return signed
        },
        isDev ? 'testnet-clay':'mainnet',
      )

Next steps:

For more infomation, please check below.

pageAPI Documentation

Please visit here for an example of VESS-KIT usage.

VESS: https://app.vess.id/

Github: https://github.com/cvoxelprotocol/vess-kit

Last updated