Security News
Supply Chain Attack Detected in Solana's web3.js Library
A supply chain attack has been detected in versions 1.95.6 and 1.95.7 of the popular @solana/web3.js library.
lisk-elements
Advanced tools
Lisk Elements is a JavaScript library for Lisk, the blockchain application platform.
Add Lisk Elements as a dependency of your project:
$ npm install --save lisk-elements
Import using ES6 modules syntax:
import lisk from 'lisk-elements';
Or using Node.js modules:
const lisk = require('lisk-elements');
Or import specific namespaced functionality:
import { APIClient, transactions } from 'lisk-elements';
// or
const { APIClient, transactions } = require('lisk-elements');
Note: If you are installing Lisk Elements as an npm dependency via a GitHub reference, you will need to manually build the distribution files by running the following commands from the root directory of your project:
cd node_modules/lisk-elements
npm run build
Our source code is hosted on GitHub. You can build the distribution yourself by cloning the repository, installing the relevant dependencies and running our build script as follows:
git clone https://github.com/LiskHQ/lisk-elements.git
cd lisk-elements/packages/lisk-elements
npm install
npm run build
Access functionality via the relevant namespace. For example, the following will create and (locally) sign a transfer (type 0) transaction, and then broadcast it to the Lisk Testnet.
const transaction = lisk.transaction.transfer({
amount: '123000000',
recipientId: '12668885769632475474L',
passphrase:
'robust swift grocery peasant forget share enable convince deputy road keep cheap',
});
const client = lisk.APIClient.createTestnetAPIClient();
client.transactions
.broadcast(transaction)
.then(console.info)
.catch(console.error);
Full documentation can be found on the Lisk documentation site.
Package | Version | Description |
---|---|---|
lisk-elements | Package contains everything | |
@liskhq/lisk-client | A default set of Elements for use by clients of the Lisk network | |
@liskhq/lisk-api-client | An API client for the Lisk network | |
@liskhq/lisk-constants | General constants for use with Lisk-related software | |
@liskhq/lisk-cryptography | General cryptographic functions for use with Lisk-related software | |
@liskhq/lisk-passphrase | Mnemonic passphrase helpers for use with Lisk-related software | |
@liskhq/lisk-transactions | Everything related to transactions according to the Lisk protocol | |
@liskhq/lisk-transaction-pool | Transaction pool implementation for the Lisk network | |
@liskhq/lisk-p2p | unstructured P2P library for the Lisk protocol | |
@liskhq/lisk-validator | Custom validations utilities related to Lisk protocol | |
@liskhq/lisk-dpos | DPoS consensus algorithm implementation according to the Lisk protocol | |
@liskhq/lisk-bft | Byzantine fault tolerance implementation according to the Lisk protocol | |
@liskhq/lisk-chain | Implements blocks and state management that are used for block processing according to the Lisk protocol |
To run tests for all packages in lisk-elements, run the following command in the root folder:
npm test
To run tests for a specific package, run the same command in the relevant package directory.
Example:
cd packages/lisk-cryptography
npm test
Installation is failing, what should I do?
Make sure you are installing in the root folder, not on the package level.
Run `npm run clean` and `npm run clean:node_modules`, then install again.
I can't build the package, what should I do?
Make sure you first run `npm i`, and then `npm run build` in the root directory.
Tests are failing!
Make sure you are using the correct version of node and npm.
In our current build we recommend node v8.12.0 and npm v6.4.1.
https://github.com/LiskHQ/lisk-elements/graphs/contributors
Copyright 2016-2019 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.
FAQs
Elements for building blockchain applications in the Lisk network
The npm package lisk-elements receives a total of 7 weekly downloads. As such, lisk-elements popularity was classified as not popular.
We found that lisk-elements demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A supply chain attack has been detected in versions 1.95.6 and 1.95.7 of the popular @solana/web3.js library.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.