basketmap-services v0.1.0

basketmap-services

Topic Manager and Lookup Service for BasketMap Registry

API

Table of Contents

• BasketMapLookupService
  • Parameters
• BasketMapTopicManager
  • getDocumentation
• BasketMapStorageEngine
  • Parameters
  • storeRecord
    • Parameters
  • deleteRecord
    • Parameters
  • findById
    • Parameters
  • findByName
    • Parameters

BasketMapLookupService

Implements a lookup service for BasketMap name registry

Parameters

• storageEngine

BasketMapTopicManager

Implements a topic manager for BasketMap name registry

getDocumentation

Returns the documentation for the BasketMap topic

Returns Promise[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) the documentation given as a string

BasketMapStorageEngine

Implements a Lookup StorageEngine for BasketMap name registry

Parameters

• db connected mongo database instance

storeRecord

Parameters

• txid string
• outputIndex number
• registration BasketMapRegistration

Returns Promise\

deleteRecord

Delete a matching BasketMap record

Parameters

• txid string
• outputIndex number

Returns Promise\

findById

Find basket type registration by Id

Parameters

• basketID string
• registryOperators Array[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
• type
• registryOperator

Returns Promise[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

findByName

Find basket type registration token by name

Parameters

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

Returns Promise[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

License & Confidentiality

This is proprietary software developed and owned by Peer-to-peer Privacy Systems Research, LLC. Except as provided for in your CWI Partner Agreement with us, you may not use this software and must keep it confidential.