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

@digitalcredentials/issuer-registry-client

v3.0.0

Published

Known issuers / verifiers registry client, for use in Typescript, browser, and React Native.

Downloads

316

Readme

Known Issuer Registry Client (@digitalcredentials/issuer-registry-client)

Build status NPM Version

Isomorphic client for fetching Known Issuer/Known Verifier registries for Node, browser and React Native.

Table of Contents

Background

This is a client library for loading Known Issuer or Known Verifier Registries, which are essentially dictionaries of DIDs, containing information on known issuers and verifiers.

The format of these registries is temporary, while the Verifiable Issuers and Verifiers spec is being incubated in the W3C CCG.

Security

Assumes the loaded registries are public, accessible via https.

Note that an individual DID can appear in multiple registries. Because of that, the order of registries loaded matters. For example, given a registry:

const knownRegistries = [{
    "name": "DCC Pilot Registry",
    "url": "https://digitalcredentials.github.io/issuer-registry/registry.json"
  },
  {
    "name": "DCC Sandbox Registry",
    "url": "https://digitalcredentials.github.io/sandbox-registry/registry.json"
  }]

If an issuer DID is contained in both of those registries, the issuer entry (that contains the issuer name and URL) will come from the first registry, "DCC Pilot Registry".

In other words, verifiers and other implementers must order the registries in order of most authoritative to least.

Install

  • Node.js 18+ is recommended.

NPM

To install via NPM:

npm install @digitalcredentials/issuer-registry-client

Development

To install locally (for development):

git clone https://github.com/digitalcredentials/issuer-registry-client.git
cd issuer-registry-client
npm install

Usage

First, put together an array of known issuer and verifier registries you would like to check against:

const knownRegistries = [
  {
    "name": "DCC Pilot Registry",
    "url": "https://digitalcredentials.github.io/issuer-registry/registry.json"
  },
  {
    "name": "DCC Sandbox Registry",
    "url": "https://digitalcredentials.github.io/sandbox-registry/registry.json"
  },
  {
    "name": "DCC Community Registry",
    "url": "https://digitalcredentials.github.io/community-registry/registry.json"
  },
  {
    "name": "DCC Registry",
    "url": "https://digitalcredentials.github.io/dcc-registry/registry.json"
  }
]

You can now:

import { RegistryClient } from '@digitalcredentials/issuer-registry-client'

const registries = new RegistryClient()

// Load the registries from the web (typically done at app startup).
await registries.load({ config: knownRegistries })

// You can now query to see if a DID is known in any registry
console.log(registries.didEntry('did:key:z6MkpLDL3RoAoMRTwTgo3rs39ZwssfaPKtGdZw7AGRN7CK4W'))
/**
DidMapRegistryEntry {
  name: 'My University',
  url: 'https://digitalcredentials.mit.edu',
  location: 'Cambridge, MA, USA',
  inRegistries: Set(2) {
    {
      name: 'DCC Community Registry',
      url: 'https://digitalcredentials.github.io/community-registry/registry.json',
      rawContents: [Object]
    },
    {
      name: 'DCC Sandbox Registry',
      url: 'https://digitalcredentials.github.io/sandbox-registry/registry.json',
      rawContents: [Object]
    }
  }
}
 */

registries.didEntry('did:example:does-not-exist')
// undefined

Contribute

PRs accepted.

If editing the Readme, please conform to the standard-readme specification.

License

MIT License © 2022 Digital Credentials Consortium.