TurtleCoin Javascript Utilities

Master Build Status

Development Build Status

This package contains code that wraps turtlecoin-crypto primitives into an easier to use interface. This includes the ability to easily discover funds for a wallet, create transactions, sign transactions (ring signatures), create new wallets, verify addresses, and handful of other useful methods. These methods can then be wrapped into a Javascript-based wallet such as turtlecoin-wallet-backend-js.

If you experience any issues with this library, the best way to address such situations is to submit a Pull Request to resolve the issue you are running into.

Installation

npm install turtlecoin-utils

Initialization

JavaScript

const TurtleCoinUtils = require('turtlecoin-utils').CryptoNote
const coinUtils = new TurtleCoinUtils()

TypeScript

import { CryptoNote } from 'turtlecoin-utils'
const coinUtils = new CryptoNote()

You can find TypeScript type definitions here

Browser Support

When packing for the browser with a tool like webpack we advise that you use the ready event of the webpacked module to determine when the Cryptographic methods are available.

<script src="TurtleCoinUtils.js"></script>
<script>
  TurtleCoinUtils.on('ready', () => {
    const coinUtils = new TurtleCoinUtils.CryptoNote()
  })
</script>

Documentation

You can find the full documentation for this library here

Credits

Special thanks goes out to:

• Lucas Jones
• Paul Shapiro
• Luigi111
• The MyMonero Project
• The Masari Project: gnock
• The Plentum Project: DaveLong