viem 2.0.0-beta.5 → 2.0.0-beta.8

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('.')
 

package/_cjs/chains/opStack/decorators/public.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"public.js","sourceRoot":"","sources":["../../../../chains/opStack/decorators/public.ts"],"names":[],"mappings":";;;AASA,kFAI4C;AAC5C,kFAI4C;AAC5C,wFAI+C;AAC/C,wFAI+C;AAC/C,kEAIoC;AACpC,kEAIoC;AACpC,wEAIuC;AACvC,wEAIuC;AA4QvC,SAAgB,eAAe;IAC7B,OAAO,CAIL,MAA2C,EACR,EAAE;QACrC,OAAO;YACL,qBAAqB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,gDAAqB,EAAC,MAAM,EAAE,IAAI,CAAC;YACpE,qBAAqB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,gDAAqB,EAAC,MAAM,EAAE,IAAI,CAAC;YACpE,wBAAwB,EAAE,CAAC,IAAI,EAAE,EAAE,CACjC,IAAA,sDAAwB,EAAC,MAAM,EAAE,IAAI,CAAC;YACxC,wBAAwB,EAAE,CAAC,IAAI,EAAE,EAAE,CACjC,IAAA,sDAAwB,EAAC,MAAM,EAAE,IAAI,CAAC;YACxC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,gCAAa,EAAC,MAAM,EAAE,IAAI,CAAC;YACpD,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,gCAAa,EAAC,MAAM,EAAE,IAAI,CAAC;YACpD,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sCAAgB,EAAC,MAAM,EAAE,IAAI,CAAC;YAC1D,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sCAAgB,EAAC,MAAM,EAAE,IAAI,CAAC;SAC3D,CAAA;IACH,CAAC,CAAA;AACH,CAAC;AApBD,0CAoBC"}

package/_cjs/chains/opStack/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../chains/opStack/types.ts"],"names":[],"mappings":""}

package/_esm/chains/opStack/decorators/public.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"public.js","sourceRoot":"","sources":["../../../../chains/opStack/decorators/public.ts"],"names":[],"mappings":"AASA,OAAO,EAGL,qBAAqB,GACtB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAGL,qBAAqB,GACtB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAGL,wBAAwB,GACzB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAGL,wBAAwB,GACzB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAGL,aAAa,GACd,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAGL,aAAa,GACd,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAGL,gBAAgB,GACjB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAGL,gBAAgB,GACjB,MAAM,gCAAgC,CAAA;AA4QvC,MAAM,UAAU,eAAe;IAC7B,OAAO,CAIL,MAA2C,EACR,EAAE;QACrC,OAAO;YACL,qBAAqB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC;YACpE,qBAAqB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC;YACpE,wBAAwB,EAAE,CAAC,IAAI,EAAE,EAAE,CACjC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC;YACxC,wBAAwB,EAAE,CAAC,IAAI,EAAE,EAAE,CACjC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC;YACxC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC;YACpD,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC;YACpD,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC;YAC1D,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC;SAC3D,CAAA;IACH,CAAC,CAAA;AACH,CAAC"}

package/_esm/chains/opStack/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/_esm/chains/opStack/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../chains/opStack/types.ts"],"names":[],"mappings":""}

