@klayr/elements

Klayr Elements

Klayr Elements is a JavaScript library for building blockchain applications in the Klayr network

Installation

Installation via npm

Add Klayr Elements as a dependency of your project:

$ npm install --save @klayr/elements

Import using ES6 modules syntax:

import * as klayr from '@klayr/elements';

Or using Node.js modules:

const klayr = require('@klayr/elements');

Or import specific namespaced functionality:

import { transactions } from '@klayr/elements';
// or
const { transactions } = require('@klayr/elements');

Packages

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

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.