https://github.com/Cryptonomic/ConseilJS
Client-side library for building decentralized applications.
https://github.com/Cryptonomic/ConseilJS
blockchains decentralized-applications javascript tezos typescript
Last synced: 9 months ago
JSON representation
Client-side library for building decentralized applications.
- Host: GitHub
- URL: https://github.com/Cryptonomic/ConseilJS
- Owner: Cryptonomic
- License: apache-2.0
- Created: 2018-05-27T04:50:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-28T17:55:22.000Z (over 1 year ago)
- Last Synced: 2025-04-30T23:08:33.065Z (9 months ago)
- Topics: blockchains, decentralized-applications, javascript, tezos, typescript
- Language: TypeScript
- Size: 8.88 MB
- Stars: 111
- Watchers: 12
- Forks: 35
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Audit: audits/2020-07-09_Apriorit_Audit.pdf
Awesome Lists containing this project
- awesome-list - ConseilJS - side library for building decentralized applications. | Cryptonomic | 99 | (TypeScript)
README
Note: As of January 2023, ConseilJS is maintained on a best effort basis for Tezos: https://discourse.cryptonomic.tech/t/psa-conseil-conseiljs-will-now-be-maintained-on-a-best-effort-basis-for-tezos/235/2
# ConseilJS-core
[](https://www.npmjs.com/package/conseiljs)
[](https://www.npmjs.com/package/conseiljs)
[](https://travis-ci.org/Cryptonomic/ConseilJS)
[](https://coveralls.io/github/Cryptonomic/ConseilJS?branch=master)
[](https://sonarcloud.io/dashboard?id=Cryptonomic_ConseilJS)
[](https://snyk.io/advisor/npm-package/conseiljs)
A library for building decentralized applications in Typescript and Javascript, currently focused on the [Tezos](http://tezos.com/) platform.
ConseilJS connects to Tezos nodes for live chain data and operations and to [Conseil](https://github.com/Cryptonomic/Conseil) servers for high-performance analytics on blockchain data. Internally, Cryptonomic uses [Nautilus](https://github.com/Cryptonomic/Nautilus) for infrastructure deployments of these services. This is the library at the core of our products – [Arronax](https://arronax.io), [Periscope](https://periscope.arronax.io), [Harpoon](https://harpoon.arronax.io) and certainly [Galleon](https://cryptonomic.tech/galleon.html). There are [ReasonML bindings](https://github.com/Cryptonomic/ConseilJS-ReasonML-Bindings) as well.
Cryptonomic offers an infrastructure service - [Nautilus Cloud](https://nautilus.cloud) which enables quick access to the Tezos platform along with products that make it easier build on it.
## Sub-modules
As of version 5.0.0, ConseilJS has been split into three parts: this library, which is considered to be the core, ConseilJS-softsigner and ConseilJS-ledgersigner. This was done in an effort to make the library more portable across different environments. If neither of these additional modules meet your needs, the `Signer` and `KeyStore` [interfaces](https://github.com/Cryptonomic/ConseilJS/blob/master/ConseilJS-core/src/types/ExternalInterfaces.ts) can be implemented separately. In addition to a `Signer` and a `KeyStore`, `fetch` and `logger` objects are required to be provided, see below.
For more details on how to use these libraries see their respective readme files: [ConseilJS-core](./blob/master/ConseilJS/docs/README.md), [ConseilJS-softsigner](https://github.com/Cryptonomic/ConseilJS-softsigner/blob/master/README.md), [ConseilJS-ledgersigner](https://github.com/Cryptonomic/ConseilJS-ledgersigner/blob/master/README.md). There is also an [AWS KMS signer](https://www.npmjs.com/package/@tacoinfra/tezos-kms) that is compatible with ConseilJS, maintained by [@tacoinfra](https://github.com/tacoinfra).
## Use with Nodejs
Add our [NPM package](https://www.npmjs.com/package/conseiljs) to your project and a signing library.
```bash
npm i conseiljs
npm i conseiljs-softsigner
```
```javascript
import fetch from 'node-fetch';
import * as log from 'loglevel';
import { registerFetch, registerLogger, Signer, TezosMessageUtils } from 'conseiljs';
import { KeyStoreUtils, SoftSigner } from 'conseiljs-softsigner';
const logger = log.getLogger('conseiljs');
logger.setLevel('debug', false);
registerLogger(logger);
registerFetch(fetch);
let signer: Signer;
const keyStore = await KeyStoreUtils.restoreIdentityFromSecretKey('edskRgu8wHxjwayvnmpLDDijzD3VZDoAH7ZLqJWuG4zg7LbxmSWZWhtkSyM5Uby41rGfsBGk4iPKWHSDniFyCRv3j7YFCknyHH');
signer = await SoftSigner.createSigner(TezosMessageUtils.writeKeyWithHint(keyStore.secretKey, 'edsk'), -1);
```
## Use with React
We have a complete [React application tutorial](https://github.com/Cryptonomic/ConseilJS-Tutorials) for you to check out.
## Use with React Native
Project [honeybadger](https://github.com/Cryptonomic/honeybadger), which is the basis for [Galleon Mobile](https://apps.apple.com/us/app/galleon-mobile-wallet/id1521872814) us built with ConseilJS as well. Due to limitations of react-native we re-implemented some of the necessary functionality into a [separate module](https://github.com/Cryptonomic/honeybadger/tree/trunk/src/softsigner).
## Use with Web
```html
//conseiljssoftsigner.
...
```
The web version sets fetch and logger internally to `window.fetch` and `console` respectively.
A fully functional sample [html page](https://github.com/Cryptonomic/ConseilJS-HTML-Example) is available too.
## API Overview and Examples
We have [ready-to-use examples](https://cryptonomic.github.io/ConseilJS/) 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](http://reddit.com/r/tezos/) or the [Tezos StackExchange](https://tezos.stackexchange.com). We certainly welcome pull requests as well.
## Other references
[Developer Handbook](https://handbook.cryptonomic.tech/)
[Smart Contract Development Syllabus](https://medium.com/the-cryptonomic-aperiodical/smart-contract-development-syllabus-f285a8463a4d)
[Wiki](https://github.com/Cryptonomic/ConseilJS/wiki/Tutorial:-Querying-for-Tezos-alphanet-data-using-the-ConseilJS-v2-API)
[Riot Dev Channel](https://matrix.to/#/!rUwpbdwWhWgKINPyOD:cryptonomic.tech?via=cryptonomic.tech&via=matrix.org&via=ostez.com)
[Cryptonomic Reddit](https://www.reddit.com/r/cryptonomic)
[The Cryptonomic Aperiodical](https://medium.com/the-cryptonomic-aperiodical)
[@CryptonomicTech](https://twitter.com/CryptonomicTech)