electronero-nodejs-sdk

A Node.js wallet manager for interacting with an electronero-wallet-rpc, pulse-wallet-rpc, litenero-wallet-rpc, goldnero-wallet-rpc, or crystaleum-wallet-rpc.

Forked from PsychicCat/monero-nodejs || For more information about Monero, visit: https://getmonero.org
Maintained for Electronero(a fork of Monero, blockchain fork of ETN) with upstream and custom patches || For more information about Electronero, visit: https://t.me/electronero

If you found this useful, please consider contributing to Electronero Network Project!

---

Install the package

Clone the Github repository

git clone https://github.com/electronero/electronero-nodejs-sdk.git

Via Submodule

git submodule add https://github.com/electronero/electronero-nodejs-sdk.git 

Initializing a wallet

Require the module:

var neroWallet = require('electronero-nodejs-sdk');

Create a new instance of the wallet:

var Wallet = new neroWallet();

This creates a wallet using the following simplewallet default RPC settings:

• hostname - '127.0.0.1'
• port - 12090

To connect to a wallet with different settings, pass in the values:

var Wallet = new neroWallet($HOSTNAME, $PORT);

Note: versions of electronero-nodejs-sdk prior to 1.0 require hostname with the 'http://' prefix, 3.0 and greater only require the IP address.

Testing

Some basic tests can now be run locally to verify the library and your simplewallet instance are communicating. The tests assume simplewallet will be listening at the default config settings. Tests are run via mocha. To run the tests, clone the repository and then:

npm install
npm test

Example Usage

    Wallet.balance().then(function(balance) {
        console.log(balance);
    });

Wallet Methods

create_wallet

Parameters: * `filename` - filename of wallet to create (_string_)
* `password` - wallet password (_string_)
* `language` - language to use for mnemonic phrase (_string_)
Function: Creates a new wallet.
Usage:

Wallet.create_wallet('crfi_wallet', '', 'English');

### open_walllet
Parameters:
* `filename` - filename of wallet to open (_string_)
* `password` -wallet password (_string_)
Function: Opens a wallet.
Usage:

Wallet.open_wallet('nero_wallet', '');

balance

Function: Responds with the current balance and unlocked (spendable) balance of the wallet in atomic units. Divide by 1e12 to convert.
Usage:

Wallet.balance();

Example response:

{ balance: 3611980142579999, unlocked_balance: 3611980142579999 }

address

Function: Responds with the Monero address of the wallet.
Usage:

Wallet.address();

Example response:

{ address: '44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A' }

transfer

Parameters:
* `destinations` - an object OR an array of objects in the following format: `{amount: (*number*), address: (*string*)}`
* `options` - an object with the following properties (_optional_)

{
  mixin: (_number_), // amount of existing transaction outputs to mix yours with (default is 4)
  unlockTime: (_number_), // number of blocks before tx is spendable (default is 0)
  pid: (_string_) // optional payment ID (a 64 character hexadecimal string used for identifying the sender of a payment)
  payment*id: (\_string*) // optional payment ID (a 64 character hexadecimal string used for identifying the sender of a payment)
  do*not_relay: (\_boolean*) // optional boolean used to indicate whether a transaction should be relayed or not
  priority: (_integer_) // optional transaction priority
  get*tx_hex: (\_boolean*) // optional boolean used to indicate that the transaction should be returned as hex string after sending
  get*tx_key: (\_boolean*) // optional boolean used to indicate that the transaction key should be returned after sending
}

Function: Transfers Monero to a single recipient OR a group of recipients in a single transaction. Responds with the transaction hash of the payment.
Usage:

Wallet.transfer(destinations, options);

Example response:

{ tx_hash: '<b9272a68b0f242769baa1ac2f723b826a7efdc5ba0c71a2feff4f292967936d8>', tx_key: '' }

transferSplit

Function: Same as `transfer`, but can split into more than one transaction if necessary. Responds with a list of transaction hashes.

Additional property available for the options parameter:

• new_algorithm - true to use the new transaction construction algorithm. defaults to false. (boolean)
  

Usage:

Wallet.transferSplit(destinations, options);

Example response:

{ tx_hash_list: [ '<f17fb226ebfdf784a0f5814e1c5bb78c19ea26930a0d706c9dc1085a250ceb37>' ] }

sweep_dust

Function: Sends all dust outputs back to the wallet, to make funds easier to spend and mix. Responds with a list of the corresponding transaction hashes.
Usage:

Wallet.sweep_dust();

Example response:

{ tx_hash_list: [ '<75c666fc96120a643321a5e76c0376b40761582ee40cc4917e8d1379a2c8ad9f>' ] }

sweep_all

Function: Sends all spendable outputs to the specified address. Responds with a list of the corresponding transaction hashes.
Usage:

Wallet.sweep_all('44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A');

Example response:

{ tx_hash_list: [ '<75c666fc96120a643321a5e76c0376b40761582ee40cc4917e8d1379a2c8ad9f>' ] }

getPayments

Parameters:
* `paymentID` - the payment ID to scan wallet for included transactions (_string_)
Function: Returns a list of incoming payments using a given payment ID.

Usage:

Wallet.getPayments(paymentID);

getBulkPayments

Parameters:
* `paymentIDs` - the payment ID or list of IDs to scan wallet for (_array_)
* `minHeight` - the minimum block height to begin scanning from (example: 800000) (_number_)
Function: Returns a list of incoming payments using a single payment ID or a list of payment IDs from a given height.
Usage:

Wallet.getBulkPayments(paymentIDs, minHeight);

incomingTransfers

Parameters:
* `type` - accepts `"all"`: all the transfers, `"available"`: only transfers that are not yet spent, or `"unavailable"`: only transfers which have been spent (_string_)
Function: Returns a list of incoming transfers to the wallet.
Usage:

Wallet.incomingTransfers(type);

queryKey

Parameters:
* `type` - accepts `"mnemonic"`: the mnemonic seed for restoring the wallet, or `"view_key"`: the wallet's view key (_string_)
Function: Returns the wallet's spend key (mnemonic seed) or view private key.

Usage:

Wallet.queryKey(type);

integratedAddress

Parameters:
* `paymentID` - a 64 character hex string. if not provided, a random payment ID is generated. (_string_, optional)
Function: Make and return a new integrated address from your wallet address and a payment ID.
Usage:

Wallet.integratedAddress(paymentID);

OR:

Wallet.integratedAddress();

Example response:

{ integrated_address: '4HCSju123guax69cVdqVP5APVLkcxxjjXdcP9fJWZdNc5mEpn3fXQY1CFmJDvyUXzj2Fy9XafvUgMbW91ZoqwqmQ96NYBVqEd6JAu9j3gk' }

splitIntegrated

Parameters:
* `address` - an integrated Monero address (_string_)
Function: Returns the standard address and payment ID corresponding to a given integrated address.
Usage:

Wallet.splitIntegrated(address);

Example response:

{ payment_id: '<61eec5ffd3b9cb57>',
  standard_address: '44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A' }

height

Parameters:
* `callback` - a callback function that responds with an error or the response data in the following order: (_error, data_)
Function: Returns the current block height of the daemon.
Usage:

Wallet.height();

Example response:

{ height: 874458 }

stopWallet

Function: Cleanly shuts down the current simplewallet process.
Usage:

Wallet.stopWallet();

store

Usage:

Wallet.store();

rescan

Usage:

Wallet.rescan();