Lisk Plugin Backup

Installation

npm install lisk-plugin-backup
# or
yarn add lisk-plugin-backup

Getting started

// src/application/index.js

import { BackupPlugin } from 'lisk-plugin-backup';

app.registerPlugin(BackupPlugin);

Usage

Once configured, the plugin will backup the data when appropriate. Currently, only forger-info are supported, and they will be backup'ed every time you forge a block.

Configuration

The plugin is designed to support a number of ways to backup the data. So far only the s3 adapter is available.

// src/application/index.js

const appConfig = utils.objects.mergeDeep({}, configDevnet, {
  plugins:  {
      "backup": {
          "forgerInfo": {
              "enable": true,
              "adapter": "s3",
              "adapterParams": {
                  "accessKey": "YOUR_ACCESS_KEY",
                  "privateKey": "YOUR_PRIVATE_KEY",
                  "region": "YOUR_REGION",
                  "endpoint": "YOUR_BUCK_HOSTNAME_WITHOUT_SCHEME",
                  "objectPath": "DESTINATION_PATH",
                  "metadata": { // arbitratry metadata for the S3 object
                      "chain": "MY_CHAIN_NAME",
                      "network": "devnet"
                  }
              }
          }
      }
  },
});

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