viem 0.0.0-main.20231117T224608 → 0.0.0-main.20231119T230454

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/_cjs/errors/version.js +1 -1
  2. package/_cjs/utils/unit/formatEther.js.map +1 -1
  3. package/_cjs/utils/unit/formatGwei.js.map +1 -1
  4. package/_cjs/utils/unit/formatUnits.js.map +1 -1
  5. package/_cjs/utils/unit/parseEther.js.map +1 -1
  6. package/_cjs/utils/unit/parseGwei.js.map +1 -1
  7. package/_cjs/utils/unit/parseUnits.js.map +1 -1
  8. package/_esm/errors/version.js +1 -1
  9. package/_esm/utils/unit/formatEther.js +11 -0
  10. package/_esm/utils/unit/formatEther.js.map +1 -1
  11. package/_esm/utils/unit/formatGwei.js +11 -0
  12. package/_esm/utils/unit/formatGwei.js.map +1 -1
  13. package/_esm/utils/unit/formatUnits.js +11 -0
  14. package/_esm/utils/unit/formatUnits.js.map +1 -1
  15. package/_esm/utils/unit/parseEther.js +11 -0
  16. package/_esm/utils/unit/parseEther.js.map +1 -1
  17. package/_esm/utils/unit/parseGwei.js +11 -0
  18. package/_esm/utils/unit/parseGwei.js.map +1 -1
  19. package/_esm/utils/unit/parseUnits.js +11 -0
  20. package/_esm/utils/unit/parseUnits.js.map +1 -1
  21. package/_types/errors/version.d.ts +1 -1
  22. package/_types/utils/unit/formatEther.d.ts +11 -0
  23. package/_types/utils/unit/formatEther.d.ts.map +1 -1
  24. package/_types/utils/unit/formatGwei.d.ts +11 -0
  25. package/_types/utils/unit/formatGwei.d.ts.map +1 -1
  26. package/_types/utils/unit/formatUnits.d.ts +11 -0
  27. package/_types/utils/unit/formatUnits.d.ts.map +1 -1
  28. package/_types/utils/unit/parseEther.d.ts +11 -0
  29. package/_types/utils/unit/parseEther.d.ts.map +1 -1
  30. package/_types/utils/unit/parseGwei.d.ts +11 -0
  31. package/_types/utils/unit/parseGwei.d.ts.map +1 -1
  32. package/_types/utils/unit/parseUnits.d.ts +11 -0
  33. package/_types/utils/unit/parseUnits.d.ts.map +1 -1
  34. package/errors/version.ts +1 -1
  35. package/package.json +1 -1
  36. package/utils/unit/formatEther.ts +11 -0
  37. package/utils/unit/formatGwei.ts +11 -0
  38. package/utils/unit/formatUnits.ts +11 -0
  39. package/utils/unit/parseEther.ts +11 -0
  40. package/utils/unit/parseGwei.ts +11 -0
  41. package/utils/unit/parseUnits.ts +11 -0
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.version = void 0;
4
- exports.version = '0.0.0-main.20231117T224608';
4
+ exports.version = '0.0.0-main.20231119T230454';
5
5
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"formatEther.js","sourceRoot":"","sources":["../../../utils/unit/formatEther.ts"],"names":[],"mappings":";;;AAAA,qDAAoD;AAEpD,qDAAyE;AAIzE,SAAgB,WAAW,CAAC,GAAW,EAAE,OAAuB,KAAK;IACnE,OAAO,IAAA,4BAAW,EAAC,GAAG,EAAE,oBAAU,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC;AAFD,kCAEC"}
1
+ {"version":3,"file":"formatEther.js","sourceRoot":"","sources":["../../../utils/unit/formatEther.ts"],"names":[],"mappings":";;;AAAA,qDAAoD;AAEpD,qDAAyE;AAezE,SAAgB,WAAW,CAAC,GAAW,EAAE,OAAuB,KAAK;IACnE,OAAO,IAAA,4BAAW,EAAC,GAAG,EAAE,oBAAU,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC;AAFD,kCAEC"}
@@ -1 +1 @@
1
- {"version":3,"file":"formatGwei.js","sourceRoot":"","sources":["../../../utils/unit/formatGwei.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAEnD,qDAAyE;AAIzE,SAAgB,UAAU,CAAC,GAAW,EAAE,OAAc,KAAK;IACzD,OAAO,IAAA,4BAAW,EAAC,GAAG,EAAE,mBAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAC1C,CAAC;AAFD,gCAEC"}
1
+ {"version":3,"file":"formatGwei.js","sourceRoot":"","sources":["../../../utils/unit/formatGwei.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAEnD,qDAAyE;AAezE,SAAgB,UAAU,CAAC,GAAW,EAAE,OAAc,KAAK;IACzD,OAAO,IAAA,4BAAW,EAAC,GAAG,EAAE,mBAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAC1C,CAAC;AAFD,gCAEC"}
@@ -1 +1 @@
1
- {"version":3,"file":"formatUnits.js","sourceRoot":"","sources":["../../../utils/unit/formatUnits.ts"],"names":[],"mappings":";;;AAIA,SAAgB,WAAW,CAAC,KAAa,EAAE,QAAgB;IACzD,IAAI,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;IAE9B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAExC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAEzC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;QACxB,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;QAC3C,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;KACzC,CAAA;IACD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACxC,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,IAAI,GAAG,GAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAC9B,EAAE,CAAA;AACJ,CAAC;AAhBD,kCAgBC"}
1
+ {"version":3,"file":"formatUnits.js","sourceRoot":"","sources":["../../../utils/unit/formatUnits.ts"],"names":[],"mappings":";;;AAeA,SAAgB,WAAW,CAAC,KAAa,EAAE,QAAgB;IACzD,IAAI,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;IAE9B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAExC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAEzC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;QACxB,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;QAC3C,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;KACzC,CAAA;IACD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACxC,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,IAAI,GAAG,GAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAC9B,EAAE,CAAA;AACJ,CAAC;AAhBD,kCAgBC"}
@@ -1 +1 @@
1
- {"version":3,"file":"parseEther.js","sourceRoot":"","sources":["../../../utils/unit/parseEther.ts"],"names":[],"mappings":";;;AAAA,qDAAoD;AAGpD,mDAAsE;AAItE,SAAgB,UAAU,CAAC,KAAa,EAAE,OAAuB,KAAK;IACpE,OAAO,IAAA,0BAAU,EAAC,KAAK,EAAE,oBAAU,CAAC,IAAI,CAAC,CAAC,CAAA;AAC5C,CAAC;AAFD,gCAEC"}
1
+ {"version":3,"file":"parseEther.js","sourceRoot":"","sources":["../../../utils/unit/parseEther.ts"],"names":[],"mappings":";;;AAAA,qDAAoD;AAGpD,mDAAsE;AAetE,SAAgB,UAAU,CAAC,KAAa,EAAE,OAAuB,KAAK;IACpE,OAAO,IAAA,0BAAU,EAAC,KAAK,EAAE,oBAAU,CAAC,IAAI,CAAC,CAAC,CAAA;AAC5C,CAAC;AAFD,gCAEC"}
@@ -1 +1 @@
1
- {"version":3,"file":"parseGwei.js","sourceRoot":"","sources":["../../../utils/unit/parseGwei.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAGnD,mDAAsE;AAItE,SAAgB,SAAS,CAAC,KAAa,EAAE,OAAc,KAAK;IAC1D,OAAO,IAAA,0BAAU,EAAC,KAAK,EAAE,mBAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC"}
1
+ {"version":3,"file":"parseGwei.js","sourceRoot":"","sources":["../../../utils/unit/parseGwei.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAGnD,mDAAsE;AAetE,SAAgB,SAAS,CAAC,KAAa,EAAE,OAAc,KAAK;IAC1D,OAAO,IAAA,0BAAU,EAAC,KAAK,EAAE,mBAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC"}
@@ -1 +1 @@
1
- {"version":3,"file":"parseUnits.js","sourceRoot":"","sources":["../../../utils/unit/parseUnits.ts"],"names":[],"mappings":";;;AAIA,SAAgB,UAAU,CAAC,KAAa,EAAE,QAAgB;IACxD,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAEhD,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAGxC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAGxC,IAAI,QAAQ,KAAK,CAAC,EAAE;QAClB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC;YAC1C,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;QACrC,QAAQ,GAAG,EAAE,CAAA;KACd;SAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE;QACrC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG;YAC1B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC;YAC/B,QAAQ,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,CAAC;YACtC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;SACzB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAA;QACtD,IAAI,OAAO,GAAG,CAAC;YACb,QAAQ,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;;YACrE,QAAQ,GAAG,GAAG,IAAI,GAAG,OAAO,EAAE,CAAA;QAEnC,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE;YAC9B,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC5B,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;SACpC;QAED,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;KACvC;SAAM;QACL,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;KAC1C;IAED,OAAO,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,GAAG,QAAQ,EAAE,CAAC,CAAA;AAC9D,CAAC;AArCD,gCAqCC"}
1
+ {"version":3,"file":"parseUnits.js","sourceRoot":"","sources":["../../../utils/unit/parseUnits.ts"],"names":[],"mappings":";;;AAeA,SAAgB,UAAU,CAAC,KAAa,EAAE,QAAgB;IACxD,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAEhD,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAGxC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAGxC,IAAI,QAAQ,KAAK,CAAC,EAAE;QAClB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC;YAC1C,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;QACrC,QAAQ,GAAG,EAAE,CAAA;KACd;SAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE;QACrC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG;YAC1B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC;YAC/B,QAAQ,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,CAAC;YACtC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;SACzB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAA;QACtD,IAAI,OAAO,GAAG,CAAC;YACb,QAAQ,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;;YACrE,QAAQ,GAAG,GAAG,IAAI,GAAG,OAAO,EAAE,CAAA;QAEnC,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE;YAC9B,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC5B,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;SACpC;QAED,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;KACvC;SAAM;QACL,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;KAC1C;IAED,OAAO,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,GAAG,QAAQ,EAAE,CAAC,CAAA;AAC9D,CAAC;AArCD,gCAqCC"}
@@ -1,2 +1,2 @@
1
- export const version = '0.0.0-main.20231117T224608';
1
+ export const version = '0.0.0-main.20231119T230454';
2
2
  //# sourceMappingURL=version.js.map
@@ -1,5 +1,16 @@
1
1
  import { etherUnits } from '../../constants/unit.js';
2
2
  import { formatUnits } from './formatUnits.js';
3
+ /**
4
+ * Converts numerical wei to a string representation of ether.
5
+ *
6
+ * - Docs: https://viem.sh/docs/utilities/formatEther.html
7
+ *
8
+ * @example
9
+ * import { formatEther } from 'viem'
10
+ *
11
+ * formatEther(1000000000000000000n)
12
+ * // '1'
13
+ */
3
14
  export function formatEther(wei, unit = 'wei') {
4
15
  return formatUnits(wei, etherUnits[unit]);
5
16
  }
@@ -1 +1 @@
1
- {"version":3,"file":"formatEther.js","sourceRoot":"","sources":["../../../utils/unit/formatEther.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,OAAO,EAA6B,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAIzE,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,OAAuB,KAAK;IACnE,OAAO,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC"}
1
+ {"version":3,"file":"formatEther.js","sourceRoot":"","sources":["../../../utils/unit/formatEther.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEpD,OAAO,EAA6B,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAIzE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,OAAuB,KAAK;IACnE,OAAO,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC"}
@@ -1,5 +1,16 @@
1
1
  import { gweiUnits } from '../../constants/unit.js';
2
2
  import { formatUnits } from './formatUnits.js';
3
+ /**
4
+ * Converts numerical wei to a string representation of gwei.
5
+ *
6
+ * - Docs: https://viem.sh/docs/utilities/formatGwei.html
7
+ *
8
+ * @example
9
+ * import { formatGwei } from 'viem'
10
+ *
11
+ * formatGwei(1000000000n)
12
+ * // '1'
13
+ */
3
14
  export function formatGwei(wei, unit = 'wei') {
4
15
  return formatUnits(wei, gweiUnits[unit]);
5
16
  }
@@ -1 +1 @@
1
- {"version":3,"file":"formatGwei.js","sourceRoot":"","sources":["../../../utils/unit/formatGwei.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAEnD,OAAO,EAA6B,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAIzE,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,OAAc,KAAK;IACzD,OAAO,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAC1C,CAAC"}
1
+ {"version":3,"file":"formatGwei.js","sourceRoot":"","sources":["../../../utils/unit/formatGwei.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAEnD,OAAO,EAA6B,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAIzE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,OAAc,KAAK;IACzD,OAAO,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAC1C,CAAC"}
@@ -1,3 +1,14 @@
1
+ /**
2
+ * Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number..
3
+ *
4
+ * - Docs: https://viem.sh/docs/utilities/formatUnits.html
5
+ *
6
+ * @example
7
+ * import { formatUnits } from 'viem'
8
+ *
9
+ * formatUnits(420000000000n, 9)
10
+ * // '420'
11
+ */
1
12
  export function formatUnits(value, decimals) {
2
13
  let display = value.toString();
3
14
  const negative = display.startsWith('-');
@@ -1 +1 @@
1
- {"version":3,"file":"formatUnits.js","sourceRoot":"","sources":["../../../utils/unit/formatUnits.ts"],"names":[],"mappings":"AAIA,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,QAAgB;IACzD,IAAI,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;IAE9B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAExC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAEzC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;QACxB,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;QAC3C,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;KACzC,CAAA;IACD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACxC,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,IAAI,GAAG,GAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAC9B,EAAE,CAAA;AACJ,CAAC"}
1
+ {"version":3,"file":"formatUnits.js","sourceRoot":"","sources":["../../../utils/unit/formatUnits.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,QAAgB;IACzD,IAAI,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;IAE9B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAExC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAEzC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;QACxB,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;QAC3C,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;KACzC,CAAA;IACD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACxC,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,IAAI,GAAG,GAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAC9B,EAAE,CAAA;AACJ,CAAC"}
@@ -1,5 +1,16 @@
1
1
  import { etherUnits } from '../../constants/unit.js';
2
2
  import { parseUnits } from './parseUnits.js';
3
+ /**
4
+ * Converts a string representation of ether to numerical wei.
5
+ *
6
+ * - Docs: https://viem.sh/docs/utilities/parseEther.html
7
+ *
8
+ * @example
9
+ * import { parseEther } from 'viem'
10
+ *
11
+ * parseEther('420')
12
+ * // 420000000000000000000n
13
+ */
3
14
  export function parseEther(ether, unit = 'wei') {
4
15
  return parseUnits(ether, etherUnits[unit]);
5
16
  }
@@ -1 +1 @@
1
- {"version":3,"file":"parseEther.js","sourceRoot":"","sources":["../../../utils/unit/parseEther.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAGpD,OAAO,EAA4B,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAItE,MAAM,UAAU,UAAU,CAAC,KAAa,EAAE,OAAuB,KAAK;IACpE,OAAO,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA;AAC5C,CAAC"}
1
+ {"version":3,"file":"parseEther.js","sourceRoot":"","sources":["../../../utils/unit/parseEther.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAGpD,OAAO,EAA4B,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAItE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa,EAAE,OAAuB,KAAK;IACpE,OAAO,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA;AAC5C,CAAC"}
@@ -1,5 +1,16 @@
1
1
  import { gweiUnits } from '../../constants/unit.js';
2
2
  import { parseUnits } from './parseUnits.js';
3
+ /**
4
+ * Converts a string representation of gwei to numerical wei.
5
+ *
6
+ * - Docs: https://viem.sh/docs/utilities/parseGwei.html
7
+ *
8
+ * @example
9
+ * import { parseGwei } from 'viem'
10
+ *
11
+ * parseGwei('420')
12
+ * // 420000000000n
13
+ */
3
14
  export function parseGwei(ether, unit = 'wei') {
4
15
  return parseUnits(ether, gweiUnits[unit]);
5
16
  }
@@ -1 +1 @@
1
- {"version":3,"file":"parseGwei.js","sourceRoot":"","sources":["../../../utils/unit/parseGwei.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAA4B,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAItE,MAAM,UAAU,SAAS,CAAC,KAAa,EAAE,OAAc,KAAK;IAC1D,OAAO,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC"}
1
+ {"version":3,"file":"parseGwei.js","sourceRoot":"","sources":["../../../utils/unit/parseGwei.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAA4B,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAItE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa,EAAE,OAAc,KAAK;IAC1D,OAAO,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAC3C,CAAC"}
@@ -1,3 +1,14 @@
1
+ /**
2
+ * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
3
+ *
4
+ * - Docs: https://viem.sh/docs/utilities/parseUnits.html
5
+ *
6
+ * @example
7
+ * import { parseUnits } from 'viem'
8
+ *
9
+ * parseUnits('420', 9)
10
+ * // 420000000000n
11
+ */
1
12
  export function parseUnits(value, decimals) {
2
13
  let [integer, fraction = '0'] = value.split('.');
3
14
  const negative = integer.startsWith('-');
@@ -1 +1 @@
1
- {"version":3,"file":"parseUnits.js","sourceRoot":"","sources":["../../../utils/unit/parseUnits.ts"],"names":[],"mappings":"AAIA,MAAM,UAAU,UAAU,CAAC,KAAa,EAAE,QAAgB;IACxD,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAEhD,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAExC,sBAAsB;IACtB,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAExC,mEAAmE;IACnE,IAAI,QAAQ,KAAK,CAAC,EAAE;QAClB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC;YAC1C,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;QACrC,QAAQ,GAAG,EAAE,CAAA;KACd;SAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE;QACrC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG;YAC1B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC;YAC/B,QAAQ,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,CAAC;YACtC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;SACzB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAA;QACtD,IAAI,OAAO,GAAG,CAAC;YACb,QAAQ,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;;YACrE,QAAQ,GAAG,GAAG,IAAI,GAAG,OAAO,EAAE,CAAA;QAEnC,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE;YAC9B,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC5B,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;SACpC;QAED,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;KACvC;SAAM;QACL,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;KAC1C;IAED,OAAO,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,GAAG,QAAQ,EAAE,CAAC,CAAA;AAC9D,CAAC"}
1
+ {"version":3,"file":"parseUnits.js","sourceRoot":"","sources":["../../../utils/unit/parseUnits.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa,EAAE,QAAgB;IACxD,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAEhD,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAExC,sBAAsB;IACtB,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAExC,mEAAmE;IACnE,IAAI,QAAQ,KAAK,CAAC,EAAE;QAClB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC;YAC1C,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;QACrC,QAAQ,GAAG,EAAE,CAAA;KACd;SAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE;QACrC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG;YAC1B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC;YAC/B,QAAQ,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,CAAC;YACtC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;SACzB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAA;QACtD,IAAI,OAAO,GAAG,CAAC;YACb,QAAQ,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;;YACrE,QAAQ,GAAG,GAAG,IAAI,GAAG,OAAO,EAAE,CAAA;QAEnC,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE;YAC9B,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC5B,OAAO,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAA;SACpC;QAED,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;KACvC;SAAM;QACL,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;KAC1C;IAED,OAAO,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,GAAG,QAAQ,EAAE,CAAC,CAAA;AAC9D,CAAC"}
@@ -1,2 +1,2 @@
1
- export declare const version = "0.0.0-main.20231117T224608";
1
+ export declare const version = "0.0.0-main.20231119T230454";
2
2
  //# sourceMappingURL=version.d.ts.map
@@ -1,4 +1,15 @@
1
1
  import { type FormatUnitsErrorType } from './formatUnits.js';
2
2
  export type FormatEtherErrorType = FormatUnitsErrorType;
3
+ /**
4
+ * Converts numerical wei to a string representation of ether.
5
+ *
6
+ * - Docs: https://viem.sh/docs/utilities/formatEther.html
7
+ *
8
+ * @example
9
+ * import { formatEther } from 'viem'
10
+ *
11
+ * formatEther(1000000000000000000n)
12
+ * // '1'
13
+ */
3
14
  export declare function formatEther(wei: bigint, unit?: 'wei' | 'gwei'): string;
4
15
  //# sourceMappingURL=formatEther.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"formatEther.d.ts","sourceRoot":"","sources":["../../../utils/unit/formatEther.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,oBAAoB,EAAe,MAAM,kBAAkB,CAAA;AAEzE,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAA;AAEvD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,KAAK,GAAG,MAAc,UAEpE"}
1
+ {"version":3,"file":"formatEther.d.ts","sourceRoot":"","sources":["../../../utils/unit/formatEther.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,oBAAoB,EAAe,MAAM,kBAAkB,CAAA;AAEzE,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAA;AAEvD;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,KAAK,GAAG,MAAc,UAEpE"}
@@ -1,4 +1,15 @@
1
1
  import { type FormatUnitsErrorType } from './formatUnits.js';
2
2
  export type FormatGweiErrorType = FormatUnitsErrorType;
3
+ /**
4
+ * Converts numerical wei to a string representation of gwei.
5
+ *
6
+ * - Docs: https://viem.sh/docs/utilities/formatGwei.html
7
+ *
8
+ * @example
9
+ * import { formatGwei } from 'viem'
10
+ *
11
+ * formatGwei(1000000000n)
12
+ * // '1'
13
+ */
3
14
  export declare function formatGwei(wei: bigint, unit?: 'wei'): string;
4
15
  //# sourceMappingURL=formatGwei.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"formatGwei.d.ts","sourceRoot":"","sources":["../../../utils/unit/formatGwei.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,oBAAoB,EAAe,MAAM,kBAAkB,CAAA;AAEzE,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAA;AAEtD,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,KAAa,UAE1D"}
1
+ {"version":3,"file":"formatGwei.d.ts","sourceRoot":"","sources":["../../../utils/unit/formatGwei.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,oBAAoB,EAAe,MAAM,kBAAkB,CAAA;AAEzE,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAA;AAEtD;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,KAAa,UAE1D"}
@@ -1,4 +1,15 @@
1
1
  import type { ErrorType } from '../../errors/utils.js';
2
2
  export type FormatUnitsErrorType = ErrorType;
3
+ /**
4
+ * Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number..
5
+ *
6
+ * - Docs: https://viem.sh/docs/utilities/formatUnits.html
7
+ *
8
+ * @example
9
+ * import { formatUnits } from 'viem'
10
+ *
11
+ * formatUnits(420000000000n, 9)
12
+ * // '420'
13
+ */
3
14
  export declare function formatUnits(value: bigint, decimals: number): string;
4
15
  //# sourceMappingURL=formatUnits.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"formatUnits.d.ts","sourceRoot":"","sources":["../../../utils/unit/formatUnits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAA;AAE5C,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAgB1D"}
1
+ {"version":3,"file":"formatUnits.d.ts","sourceRoot":"","sources":["../../../utils/unit/formatUnits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAA;AAE5C;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAgB1D"}
@@ -1,5 +1,16 @@
1
1
  import type { ErrorType } from '../../errors/utils.js';
2
2
  import { type ParseUnitsErrorType } from './parseUnits.js';
3
3
  export type ParseEtherErrorType = ParseUnitsErrorType | ErrorType;
4
+ /**
5
+ * Converts a string representation of ether to numerical wei.
6
+ *
7
+ * - Docs: https://viem.sh/docs/utilities/parseEther.html
8
+ *
9
+ * @example
10
+ * import { parseEther } from 'viem'
11
+ *
12
+ * parseEther('420')
13
+ * // 420000000000000000000n
14
+ */
4
15
  export declare function parseEther(ether: string, unit?: 'wei' | 'gwei'): bigint;
5
16
  //# sourceMappingURL=parseEther.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"parseEther.d.ts","sourceRoot":"","sources":["../../../utils/unit/parseEther.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,OAAO,EAAE,KAAK,mBAAmB,EAAc,MAAM,iBAAiB,CAAA;AAEtE,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG,SAAS,CAAA;AAEjE,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,KAAK,GAAG,MAAc,UAErE"}
1
+ {"version":3,"file":"parseEther.d.ts","sourceRoot":"","sources":["../../../utils/unit/parseEther.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,OAAO,EAAE,KAAK,mBAAmB,EAAc,MAAM,iBAAiB,CAAA;AAEtE,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG,SAAS,CAAA;AAEjE;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,KAAK,GAAG,MAAc,UAErE"}
@@ -1,5 +1,16 @@
1
1
  import type { ErrorType } from '../../errors/utils.js';
2
2
  import { type ParseUnitsErrorType } from './parseUnits.js';
3
3
  export type ParseGweiErrorType = ParseUnitsErrorType | ErrorType;
4
+ /**
5
+ * Converts a string representation of gwei to numerical wei.
6
+ *
7
+ * - Docs: https://viem.sh/docs/utilities/parseGwei.html
8
+ *
9
+ * @example
10
+ * import { parseGwei } from 'viem'
11
+ *
12
+ * parseGwei('420')
13
+ * // 420000000000n
14
+ */
4
15
  export declare function parseGwei(ether: string, unit?: 'wei'): bigint;
5
16
  //# sourceMappingURL=parseGwei.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"parseGwei.d.ts","sourceRoot":"","sources":["../../../utils/unit/parseGwei.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,OAAO,EAAE,KAAK,mBAAmB,EAAc,MAAM,iBAAiB,CAAA;AAEtE,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG,SAAS,CAAA;AAEhE,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,KAAa,UAE3D"}
1
+ {"version":3,"file":"parseGwei.d.ts","sourceRoot":"","sources":["../../../utils/unit/parseGwei.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,OAAO,EAAE,KAAK,mBAAmB,EAAc,MAAM,iBAAiB,CAAA;AAEtE,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG,SAAS,CAAA;AAEhE;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,KAAa,UAE3D"}
@@ -1,4 +1,15 @@
1
1
  import type { ErrorType } from '../../errors/utils.js';
2
2
  export type ParseUnitsErrorType = ErrorType;
3
+ /**
4
+ * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
5
+ *
6
+ * - Docs: https://viem.sh/docs/utilities/parseUnits.html
7
+ *
8
+ * @example
9
+ * import { parseUnits } from 'viem'
10
+ *
11
+ * parseUnits('420', 9)
12
+ * // 420000000000n
13
+ */
3
14
  export declare function parseUnits(value: string, decimals: number): bigint;
4
15
  //# sourceMappingURL=parseUnits.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"parseUnits.d.ts","sourceRoot":"","sources":["../../../utils/unit/parseUnits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,MAAM,mBAAmB,GAAG,SAAS,CAAA;AAE3C,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAqCzD"}
1
+ {"version":3,"file":"parseUnits.d.ts","sourceRoot":"","sources":["../../../utils/unit/parseUnits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,MAAM,mBAAmB,GAAG,SAAS,CAAA;AAE3C;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAqCzD"}
package/errors/version.ts CHANGED
@@ -1 +1 @@
1
- export const version = '0.0.0-main.20231117T224608'
1
+ export const version = '0.0.0-main.20231119T230454'
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "viem",
3
3
  "description": "TypeScript Interface for Ethereum",
4
- "version": "0.0.0-main.20231117T224608",
4
+ "version": "0.0.0-main.20231119T230454",
5
5
  "type": "module",
6
6
  "main": "./_cjs/index.js",
7
7
  "module": "./_esm/index.js",
@@ -4,6 +4,17 @@ import { type FormatUnitsErrorType, formatUnits } from './formatUnits.js'
4
4
 
5
5
  export type FormatEtherErrorType = FormatUnitsErrorType
6
6
 
7
+ /**
8
+ * Converts numerical wei to a string representation of ether.
9
+ *
10
+ * - Docs: https://viem.sh/docs/utilities/formatEther.html
11
+ *
12
+ * @example
13
+ * import { formatEther } from 'viem'
14
+ *
15
+ * formatEther(1000000000000000000n)
16
+ * // '1'
17
+ */
7
18
  export function formatEther(wei: bigint, unit: 'wei' | 'gwei' = 'wei') {
8
19
  return formatUnits(wei, etherUnits[unit])
9
20
  }
@@ -4,6 +4,17 @@ import { type FormatUnitsErrorType, formatUnits } from './formatUnits.js'
4
4
 
5
5
  export type FormatGweiErrorType = FormatUnitsErrorType
6
6
 
7
+ /**
8
+ * Converts numerical wei to a string representation of gwei.
9
+ *
10
+ * - Docs: https://viem.sh/docs/utilities/formatGwei.html
11
+ *
12
+ * @example
13
+ * import { formatGwei } from 'viem'
14
+ *
15
+ * formatGwei(1000000000n)
16
+ * // '1'
17
+ */
7
18
  export function formatGwei(wei: bigint, unit: 'wei' = 'wei') {
8
19
  return formatUnits(wei, gweiUnits[unit])
9
20
  }
@@ -2,6 +2,17 @@ import type { ErrorType } from '../../errors/utils.js'
2
2
 
3
3
  export type FormatUnitsErrorType = ErrorType
4
4
 
5
+ /**
6
+ * Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number..
7
+ *
8
+ * - Docs: https://viem.sh/docs/utilities/formatUnits.html
9
+ *
10
+ * @example
11
+ * import { formatUnits } from 'viem'
12
+ *
13
+ * formatUnits(420000000000n, 9)
14
+ * // '420'
15
+ */
5
16
  export function formatUnits(value: bigint, decimals: number) {
6
17
  let display = value.toString()
7
18
 
@@ -5,6 +5,17 @@ import { type ParseUnitsErrorType, parseUnits } from './parseUnits.js'
5
5
 
6
6
  export type ParseEtherErrorType = ParseUnitsErrorType | ErrorType
7
7
 
8
+ /**
9
+ * Converts a string representation of ether to numerical wei.
10
+ *
11
+ * - Docs: https://viem.sh/docs/utilities/parseEther.html
12
+ *
13
+ * @example
14
+ * import { parseEther } from 'viem'
15
+ *
16
+ * parseEther('420')
17
+ * // 420000000000000000000n
18
+ */
8
19
  export function parseEther(ether: string, unit: 'wei' | 'gwei' = 'wei') {
9
20
  return parseUnits(ether, etherUnits[unit])
10
21
  }
@@ -5,6 +5,17 @@ import { type ParseUnitsErrorType, parseUnits } from './parseUnits.js'
5
5
 
6
6
  export type ParseGweiErrorType = ParseUnitsErrorType | ErrorType
7
7
 
8
+ /**
9
+ * Converts a string representation of gwei to numerical wei.
10
+ *
11
+ * - Docs: https://viem.sh/docs/utilities/parseGwei.html
12
+ *
13
+ * @example
14
+ * import { parseGwei } from 'viem'
15
+ *
16
+ * parseGwei('420')
17
+ * // 420000000000n
18
+ */
8
19
  export function parseGwei(ether: string, unit: 'wei' = 'wei') {
9
20
  return parseUnits(ether, gweiUnits[unit])
10
21
  }
@@ -2,6 +2,17 @@ import type { ErrorType } from '../../errors/utils.js'
2
2
 
3
3
  export type ParseUnitsErrorType = ErrorType
4
4
 
5
+ /**
6
+ * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
7
+ *
8
+ * - Docs: https://viem.sh/docs/utilities/parseUnits.html
9
+ *
10
+ * @example
11
+ * import { parseUnits } from 'viem'
12
+ *
13
+ * parseUnits('420', 9)
14
+ * // 420000000000n
15
+ */
5
16
  export function parseUnits(value: string, decimals: number) {
6
17
  let [integer, fraction = '0'] = value.split('.')
7
18