Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xkrsz/moneyro
Node.js library for interacting with Monero API.
https://github.com/xkrsz/moneyro
cryptocurrency monero monero-api nodejs
Last synced: 19 days ago
JSON representation
Node.js library for interacting with Monero API.
- Host: GitHub
- URL: https://github.com/xkrsz/moneyro
- Owner: xkrsz
- Created: 2018-04-30T14:31:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-05-14T18:46:05.000Z (over 6 years ago)
- Last Synced: 2024-10-22T22:34:14.607Z (28 days ago)
- Topics: cryptocurrency, monero, monero-api, nodejs
- Language: JavaScript
- Homepage:
- Size: 68.4 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# moneyro
Node.js library for interacting with Monero API.
[](https://badge.fury.io/js/moneyro)
[](https://david-dm.org/krszwsk/moneyro)
## Library not tested in production environment yet.
## Table of contents
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Running `monero-wallet-rpc`](#running-monero-wallet-rpc)
- [Usage](#usage)
- [API](#api)
## Installation
```
yarn add moneyro
```
## Prerequisites
`Wallet` needs a running `monero-wallet-rpc`, while `Daemon` connects to `monerod`.
Head to https://getmonero.org/downloads/ and download Command-Line tools for your platform.
### Running `monero-wallet-rpc`
1. Start your daemon:
```
./monerod --testnet
```
2. Start wallet RPC client
```
./monero-wallet-rpc \
--testnet --rpc-bind-port 18082 \
--wallet-dir \
--disable-rpc-login \
--log-level 4
```
And that's it, you're ready to use `moneyro`.
## Usage
### Wallet
```js
import { Wallet } from 'moneyro';
const wallet = new Wallet();
(async () => {
try {
await wallet.create('test-wallet', 'strongpassword');
const response = await wallet.getAddress();
console.log(response); // { address: '...', addresses: [ ... ] }
} catch (err) {
console.error(err);
}
})();
```
### Daemon
```js
import { Daemon } from 'moneyro';
const daemon = new Daemon({
hostname: 'testnet.xmrchain.net',
});
(async () => {
try {
const response = await daemon.getBlockCount();
console.log(response); // { count: 1098883, status: 'OK' }
} catch (err) {
console.error(err);
}
})();
```
## API
### Wallet
#### constructor([options])
##### options
Type: `Object`
###### hostname
Type: `string`
Default: `'127.0.0.1'`
###### port
Type: `int`
Default: `18082`
###### username
Type: `string`
###### password
Type: `string`
#### create(filename, password, [language])
Creates a new wallet. You need to have set the
argument "–wallet-dir" when launching monero-wallet-rpc to make this work.
##### filename
Type: `string`
##### password
Type: `string`
##### language
Type: `string`
Default: `'English'`
#### open(filename, password)
Opens a wallet. You need to have set the
argument "–wallet-dir" when launching monero-wallet-rpc to make this work.
##### filename
Type: `string`
##### password
Type: `string`
#### getBalance()
##### Returns `Promise`:
###### balance
Type: `uint`
###### unlockedBalance
Type: `uint`
#### transfer(options)
Transfers monero to specified recipient(s).
##### options
Type: `Object`
###### destinations
Type: `array<{ amount: uint, address: string }>`
###### mixin
Type: `uint`
Number of outpouts from the blockchain to mix with (0 means no mixing).
###### unlockTime
Type: `uint`
Number of blocks before the monero can be spent (0 to not add a lock).
###### priority
Type: `uint`
Options:
- `0`
- `1`
- `2`
- `3`
###### getTxHex
Type: `boolean`
###### paymentId
Type: `string`
Default: `''`
Random 32-byte/64-character hex string to identify a transaction.
###### getTxKey
Type: `boolean`
Default: `false`
###### doNotRelay
Type: `boolean`
Default: `false`
### Daemon