For the best viewing experience, please turn your phone to portrait mode.

Lisk Elements User Guide

This section details how to use Lisk Elements, once you have successfully installed it.

Node.js

Simply import (or require) the package and access its functionality according to the relevant namespace.

import lisk from 'lisk-elements';

const transaction = lisk.transaction.transfer({
    amount: '100000000',
    recipientId: '15434119221255134066L',
    passphrase: 'robust swift grocery peasant forget share enable convince deputy road keep cheap',
});

Equivalent using require syntax:

const lisk = require('lisk-elements').default;

const transaction = lisk.transaction.transfer({
    amount: '100000000',
    recipientId: '15434119221255134066L',
    passphrase: 'robust swift grocery peasant forget share enable convince deputy road keep cheap',
});

Browser

Coming soon.

Sub-packages

For usage regarding each sub-package, see the following pages:

Subcategories Description
API Client The Lisk Elements API Client provides a convenient wrapper for interacting with the public API of nodes on the Lisk network
Constants The Constants object provides some handy general-purpose constants for use with the Lisk Ecosystem
Cryptography The cryptography module provides all the cryptographic functionality necessary when interacting with the Lisk ecosystem
Mnemonic The passphrase module provides tools for generating and validating mnemonic passphrases
Transactions The transactions module provides functions for creating transactions of every type, plus a set of utility functions