Lisk Elements Documentation
- Packages: Stand-alone packages of Lisk Elements
- API Client: An API client for interacting with nodes on the Lisk network.
- Client: A default set of elements for use by clients of the Lisk network
- Constants: A set of Lisk-related constants.
- Cryptography: Relevant cryptographic functions.
- Passphrase: Mnemonic passphrase helpers.
- Transactions: Functions for creating, signing and verifying transactions.
Documentation on lisk.io remains up to date with version updates. The table below provides an overview about the former releases and documentation versions of Lisk Elements.
|v2.3.0||19/08/02||Current version, live on lisk.io/documentation|
|v2.2.0||19/07/24||Lisk Elements 2.2 docs|
|v2.1.0||19/06/24||Lisk Elements 2.1 docs|
|v2.0.0||19/01/07||Lisk Elements 2.0 docs|
|v1.1.3||18/11/22||Lisk Elements 1.1 docs|
|v1.0.0||18/08/06||Lisk Elements 1.0 docs|
- Platforms with Node.js version 8.10 and above.
Lisk Elements requires Node.js as the underlying engine for code execution.
This document describes how to install Node and NPM for installation via NPM.
Follow the instructions for your operating system on the Node.js downloads page.
NPM is automatically installed along with Node.js.
Confirm that Node.JS and NPM have been successfully installed by running
node --version npm --version
This section details how to install Lisk Elements for a given distribution.
As all packages in Lisk Elements are independent from each other, they can be installed seperately.
Installation via NPM
To install the latest version of Lisk Elements for use as a dependency in a Node.js project, please proceed with the following:
npm install --save lisk-elements
npm install --save @liskhq/<package-name>
<package-name> can be any of the sub packages in Lisk Elements.
For concrete code examples for each package, check the Packages section.
Upon successful completion, NPM will add the Lisk Elements package to your
Load via CDN
Include the following script using the following HTML. The
lisk variable will be exposed.
To include other packages of Lisk Elements, replace
lisk-client with any of the packages of Lisk Elements.
To update your installation to the latest version of Lisk Elements, simply run the following command:
npm update --save lisk-elements
Contribute to the Codebase
Everyone is invited to contribute to the Lisk Elements codebase. We welcome and appreciate all contributions.
All necessary information can be found on our Lisk Elements Github.
Please be sure to read and follow our Contribution Guidelines.
If you have any further questions please join our Gitter channel.