get-komodo-rewards
Calculate the accrued rewards for a given Komodo UTXO
Last updated 2 years ago by lukechilds .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install get-komodo-rewards 
SYNC missed versions from official npm registry.

get-komodo-rewards

Calculate the accrued rewards for a given Komodo UTXO

Build Status codecov npm

Calculates the rewards in satoshis for a given Komodo UTXO. Heavily tested and 100% compliant with komodod consensus.

Originally built for our Ledger KMD Reward Claim app. Released as a re-usable module for the benefit of the Komodo ecosystem.

Install

npm install get-komodo-rewards

Usage

Pass in a utxo object and an integer of the accrued rewards in satoshis will be returned.

const getKomodoRewards = require('get-komodo-rewards');

const utxo = {
  tiptime: 1552292091,
  locktime: 1552248193,
  height: 1263192,
  satoshis: 3206795322480
};

const rewards = getKomodoRewards(utxo);
// 205000320

Tip

tiptime should be the current tiptime from komodod.

If you don't have access to this you can use a client-side generated UNIX timestamp at the cost of slightly reduced accuracy. If you do this, use a timestamp ~10 minutes in the past to avoid over calculating the rewards and creating an invalid transaction.

API

getKomodoRewards(utxo)

Returns a the accrued rewards in satoshis.

utxo

Type: Object

An object containing the following properties of the UTXO:

tiptime

Type: number

The current tiptime of the Komodo blockchain.

locktime

Type: number

The locktime value of the UTXO.

height

Type: number

The height of the UTXO.

satoshis

Type: number

The value of the UTXO in satoshis.

License

MIT © Atomic Labs
MIT © Luke Childs

Current Tags

  • 1.0.2                                ...           latest (2 years ago)

4 Versions

  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (0)
None
Dev Dependencies (5)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |