babbage-protomap

ProtoMap

ProtoMap is a library designed to resolve protocol permissions within the MetaNet ecosystem. At its core, ProtoMap empowers users with precise insights into the specific data that applications request when seeking protocol permissions. Beyond abstract protocol IDs, ProtoMap reveals concrete details such as names, icons, descriptions, and protocol documentation links.

This transparency equips MetaNet users to make informed decisions about granting access to their personal information. Navigate data permissions with confidence, thanks to simple integration of ProtoMap.

Installation

Simply use npm to include ProtoMap in your project:

npm install babbage-protomap

Usage

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

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

import { ProtoMap } from 'babbage-protomap'

const init = async () => {
    const protoMap = new ProtoMap()
    
    // Register a new protocol
    await protoMap.registerNewProtocol(
        1, 
        'social apps', 
        'Social Apps Protocol', 
        'uhrp://abcdefg', 
        'The social media application protocol', 
        'https://projectbabbage.com'
    )

    // Resolve protocol information using registryOperator, securityLevel, and protocolID
    const protocolInfo = await protoMap.resolveProtocol(
        '032e5bd6b837cfb30208bbb1d571db9ddf2fb1a7b59fb4ed2a31af632699f770a1', 
        1,
        'social apps'
    )
    console.log(protocolInfo)
    /**
     * Example Response
     {
            securityLevel: '1',
            protocolID: 'social apps',
            name: 'Social Apps Protocol',
            iconURL: 'uhrp://abcdefg',
            description: 'The social media application protocol',
            documentationURL: 'https://projectbabbage.com',
            registryOperator: '032e5bd6b837cfb30208bbb1d571db9ddf2fb1a7b59fb4ed2a31af632699f770a1'
       }
    **/
}
init()

API

Table of Contents

• ProtoMap
  • Parameters
  • registerNewProtocol
    • Parameters
  • resolveProtocol
    • Parameters
  • listOwnRegistryEntries
  • revokeOwnRegistryEntry
    • Parameters

ProtoMap

Make informed decisions about who can access your personal information

Parameters

• ``
• config ConfederacyConfig

registerNewProtocol

Registers a new protocol

Parameters

• securityLevel (0 | 1 | 2)
• protocolID string
• name string
• iconURL string
• description string
• documentationURL string

Returns Promise<void>

resolveProtocol

Resolves a protocol from it's metadata

Parameters

• registryOperator string the operator of the protocol registration to resolve
• securityLevel (0 | 1 | 2) determines the set permission level of this protocol
• protocolID string identifier with this protocol registration
• confederacyURL the Confederacy host of the overlay where the UTXO is tracked

Returns Promise<ProtoMapRecord>

listOwnRegistryEntries

Gets all the protocol registry entries from a user's basket

Returns Promise<ProtoMapRecord>

revokeOwnRegistryEntry

Revokes a owned protocol registration

Parameters

• entry ProtoMapRecord protocol registration entry to revoke

Returns Promise<void>

License

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