npm

Need private packages and team management tools?Check out npm Orgs. »

conseiljs

0.3.1 • Public • Published

ConseilJS

npm version npm Build Status Coverage Status dependencies

A library for building decentralized applications in Typescript and Javascript, currently focused on the Tezos platform.

ConseilJS connects to Tezos nodes for live chain data and operations and to Conseil servers for high-performance analytics on blockchain data. Internally, Cryptonomic uses Nautilus for infrastructure deployments of these services. This is the library at the core of our products, Arronax, Mininax and certainly Galleon. There are now ReasonML bindings as well.

Use with Nodejs

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' }

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

Use with Web

<script src="https://cdn.jsdelivr.net/gh/cryptonomic/conseiljs/dist-web/conseiljs.min.js"
        integrity="sha384-9KFoSwB7AGW9/uAX7v//0xQaYLNB6ZV9+MXhm5WJAEFiyye4XGdtCd2WNXqU5x3B"
        crossorigin="anonymous"></script> 

A fully functional sample html page 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

install

npm i conseiljs

Downloadsweekly downloads

292

version

0.3.1

license

Apache-2.0

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability