Tezos JS Library
Switch branches/tags
Nothing to show
Clone or download

README.md

eztz - Javascript API library for Tezos

Build Status codecov

This library is compatible with the Tezos blockchain, implementing communication with the JSON RPC API and providing key generation, signing, verification, and contract interaction. eztz.js is used by numerous projects, including TezBox and Bakechain.

You can checkout our Documentation, or follow installation below.

By default, eztz will connect to https://rpc.tezrpc.me - public Tezos infrastructure provided by TezTech. You can switch this to use your own local node, or a node of your choosing, via eztz.node.setProvider(url).

Installation

In browser, just include dist/eztz.min.js and you're good to go.

NPM plugin in development

Building

Rebuild bundle using the following code (requires webpack):

npm run-script build

Usage

Include the eztz.js file and use the eztz object directly:

<script src="./eztz.min.js"></script>
<script>
    eztz.rpc.getBalance("tz1LSAycAVcNdYnXCy18bwVksXci8gUC2YpA").then(function(res){
        alert("Your balance is " + res);
    }).catch(function(e){
        console.log(e);
    });
</script>

Future Development

Our current goals are:

  • Add support for additional RPC endpoints (e.g. voting)
  • Hardware wallet support
  • Support for additional cryto curves
  • Add additional tests

Contribute

Please feel free to contribute - I will merge any pull requests as soon as I've gone through the changes.

Author

Originally developed by Stephen Andrews, eztz.js is now owned by TezTech.

Support Us

Development is now funded by a generous grant from the Tezos Foundation. Donations are also welcone.

Bitcoin: 1KSiyfgs5XwTZjaLpmCTHxonsyXMx383P1 Tezos: tz1cLDXASgh48ntYmLqM3cqPEXmUtpJVVPma

Credits

https://github.com/bitcoinjs/bs58check (for base58check encode/decode)
https://github.com/jedisct1/libsodium.js (for all crypto related functions)
https://github.com/bitcoinjs/bip39 (for mnemonic code)
https://github.com/crypto-browserify/pbkdf2 (for passphrase hashing)
https://github.com/feross/buffer (for browser buffer)

License

MIT