Options
All
  • Public
  • Public/Protected
  • All
Menu

turtlecoin-utils

image

TurtleCoin Utilities

NPM

Prerequisite Documentation Maintenance License: GPL-3.0 Twitter: TurtlePay

Master Build Status

Build Status

Development Build Status

Build Status

Overview

This package contains a number of different utility libraries that help with the following network and wallet based activities:

  • Wallet (and Address) generation, verification, and encoding/decoding
  • Block handling, construction, decoding, and ID and PoW hash calculation
  • Block template handling
  • Multisig operations including Multisig participant message exchanges
  • RPC interations with TurtleCoind and Wallet-API
  • Network P2P communication protocols (connect to the P2P network directly)
  • Transaction construction facilities
  • Ledger hardware wallet interaction for the TurtleCoin┬« Ledger Wallet Application
  • Transaction handling, construction, decoding, hash calculations, TX_EXTRA parsing, etc
  • Deterministic subwallet generation
  • And much, much, more...

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:

Generated using TypeDoc