update getFeeValue for create coin tx

Author: shrpne

.eslintrc.js

@@ -2,7 +2,7 @@
 
 module.exports = {
   root: true,
-  // parser: 'babel-eslint',
+  parser: 'babel-eslint',
   // parserOptions: {
   //   sourceType: 'module'
   // },

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.20.0 - 2020.12.30
+- **BREAKING** change fee calculation for Create Coin tx (now it depends on unit value)
+- add `coinSymbolLength` param to `getFeeValue`
+
 ## 0.19.0 - 2020.12.22
 - **BREAKING** change unit value, which is used in fee calculation, from 0.001 to 0.1
 

README.md

@@ -34,7 +34,8 @@ Params:
 - txType: number or string, tx type
 - options: object
 - options.payload: string or Buffer, tx payload
-- options.coinSymbol: string, coin symbol if tx is coin creation
+- options.coinSymbol: string, coin symbol if tx is coin creation (can be replaced with `coinSymbolLength`)
+- options.coinSymbolLength: number, coin symbol length if tx is coin creation (can be replaced with `coinSymbol`)
 - options.multisendCount: number, count of recipients if tx is multisend
 ```
 import { getFeeValue, TX_TYPE } from 'minterjs-util';
@@ -49,7 +50,10 @@ getFeeValue(TX_TYPE.SEND, {payload: 'asé'});
 // 0.018
 
 getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbol: 'ABCDEFG'});
-// 100
+// 10000
+
+getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbolLength: 6});
+// 100000
 
 getFeeValue(TX_TYPE.MULTISEND, {multisendCount: 5});
 // 0.035

build/rollup.config.js

@@ -8,6 +8,14 @@ import babel from 'rollup-plugin-babel';
 export default {
     input: 'src/index.js',
     plugins: [
+        babel({
+            babelrc: false,
+            configFile: false,
+            "plugins": [
+                "@babel/plugin-proposal-optional-chaining",
+                "@babel/plugin-proposal-numeric-separator",
+            ],
+        }),
         commonjs({
             // namedExports: {
             //     'node_modules/ethereumjs-util/dist/index.js': [ 'stripHexPrefix', 'padToEven' ],

package.json

@@ -1,6 +1,6 @@
 {
   "name": "minterjs-util",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Utils for Minter",
   "main": "dist/cjs/index.js",
   "module": "src/index.js",

src/fee.js

@@ -6,10 +6,11 @@ import {TX_TYPE} from './tx-types.js';
  * @param txType
  * @param {string|Buffer} [payload]
  * @param {string} [coinSymbol]
+ * @param {number} [coinSymbolLength]
  * @param {number} [multisendCount]
  * @return {boolean|number}
  */
-export function getFeeValue(txType, {payload, coinSymbol, multisendCount} = {}) {
+export function getFeeValue(txType, {payload, coinSymbol, coinSymbolLength, multisendCount} = {}) {
     // txType to string
     if (!isHexString(txType)) {
         txType = `0x${padToEven(txType.toString(16)).toUpperCase()}`;
@@ -34,27 +35,40 @@ export function getFeeValue(txType, {payload, coinSymbol, multisendCount} = {})
     const COIN_UNIT_PART = 1 / COIN_UNIT; // negate js math quirks, ex.: 18 * 0.001 = 0.018000000000000002
     // multisend fee = base fee + extra fee based on count
     const multisendExtraCountFee = txType === TX_TYPE.MULTISEND ? (multisendCount - 1) * MULTISEND_FEE_DELTA : 0;
-    // coin symbol extra fee, value in base coin (not in units)
-    const coinSymbolFee = txType === TX_TYPE.CREATE_COIN ? getCoinSymbolFee(coinSymbol) : 0;
-    return (baseUnits + payloadLength * 2 + multisendExtraCountFee) / COIN_UNIT_PART + coinSymbolFee;
+    // coin symbol extra fee, value in units (not in base coin)
+    const coinSymbolFee = txType === TX_TYPE.CREATE_COIN ? getCoinSymbolFee(coinSymbol, coinSymbolLength) : 0;
+    return (baseUnits + payloadLength * 2 + multisendExtraCountFee + coinSymbolFee) / COIN_UNIT_PART;
 }
 
 //
 /**
  * @param {string} ticker
+ * @param {number} [length]
  * @return {number} - value in base coin (not in units)
  */
-export function getCoinSymbolFee(ticker) {
-    return COIN_SYMBOL_FEES[ticker && ticker.length] || 100;
+export function getCoinSymbolFee(ticker, length) {
+    if (!length) {
+        length = ticker?.length;
+    }
+    if (!isValidLength(length)) {
+        length = 7;
+    }
+    return COIN_SYMBOL_FEES[length];
+
+    // eslint-disable-next-line unicorn/consistent-function-scoping, no-shadow
+    function isValidLength(length) {
+        return length >= 3 && length <= 7;
+    }
 }
 
-// value in base coin (not in units)
+// value in units (not in base coin)
 // @See https://github.com/MinterTeam/minter-go-node/blob/master/core/transaction/create_coin.go#L93
 export const COIN_SYMBOL_FEES = {
-    3: 1000000,
-    4: 100000,
-    5: 10000,
-    6: 1000,
+    3: 1_000_000_000,
+    4: 100_000_000,
+    5: 10_000_000,
+    6: 1_000_000,
+    7: 100_000,
 };
 
 export const MULTISEND_FEE_DELTA = 5;

test/fee.test.js

@@ -18,13 +18,14 @@ describe('getFeeValue', () => {
     });
 
     test('create coin', () => {
-        expect(getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbol: 'ABCDEFG'})).toEqual(100);
-        expect(getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbol: 'ABCDEFGHIJ'})).toEqual(100);
-        expect(getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbol: 'ABC'})).toEqual(1000000);
+        expect(getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbol: 'ABCDEFG'})).toEqual(10_000);
+        expect(getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbol: 'ABCDEFGHIJ'})).toEqual(10_000);
+        expect(getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbol: 'ABC'})).toEqual(100_000_000);
+        expect(getFeeValue(TX_TYPE.CREATE_COIN, {coinSymbolLength: 4})).toEqual(10_000_000);
     });
 
-    test('create coin without coinSymbolLength', () => {
-        expect(getFeeValue(TX_TYPE.CREATE_COIN)).toEqual(100);
+    test('create coin without coin symbol', () => {
+        expect(getFeeValue(TX_TYPE.CREATE_COIN)).toEqual(10000);
     });
 
     test('multisend', () => {