You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
jojapoppa d92999f41a build... 1 year ago
dist build... 1 year ago
docs docs 1 year ago
src build... 1 year ago
test working on tests 1 year ago
.gitignore initial checkin 1 year ago
CONTRIBUTING.md initial checkin 1 year ago
LICENSE initial checkin 1 year ago
README.md new daemon api 1 year ago
build.sh build 1 year ago
package-lock.json build... 1 year ago
package.json build... 1 year ago
tsconfig.json initial checkin 1 year ago
typedoc.json initial checkin 1 year ago
webpack.config.js naming 1 year ago

README.md

image]

FedoraGold (FED) Utilities

Prerequisite Documentation Maintenance License: GPL-3.0

Adapted from the library turtlecoin-utils

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 fedoragold_daemon 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.

Initialization

TypeScript

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

Javascript

const FedoragoldUtils = require('fedoragold-utils')
const coinUtils = new FedoragoldUtils.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="FedoragoldUtils.js"></script>
<script>
  FedoragoldUtils.on('ready', () => {
    const coinUtils = new FedoragoldUtils.CryptoNote()
  })
</script>

Documentation

You can find the full documentation for this library here

Credits

Special thanks goes out to: