Fantasygold-core NPM

FantasyGold

A pure, powerful core for your Litecoin project.

FantasyGold is a complete, native interface to the Litecoin network, and provides the core functionality needed to develop apps for Litecoin.

#Principles

Litecoin is a powerful new peer-to-peer platform for the next generation of financial and social technology. The decentralized nature of the Litecoin network allows for highly resilient Litecoin infrastructure, and the developer community needs reliable, open-source tools to implement Litecoin apps and services.

FantasyGold unchains developers from fallible, centralized APIs, and provides the tools to interact with the real Litecoin network.

#Get Started

FantasyGold-Core runs on node, and can be installed via npm:

npm install fantasygold-core

It is a collection of objects useful to Litecoin applications; class-like idioms are enabled viaSoop. In most cases, a developer will require the object's class directly. For instance:

var  = require('fantasygold-core');
var Address = .Address;
var Transaction = .Transaction;
var PeerManager = .PeerManager;

#Examples

Examples are provided here Build the examples by installing and running gulp:

npm install -g gulp
gulp

Javascript files available at /examples folder.

#Security

Please use at your own risk.

is still under heavy development and not quite ready for "drop-in" production use. If you find a security issue, please email pembo210@gmail

#Contributing

needs some developer love. Please send pull requests for bug fixes, code optimization, and ideas for improvement.

#Browser support

Building the browser bundle

To build full bundle for the browser (this is automatically executed after you run npm install):

node browser/build.js -a

This will generate a browser/bundle.js file which you can include in your HTML to use in the browser.

##Example browser usage

From example/simple.html

<!DOCTYPE html>
<html>
  <body>
    <script src="../browser/bundle.js"></script>
    <script>
      var  = require('');
      var Address = .Address;
      var a = new Address('sgrHPw4aEPos8YJDNfefsUSjPYWc5fzpLE');
      console.log('sgrHPw4aEPos8YJDNfefsUSjPYWc5fzpLE is valid? '+a.isValid());
    </script>
  </body>
</html>

You can check a more complex usage example at examples/example.html.

Generating a customized browser bundle

To build the main bundle, run:

node browser/build.js -m

To build all features into the bundle (which will lead to a large file size), run:

node browser/build.js -a

To generate a customized bundle, you can specify which submodules you want to include in it with the -s option:

node browser/build.js -s Transaction,Address

This will generate a browser/bundle.js containing only the Transaction and Address class, with all their dependencies. Use this option if you are not using the whole library, to optimize the bundle size, script loading time, and general resource usage.

Tests

Run tests in node:

mocha

Or generate tests in the browser:

grunt shell

And then open test/index.html in your browser.

To run the code coverage report:

npm run-script coverage

And then open coverage/lcov-report/index.html in your browser.

#License

Bitcore Code released under the MIT license.

http://merkle.group

fantasygold FGC satoshi money currency virtual

asn1.js async bignum binary bindings bn.js brfs browserify-buffertools bufferput buffers buffertools elliptic hash.js jsrsasign node-gyp preconditions protobufjs sjcl socks5-client

@everything-registry/sub-chunk-1647

0.0.1

6 years ago