Code Monkey home page Code Monkey logo

conseiljs's Introduction

ConseilJS

npm version npm Build Status Coverage Status dependencies

Client-side library for building decentralized applications, currently focused on Tezos.

ConseilJS connects to Conseil for cached blockchain data and Nautilus for live chain data and operations.

Use

Add our NPM package to your project.

$ npm i conseiljs

If you are using webpack in your project, add below lines to your webpack.config.js file:

 node: {
    fs: 'empty'
  }

Develop

You can find some tutorials in our wiki to help you get started with ConseilJS.

Below is the list of namespaces you can import to your project and start building immediately:

TezosNodeQuery - Utility functions for interacting with the Tezos node.

TezosConseilClient - Functions for querying the Conseil backend REST API v2

TezosConseilQuery - Functions for querying the Conseil backend REST API v1

TezosHardwareWallet - Functions for interaction with the Tezos node via a Hardware wallet. (Only Ledger Nano S for now)

TezosMessageCodec - A collection of functions to encode and decode various Tezos P2P message components

TezosOperations - Functions for sending operations on the Tezos network.

TezosWallet - Functions for Tezos wallet functionality.

TezosTypes - Types used to process data returned from Conseil server.

Example import:

import { TezosOperations } from 'conseiljs';

Run Tests

Unit Tests

npm run test runs all unit tests.

Integration Tests

Add a file called servers.ts under the integration_test with these contents:

export const servers = {
    conseilServer: '',
    conseilApiKey: '',
    tezosServer: ''
}

The blank strings should be replaced with the details of your Conseil & Tezos servers.

After this, npm run integration-test to run all integration tests. Please note that some of the integration tests require the usage of a hardware wallet.

Dependency Issues

  • As later versions of the npm package libsodium-sumo (a JS wrapper around libSodium) do not support all methods of libSodium, this version must remain at 0.5.4
  • AWS-SDK dependency must remain as the Ledger Connect feature depends on this package

conseiljs's People

Contributors

anonymoussprocket avatar ba205 avatar developer0623 avatar jurajselep avatar neocybereth avatar umurb avatar vishakh avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.