Cirquity RPC
This project is designed to make it very easy to interact with various RPC APIs available within the Cirquity Project. This entire project uses Javascript Promises to make things fast, easy, and safe.
Table of Contents
Dependencies
- NodeJS v8.x >= 8.x
- Cirquity >= v0.4.1
Installation
npm install --save cirquity-rpc
Initialization
Cirquityd
const Cirquityd = require('cirquity-rpc').Cirquityd
const daemon = new Cirquityd({
host: '127.0.0.1', // ip address or hostname of the Cirquityd host
port: 18128, // what port is the RPC server running on
timeout: 2000, // request timeout
ssl: false, // whether we need to connect using SSL/TLS
userAgent: 'cirquity-rpc/1.0.2' // specify a customer user-agent or use the default
})
Wallet-API
const CirquityAPI = require('cirquity-rpc').CirquityAPI
const wallet = new CirquityAPI({
host: '127.0.0.1', // ip address or hostname of wallet-api host
port: 18127, // port wallet-api is running on, default is 8070
timeout: 5000, // how long to wait before timing out the connection
ssl: false, // whether or not to connect through SSL
password: 'password', // your rpc password
defaultMixin: 3, // should be configured to the default mixin, or false if no default mixin is set
defaultFee: 0.1, // the default fee of your network, in decimal not atomic units
decimalDivisor: 100, // how many decimals will be used
defaultUnlockTime: 0, // default unlock time
userAgent: 'cirquity-rpc/1.0.2' // specify a customer user-agent or use the default
})
Documentation
You can find the full documentation for this library here
License
Copyright (C) 2018-2019 Brandon Lehmann, The Turtlecoin Developers
Copyright (C) 2019-2020 Deeterd, The Cirquity Developers
Please see the included LICENSE file for more information.