/quicknode-marketplace-add-on

Primary LanguageJavaScriptMIT LicenseMIT

Quicknode Marketplace Starter Code - Javascript

This repo is an example of how to build a QuickNode Marketplace add-on using node.js, Express.js, and sequelize with PostgreSQL.

It implements the 4 provisioning routes that a partner needs to integrate with Marketplace, as well as the required Healthcheck route.

It also has support for:

Getting Started

To install and run the application locally:

  1. Clone this repo.
  2. npm install
  3. Copy and fill .env: cp .env.example .env
  4. Create database: npx sequelize-cli db:create
  5. Run migrations: npx sequelize-cli db:migrate --migrations-path src/migrations
  6. Run seeders to have test data in development env: npx sequelize-cli db:seed:all --seeders-path src/seeders
  7. Run npm start

Routes

The application has 4 provisioning routes protected by HTTP Basic Auth:

  • POST /provision
  • PUT /update
  • DELETE /deactivate
  • DELETE /deprovision

It has a public healthcheck route that returns 200 if the service and the database is up and running:

  • GET /healthcheck

It has a dashboard that can be accessed using Single Sign On with JSON Web Token (JWT):

  • GET /dashboard?jwt=foobar

It has an JSON RPC route:

  • POST /rpc

Testing with qn-marketplace-cli

You can use the qn-marketplace-cli tool to quickly test your add-on while developing it.

To obtain a basic auth string, you can use Ruby or your language of choice with your username and password, as such:

Base64.encode64("username:password")

For the commands below, the --basic-auth flag is the Base64 encoding of username:password. You need to make sure to replace that with your valid credentials (as defined in your .env file).

Provisioning:

./qn-marketplace-cli pudd --base-url http://localhost:3030 --basic-auth dXNlcm5hbWU6cGFzc3dvcmQ=

SSO:

./qn-marketplace-cli sso --url http://localhost:3030/provision --jwt-secret jwt-secret --basic-auth dXNlcm5hbWU6cGFzc3dvcmQ=

RPC:

./qn-marketplace-cli rpc --url http://localhost:3030/provision --rpc-method qn_test --rpc-url http://localhost:3030/rpc  --rpc-params "[\"abc\"]" --basic-auth dXNlcm5hbWU6cGFzc3dvcmQ=

Healthcheck:

./qn-marketplace-cli healthcheck --url http://localhost:3030/healthcheck

License

MIT