npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@verida/vda-name-client

v4.3.0

Published

Client to manage adding and fetching names from the blockchain

Downloads

795

Readme

VDA Name Client

A client library for registering / unregistering a human readable username alias for a DID.

DID's can have multiple usernames (although the smart contract currently limits to just 1)

Dependencies

This package dependes on the following verida-js packages:

  • @verida/types
  • @verida/vda-common
  • @verida/helpers
  • @verida/vda-client-base

And dependes on the following packages for test:

  • @verida/vda-common-test

Installation

yarn add @verida/vda-name-client

Usage

This library can be in read only mode where it just fetches DID's and usernames or in read and write mode where it can also register / unregister usernames.

Read Only

Setup the library in read only mode for reading usernames and DIDs:

import { VeridaNameClient } from '@verida/vda-name-client'
import { EnvironmentType } from '@verida/types'

// Create name Client
const nameClient = new VeridaNameClient({
    environment: EnvironmentType.TESTNET
})

Get usernames for a DID

const usernames = await nameClient.getUsernames(DID_ADDRESS);
console.log(usernames)

Get DID for a username

const USERNAME = 'johndoe.vda'

const did = await nameClient.getDid(USERNAME);
console.log(did)

Read and Write

In order to write to the blockchain, you will require a Polygon private key with MATIC tokens.

Setup the library in read and write mode to support the above get methods and register / unregister usernames:

import { VeridaNameClient } from '@verida/vda-name-client'
import { EnvironmentType, Web3CallType } from '@verida/types'

// DID address that controls the proof of eligibility to mint the SBT
const DID_ADDRESS = '0x...'
// DID private key that controls the proof of eligibility to mint the SBT
const DID_PRIVATE_KEY = '0x...'
// Polygon private key that will fund blockchain transactions
const POLYGON_PRIVATE_KEY = '0x...'
// How to make blockchain requests. This should be 'web3' unless using Verida's meta transaction server.
const CALL_TYPE = 'web3'
// (Optional) Polygon RPC URL (Mumbai testnet)
const RPC_URL = 'https://rpc-mumbai.maticvigil.com'

// Create name Client
const nameClient = new VeridaNameClient({
    environment: EnvironmentType.TESTNET
    callType: CALL_TYPE,
    did: DID_ADDRESS,
    signKey: DID_PRIVATE_KEY,
    web3Options: {
        rpcUrl: RPC_URL,
        privateKey: POLYGON_PRIVATE_KEY
    }
})

Register a name

const USERNAME = 'johndoe.vda'

await nameClient.register(USERNAME)

Unregister a name

const USERNAME = 'johndoe.vda'

await nameClient.unregister(USERNAME)