@aeternity/aepp-sdk 12.0.0 → 12.1.0

package/src/utils/mptree.ts

@@ -15,30 +15,32 @@
  *  PERFORMANCE OF THIS SOFTWARE.
  */
 
-import { encode as rlpEncode } from 'rlp'
-import type { Input } from 'rlp'
-import { hash } from './crypto'
+/* eslint-disable default-case */
+import { encode as rlpEncode } from 'rlp';
+import type { Input } from 'rlp';
+import { hash } from './crypto';
 import {
   MerkleTreeHashMismatchError,
   MissingNodeInTreeError,
   UnknownPathNibbleError,
-  UnknownNodeLengthError
-} from './errors'
+  UnknownNodeLengthError,
+} from './errors';
 
 enum NodeType {
   Branch,
   Extension,
-  Leaf
+  Leaf,
 }
 
-export type MPTreeBinary = [Buffer, Array<[Buffer, Buffer[]]>]
+export type MPTreeBinary = [Buffer, Array<[Buffer, Buffer[]]>];
 
 export default class MPTree {
-  private readonly rootHash: string
-  private readonly nodes: { [key: string]: Buffer[] }
+  private readonly rootHash: string;
 
-  private static nodeHash (node: Input): string {
-    return Buffer.from(hash(rlpEncode(node))).toString('hex')
+  private readonly nodes: { [key: string]: Buffer[] };
+
+  private static nodeHash(node: Input): string {
+    return Buffer.from(hash(rlpEncode(node))).toString('hex');
   }
 
   /**
@@ -46,56 +48,56 @@ export default class MPTree {
    * @param binary - Binary
    * @returns Merkle Patricia Tree
    */
-  constructor (binary: MPTreeBinary) {
-    this.rootHash = binary[0].toString('hex')
+  constructor(binary: MPTreeBinary) {
+    this.rootHash = binary[0].toString('hex');
     this.nodes = Object.fromEntries(
-      binary[1].map((node) => [node[0].toString('hex'), node[1]])
-    )
+      binary[1].map((node) => [node[0].toString('hex'), node[1]]),
+    );
 
-    if (this.nodes[this.rootHash] === undefined) throw new MissingNodeInTreeError('Can\'t find a node by root hash')
+    if (this.nodes[this.rootHash] === undefined) throw new MissingNodeInTreeError('Can\'t find a node by root hash');
     Object.entries(this.nodes).forEach(([key, node]) => {
-      if (MPTree.nodeHash(node) !== key) throw new MerkleTreeHashMismatchError()
-      const { type, payload } = MPTree.parseNode(node)
+      if (MPTree.nodeHash(node) !== key) throw new MerkleTreeHashMismatchError();
+      const { type, payload } = MPTree.parseNode(node);
       switch (type) {
         case NodeType.Branch:
           payload
             .slice(0, 16)
-            .filter(n => n.length)
+            .filter((n) => n.length)
             .forEach((n) => {
               if (this.nodes[n.toString('hex')] === undefined) {
-                throw new MissingNodeInTreeError('Can\'t find a node by hash in branch node')
+                throw new MissingNodeInTreeError('Can\'t find a node by hash in branch node');
               }
-            })
-          break
+            });
+          break;
         case NodeType.Extension:
           if (this.nodes[payload[0].toString('hex')] === undefined) {
-            throw new MissingNodeInTreeError('Can\'t find a node by hash in extension node')
+            throw new MissingNodeInTreeError('Can\'t find a node by hash in extension node');
           }
       }
-    })
+    });
   }
 
-  isEqual (tree: MPTree): boolean {
-    return this.rootHash === tree.rootHash
+  isEqual(tree: MPTree): boolean {
+    return this.rootHash === tree.rootHash;
   }
 
-  private static parseNode (node: Buffer[]): {
-    type: NodeType
-    payload: Buffer[]
-    path: string | null
+  private static parseNode(node: Buffer[]): {
+    type: NodeType;
+    payload: Buffer[];
+    path: string | null;
   } {
     switch (node.length) {
       case 17:
-        return { type: NodeType.Branch, payload: node, path: null }
+        return { type: NodeType.Branch, payload: node, path: null };
       case 2: {
-        const nibble = node[0][0] >> 4
-        if (nibble > 3) throw new UnknownPathNibbleError(nibble)
-        const type = nibble <= 1 ? NodeType.Extension : NodeType.Leaf
-        const slice = [0, 2].includes(nibble) ? 2 : 1
-        return { type, payload: [node[1]], path: node[0].toString('hex').slice(slice) }
+        const nibble = node[0][0] >> 4; // eslint-disable-line no-bitwise
+        if (nibble > 3) throw new UnknownPathNibbleError(nibble);
+        const type = nibble <= 1 ? NodeType.Extension : NodeType.Leaf;
+        const slice = [0, 2].includes(nibble) ? 2 : 1;
+        return { type, payload: [node[1]], path: node[0].toString('hex').slice(slice) };
       }
       default:
-        throw new UnknownNodeLengthError(node.length)
+        throw new UnknownNodeLengthError(node.length);
     }
   }
 
@@ -103,39 +105,40 @@ export default class MPTree {
    * Serialize Merkle Patricia Tree
    * @returns Binary
    */
-  serialize (): MPTreeBinary {
+  serialize(): MPTreeBinary {
     return [
       Buffer.from(this.rootHash, 'hex'),
       Object.entries(this.nodes).map(([mptHash, value]) => ([
         Buffer.from(mptHash, 'hex'),
-        value
-      ]))
-    ]
+        value,
+      ])),
+    ];
   }
 
   /**
    * Retrieve value from Merkle Patricia Tree
-   * @param key - The key of the element to retrieve
+   * @param _key - The key of the element to retrieve
    * @returns Value associated to the specified key
    */
