TurtleCoin RPC
Master Build Status
This project is designed to make it very easy to interact with various RPC APIs available within the TurtleCoin Project. This entire project uses Javascript Promises to make things fast, easy, and safe.
Package Upgrade Warning
v2.0.0+ contains multiple breaking changes to the package including the removal of support for Turtle-Service, removal of deprecated TurtleCoind RPC calls that will be removed, renaming of methods, and method argument changes throughout. Please be sure to read the documentation in full before upgrading to v2.0.0+.
Table of Contents
Dependencies
- NodeJS v8.x >= 8.x
- TurtleCoin >= v0.8.4
Installation
npm install turtlecoin-rpc
Intialization
TurtleCoind
const TurtleCoind = TurtleCoind const daemon = host: '127.0.0.1' // ip address or hostname of the TurtleCoind host port: 11898 // what port is the RPC server running on timeout: 2000 // request timeout ssl: false // whether we need to connect using SSL/TLS userAgent: 'turtlecoin-rpc/2.0.0' // specify a customer user-agent or use the default
Wallet-API
const WalletAPI = WalletAPI const wallet = host: '127.0.0.1' // ip address or hostname of wallet-api host port: 8070 // 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: 01 // 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: 'turtlecoin-rpc/2.0.0' // 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
Please see the included LICENSE file for more information.