Veinte - Coin converter

Description

This library converts an amount from one coin to another, taking into account each coin's sell rate and buy rate and its coin type (fiat or cryptocurrency).

This conversion considers that fiat coins are measured in amount of coins for 1 dollar and crypto coins are measured in amount of dollars for 1 coin.

Fiat to fiat conversion is done only by converting through a crypto coin.

For example, when converting from 1 Dollar to Bitcoin, with a Dollar sell rate of 1 and a bitcoin sell rate of 9634.71, we obtain 0.00010379 Bitcoin.

Installation

npm install --save @veinte_desarrollo/coin-coverter

API

Calculate change amount

Given an amount from a certain coin which we want to sell, returns its corresponding amount from another coin that we want to buy.

calculateChangeAmount(coins, coinFieldsNames, fiatOption, amount, fromCoinId, toCoinId, cryptoCoinId)

• coins ([object]): a list of Coin objects, in which each Coin should have at least the fields listed on coinFieldsNames.
• coinFieldsNames(object): should contain the following fields:
  • coinIdField: the key name corresponding to the id in the Coin object.
  • coinTypeField: the key name corresponding to the type in the Coin object.
  • coinBuyRateField: the key name corresponding to the buy rate in the Coin object.
  • coinSellRateField: the key name corresponding to the sell rate in the Coin object.
• fiatOption(string): the value which identifies the fiat coin type.
• amount(float): the amount of origin coin.
• fromCoinId(string): the id of the origin coin.
• toCoinId(string): the id of the destinty coin.
• cryptoCoinId(string): a crypto coin id which will be used when converting from one fiat to another; if it is not the case, this field is not needed.

Example:

const coins = [
  {
    "coinId": "3",
    "coinName": "Bitcoin",
    "coinType": "cryptoCoin",
    "coinBuyRateField": 8717.11,
    "coinSellRateField": 9634.71
  },
  {
    "coinId": "4",
    "coinName": "Litecoin",
    "coinType": "cryptoCoin",
    "coinBuyRateField": 41.72,
    "coinSellRateField": 46.12
  }
];
const coinFieldsNames = {
  coinIdField: 'coinId',
  coinTypeField: 'coinType',
  coinBuyRateField: 'coinBuyRateField',
  coinSellRateField: 'coinSellRateField'
};
const fiatOption = "fiatCoin";
console.log(
  calculateChangeAmount(
    coins, coinFieldsNames, fiatOption, 1, "3", "4"
  )
); // Returns 189.00932350390286209

Calculate inverse change amount

Given an amount from a certain coin which we want to buy, returns its corresponding amount from another coin we want to sell.

calculateInverseChangeAmount(coins, coinFieldsNames, fiatOption, toAmount, fromCoinId, toCoinId, cryptoCoinId)

• coins ([object]): a list of Coin objects, in which each Coin should have at least the fields listed on coinFieldsNames.
• coinFieldsNames(object): should contain the following fields:
  • coinIdField: the key name corresponding to the id in the Coin object.
  • coinTypeField: the key name corresponding to the type in the Coin object.
  • coinBuyRateField: the key name corresponding to the buy rate in the Coin object.
  • coinSellRateField: the key name corresponding to the sell rate in the Coin object.
• fiatOption(string): the value which identifies the fiat coin type.
• toAmount(float): the amount of destiny coin.
• fromCoinId(string): the id of the origin coin.
• toCoinId(string): the id of the destinty coin.
• cryptoCoinId(string): a crypto coin id which will be used when converting from one fiat to another; if it is not the case, this field is not needed.

Example:

const coins = [
  {
    "coinId": "3",
    "coinName": "Bitcoin",
    "coinType": "cryptoCoin",
    "coinBuyRateField": 8717.11,
    "coinSellRateField": 9634.71
  },
  {
    "coinId": "4",
    "coinName": "Litecoin",
    "coinType": "cryptoCoin",
    "coinBuyRateField": 41.72,
    "coinSellRateField": 46.12
  }
];
const coinFieldsNames = {
  coinIdField: 'coinId',
  coinTypeField: 'coinType',
  coinBuyRateField: 'coinBuyRateField',
  coinSellRateField: 'coinSellRateField'
};
const fiatOption = "fiatCoin";
console.log(
  calculateInverseChangeAmount(
    coins, coinFieldsNames, fiatOption, 189.00932350390286209, "3", "4"
  )
); // Returns 1