@algodex/algodex-sdk/lib/utils/units/fromBaseUnits.js

API calls for interacting with the Algorand blockchain

/*
 * Copyright (C) 2021-2022 Algodex VASP (BVI) Corp.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

const Big = require('big.js');

/**
 * Converts an asset amount from base units to whole units
 *
 * Formula: amount / (10 ^ decimals)
 *
 * @param {Number} amount the asset amount in base units
 * @param {Number} decimals asset's `decimals` property (default = 6 for ALGO)
 * @return {Number} the asset amount in whole units, e.g. 2.187
 * @memberOf Big.prototype
 */
function fromBaseUnits(amount, decimals = 6) {
  const divisor = new Big(10).pow(decimals);
  const baseUnits = new Big(amount).round(decimals);
  return baseUnits.div(divisor).toNumber();
}

module.exports = fromBaseUnits;