basketmap v0.2.25

BasketMap

BasketMap is a library designed to enhance UTXO basket access within the MetaNet ecosystem. When presented with a UTXO basket access request, BasketMap allows wallets to resolves the basket's type ID to provide comprehensive information about the basket type, including its name, icon, and key attributes. This enables users to make well-informed decisions about data access, as they gain a clear understanding of the basket's contents and intended use. Seamlessly integrate BasketMap to improve the transparency of UTXO basket access on the MetaNet.

Installation

Simply use npm to include BasketMap in your project:

npm install basketmap

Usage

You can easily register and resolve information about UTXO baskets by following the example code below.

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

import { BasketMap } from 'basketmap'

const init = async () => {
    const basketMap = new BasketMap()
    
    // Register a new Basket
    await basketMap.registerNewBasket(
        'todo',
        'Todo List Items',
        'uhrp://abcdefg', 
        'ToDo list items represented as UTXO based tokens are stored in this basket.',
        'https://projectbabbage.com'
    )

    // Resolve basket information using the basketId and registryOperator
    const basketInfo= await basketMap.resolveBasketById(
        'todo',
        '032e5bd6b837cfb30208bbb1d571db9ddf2fb1a7b59fb4ed2a31af632699f770a1'
    )
    console.log(basketInfo)
    /**
     * Example Response
     {
            basketId: 'todo',
            name: 'Todo List Items',
            iconURL: 'uhrp://abcdefg',
            description: 'ToDo list items represented as UTXO based tokens are stored in this basket.',
            documentationURL: 'https://projectbabbage.com',
            registryOperator: '032e5bd6b837cfb30208bbb1d571db9ddf2fb1a7b59fb4ed2a31af632699f770a1'
       }
    **/
}
init()

API

Table of Contents

• BasketMap
  • Parameters
  • registerNewBasket
    • Parameters
  • resolveBasketById
    • Parameters
  • resolveBasketByName
    • Parameters
  • listOwnRegistryEntries
  • revokeOwnRegistryEntry
    • Parameters

BasketMap

Empowering effortless UTXO basket information retrieval and registration

Parameters

• config ConfederacyConfig

registerNewBasket

Register a new basket type

Parameters

• basketID string
• name string
• iconURL string
• description string
• documentationURL string

Returns Promise\

resolveBasketById

Resolves a basket from it's metadata

Parameters

• basketID string identifies the type of basket
• registryOperators Array[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
• registryOperator the operator of the basket type registration to resolve

Returns Promise[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<BasketMapRecord>

resolveBasketByName

Resolves basket information by name

Parameters

• name string name associated with a particular basket type
• registryOperators Array[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
• registryOperator the operator of the basket type registration to resolve

Returns Promise[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<BasketMapRecord>

listOwnRegistryEntries

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

Returns Promise\

revokeOwnRegistryEntry

Revokes a owned basket type registration

Parameters

• entry BasketMapRecord basket type registration entry to revoke

Returns Promise\

License

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