viem 1.19.3 → 1.19.5

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

@@ -1,4 +1,15 @@
 import { type FormatUnitsErrorType } 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 declare function formatGwei(wei: bigint, unit?: 'wei'): string;
 //# sourceMappingURL=formatGwei.d.ts.map

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

@@ -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"}
+{"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"}

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

@@ -1,4 +1,15 @@
 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 declare function formatUnits(value: bigint, decimals: number): string;
 //# sourceMappingURL=formatUnits.d.ts.map

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

@@ -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"}
+{"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"}

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

@@ -1,5 +1,16 @@
 import type { ErrorType } from '../../errors/utils.js';
 import { type ParseUnitsErrorType } 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 declare function parseEther(ether: string, unit?: 'wei' | 'gwei'): bigint;
 //# sourceMappingURL=parseEther.d.ts.map

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

@@ -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"}
+{"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"}

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

@@ -1,5 +1,16 @@
 import type { ErrorType } from '../../errors/utils.js';
 import { type ParseUnitsErrorType } 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 declare function parseGwei(ether: string, unit?: 'wei'): bigint;
 //# sourceMappingURL=parseGwei.d.ts.map

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

@@ -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"}
+{"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"}

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/celo/serializers.ts

@@ -231,7 +231,7 @@ export function assertTransactionCIP64(
   )
     throw new TipAboveFeeCapError({ maxFeePerGas, maxPriorityFeePerGas })
 
-  if (isPresent(feeCurrency) && !feeCurrency?.startsWith('0x')) {
+  if (isPresent(feeCurrency) && !isAddress(feeCurrency)) {
     throw new BaseError(
       '`feeCurrency` MUST be a token address for CIP-64 transactions.',
     )

package/chains/celo/utils.ts

@@ -43,7 +43,9 @@ export function isCIP42(
   transaction: CeloTransactionSerializable | CeloTransactionRequest,
 ): transaction is TransactionSerializableCIP42 {
   // Enable end-user to force the tx to be considered as a cip42
-  if (transaction.type) return transaction.type === 'cip42'
+  if (transaction.type === 'cip42') {
+    return true
+  }
 
   return (
     isEIP1559(transaction) &&
@@ -56,8 +58,19 @@ export function isCIP42(
 export function isCIP64(
   transaction: CeloTransactionSerializable | CeloTransactionRequest,
 ): transaction is TransactionSerializableCIP64 {
-  // Enable end-user to force the tx to be considered as a cip64
-  if (transaction.type) return transaction.type === 'cip64'
+  /*
+   * Enable end user to force the tx to be considered as a CIP-64.
+   *
+   * The preliminary type will be determined as "eip1559" by src/utils/transaction/getTransactionType.ts
+   * and so we need the logic below to check for the specific value instead of checking if just any
+   * transaction type is provided. If that's anything else than "cip64" then we need to reevaluate the
+   * type based on the transaction fields.
+   *
+   * Modify with caution and according to https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0064.md
+   */
+  if (transaction.type === 'cip64') {
+    return true
+  }
 
   return (
     isEIP1559(transaction) &&

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/chains/definitions/bscTestnet.ts

@@ -10,8 +10,8 @@ export const bscTestnet = /*#__PURE__*/ defineChain({
     symbol: 'tBNB',
   },
   rpcUrls: {
-    default: { http: ['https://data-seed-prebsc-1-s1.binance.org:8545'] },
-    public: { http: ['https://data-seed-prebsc-1-s1.binance.org:8545'] },
+    default: { http: ['https://data-seed-prebsc-1-s1.bnbchain.org:8545'] },
+    public: { http: ['https://data-seed-prebsc-1-s1.bnbchain.org:8545'] },
   },
   blockExplorers: {
     etherscan: { name: 'BscScan', url: 'https://testnet.bscscan.com' },

package/chains/definitions/shibarium.ts

@@ -0,0 +1,32 @@
+import { defineChain } from '../../utils/chain/defineChain.js'
+
+export const shibarium = /*#__PURE__*/ defineChain({
+  id: 109,
+  name: 'Shibarium',
+  network: 'shibarium',
+  nativeCurrency: { name: 'Bone', symbol: 'BONE', decimals: 18 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.shibrpc.com'],
+    },
+    public: {
+      http: ['https://rpc.shibrpc.com'],
+    },
+  },
+  blockExplorers: {
+    etherscan: {
+      name: 'Blockscout',
+      url: 'https://shibariumscan.io',
+    },
+    default: {
+      name: 'Blockscout',
+      url: 'https://shibariumscan.io',
+    },
+  },
+  contracts: {
+    multicall3: {
+      address: '0x864Bf681ADD6052395188A89101A1B37d3B4C961',
+      blockCreated: 265900,
+    },
+  },
+})

package/chains/index.ts

@@ -137,6 +137,7 @@ export { songbird } from './definitions/songbird.js'
 export { songbirdTestnet } from './definitions/songbirdTestnet.js'
 export { spicy } from './definitions/spicy.js'
 export { shardeumSphinx } from './definitions/shardeumSphinx.js'
+export { shibarium } from './definitions/shibarium.js'
 export { syscoin } from './definitions/syscoin.js'
 export { syscoinTestnet } from './definitions/syscoinTestnet.js'
 export { taraxa } from './definitions/taraxa.js'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "1.19.3",
+  "version": "1.19.5",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

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