-  get (key: string): Buffer | undefined {
-    let searchFrom = this.rootHash
-    while (true) {
-      const { type, payload, path } = MPTree.parseNode(this.nodes[searchFrom])
+  get(_key: string): Buffer | undefined {
+    let searchFrom = this.rootHash;
+    let key = _key;
+    while (true) { // eslint-disable-line no-constant-condition
+      const { type, payload, path } = MPTree.parseNode(this.nodes[searchFrom]);
       switch (type) {
         case NodeType.Branch:
-          if (key.length === 0) return payload[16]
-          searchFrom = payload[+`0x${key[0]}`].toString('hex')
-          key = key.substr(1)
-          break
+          if (key.length === 0) return payload[16];
+          searchFrom = payload[+`0x${key[0]}`].toString('hex');
+          key = key.substring(1);
+          break;
         case NodeType.Extension:
-          if (key.substr(0, path?.length) !== path) return undefined
-          searchFrom = payload[0].toString('hex')
-          key = key.substr(path.length)
-          break
+          if (key.substring(0, path?.length) !== path) return undefined;
+          searchFrom = payload[0].toString('hex');
+          key = key.substring(path.length);
+          break;
         case NodeType.Leaf:
-          if (path !== key) return undefined
-          return payload[0]
+          if (path !== key) return undefined;
+          return payload[0];
       }
     }
   }

package/src/utils/other.ts

@@ -1,36 +1,44 @@
-export const pause = async (duration: number): Promise<void> =>
-  await new Promise(resolve => setTimeout(resolve, duration))
+export const pause = async (duration: number): Promise<void> => new Promise((resolve) => {
+  setTimeout(resolve, duration);
+});
 
 export const mapObject = <InputV, OutputV>(
   object: { [k: string]: InputV },
   fn: (
     value: [string, InputV], index: number, array: Array<[string, InputV]>
-  ) => [number | string, OutputV]
-): { [k: string]: OutputV } => Object.fromEntries(Object.entries(object).map(fn))
+  ) => [number | string, OutputV],
+): { [k: string]: OutputV } => Object.fromEntries(Object.entries(object).map(fn));
 
 // remove after dropping webpack4 support
 const isWebpack4Buffer = (() => {
   try {
-    Buffer.concat([Uint8Array.from([])])
-    return false
+    Buffer.concat([Uint8Array.from([])]);
+    return false;
   } catch (error) {
-    return true
+    return true;
   }
-})()
+})();
 
 export const concatBuffers = isWebpack4Buffer
-  ? (list: readonly Uint8Array[], totalLength?: number): Buffer =>
-      Buffer.concat(list.map(el => Buffer.from(el)), totalLength)
-  : Buffer.concat
+  ? (list: readonly Uint8Array[], totalLength?: number): Buffer => (
+    Buffer.concat(list.map((el) => Buffer.from(el)), totalLength)
+  )
+  : Buffer.concat;
 
 /**
  * Object key type guard
- * @param key - Object key
- * @param object - object
+ * @param key - Maybe object key
+ * @param object - Object
  */
