Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Latest commit

 

History

History
70 lines (51 loc) · 5.94 KB

README.md

File metadata and controls

70 lines (51 loc) · 5.94 KB

Logo

Lisk Elements

License: Apache 2.0

What is Lisk Elements

Lisk Elements is a collection of libraries, each of them implementing some form of blockchain application functionality such as cryptography, transactions, p2p, etc. Each library is designed to be compatible with the Lisk Protocol.

Lisk Elements supports the modular architecture of the Lisk SDK, where libraries can be created or modified to suit individual blockchain application requirements.

Packages

Package Version Description
lisk-elements npm Package contains everything
@liskhq/lisk-api-client npm An API client for the Lisk network
@liskhq/lisk-chain npm Implements blocks and state management that are used for block processing according to the Lisk protocol
@liskhq/lisk-codec npm Decoder and encoder using Lisk JSON schema according to the Lisk protocol
@liskhq/lisk-cryptography npm General cryptographic functions for use with Lisk-related software
@liskhq/lisk-db npm A database access implementation for use with Lisk-related software
@liskhq/lisk-p2p npm unstructured P2P library for the Lisk protocol
@liskhq/lisk-passphrase npm Mnemonic passphrase helpers for use with Lisk-related software
@liskhq/lisk-transactions npm Everything related to transactions according to the Lisk protocol
@liskhq/lisk-transaction-pool npm Transaction pool implementation for the Lisk network
@liskhq/lisk-tree npm Merkle tree implementations for use with Lisk-related software
@liskhq/lisk-utils npm Generic utility functions for use with Lisk-related software
@liskhq/lisk-validator npm Validation library according to the Lisk protocol

Installation

If you want to install all elements as dependency of your project you can install it via.

$ npm install --save lisk-elements

Or you can install individual packages what you need e.g.

$ npm install --save @liskhq/lisk-transactions
$ npm install --save @liskhq/lisk-cryptography

Get Involved

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

License

Copyright 2016-2020 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.