Chlu Marketplace JS

Marketplace implementation in Node.JS for the Chlu protocol

Usage

You can use this library in three ways:

• start the HTTP server (easiest way)
• include the HTTP API as an Express sub-app in your existing application
• import the library directly in your existing application

Note: the Chlu Marketplace will start and run a js-ipfs node when used

Documentation

Here are some generated HTML docs for the library. Documentation

Starting the HTTP Server

Note: if you are running other Chlu apps, make sure they are set to the same network.

• clone this repository
• yarn start
• your Marketplace is now running
  • all data is saved in ~/.chlu-marketplace by default
  • also check out yarn start --help to see additional options
  • if you need to access your marketplace from the internet then --marketplace-location is mandatory

Using the library directly

const Marketplace = require('chlu-marketplace-js')

const options = {
  db: {
    password: 'yourpassword'
  }
  // You can pass other options to customize behavior
  // Check out the documentation above for more information
}

const mkt = new Marketplace(options)

// This is not mandatory, the marketplace will be
// started automatically when you use it if it has
// not been started before
await mkt.start()

// Use it
await mkt.registerVendor(...)
await mkt.createPoPR(...)

Using the HTTP API in an Express app

const mktServer = require('chlu-marketplace-js/src/server')
const Marketplace = require('chlu-marketplace-js')

const express = require('express')
const app = express()

// 'app' is your existing express application

app.use('/chlu', mktServer)

app.listen(3000, () => {
    // Done! Your marketplace is mounted at /chlu
})

// If you need custom Marketplace configuration, replace the marketplace instance:

app.locals.mkt = new Marketplace({ ...options })

// The required submodules will be started when the first request
// arrives. If you want to start them right away (recommended) run:
await app.locals.mkt.start() // returns a Promise, make sure to catch errors!

Quickly setup a vendor

There is a non interactive command that generates a new DID, then sets it up as a vendor on a marketplace. Istructions are in the chlu-wallet README