node-syscoin
NOTE: THIS PROJECT IS DEPRECATED AND NO LONGER MAINTAINED. The active fork for this project is now located at syscoin/syscoin-core.
node-syscoin is a simple wrapper for the Syscoin client's JSON-RPC API.
The API is equivalent to the API document here.
The methods are exposed as lower camelcase methods on the syscoin.Client
object, or you may call the API directly using the cmd
method.
Install
npm install syscoin
Examples
Create client
// all config options are optionalvar client = host: 'localhost' port: 8332 user: 'username' pass: 'password' timeout: 30000;
Get balance across all accounts with minimum confirmations of 6
client;
cmd
Getting the balance directly using client;
Batch multiple RPC calls into single HTTP request
var batch = ;for var i = 0; i < 10; ++i batch;client;
SSL
See Enabling SSL on original client.
If you're using this to connect to syscoind across a network it is highly
recommended to enable ssl
, otherwise an attacker may intercept your RPC credentials
resulting in theft of your syscoins.
When enabling ssl
by setting the configuration option to true
, the sslStrict
option (verifies the server certificate) will also be enabled by default. It is
highly recommended to specify the sslCa
as well, even if your syscoind has
a certificate signed by an actual CA, to ensure you are connecting
to your own syscoind.
var client = host: 'localhost' port: 8332 user: 'username' pass: 'password' ssl: true sslStrict: true sslCa: fs;