Table of Contents
What is the Lisk SDK?
The Lisk SDK aims to provide an easy and reliable software development kit for building blockchain applications which are compatible with the Lisk protocol.
The architecture of the Lisk SDK has been designed so that it can be extended to meet the requirements of a wide variety of blockchain application use cases.
The Lisk SDK makes every effort to allow developers to focus simply and purely on writing the code that matters to their own blockchain application, and nothing more.
The following dependencies need to be installed in order to run blockchain clients created with the Lisk SDK.
If you are using NVM, install the correct version as shown below:
It is recommended to install Lisk Commander globally with NPM (Node Package Manager), to facilitate the convenient usage of the Lisk Commander CLI.
To check the successful installation of Lisk Commander, run the following command:
Once Lisk Commander is installed, install the following compiler dependencies as well.
Ensure that Homebrew is installed.
Initializing a new blockchain client
Execute the lisk init command of Lisk Commander as shown below, to bootstrap a default blockchain client in the current folder.
As a result of executing the init command, you will be asked for the Name, ChainID, Description, Author, and License of the new blockchain client.
Next, all the required files are created by Lisk Commander.
It is now already possible to start the newly bootstrapped blockchain client with default configurations for a local Devnet:
Configure your blockchain parameters
The blockchain client offers a variety of configuration options such as blockTime, maxTransactionsSize, and much more.
For a complete overview of the client configuration options, please check out the SDK configuration reference and the Blockchain client configuration guide.
To use the custom config with the client, use the -config flag. Also add the -overwrite-config flag, if you used another config the last time the client was started.
Registering new modules and plugins
A module defines the logic that makes state changes on-chain, meaning that it will be a part of the blockchain protocol.
A plugin, on the other hand, defines an off-chain logic that is not part of the blockchain protocol but enhances the blockchain application features.
Add your new module or plugin to your blockchain client conveniently with Lisk Commander:
Generating a new module
Use the generate:module command in the root folder of the blockchain client to generate a ready-to-use module template.
For more detailed explanations how to create a module, please refer to the guide How to create a module
Generating a new plugin
Use the generate:plugin command in the root folder of the blockchain client to generate a ready-to-use plugin template.
For a more detailed explanation of how to create a plugin, please refer to the guide: How to create a plugin
For further explanations, guides and tutorials, see the official Lisk SDK documentation.
The Lisk SDK operates on the NodeJS runtime and consists primarily of an application framework (Lisk Framework), a collection of libraries providing blockchain application functionalities (Lisk Elements), and a powerful command-line tool (Lisk Commander) helping developers to build a blockchain application using Lisk Framework. The diagram below provides a high-level overview of the architecture:
Directory Description Framework An application framework responsible for establishing and maintaining the interactions between the modules of a Lisk blockchain application. Elements A collection of libraries, each of them implementing some form of blockchain application functionality such as cryptography, transactions, p2p, etc. Commander A command line tool to help developers to build a blockchain application using Lisk Framework.
Reason How Want to chat with our community Reach them on Discord Found a bug Open a new issue Found a security issue See our bounty program Want to share your research Propose your research Want to develop with us Create a fork
How to Contribute
To contribute to lisk-sdk, framework or elements:
Clone the repository: git clone https://github.com/LiskHQ/lisk-sdk.git
Install Yarn Classic globally
Install dependencies and build:
- yarn build
Testing your local lisk-sdk in your application.
In order to link your local lisk-sdk repository and test your application which uses lisk-sdk, simply follow the steps below in your local lisk-sdk repository and run yarn link lisk-sdk in the root of your application.
Once you have linked your local repo, every time you make changes in lisk-sdk/elements you must build packages before testing:
a. To build all packages: npm run build or yarn build
b. To build specific package: yarn workspace <package name> build or go into each package folder and yarn build or npm run build Example: yarn workspace @liskhq/lisk-p2p build
Note: In case you face any issues during the installation, make sure you have the right version of yarn and node and try resetting the project with yarn clean:full.
By using the Beta release of the Lisk SDK, you acknowledge and agree that you have an adequate understanding of the risks associated with the use of the Beta release of the Lisk SDK and that it is provided on an “as is” and “as available” basis, without any representations or warranties of any kind. To the fullest extent permitted by law, in no event shall the Lisk Foundation or other parties involved in the development of the Beta release of the Lisk SDK have any liability whatsoever to any person for any direct or indirect loss, liability, cost, claim, expense or damage of any kind, whether in contract or in tort, including negligence, or otherwise, arising out of or related to the use of all or part of the Beta release of the Lisk SDK.
Copyright 2016-2023 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
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.