echojs-lib
    TypeScript icon, indicating that this package has built-in type declarations

    1.13.6 • Public • Published

    Echojs-lib (echojs-lib)

    Build Status David npm npm

    Pure JavaScript ECHO library for node.js and browsers. Can be used to construct, sign and broadcast transactions in JavaScript, and to easily obtain data from the blockchain via public apis.

    Setup

    This library can be obtained through npm:

    npm install echojs-lib
    

    Preparation

    Launched echo node (https://github.com/echoprotocol/echo-core) with open port

    Usage

    const { default: echo } = require('echojs-lib');
    
    await echo.connect('ws://127.0.0.1:9000');
    const account = await echo.api.getObject('1.2.0');

    You also can use it with import

    import echo from 'echojs-lib';
    
    await echo.connect('ws://127.0.0.1:9000');
    const account = await echo.api.getObject('1.2.0');

    To more examples and options look at section below

    Connection - More connections options

    API - List with all api methods

    Subscriber - Subscriber module

    Cache - Information about cache

    Redux - Information about integrating lib cache to redux with auto update

    Transactions - Transactions examples

    Crypto - Create private/public keys example

    Constants - List of constants you can use

    Serializers - List of all serializers

    Contract - Information about contract

    Run Tests

    Tests use a locally running Echo node. Therefore, before starting the tests, you need to start Echo with predefined configuration parameters.

    The easiest way is to use docker-compose:

    cd .test
    docker-compose up

    After the node is started, you can run the tests:

    npm run test

    License

    The MIT License

    Copyright (c) 2018 - 2019 Echo Technological Solutions LLC

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Keywords

    none

    Install

    npm i echojs-lib

    DownloadsWeekly Downloads

    74

    Version

    1.13.6

    License

    MIT

    Unpacked Size

    1.82 MB

    Total Files

    487

    Last publish

    Collaborators

    • echojs