CertMap

CertMap is a library that redefines certificate access within the MetaNet ecosystem. When encountering a certificate access grant, CertMap resolves the type ID to comprehensive information about the certificate type, showcasing its name, icon, and other essential details. This approach empowers users with a clear understanding of the certificate's nature and purpose, aiding them in informed decisions about granting access to their personal information. Seamlessly integrate CertMap to enhance the transparency of certificate interactions on the MetaNet.

Installation

Simply use npm to include CertMap in your project:

npm install certmap

Usage

You can easily register and resolve certificate types by following the example code below.

Note: You must have your MetaNet Client running in order for this to work!

import { CertMap } from 'certmap'

const init = async () => {
    const certMap = new CertMap()
    
    // Register a new certificate
    await certMap.registerNewCertificateType(
        'z40BOInXkI8m7f/wBrv4MJ09bZfzZbTj2fJqCtONqCY=',
        'SigniCert Certifier',
        'uhrp://abcdefg', 
        'Babbage identity certifier used to verify users within the Babbage MetaNet Client.',
        'https://projectbabbage.com',
        {
            firstName: 'First name of the user being certified',
            profileName: 'Last name of the user being certified',
            profilePhoto: 'UHRP URL of a verified profile photo of the user being certified'
        }
    )

    // Resolve certificate type information using registryOperator, and type
    const certificateTypeInfo= await certMap.resolveCertificateType(
        '032e5bd6b837cfb30208bbb1d571db9ddf2fb1a7b59fb4ed2a31af632699f770a1', 
        'z40BOInXkI8m7f/wBrv4MJ09bZfzZbTj2fJqCtONqCY='
    )
    console.log(certificateTypeInfo)
    /**
     * Example Response
     {
            type: 'z40BOInXkI8m7f/wBrv4MJ09bZfzZbTj2fJqCtONqCY=',
            name: 'SigniCert Certifier',
            iconURL: 'uhrp://abcdefg',
            description: 'Babbage identity certifier used to verify users within the Babbage MetaNet Client.',
            documentationURL: 'https://projectbabbage.com',
            fields: {
                firstName: 'First name of the user being certified',
                profileName: 'Last name of the user being certified',
                profilePhoto: 'UHRP URL of a verified profile photo of the user being certified'
            }
            registryOperator: '032e5bd6b837cfb30208bbb1d571db9ddf2fb1a7b59fb4ed2a31af632699f770a1'
       }
    **/
}
init()

API

Table of Contents

• CertMap
  • Parameters
  • registerNewCertificateType
    • Parameters
  • resolveCertificateByType
    • Parameters
  • resolveCertificateByName
    • Parameters
  • listOwnRegistryEntries
  • revokeOwnRegistryEntry
    • Parameters

CertMap

Make informed decisions about who can access your personal information

Parameters

• ``
• config ConfederacyConfig

registerNewCertificateType

Register a new certificate type

Parameters

• type string
• name string
• iconURL string
• description string
• documentationURL string
• fields object An object whose keys are field names, and whose values are objects, where each field object contains a human-readable field name, and a human-readable field description

Returns Promise<void>

resolveCertificateByType

Resolves a certificate type from it's metadata

Parameters

• type string identifier of the certificate type
• registryOperators Array<string>
• registryOperator the operator of the certificate type registration to resolve

Returns Promise<Array<CertMapRecord>>

resolveCertificateByName

Resolves certificate information by name

Parameters

• name string name associated with a particular certificate type
• registryOperators Array<string>
• registryOperator the operator of the certificate type registration to resolve

Returns Promise<Array<CertMapRecord>>

listOwnRegistryEntries

Gets all the certificate type registry entries from a user's basket

Returns Promise<Array<CertMapRecord>>

revokeOwnRegistryEntry

Revokes a owned certificate type registration

Parameters

• entry CertMapRecord certificate type registration entry to revoke

Returns Promise<void>

License

The license for the code in this repository is the Open BSV License