-export function isKeyOfObject<T> (
-  key: string | number | symbol,
-  object: T
-): key is keyof T {
-  return key in object
+export function isKeyOfObject<T>(key: string | number | symbol, object: T): key is keyof T {
+  return key in object;
+}
+
+/**
+ * Array item type guard
+ * @param item - Maybe array item
+ * @param array - Array
+ */
+export function isItemOfArray<T>(item: any, array: readonly T[]): item is T {
+  return array.includes(item);
 }

package/src/utils/semver-satisfies.ts

@@ -1,17 +1,21 @@
-export default function (version: string, geVersion: string, ltVersion: string): boolean {
+export default function semverSatisfies(
+  version: string,
+  geVersion: string,
+  ltVersion: string,
+): boolean {
   const getComponents = (v: string): number[] => v
-    .split(/[-+]/)[0].split('.').map(i => +i)
+    .split(/[-+]/)[0].split('.').map((i) => +i);
 
-  const versionComponents = getComponents(version)
-  const geComponents = getComponents(geVersion)
-  const ltComponents = getComponents(ltVersion)
+  const versionComponents = getComponents(version);
+  const geComponents = getComponents(geVersion);
+  const ltComponents = getComponents(ltVersion);
 
-  const base = Math.max(...versionComponents, ...geComponents, ...ltComponents) + 1
+  const base = Math.max(...versionComponents, ...geComponents, ...ltComponents) + 1;
   const componentsToNumber = (components: number[]): number => components.reverse()
-    .reduce((acc, n, idx) => acc + n * Math.pow(base, idx), 0)
+    .reduce((acc, n, idx) => acc + n * base ** idx, 0);
 
-  const vNumber = componentsToNumber(versionComponents)
-  const geNumber = componentsToNumber(geComponents)
-  const ltNumber = componentsToNumber(ltComponents)
-  return vNumber >= geNumber && vNumber < ltNumber
+  const vNumber = componentsToNumber(versionComponents);
+  const geNumber = componentsToNumber(geComponents);
+  const ltNumber = componentsToNumber(ltComponents);
+  return vNumber >= geNumber && vNumber < ltNumber;
 }

package/src/utils/string.ts

@@ -20,8 +20,8 @@
  * @param s - String to convert
  * @returns Converted string
  */
-export function snakeToPascal (s: string): string {
-  return s.replace(/_./g, match => match[1].toUpperCase())
+export function snakeToPascal(s: string): string {
+  return s.replace(/_./g, (match) => match[1].toUpperCase());
 }
 
 /**
@@ -29,8 +29,8 @@ export function snakeToPascal (s: string): string {
  * @param s - String to convert
  * @returns Converted string
  */
-export function pascalToSnake (s: string): string {
-  return s.replace(/[A-Z]/g, match => `_${match.toLowerCase()}`)
+export function pascalToSnake(s: string): string {
+  return s.replace(/[A-Z]/g, (match) => `_${match.toLowerCase()}`);
 }
 
 /**
@@ -38,8 +38,8 @@ export function pascalToSnake (s: string): string {
  * @param str - String to validate.
  * @returns True if the string is valid hex, false otherwise.
  */
-export function isHex (str: string): boolean {
-  return str.length % 2 === 0 && /^[0-9a-f]+$/i.test(str)
+export function isHex(str: string): boolean {
+  return str.length % 2 === 0 && /^[0-9a-f]+$/i.test(str);
 }
 
 /**
@@ -47,8 +47,8 @@ export function isHex (str: string): boolean {
  * @param str - String to validate.
  * @returns True if the string is valid base-64, false otherwise.
  */
-export function isBase64 (str: string): boolean {
-  if (str.length % 4 > 0 || /[^0-9a-z+/=]/i.test(str)) return false
-  const index = str.indexOf('=')
-  return index === -1 || /={1,2}/.test(str.slice(index))
+export function isBase64(str: string): boolean {
+  if (str.length % 4 > 0 || /[^0-9a-z+/=]/i.test(str)) return false;
+  const index = str.indexOf('=');
+  return index === -1 || /={1,2}/.test(str.slice(index));
 }

package/es/tx/builder/field-types.d.ts

@@ -1,62 +0,0 @@
-/// <reference types="node" />
-import BigNumber from 'bignumber.js';
-import { AensName } from './constants';
-import { EncodedData } from '../../utils/encoder';
-declare type Int = number | string | BigNumber;
-export declare class Field {
-    prototype: any;
-    static serialize(value: any, _txFields?: object): Buffer;
-    static deserialize(value: Buffer): any;
-}
-export declare class Name extends Field {
-    /**
-     * @param value - AENS name
-     */
-    static serialize(value: AensName): Buffer;
-    /**
-     * @param value - AENS name
-     */
-    static deserialize(value: Buffer): string;
-}
-export declare class NameId extends Field {
-    /**
-     * @param value - AENS name ID
-     */
-    static serialize(value: AensName | EncodedData<'nm'>): Buffer;
-    /**
-     * @param value - AENS name ID Buffer
-     */
-    static deserialize(value: Buffer): string;
-}
-export declare class NameFee extends Field {
-    /**
-     * @param value - AENS name fee Buffer
-     * @param txFields - Transaction fields
-     * @param txFields.name - AENS Name in transaction
-     */
-    static serialize(value: Int | undefined, { name }: {
-        name: AensName;
-    }): Buffer;
-    /**
-     * @param value - AENS name fee Buffer
-     * @returns AENS name fee
-     */
-    static deserialize(value: Buffer): string;
-}
-export declare class Deposit extends Field {
-    /**
-     * @param value - Deposit value in string format. Should be equal to  '0'.
-     * @returns Deposit value Buffer.
-     */
-    static serialize(value?: string): Buffer;
-    /**
-     * @param value - Deposit value Buffer.
-     * @returns Deposit value.
-     */
-    static deserialize(value: Buffer): string;
-}
-export declare class GasPrice extends Field {
-    static serialize(value?: Int): Buffer;
-    static deserialize(value: Buffer): string;
-}
-export {};

package/es/tx/builder/field-types.mjs

@@ -1,126 +0,0 @@
-import _buffer from "buffer";
-const {
-  Buffer: _Buffer
-} = _buffer;
-import { writeId, readId, produceNameId, getMinimumNameFee, readInt, writeInt, isNameValid } from "./helpers.mjs";
-import { InsufficientNameFeeError, IllegalArgumentError } from "../../utils/errors.mjs";
-import BigNumber from 'bignumber.js';
-import { MIN_GAS_PRICE } from "./constants.mjs";
-// todo: update me
-// ? This is a TS workaround because this has to be a class with only static methods
-export class Field {
-  static serialize(value) {
-    let _txFields = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-
-    return _Buffer.from(value);
-  }
-
-  static deserialize(value) {
-    return value.toString();
-  }
-
-}
-export class Name extends Field {
-  /**
-   * @param value - AENS name
-   */
-  static serialize(value) {
-    return _Buffer.from(value);
-  }
-  /**
-   * @param value - AENS name
-   */
-
-
-  static deserialize(value) {
-    return value.toString();
-  }
-
-}
-export class NameId extends Field {
-  /**
-   * @param value - AENS name ID
-   */
-  static serialize(value) {
-    return writeId(isNameValid(value) ? produceNameId(value) : value);
-  }
-  /**
-   * @param value - AENS name ID Buffer
-   */
-
-
-  static deserialize(value) {
-    return readId(value);
-  }
-
-}
-export class NameFee extends Field {
-  /**
-   * @param value - AENS name fee Buffer
-   * @param txFields - Transaction fields
-   * @param txFields.name - AENS Name in transaction
-   */
-  static serialize(value, _ref) {
-    var _value;
-
-    let {
-      name
-    } = _ref;
-    const minNameFee = getMinimumNameFee(name);
-    (_value = value) !== null && _value !== void 0 ? _value : value = minNameFee;
-
-    if (minNameFee.gt(value)) {
-      throw new InsufficientNameFeeError(new BigNumber(value), minNameFee);
-    }
-
-    return writeInt(value);
-  }
-  /**
-   * @param value - AENS name fee Buffer
-   * @returns AENS name fee
-   */
-
-
-  static deserialize(value) {
-    return readInt(value);
-  }
-
-}
-export class Deposit extends Field {
-  /**
-   * @param value - Deposit value in string format. Should be equal to  '0'.
-   * @returns Deposit value Buffer.
-   */
-  static serialize() {
-    let value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '0';
-    if (parseInt(value) !== 0) throw new IllegalArgumentError(`Contract deposit is not refundable, so it should be equal 0, got ${value.toString()} instead`);
-    return writeInt(0);
-  }
-  /**
-   * @param value - Deposit value Buffer.
-   * @returns Deposit value.
-   */
-
-
-  static deserialize(value) {
-    return readInt(value);
-  }
-
-}
-export class GasPrice extends Field {
-  static serialize() {
-    let value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : MIN_GAS_PRICE;
-
-    if (+value < MIN_GAS_PRICE) {
-      throw new IllegalArgumentError(`Gas price ${value.toString()} must be bigger then ${MIN_GAS_PRICE}`);
-    }
-
-    return writeInt(value);
-  }
-
-  static deserialize(value) {
-    return readInt(value);
-  }
-
-}
-//# sourceMappingURL=field-types.mjs.map

package/es/tx/builder/field-types.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"field-types.mjs","names":["writeId","readId","produceNameId","getMinimumNameFee","readInt","writeInt","isNameValid","InsufficientNameFeeError","IllegalArgumentError","BigNumber","MIN_GAS_PRICE","Field","serialize","value","_txFields","from","deserialize","toString","Name","NameId","NameFee","name","minNameFee","gt","Deposit","parseInt","GasPrice"],"sources":["../../../src/tx/builder/field-types.ts"],"sourcesContent":["import {\n  writeId, readId, produceNameId, getMinimumNameFee, readInt, writeInt, isNameValid\n} from './helpers'\nimport { InsufficientNameFeeError, IllegalArgumentError } from '../../utils/errors'\nimport BigNumber from 'bignumber.js'\nimport { MIN_GAS_PRICE, AensName } from './constants'\nimport { EncodedData } from '../../utils/encoder'\n\ntype Int = number | string | BigNumber\n\n// todo: update me\n// ? This is a TS workaround because this has to be a class with only static methods\nexport class Field {\n  public prototype: any\n\n  static serialize (value: any, _txFields: object = {}): Buffer {\n    return Buffer.from(value)\n  }\n\n  static deserialize (value: Buffer): any {\n    return value.toString()\n  }\n}\n\nexport class Name extends Field {\n  /**\n   * @param value - AENS name\n   */\n  static serialize (value: AensName): Buffer {\n    return Buffer.from(value)\n  }\n\n  /**\n   * @param value - AENS name\n   */\n  static deserialize (value: Buffer): string {\n    return value.toString()\n  }\n}\n\nexport class NameId extends Field {\n  /**\n   * @param value - AENS name ID\n   */\n  static serialize (value: AensName | EncodedData<'nm'>): Buffer {\n    return writeId(isNameValid(value) ? produceNameId(value) : value)\n  }\n\n  /**\n   * @param value - AENS name ID Buffer\n   */\n  static deserialize (value: Buffer): string {\n    return readId(value)\n  }\n}\n\nexport class NameFee extends Field {\n  /**\n   * @param value - AENS name fee Buffer\n   * @param txFields - Transaction fields\n   * @param txFields.name - AENS Name in transaction\n   */\n  static serialize (value: Int | undefined, { name }: { name: AensName }): Buffer {\n    const minNameFee = getMinimumNameFee(name)\n    value ??= minNameFee\n    if (minNameFee.gt(value)) {\n      throw new InsufficientNameFeeError(new BigNumber(value), minNameFee)\n    }\n    return writeInt(value)\n  }\n\n  /**\n   * @param value - AENS name fee Buffer\n   * @returns AENS name fee\n   */\n  static deserialize (value: Buffer): string {\n    return readInt(value)\n  }\n}\n\nexport class Deposit extends Field {\n  /**\n   * @param value - Deposit value in string format. Should be equal to  '0'.\n   * @returns Deposit value Buffer.\n   */\n  static serialize (value: string = '0'): Buffer {\n    if (parseInt(value) !== 0) throw new IllegalArgumentError(`Contract deposit is not refundable, so it should be equal 0, got ${value.toString()} instead`)\n    return writeInt(0)\n  }\n\n  /**\n   * @param value - Deposit value Buffer.\n   * @returns Deposit value.\n   */\n  static deserialize (value: Buffer): string {\n    return readInt(value)\n  }\n}\n\nexport class GasPrice extends Field {\n  static serialize (value: Int = MIN_GAS_PRICE): Buffer {\n    if (+value < MIN_GAS_PRICE) {\n      throw new IllegalArgumentError(`Gas price ${value.toString()} must be bigger then ${MIN_GAS_PRICE}`)\n    }\n    return writeInt(value)\n  }\n\n  static deserialize (value: Buffer): string {\n    return readInt(value)\n  }\n}\n"],"mappings":";;;;SACEA,O,EAASC,M,EAAQC,a,EAAeC,iB,EAAmBC,O,EAASC,Q,EAAUC,W;SAE/DC,wB,EAA0BC,oB;AACnC,OAAOC,SAAP,MAAsB,cAAtB;SACSC,a;AAKT;AACA;AACA,OAAO,MAAMC,KAAN,CAAY;EAGD,OAATC,SAAS,CAAEC,KAAF,EAA8C;IAAA,IAAhCC,SAAgC,uEAAZ,EAAY;;IAC5D,OAAO,QAAOC,IAAP,CAAYF,KAAZ,CAAP;EACD;;EAEiB,OAAXG,WAAW,CAAEH,KAAF,EAAsB;IACtC,OAAOA,KAAK,CAACI,QAAN,EAAP;EACD;;AATgB;AAYnB,OAAO,MAAMC,IAAN,SAAmBP,KAAnB,CAAyB;EAC9B;AACF;AACA;EACkB,OAATC,SAAS,CAAEC,KAAF,EAA2B;IACzC,OAAO,QAAOE,IAAP,CAAYF,KAAZ,CAAP;EACD;EAED;AACF;AACA;;;EACoB,OAAXG,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOA,KAAK,CAACI,QAAN,EAAP;EACD;;AAb6B;AAgBhC,OAAO,MAAME,MAAN,SAAqBR,KAArB,CAA2B;EAChC;AACF;AACA;EACkB,OAATC,SAAS,CAAEC,KAAF,EAA+C;IAC7D,OAAOb,OAAO,CAACM,WAAW,CAACO,KAAD,CAAX,GAAqBX,aAAa,CAACW,KAAD,CAAlC,GAA4CA,KAA7C,CAAd;EACD;EAED;AACF;AACA;;;EACoB,OAAXG,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOZ,MAAM,CAACY,KAAD,CAAb;EACD;;AAb+B;AAgBlC,OAAO,MAAMO,OAAN,SAAsBT,KAAtB,CAA4B;EACjC;AACF;AACA;AACA;AACA;EACkB,OAATC,SAAS,CAAEC,KAAF,QAAgE;IAAA;;IAAA,IAAtC;MAAEQ;IAAF,CAAsC;IAC9E,MAAMC,UAAU,GAAGnB,iBAAiB,CAACkB,IAAD,CAApC;IACA,UAAAR,KAAK,UAAL,iCAAAA,KAAK,GAAKS,UAAV;;IACA,IAAIA,UAAU,CAACC,EAAX,CAAcV,KAAd,CAAJ,EAA0B;MACxB,MAAM,IAAIN,wBAAJ,CAA6B,IAAIE,SAAJ,CAAcI,KAAd,CAA7B,EAAmDS,UAAnD,CAAN;IACD;;IACD,OAAOjB,QAAQ,CAACQ,KAAD,CAAf;EACD;EAED;AACF;AACA;AACA;;;EACoB,OAAXG,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOT,OAAO,CAACS,KAAD,CAAd;EACD;;AArBgC;AAwBnC,OAAO,MAAMW,OAAN,SAAsBb,KAAtB,CAA4B;EACjC;AACF;AACA;AACA;EACkB,OAATC,SAAS,GAA+B;IAAA,IAA7BC,KAA6B,uEAAb,GAAa;IAC7C,IAAIY,QAAQ,CAACZ,KAAD,CAAR,KAAoB,CAAxB,EAA2B,MAAM,IAAIL,oBAAJ,CAA0B,oEAAmEK,KAAK,CAACI,QAAN,EAAiB,UAA9G,CAAN;IAC3B,OAAOZ,QAAQ,CAAC,CAAD,CAAf;EACD;EAED;AACF;AACA;AACA;;;EACoB,OAAXW,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOT,OAAO,CAACS,KAAD,CAAd;EACD;;AAhBgC;AAmBnC,OAAO,MAAMa,QAAN,SAAuBf,KAAvB,CAA6B;EAClB,OAATC,SAAS,GAAsC;IAAA,IAApCC,KAAoC,uEAAvBH,aAAuB;;IACpD,IAAI,CAACG,KAAD,GAASH,aAAb,EAA4B;MAC1B,MAAM,IAAIF,oBAAJ,CAA0B,aAAYK,KAAK,CAACI,QAAN,EAAiB,wBAAuBP,aAAc,EAA5F,CAAN;IACD;;IACD,OAAOL,QAAQ,CAACQ,KAAD,CAAf;EACD;;EAEiB,OAAXG,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOT,OAAO,CAACS,KAAD,CAAd;EACD;;AAViC"}

package/es/tx/min-fee.d.ts

@@ -1,20 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { TX_TYPE, TxParamsCommon } from './builder/schema';
-import { AE_AMOUNT_FORMATS } from '../utils/amount-formatter';
-/**
- * Calculate min fee
- * @param txType - Transaction type
- * @param options - Options object
- * @param options.params - Tx params
- * @example
- * ```js
- * calculateMinFee('spendTx', { gasLimit, params })
- * ```
- */
-export default function calculateMinFee(txType: TX_TYPE, { params, vsn, denomination }: CalculateMinFeeOptions): BigNumber;
-interface CalculateMinFeeOptions {
-    params: TxParamsCommon;
-    vsn?: number;
-    denomination?: AE_AMOUNT_FORMATS;
-}
-export {};

package/es/tx/min-fee.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"min-fee.mjs","names":["BigNumber","MIN_GAS_PRICE","TX_TYPE","buildTx","isKeyOfObject","BASE_GAS","GAS_PER_BYTE","KEY_BLOCK_INTERVAL","TX_FEE_BASE_GAS","txType","feeFactors","channelForceProgress","channelOffChain","channelOffChainCallContract","channelOffChainCreateContract","channelOffChainUpdateDeposit","channelOffChainUpdateWithdrawal","channelOffChainUpdateTransfer","contractCreate","contractCall","gaAttach","gaMeta","payingFor","factor","TX_FEE_OTHER_GAS","txSize","relativeTtl","innerTxSize","oracleRegister","oracleExtend","oracleQuery","oracleResponse","times","plus","Math","ceil","floor","minus","getOracleRelativeTtl","params","ttlKeys","buildFee","vsn","denomination","rlpEncoded","length","tx","encodedTx","calculateMinFee","fee","previousFee","eq"],"sources":["../../src/tx/min-fee.ts"],"sourcesContent":["import BigNumber from 'bignumber.js'\nimport { MIN_GAS_PRICE, TX_TYPE, TxParamsCommon } from './builder/schema'\nimport { AE_AMOUNT_FORMATS } from '../utils/amount-formatter'\nimport { buildTx } from './builder'\nimport { isKeyOfObject } from '../utils/other'\n\nconst BASE_GAS = 15000\nconst GAS_PER_BYTE = 20\nconst KEY_BLOCK_INTERVAL = 3\n\n/**\n * Calculate the Base fee gas\n * @see {@link https://github.com/aeternity/protocol/blob/master/consensus/README.md#gas}\n * @param txType - The transaction type\n * @returns The base fee\n * @example\n * ```js\n * TX_FEE_BASE('channelForceProgress') => new BigNumber(30 * 15000)\n * ```\n */\nconst TX_FEE_BASE_GAS = (txType: TX_TYPE): BigNumber => {\n  const feeFactors = {\n    [TX_TYPE.channelForceProgress]: 30,\n    [TX_TYPE.channelOffChain]: 0,\n    [TX_TYPE.channelOffChainCallContract]: 0,\n    [TX_TYPE.channelOffChainCreateContract]: 0,\n    [TX_TYPE.channelOffChainUpdateDeposit]: 0,\n    [TX_TYPE.channelOffChainUpdateWithdrawal]: 0,\n    [TX_TYPE.channelOffChainUpdateTransfer]: 0,\n    [TX_TYPE.contractCreate]: 5,\n    [TX_TYPE.contractCall]: 12,\n    [TX_TYPE.gaAttach]: 5,\n    [TX_TYPE.gaMeta]: 5,\n    [TX_TYPE.payingFor]: 1 / 5\n  } as const\n  const factor = feeFactors[txType as keyof typeof feeFactors] ?? 1\n  return new BigNumber(factor * BASE_GAS)\n}\n\n/**\n * Calculate fee for Other types of transactions\n * @see {@link https://github.com/aeternity/protocol/blob/master/consensus/README.md#gas}\n * @param txType - The transaction type\n * @param txSize - The transaction size\n * @returns parameters - The transaction parameters\n * @returns parameters.relativeTtl - The relative ttl\n * @returns parameters.innerTxSize - The size of the inner transaction\n * @returns The Other fee\n * @example\n * ```js\n * TX_FEE_OTHER_GAS('oracleResponse',10, { relativeTtl: 10, innerTxSize: 10 })\n *  => new BigNumber(10).times(20).plus(Math.ceil(32000 * 10 / Math.floor(60 * 24 * 365 / 2)))\n * ```\n */\nconst TX_FEE_OTHER_GAS = (\n  txType: TX_TYPE,\n  txSize: number,\n  { relativeTtl, innerTxSize }: { relativeTtl: number, innerTxSize: number }\n): BigNumber => {\n  switch (txType) {\n    case TX_TYPE.oracleRegister:\n    case TX_TYPE.oracleExtend:\n    case TX_TYPE.oracleQuery:\n    case TX_TYPE.oracleResponse:\n      return new BigNumber(txSize)\n        .times(GAS_PER_BYTE)\n        .plus(\n          Math.ceil(32000 * relativeTtl / Math.floor(60 * 24 * 365 / KEY_BLOCK_INTERVAL))\n        )\n    case TX_TYPE.gaMeta:\n    case TX_TYPE.payingFor:\n      return new BigNumber(txSize).minus(innerTxSize).times(GAS_PER_BYTE)\n    default:\n      return new BigNumber(txSize).times(GAS_PER_BYTE)\n  }\n}\n\nfunction getOracleRelativeTtl (params: any, txType: TX_TYPE): number {\n  const ttlKeys = {\n    [TX_TYPE.oracleRegister]: 'oracleTtlValue',\n    [TX_TYPE.oracleExtend]: 'oracleTtlValue',\n    [TX_TYPE.oracleQuery]: 'queryTtlValue',\n    [TX_TYPE.oracleResponse]: 'responseTtlValue'\n  } as const\n\n  if (!isKeyOfObject(txType, ttlKeys)) return 1\n  else return params[ttlKeys[txType]]\n}\n\n/**\n * Calculate fee based on tx type and params\n */\nfunction buildFee (\n  txType: TX_TYPE,\n  { params, vsn, denomination }:\n  { params: TxParamsCommon, vsn?: number, denomination?: AE_AMOUNT_FORMATS }\n): BigNumber {\n  const { rlpEncoded: { length } } = buildTx(params, txType, { vsn, denomination })\n\n  return TX_FEE_BASE_GAS(txType)\n    .plus(TX_FEE_OTHER_GAS(txType, length, {\n      relativeTtl: getOracleRelativeTtl(params, txType),\n      innerTxSize: [TX_TYPE.gaMeta, TX_TYPE.payingFor].includes(txType)\n        ? params.tx.tx.encodedTx.rlpEncoded.length\n        : 0\n    }))\n    .times(MIN_GAS_PRICE)\n}\n\n/**\n * Calculate min fee\n * @param txType - Transaction type\n * @param options - Options object\n * @param options.params - Tx params\n * @example\n * ```js\n * calculateMinFee('spendTx', { gasLimit, params })\n * ```\n */\nexport default function calculateMinFee (\n  txType: TX_TYPE, { params, vsn, denomination }: CalculateMinFeeOptions\n): BigNumber {\n  let fee = new BigNumber(0)\n  let previousFee\n  do {\n    previousFee = fee\n    fee = buildFee(txType, { params: { ...params, fee }, vsn, denomination })\n  } while (!fee.eq(previousFee))\n  return fee\n}\n\ninterface CalculateMinFeeOptions {\n  params: TxParamsCommon\n  vsn?: number\n  denomination?: AE_AMOUNT_FORMATS\n}\n"],"mappings":";AAAA,OAAOA,SAAP,MAAsB,cAAtB;SACSC,a,EAAeC,O;SAEfC,O;SACAC,a;AAET,MAAMC,QAAQ,GAAG,KAAjB;AACA,MAAMC,YAAY,GAAG,EAArB;AACA,MAAMC,kBAAkB,GAAG,CAA3B;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,MAAMC,eAAe,GAAIC,MAAD,IAAgC;EAAA;;EACtD,MAAMC,UAAU,GAAG;IACjB,CAACR,OAAO,CAACS,oBAAT,GAAgC,EADf;IAEjB,CAACT,OAAO,CAACU,eAAT,GAA2B,CAFV;IAGjB,CAACV,OAAO,CAACW,2BAAT,GAAuC,CAHtB;IAIjB,CAACX,OAAO,CAACY,6BAAT,GAAyC,CAJxB;IAKjB,CAACZ,OAAO,CAACa,4BAAT,GAAwC,CALvB;IAMjB,CAACb,OAAO,CAACc,+BAAT,GAA2C,CAN1B;IAOjB,CAACd,OAAO,CAACe,6BAAT,GAAyC,CAPxB;IAQjB,CAACf,OAAO,CAACgB,cAAT,GAA0B,CART;IASjB,CAAChB,OAAO,CAACiB,YAAT,GAAwB,EATP;IAUjB,CAACjB,OAAO,CAACkB,QAAT,GAAoB,CAVH;IAWjB,CAAClB,OAAO,CAACmB,MAAT,GAAkB,CAXD;IAYjB,CAACnB,OAAO,CAACoB,SAAT,GAAqB,IAAI;EAZR,CAAnB;EAcA,MAAMC,MAAM,kBAAGb,UAAU,CAACD,MAAD,CAAb,qDAAoD,CAAhE;EACA,OAAO,IAAIT,SAAJ,CAAcuB,MAAM,GAAGlB,QAAvB,CAAP;AACD,CAjBD;AAmBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,MAAMmB,gBAAgB,GAAG,CACvBf,MADuB,EAEvBgB,MAFuB,WAIT;EAAA,IADd;IAAEC,WAAF;IAAeC;EAAf,CACc;;EACd,QAAQlB,MAAR;IACE,KAAKP,OAAO,CAAC0B,cAAb;IACA,KAAK1B,OAAO,CAAC2B,YAAb;IACA,KAAK3B,OAAO,CAAC4B,WAAb;IACA,KAAK5B,OAAO,CAAC6B,cAAb;MACE,OAAO,IAAI/B,SAAJ,CAAcyB,MAAd,EACJO,KADI,CACE1B,YADF,EAEJ2B,IAFI,CAGHC,IAAI,CAACC,IAAL,CAAU,QAAQT,WAAR,GAAsBQ,IAAI,CAACE,KAAL,CAAW,KAAK,EAAL,GAAU,GAAV,GAAgB7B,kBAA3B,CAAhC,CAHG,CAAP;;IAKF,KAAKL,OAAO,CAACmB,MAAb;IACA,KAAKnB,OAAO,CAACoB,SAAb;MACE,OAAO,IAAItB,SAAJ,CAAcyB,MAAd,EAAsBY,KAAtB,CAA4BV,WAA5B,EAAyCK,KAAzC,CAA+C1B,YAA/C,CAAP;;IACF;MACE,OAAO,IAAIN,SAAJ,CAAcyB,MAAd,EAAsBO,KAAtB,CAA4B1B,YAA5B,CAAP;EAdJ;AAgBD,CArBD;;AAuBA,SAASgC,oBAAT,CAA+BC,MAA/B,EAA4C9B,MAA5C,EAAqE;EACnE,MAAM+B,OAAO,GAAG;IACd,CAACtC,OAAO,CAAC0B,cAAT,GAA0B,gBADZ;IAEd,CAAC1B,OAAO,CAAC2B,YAAT,GAAwB,gBAFV;IAGd,CAAC3B,OAAO,CAAC4B,WAAT,GAAuB,eAHT;IAId,CAAC5B,OAAO,CAAC6B,cAAT,GAA0B;EAJZ,CAAhB;EAOA,IAAI,CAAC3B,aAAa,CAACK,MAAD,EAAS+B,OAAT,CAAlB,EAAqC,OAAO,CAAP,CAArC,KACK,OAAOD,MAAM,CAACC,OAAO,CAAC/B,MAAD,CAAR,CAAb;AACN;AAED;AACA;AACA;;;AACA,SAASgC,QAAT,CACEhC,MADF,SAIa;EAAA;;EAAA,IAFX;IAAE8B,MAAF;IAAUG,GAAV;IAAeC;EAAf,CAEW;EACX,MAAM;IAAEC,UAAU,EAAE;MAAEC;IAAF;EAAd,IAA6B1C,OAAO,CAACoC,MAAD,EAAS9B,MAAT,EAAiB;IAAEiC,GAAF;IAAOC;EAAP,CAAjB,CAA1C;EAEA,OAAOnC,eAAe,CAACC,MAAD,CAAf,CACJwB,IADI,CACCT,gBAAgB,CAACf,MAAD,EAASoC,MAAT,EAAiB;IACrCnB,WAAW,EAAEY,oBAAoB,CAACC,MAAD,EAAS9B,MAAT,CADI;IAErCkB,WAAW,EAAE,sCAACzB,OAAO,CAACmB,MAAT,EAAiBnB,OAAO,CAACoB,SAAzB,kBAA6Cb,MAA7C,IACT8B,MAAM,CAACO,EAAP,CAAUA,EAAV,CAAaC,SAAb,CAAuBH,UAAvB,CAAkCC,MADzB,GAET;EAJiC,CAAjB,CADjB,EAOJb,KAPI,CAOE/B,aAPF,CAAP;AAQD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,eAAe,SAAS+C,eAAT,CACbvC,MADa,SAEF;EAAA,IADM;IAAE8B,MAAF;IAAUG,GAAV;IAAeC;EAAf,CACN;EACX,IAAIM,GAAG,GAAG,IAAIjD,SAAJ,CAAc,CAAd,CAAV;EACA,IAAIkD,WAAJ;;EACA,GAAG;IACDA,WAAW,GAAGD,GAAd;IACAA,GAAG,GAAGR,QAAQ,CAAChC,MAAD,EAAS;MAAE8B,MAAM,EAAE,EAAE,GAAGA,MAAL;QAAaU;MAAb,CAAV;MAA8BP,GAA9B;MAAmCC;IAAnC,CAAT,CAAd;EACD,CAHD,QAGS,CAACM,GAAG,CAACE,EAAJ,CAAOD,WAAP,CAHV;;EAIA,OAAOD,GAAP;AACD"}