Neti Pot Manufacturer

    lisk-core
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.4 • Public • Published

    Logo

    Lisk Core

    License: Apache 2.0 GitHub tag (latest by date) GitHub repo size DeepScan grade GitHub issues GitHub closed issues

    Lisk is a next-generation crypto-currency and decentralized application platform, written entirely in JavaScript. The official documentation about the whole ecosystem can be found in https://lisk.io/documentation.

    Lisk Core is the program that implements the Lisk Protocol. In other words, Lisk Core is what every machine needs to set-up to run a node that allows for participation in the network.

    This document details how to install Lisk Core from source and from npm registry, but there are two other ways to participate in the network: binaries and Docker images. If you have satisfied the requirements from the Pre-Installation section, you can jump directly to the next section Installation Steps.

    Index

    Installation

    Dependencies

    The following dependencies need to be installed in order to run applications created with the Lisk SDK:

    Dependencies Version
    NodeJS 16.15.0

    You can find further details on installing these dependencies in our pre-installation setup guide. Clone the Lisk Core repository using Git and initialize the modules.

    From Source

    git clone https://github.com/LiskHQ/lisk-core.git
    cd lisk-core
    git checkout master
    npm ci
    npm run build
    ./bin/run --help

    From NPM

    $ npm install -g lisk-core
    $ lisk-core COMMAND
    running command...
    $ lisk-core (-v|--version|version)
    lisk-core/3.0.4 darwin-arm64 node-v16.15.0
    $ lisk-core --help [COMMAND]
    USAGE
      $ lisk-core COMMAND
    ...

    Command Topics

    Managing Lisk Node

    To start a Lisk Core node as a background process, we recommend using a process management tool, such as PM2.

    Example using PM2

    npm i -g pm2
    pm2 start "lisk-core start" --name lisk-mainnet
    pm2 status
    pm2 logs lisk-mainnet
    

    For a more advanced options refer to PM2 documentation.

    Configuring Lisk Node

    lisk-core start supports flag and environment variable options to configure a node.

    Also, custom configuration through JSON file is available through the --config, -c flag.

    Example

    With custom config file ./custom-config.json below

    {
      "network": {
        "port": 5000,
      },
      "transactionPool": {
        "maxTransactions": 8096,
        "maxTransactionsPerAccount": 1024,
      },
      "forging": {
        "delegates": [{
          "encryptedPassphrase": "iterations=10&cipherText=0dbd21ac5c154dbb72ce90a4e252a64b692203a4f8e25f8bfa1b1993e2ba7a9bd9e1ef1896d8d584a62daf17a8ccf12b99f29521b92cc98b74434ff501374f7e1c6d8371a6ce4e2d083489&iv=98a89678d1ccd054b85e3b3c&salt=c9cb4e7783cacca6c0e1c210cb9252e1&tag=5c66c5e75a6241538695fb16d8f0cdc9&version=1",
          "hashOnion": {
            "count": 10000,
            "distance": 1000,
            "hashes": [
              "aaf012545a584890a169cf57d8f7e688",
              "f7a3fb976e50d882c709edb63bde4d9c",
              "1bd121882cb1dee1107699001c2676fb",
              "c4ad7d98da02c94ef8bda2f80d35290a",
              "096f0e77f963face5e99b9db460ce45f",
              "de3d0c34bdcbdcfa2b7b1871c99d4948",
              "5deb5e369a98510932835d74768cf86c",
              "c0cd6ce3f75256149c8fe5d0bffdc99a",
              "1a32706893f1523db0c7bb81be5e55ac",
              "7e8f1ea4aa317993152e1a6b55b16f25",
              "5e5100bbd2c2d5e00197d4ec19102dd6"
            ]
          },
          "address": "9cabee3d27426676b852ce6b804cb2fdff7cd0b5"
        }],
      },
      "plugins": {
        "httpApi": {
          "port": 7000,
        },
      },
    }
    

    Running a command will overwrite the default config and use the specified options.

    lisk-core start -n devnet -c ./custom-config.json

    For a more detailed understanding of configuration read this online documentation.

    Tests

    Automated tests

    All automated tests will run with the below command.

    npm test
    

    Running a local development node

    In order to run a node for a local test, in a root folder of lisk-core, run below command.

    ./bin/run start -n devnet --data-path ./devnet-data --port 3333 --api-ws --enable-http-api-plugin --http-api-plugin-port 3334 --enable-forger-plugin
    

    This command will start a lisk-core node using data path ./devent-data with HTTPAPI and Forger Plugins. Data on the node can be obtained by commands like

    ./bin/run node:info --data-path ./devnet-data
    ./bin/run block:get 3 --data-path ./devnet-data
    

    Contributors

    https://github.com/LiskHQ/lisk-core/graphs/contributors

    License

    Copyright 2016-2022 Lisk Foundation

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    Install

    npm i lisk-core

    DownloadsWeekly Downloads

    3

    Version

    3.0.4

    License

    Apache-2.0

    Unpacked Size

    1.72 MB

    Total Files

    185

    Last publish

    Collaborators

    • juanglisk
    • michaltuleja
    • 1manugowda
    • lisk