nashcash-utils
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    image

    TurtleCoin Utilities

    NPM

    Prerequisite Documentation Maintenance License: GPL-3.0 Twitter: TurtlePay

    Master Build Status

    Build Status

    Development Build Status

    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

    TypeScript

    import {
        Address, 
        AddressPrefix, 
        Block, 
        BlockTemplate, 
        CryptoNote, 
        LevinPacket, 
        Transaction
    } from 'turtlecoin-utils'
    const coinUtils = new CryptoNote()

    Javascript

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

    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:

    Install

    npm i nashcash-utils

    DownloadsWeekly Downloads

    0

    Version

    1.0.0

    License

    GPL-3.0

    Unpacked Size

    376 kB

    Total Files

    52

    Last publish

    Collaborators

    • nashcash