An open API service indexing awesome lists of open source software.

https://github.com/ohager/pir8-grabber


https://github.com/ohager/pir8-grabber

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# signum-pir8-grabber

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
![node-current](https://img.shields.io/node/v/signum-pir8-grabber)
![npm](https://img.shields.io/npm/v/signum-pir8-grabber)

A small tool that grabs Signum transactions from a specific account by certain criteria and logs it into a file.

# Usage

> Prerequisite: NodeJS 14+ installed

Install using

```bash
npm i signum-pir8-grabber -g
pir8grabber -h
```

```
Usage: pir8grabber [options]

Options:
-V, --version output the version number
-a, --address

Address to be monitored, can be Reed-Solomon or Id
-p, --phrase Your senders Signum account passphrase (to read encrypted messages) (default: "")
-s, --signa Target amount in SIGNA
-m, --message Target message using a regex pattern
-f, --file Filename where the data is being collected (default: "./pir8grabber.json")
-l, --lines Amount of lines inside the file (default: 10)
-n, --node Your custom node. Otherwise the node is selected automatically
-y, --payment
-h, --help display help for command
```

Usage Examples:

----

Log last at maximum ten transactions sent to account `S-9K9L-4CB5-88Y5-F5G4Z` that contains the string "NDS" in their message

`pir8grabber -a S-9K9L-4CB5-88Y5-F5G4Z -m "NDS"`

----
Log last at maximum twenty transactions sent to account `S-9K9L-4CB5-88Y5-F5G4Z` that has more than 50 SIGNA into `./acme.json`

`pir8grabber -a S-9K9L-4CB5-88Y5-F5G4Z -a 50 -l 20 -f ./acme.json`

----
Log last at maximum ten transactions sent to account `S-9K9L-4CB5-88Y5-F5G4Z` that has messages starting with "foo" and considering also encrypted messages`

`pir8grabber -a S-9K9L-4CB5-88Y5-F5G4Z -m "^foo" -p "my super secret passphrase"`