viem 0.0.0-main.20231115T222931 → 0.0.0-main.20231119T230454

package/_types/utils/unit/parseUnits.d.ts

@@ -1,4 +1,15 @@
 import type { ErrorType } from '../../errors/utils.js';
 export type ParseUnitsErrorType = ErrorType;
+/**
+ * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
+ *
+ * - Docs: https://viem.sh/docs/utilities/parseUnits.html
+ *
+ * @example
+ * import { parseUnits } from 'viem'
+ *
+ * parseUnits('420', 9)
+ * // 420000000000n
+ */
 export declare function parseUnits(value: string, decimals: number): bigint;
 //# sourceMappingURL=parseUnits.d.ts.map

package/_types/utils/unit/parseUnits.d.ts.map

@@ -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"}
+{"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/chains/definitions/aurora.ts

@@ -18,4 +18,10 @@ export const aurora = /*#__PURE__*/ defineChain({
     etherscan: { name: 'Aurorascan', url: 'https://aurorascan.dev' },
     default: { name: 'Aurorascan', url: 'https://aurorascan.dev' },
   },
+  contracts: {
+    multicall3: {
+      address: '0xca11bde05977b3631167028862be2a173976ca11',
+      blockCreated: 62907816,
+    },
+  },
 })

package/errors/version.ts

@@ -1 +1 @@
-export const version = '0.0.0-main.20231115T222931'
+export const version = '0.0.0-main.20231119T230454'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "0.0.0-main.20231115T222931",
+  "version": "0.0.0-main.20231119T230454",
   "type": "module",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",

package/utils/unit/formatEther.ts

@@ -4,6 +4,17 @@ import { type FormatUnitsErrorType, formatUnits } from './formatUnits.js'
 
 export type FormatEtherErrorType = FormatUnitsErrorType
 
+/**
+ * Converts numerical wei to a string representation of ether.
+ * 
+ * - Docs: https://viem.sh/docs/utilities/formatEther.html
+ *
+ * @example
+ * import { formatEther } from 'viem'
+ *
+ * formatEther(1000000000000000000n) 
+ * // '1'
+ */
 export function formatEther(wei: bigint, unit: 'wei' | 'gwei' = 'wei') {
   return formatUnits(wei, etherUnits[unit])
 }

package/utils/unit/formatGwei.ts

@@ -4,6 +4,17 @@ import { type FormatUnitsErrorType, formatUnits } from './formatUnits.js'
 
 export type FormatGweiErrorType = FormatUnitsErrorType
 
+/**
+ * Converts numerical wei to a string representation of gwei.
+ * 
+ * - Docs: https://viem.sh/docs/utilities/formatGwei.html
+ *
+ * @example
+ * import { formatGwei } from 'viem'
+ *
+ * formatGwei(1000000000n) 
+ * // '1'
+ */
 export function formatGwei(wei: bigint, unit: 'wei' = 'wei') {
   return formatUnits(wei, gweiUnits[unit])
 }

package/utils/unit/formatUnits.ts

@@ -2,6 +2,17 @@ import type { ErrorType } from '../../errors/utils.js'
 
 export type FormatUnitsErrorType = ErrorType
 
+/**
+ *  Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number..
+ * 
+ * - Docs: https://viem.sh/docs/utilities/formatUnits.html
+ *
+ * @example
+ * import { formatUnits } from 'viem'
+ *
+ * formatUnits(420000000000n, 9) 
+ * // '420'
+ */
 export function formatUnits(value: bigint, decimals: number) {
   let display = value.toString()
 

package/utils/unit/parseEther.ts

@@ -5,6 +5,17 @@ import { type ParseUnitsErrorType, parseUnits } from './parseUnits.js'
 
 export type ParseEtherErrorType = ParseUnitsErrorType | ErrorType
 
+/**
+ * Converts a string representation of ether to numerical wei.
+ * 
+ * - Docs: https://viem.sh/docs/utilities/parseEther.html
+ *
+ * @example
+ * import { parseEther } from 'viem'
+ *
+ * parseEther('420')
+ * // 420000000000000000000n
+ */
 export function parseEther(ether: string, unit: 'wei' | 'gwei' = 'wei') {
   return parseUnits(ether, etherUnits[unit])
 }

package/utils/unit/parseGwei.ts

@@ -5,6 +5,17 @@ import { type ParseUnitsErrorType, parseUnits } from './parseUnits.js'
 
 export type ParseGweiErrorType = ParseUnitsErrorType | ErrorType
 
+/**
+ * Converts a string representation of gwei to numerical wei.
+ * 
+ * - Docs: https://viem.sh/docs/utilities/parseGwei.html
+ *
+ * @example
+ * import { parseGwei } from 'viem'
+ *
+ * parseGwei('420') 
+ * // 420000000000n
+ */
 export function parseGwei(ether: string, unit: 'wei' = 'wei') {
   return parseUnits(ether, gweiUnits[unit])
 }

package/utils/unit/parseUnits.ts

@@ -2,6 +2,17 @@ import type { ErrorType } from '../../errors/utils.js'
 
 export type ParseUnitsErrorType = ErrorType
 
+/**
+ * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
+ * 
+ * - Docs: https://viem.sh/docs/utilities/parseUnits.html
+ *
+ * @example
+ * import { parseUnits } from 'viem'
+ *
+ * parseUnits('420', 9)
+ * // 420000000000n
+ */
 export function parseUnits(value: string, decimals: number) {
   let [integer, fraction = '0'] = value.split('.')