VESS
  • VESS.id
  • Basics
    • Background
    • Why VESS?
    • VOXEL
    • How does it work
    • Roadmap
    • Terminology
  • Tutorials
    • Create your first VOXEL
    • Share your VOXELs
    • Search Other One's VOXELs
    • Dework Integration
  • Use Cases
    • for Personal
    • for DAO Managers
    • for Job Marketplace
  • VESS SDK
    • Overview
    • API Documentation
      • V2
        • Auth
          • connect()
          • Disconnect()
        • Get
          • getOrganization()
          • getAllVCsByHolder(did:string)
        • Create
          • issueEventCredEIP712()
          • issueMembershipCredEIP712()
          • issueCertificationCredEIP712()
          • createVSCredential()
      • V1
        • Get
          • getTaskCredential()
          • getHeldTaskCredentials()
          • getOrganization()
          • getCreatedOrganization()
          • getMembership()
          • getCreatedMemberships()
          • getVerifiableMembershipSubjectCredential()
          • getHeldMembershipSubjects()
          • getIssuedMembershipSubjects()
          • getHeldSelfClaimedMembershipSubjects()
          • getEvent()
          • getIssuedEvents()
          • getEventAttendance()
          • getIssuedEventAttendanceVerifiableCredentials()
          • getHeldEventAttendanceVerifiableCredentials()
          • getSocialLinks()
          • getHighlightedCredentials()
        • Create
          • createTask()
          • storeSocialLinks()
          • storeSelfClaimedMembership()
          • createOrganization()
          • createMembership()
          • createEvent()
          • issueMembershipSubject()
          • issueEventAttendanceCredential()
        • Update
          • updateTask()
          • updateOrganization()
          • updateEvent()
  • Advanced
    • Tech Architecture
    • Work Credential Data-Model
    • Visualization Protocol v0.1
Powered by GitBook
On this page
  • Install
  • Getting started
  • Initialize
  • Connect ComposeDB/Ceramic
  • Next steps:
  1. VESS SDK

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.

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

Previousfor Job MarketplaceNextAPI Documentation

Last updated 1 year ago

VESS:

Github:

API Documentation
https://app.vess.id/
https://github.com/cvoxelprotocol/vess-kit