npm hiverewards is out on 
A new npm library designed to make it easier for both end users and developers to track HIVE-based earnings and reliably interact with the Hive ecosystem APIs for different purposes.
Have you ever wondered how much you earned from a Hive game or project in the past day/week/month/year?
Have you spent days/months wiring up a Hive app just to later find out that it's misbehaving because of a node issue?
Hive Rewards is here to simplify your life. With a very little coding experience you can now execute some queries to find out your daily/weekly/monthly earnings.
Run such searches in your HTML page, directly in a terminal, or in your NodeJS scripts/backend.
npm hiverewards takes care of all the plumbing under the hood:
💰 Automatic price lookups and $ conversions, so you always know the dollar value you sent/received in any specific time range.
👨🔧 Retry mechanisms, node switching, smart caching and exponential back-off - meaning for example no surprises when a node hiccups.
🏥 Health checks to ensure the node is available before trying to fetch your data.
Hive Rewards offers two SDKs out of the box:
hiveApiCall() and hiveEngineApiCall() will automatically and gracefully rotate and retry using other healthy nodes when one fails.Project Readme
📑 CONTENTS
An SDK for Node.js and the browser, and a command‑line tool to scan HIVE and Hive‑Engine token transfers:
import { hiveRewards } from 'hiverewards';
const analyzer = await hiveRewards({ verbose: true });
const inbound = await analyzer.inbounds({
receivers: ['zillionz', 'obifenom'],
hiveSenders: { PVP_HIVE: 'cryptoshots.tips' },
tokenSenders: { PVP_TOKENS: 'cryptoshots.tips' },
hours: 2,
});
console.log(inbound);
const outbound = await analyzer.outbounds({
senders: ['cryptoshots.tips', 'karina.gpt'],
ignoredReceivers: ['keychain.swap'],
days: 1,
});
console.log(outbound);
A bundled build can be generated with Webpack:
Clone the project
Build it with
npm run build:web # outputs dist/hiverewards.bundle.js
<script src="dist/hiverewards.bundle.js"></script>
<script>
(async () => {
const analyzer = await window.HiveRewards.hiveRewards();
const result = await analyzer.inbounds({
receivers: ['obifenom'],
hiveSenders: { PVP_GAME_REWARDS: 'cryptoshots.tips' },
days: 7,
});
console.log(result);
})();
</script>
git clone <repo>
cd <repo>
npm install
npm start -- --inbound obifenom zillionz --from pvpRewards=cryptoshots.tips pveRewards=cryptoshotsdoom --hours 24
npm start -- --outbound cryptoshots.tips karina.gpt --days 1
Note: append --verbose for verbose logging
| Env var | Default |
|---|---|
HIVE_PRICE_URL | https://api.coingecko.com/api/v3/simple/price?ids=hive&vs_currencies=usd |
You can also override the initial Hive / Hive Engine node by passing a config object to the hiveRewards() factory in code.
eg.
const analyzer = await hiveRewards({
hiveNodeUrl: 'https://your.hive.node',
hiveEngineRpcUrl: 'https://your.he.rpc',
hiveEngineHistoryUrl: 'https://your.he.history',
});
Other Overrides:
| Constructor Attribute | Description | Default |
|---|---|---|
| fetch | Fetch API implementation | npm cross-fetch |
| hiveJs | pass in another @hiveio/hive-js version, if needed | v2 |
| log | custom logger | console |
| apiCallsDelay | default wait time for api call retries | 500 (with exp backoff) |
| priceCacheMins | how long Hive price is cached for | 10 mins |
| hiveHistoryLimit | page size (max account‐history ops per call) | 500 |
| heHistoryLimit | page size (max Hive-Engine history records per call) | 250 |
Wrapper for @peakd's Beacon APIs.
Usage:
import { peakdBeaconWrapper } from 'hiverewards';
const { getHealthyHiveNode, getHealthyHeNode, getHealthyHeHistoryNode } = peakdBeaconWrapper;
const hiveUrl = await getHealthyHiveNode();
const heUrl = await getHealthyHeNode();
const hehUrl = await getHealthyHeHistoryNode();
// Now you can configure your client:
hiveApi.api.setOptions({ url: hiveUrl });
...our use our Hive / Hive Engine client wrappers that automatically rotate healthy nodes:
import { healthyApisWrapper } from 'hiverewards';
const { hiveApiCall, hiveEngineApiCall, hiveEngineHistoryApiCall } = healthyApisWrapper;
const history = await hiveApiCall('getAccountHistory', ['cryptoshotsdoom', -1, 10]);
console.log(history);
const metrics = await hiveEngineApiCall({
jsonrpc: '2.0',
method: 'find',
params: {
contract: 'market',
table: 'metrics',
query: { symbol: 'DOOM' },
limit: 1,
offset: 0
},
id: 1
});
console.log(metrics);
const history = await hiveEngineHistoryApiCall('cryptoshotstips', 20);
console.log(history);
GAME UI: Coming Soon