package/_types/chains/opStack/decorators/public.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../../../chains/opStack/decorators/public.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAC/E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EAErC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EAErC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,KAAK,kCAAkC,EACvC,KAAK,kCAAkC,EAExC,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EACL,KAAK,kCAAkC,EACvC,KAAK,kCAAkC,EAExC,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAE7B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAE7B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAEhC,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAEhC,MAAM,gCAAgC,CAAA;AAEvC,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACvD;IACF;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,qBAAqB,EAAE,CACrB,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC1C,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,CAAC,EACxE,IAAI,SAAS,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,CAAC,EACrE,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,+BAA+B,CACzC,GAAG,EACH,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,+BAA+B,CAAC,CAAA;IAC7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,qBAAqB,EAAE,CACrB,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC1C,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,CAAC,EACxE,IAAI,SAAS,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,CAAC,EACrE,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,+BAA+B,CACzC,GAAG,EACH,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,+BAA+B,CAAC,CAAA;IAC7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,wBAAwB,EAAE,CACxB,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC1C,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,CAAC,EACxE,IAAI,SAAS,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,CAAC,EACrE,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,kCAAkC,CAC5C,GAAG,EACH,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,kCAAkC,CAAC,CAAA;IAChD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,wBAAwB,EAAE,CACxB,KAAK,CAAC,GAAG,SAAS,GAAG,GAAG,SAAS,OAAO,EAAE,EAC1C,YAAY,SAAS,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,SAAS,CAAC,EACxE,IAAI,SAAS,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,CAAC,EACrE,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EAEnD,UAAU,EAAE,kCAAkC,CAC5C,GAAG,EACH,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,aAAa,CACd,KACE,OAAO,CAAC,kCAAkC,CAAC,CAAA;IAChD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,aAAa,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACjE,UAAU,EAAE,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KAC/D,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,aAAa,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACjE,UAAU,EAAE,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KAC/D,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,gBAAgB,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACpE,UAAU,EAAE,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KAClE,OAAO,CAAC,0BAA0B,CAAC,CAAA;IACxC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,gBAAgB,EAAE,CAAC,aAAa,SAAS,KAAK,GAAG,SAAS,GAAG,SAAS,EACpE,UAAU,EAAE,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,KAClE,OAAO,CAAC,0BAA0B,CAAC,CAAA;CACzC,CAAA;AAED,wBAAgB,eAAe,yMAoB9B"}

package/_types/chains/opStack/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../chains/opStack/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EACV,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,cAAc,IAAI,eAAe,EACjC,qBAAqB,EACtB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EACV,WAAW,IAAI,YAAY,EAC3B,eAAe,EACf,kBAAkB,EACnB,MAAM,4BAA4B,CAAA;AAEnC,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,IAAI,CAAA;CAChB,CAAA;AACD,MAAM,MAAM,YAAY,CACtB,oBAAoB,SAAS,OAAO,GAAG,OAAO,EAC9C,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,KAAK,CACP,MAAM,EACN,oBAAoB,EACpB,SAAS,EACT,kBAAkB,CAAC,SAAS,SAAS,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC,CAC/D,GACC,qBAAqB,CAAA;AAEvB,MAAM,MAAM,wBAAwB,GAAG;IACrC,SAAS,EAAE,IAAI,CAAA;CAChB,CAAA;AACD,MAAM,MAAM,eAAe,CACzB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,oBAAoB,SAAS,OAAO,GAAG,OAAO,IAC5C,QAAQ,CACV,SAAS,EACT,oBAAoB,EACpB,qBAAqB,CAAC,SAAS,SAAS,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC,CAClE,GACC,wBAAwB,CAAA;AAE1B,KAAK,cAAc,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IACpD,eAAe,CAAC,QAAQ,CAAC,GAAG;IAC1B,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,UAAU,CAAC,EAAE,SAAS,CAAA;CACvB,CAAA;AAEH,MAAM,MAAM,4BAA4B,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IACzE,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,SAAS,CAAC,GACzD,gBAAgB,CAAC,QAAQ,CAAC,GAAG;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,UAAU,EAAE,GAAG,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AACL,MAAM,MAAM,qBAAqB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IAChE,cAAc,CAAC,QAAQ,CAAC,GACxB,4BAA4B,CAAC,QAAQ,CAAC,CAAA;AAE1C,MAAM,MAAM,qCAAqC,GAAG;IAClD,UAAU,EAAE,GAAG,GAAG,IAAI,CAAA;IACtB,SAAS,EAAE,GAAG,GAAG,IAAI,CAAA;IACrB,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IACjB,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;CAChC,CAAA;AACD,MAAM,MAAM,4BAA4B,GAAG,qBAAqB,GAC9D,qCAAqC,CAAA;AAEvC,KAAK,WAAW,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IAAI,YAAY,CACjE,MAAM,EACN,MAAM,EACN,QAAQ,CACT,GAAG;IACF,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,UAAU,CAAC,EAAE,SAAS,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,yBAAyB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IACtE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,GACvC,gBAAgB,GAAG;IACjB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,GAAG,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAEL,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IAC7D,WAAW,CAAC,QAAQ,CAAC,GACrB,yBAAyB,CAAC,QAAQ,CAAC,CAAA;AAEvC,MAAM,MAAM,kCAAkC,GAAG;IAC/C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA;AACD,MAAM,MAAM,yBAAyB,GAAG,kBAAkB,GACxD,kCAAkC,CAAA"}