Skip to content
Client-side library for building decentralized applications.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

ConseilJS

npm version npm Build Status Coverage Status dependencies

A library for building decentralized applications, currently focused on Tezos.

ConseilJS connects to the Nautilus infrastructure for high-performance analytics provided by Conseil and for live chain data and operations via the integrated Tezos node.

Use with Nodejs

Add our NPM package to your project, or include in your web project as: ``.

$ npm i conseiljs

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

node: { fs: 'empty' }

We have a complete React application example for you to check out.

Use with Web

<script src="https://cdn.jsdelivr.net/gh/cryptonomic/conseiljs/dist-web/conseiljs.min.js"
        integrity="sha384-fNmrK/ez+TaHWU7Q4NJqoApMg/PEUAoB+zaQu8zMoFfI24HT4yG1nT4U1cdApmOm"
        crossorigin="anonymous"></script>

A fully functional sample webpage example is available too.

API Overview and Examples

We have ready-to-use examples to copy/paste.

Contribute

There are many ways to contribute to this project. You can develop applications or dApps with it. You can submit bug reports or feature requests. You can ask questions about it on r/Tezos or the Tezos StackExchange. We certainly welcome pull requests as well.

Known Issues

  • Some of the P2P messages are not implemented, specifically those used in baking operations.

Dependency Requirements

  • AWS-SDK dependency must remain as the Ledger Connect feature requires it.

Other references

Wiki

Riot Dev Channel

Cryptonomic Reddit

The Cryptonomic Aperiodical

@CryptonomicTech

You can’t perform that action at this time.