Dashboard plugin

@liskhq/lisk-framework-dashboard-plugin is a plugin for the Lisk Framework that provides a user interface which enables developers to conveniently view and communicate with the blockchain application during the development.

The dashbobard plugin includes the following features:

  • Monitor recent blocks and transactions

  • Show created information about accounts

  • Create new accounts

  • Call exposed application actions

  • Listen to exposed application events

  • Create transactions

  • Get node information

Alias

dashboard

Actions

none

Events

none

Registering the plugin

How to register the dashboard plugin with the blockchain application.

const { Application, genesisBlockDevnet, configDevnet } = require('lisk-sdk');
const { DashboardPlugin } = require('@liskhq/lisk-framework-dashboard-plugin');

const app = Application.defaultApplication(genesisBlockDevnet, configDevnet);

app.registerPlugin(DashboardPlugin);

app
  .run()
  .then(() => app.logger.info('App started...'))
  .catch(error => {
    console.error('Faced error in application', error);
    process.exit(1);
  });

Plugin configuration

The dashboard plugin can be configured in the configuration of the blockchain application under plugins.dashboard.

The application will use the default values in the case whereby there is no plugin configuration provided.
Dashboard options in the configuration
const { Application, genesisBlockDevnet, configDevnet } = require('lisk-sdk');
const { DashboardPlugin } = require('@liskhq/lisk-framework-dashboard-plugin');

const appConfig = utils.objects.mergeDeep({}, configDevnet, {
    plugins: {
        dashboard: {
            applicationUrl: 'ws://localhost:8080/ws',
            port: 4005,
            host: '127.0.0.1',
            applicationName: 'Lisk',
        }
    }
});

const app = Application.defaultApplication(genesisBlockDevnet, appConfig);

app.registerPlugin(DashboardPlugin);

app
  .run()
  .then(() => app.logger.info('App started...'))
  .catch(error => {
    console.error('Faced error in application', error);
    process.exit(1);
  });

Available configuration options

{
    applicationName: {
        type: 'string',
        description: 'Application name to be shown near Logo',
    },
    applicationUrl: {
        type: 'string',
        format: 'uri',
        description: 'URL to connect',
    },
    port: {
        type: 'integer',
        minimum: 1,
        maximum: 65535,
    },
    host: {
        type: 'string',
        format: 'ip',
    },
}