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

ump-services

v0.1.3

Published

Topic Manager and Lookup Service for User Management Protocol

Downloads

10

Readme

signia-services

Topic Manager and Lookup Service for Signia Key Registry

API

Links: API, Classes

Classes

| | | --- | | KnexStorageEngine | | UMPLookupService | | UMPTopicManager |

Links: API, Classes


Class: KnexStorageEngine

export class KnexStorageEngine {
    knex: Knex;
    tablePrefix: string;
    migrations: {
        up: (knex: Knex) => Promise<void>;
        down: (knex: Knex) => Promise<void>;
    }[];
    constructor({ knex, tablePrefix = "ump_lookup_" }) 
    async storeRecord({ txid, outputIndex, presentationKeyHash, recoveryKeyHash }) 
    async deleteRecord({ txid, outputIndex }) 
    async findByPresentationKeyHash({ presentationKeyHash }) 
    async findByRecoveryKeyHash({ recoveryKeyHash }) 
}
Method deleteRecord

Deletes an existing UMP record

async deleteRecord({ txid, outputIndex }) 

Argument Details

  • obj
    • all params given in an object
Method findByPresentationKeyHash

Look up a UMP record by the presentationKeyHash

async findByPresentationKeyHash({ presentationKeyHash }) 

Argument Details

  • obj
    • params given in an object
Method findByRecoveryKeyHash

Look up a UMP record by the recoverKeyHash

async findByRecoveryKeyHash({ recoveryKeyHash }) 

Argument Details

  • obj
    • params given in an object
Method storeRecord

Stores a new UMP record

async storeRecord({ txid, outputIndex, presentationKeyHash, recoveryKeyHash }) 

Argument Details

  • obj
    • all params given in an object

Links: API, Classes


Class: UMPLookupService

Implements a Lookup Service for the User Management Protocol

export class UMPLookupService implements LookupService {
    storageEngine: KnexStorageEngine;
    constructor(storageEngine: KnexStorageEngine) 
    async getDocumentation(): Promise<string> 
    async getMetaData(): Promise<{
        name: string;
        shortDescription: string;
        iconURL?: string;
        version?: string;
        informationURL?: string;
    }> 
    async outputAdded(txid: string, outputIndex: number, outputScript: Script, topic: string) 
    async outputSpent(txid: string, outputIndex: number, topic: string) 
    async lookup({ query }) 
}
Method lookup
async lookup({ query }) 

Returns

with the data given in an object

Argument Details

  • obj
    • all params given in an object
Method outputAdded

Notifies the lookup service of a new output added.

async outputAdded(txid: string, outputIndex: number, outputScript: Script, topic: string) 

Returns

indicating the success status

Argument Details

  • obj
    • all params are given in an object
Method outputSpent

Deletes the output record once the UTXO has been spent

async outputSpent(txid: string, outputIndex: number, topic: string) 

Argument Details

  • obj
    • all params given inside an object
  • obj.txid
    • the transactionId the transaction the UTXO is apart of
  • obj.outputIndex
    • the index of the given UTXO
  • obj.topic
    • the topic this UTXO is apart of

Links: API, Classes


Class: UMPTopicManager

Implements a topic manager for User Management Protocol

export class UMPTopicManager implements TopicManager {
    identifyNeededInputs?: ((beef: number[]) => Promise<Array<{
        txid: string;
        outputIndex: number;
    }>>) | undefined;
    async getDocumentation(): Promise<string> 
    async getMetaData(): Promise<{
        name: string;
        shortDescription: string;
        iconURL?: string;
        version?: string;
        informationURL?: string;
    }> 
    async identifyAdmissibleOutputs(beef: number[], previousCoins: number[]): Promise<AdmittanceInstructions> 
}
Method identifyAdmissibleOutputs

Returns the outputs from the UMP transaction that are admissible.

async identifyAdmissibleOutputs(beef: number[], previousCoins: number[]): Promise<AdmittanceInstructions> 

Links: API, Classes


License

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