abitype - npm Package Compare versions

Comparing version 0.6.7 to 0.6.8

dist/index.d.ts

@@ -1,3 +0,3 @@
-import { A as AbiType, a as AbiParameterKind, S as SolidityAddress, b as SolidityBool, c as SolidityBytes, d as SolidityFunction, e as SolidityInt, f as SolidityString, g as SolidityTuple, h as SolidityArray, i as AbiParameter, j as SolidityFixedArrayRange, k as SolidityFixedArraySizeLookup, l as Abi, m as AbiStateMutability, T as TypedData, n as TypedDataType, o as TypedDataParameter, M as MBits } from './abi-6b6a2f3b.js';
-export { l as Abi, p as AbiError, q as AbiEvent, r as AbiFunction, s as AbiInternalType, i as AbiParameter, a as AbiParameterKind, m as AbiStateMutability, A as AbiType, t as Address, S as SolidityAddress, h as SolidityArray, v as SolidityArrayWithTuple, u as SolidityArrayWithoutTuple, b as SolidityBool, c as SolidityBytes, j as SolidityFixedArrayRange, k as SolidityFixedArraySizeLookup, d as SolidityFunction, e as SolidityInt, f as SolidityString, g as SolidityTuple, T as TypedData, w as TypedDataDomain, o as TypedDataParameter, n as TypedDataType } from './abi-6b6a2f3b.js';
+import { A as AbiType, a as AbiParameterKind, S as SolidityAddress, b as SolidityBool, c as SolidityBytes, d as SolidityFunction, e as SolidityInt, f as SolidityString, g as SolidityTuple, h as SolidityArray, i as AbiParameter, j as SolidityFixedArrayRange, k as SolidityFixedArraySizeLookup, l as Abi, m as AbiStateMutability, T as TypedData, n as TypedDataType, o as TypedDataParameter, M as MBits } from './abi-aefa4da7.js';
+export { l as Abi, p as AbiError, q as AbiEvent, r as AbiFunction, s as AbiInternalType, t as AbiItemType, i as AbiParameter, a as AbiParameterKind, m as AbiStateMutability, A as AbiType, u as Address, S as SolidityAddress, h as SolidityArray, w as SolidityArrayWithTuple, v as SolidityArrayWithoutTuple, b as SolidityBool, c as SolidityBytes, j as SolidityFixedArrayRange, k as SolidityFixedArraySizeLookup, d as SolidityFunction, e as SolidityInt, f as SolidityString, g as SolidityTuple, T as TypedData, x as TypedDataDomain, o as TypedDataParameter, n as TypedDataType } from './abi-aefa4da7.js';
 import { R as ResolvedConfig, E as Error$1, T as Tuple, M as Merge, a as Trim, P as Prettify, I as IsUnknown, F as Filter } from './config-8b48968c.js';
@@ -290,6 +290,5 @@ export { C as Config, D as DefaultConfig, R as ResolvedConfig } from './config-8b48968c.js';
 };
-declare const modifiers: readonly ["calldata", "indexed", "memory", "storage"];
-type Modifier = typeof modifiers[number];
-type FunctionModifiers = Exclude<Modifier, 'indexed'>;
-type EventModifiers = Extract<Modifier, 'indexed'>;
+type Modifier = 'calldata' | 'indexed' | 'memory' | 'storage';
+type FunctionModifier = Extract<Modifier, 'calldata' | 'memory' | 'storage'>;
+type EventModifier = Extract<Modifier, 'indexed'>;
 type InvalidFunctionParameters = `${string}${MangledReturns} (${string}` | `${string}) ${MangledReturns}${string}` | `${string})${string}${MangledReturns}${string}(${string}`;
@@ -308,3 +307,3 @@ type MangledReturns = `r${string}eturns` | `re${string}turns` | `ret${string}urns` | `retu${string}rns` | `retur${string}ns` | `return${string}s` | `r${string}e${string}turns` | `r${string}et${string}urns` | `r${string}etu${string}rns` | `r${string}etur${string}ns` | `r${string}eturn${string}s` | `re${string}t${string}urns` | `re${string}tu${string}rns` | `re${string}tur${string}ns` | `re${string}turn${string}s` | `ret${string}u${string}rns` | `ret${string}ur${string}ns` | `ret${string}urn${string}s` | `retu${string}r${string}ns` | `retu${string}rn${string}s` | `retur${string}n${string}s` | `r${string}e${string}t${string}urns` | `r${string}e${string}tu${string}rns` | `r${string}e${string}tur${string}ns` | `r${string}e${string}turn${string}s` | `re${string}t${string}u${string}rns` | `re${string}t${string}ur${string}ns` | `re${string}t${string}urn${string}s` | `ret${string}u${string}r${string}ns` | `ret${string}u${string}rn${string}s` | `retu${string}r${string}n${string}s` | `r${string}e${string}t${string}u${string}rns` | `r${string}e${string}t${string}ur${string}ns` | `r${string}e${string}t${string}urn${string}s` | `re${string}t${string}u${string}r${string}ns` | `re${string}t${string}u${string}rn${string}s` | `ret${string}u${string}r${string}n${string}s` | `r${string}e${string}t${string}u${string}r${string}ns` | `r${string}e${string}t${string}u${string}rn${string}s` | `re${string}t${string}u${string}r${string}n${string}s` | `r${string}e${string}t${string}u${string}r${string}n${string}s`;
     readonly inputs: ParseAbiParameters$1<SplitParameters<Parameters>, {
-        Modifier: EventModifiers;
+        Modifier: EventModifier;
         Structs: TStructs;
@@ -317,7 +316,7 @@ }>;
     readonly inputs: ParseAbiParameters$1<SplitParameters<_ParseFunctionParametersAndStateMutability<TSignature>['Inputs']>, {
-        Modifier: FunctionModifiers;
+        Modifier: FunctionModifier;
         Structs: TStructs;
     }>;
     readonly outputs: Tail extends `${string}returns (${infer Returns})` ? ParseAbiParameters$1<SplitParameters<Returns>, {
-        Modifier: FunctionModifiers;
+        Modifier: FunctionModifier;
         Structs: TStructs;
@@ -324,0 +323,0 @@ }> : readonly [];

dist/index.js

@@ -6,6 +6,5 @@ "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
 
+var _chunkO6V2CMEFjs = require('./chunk-O6V2CMEF.js');
 
-var _chunk4C6XNPNKjs = require('./chunk-4C6XNPNK.js');
 
-
 var _chunkXXPGZHWZjs = require('./chunk-XXPGZHWZ.js');
@@ -15,3 +14,3 @@
 var name = "abitype";
-var version = "0.6.7";
+var version = "0.6.8";
 
@@ -57,3 +56,3 @@ // src/errors.ts
 function execErrorSignature(signature) {
-  return _chunk4C6XNPNKjs.execTyped.call(void 0, 
+  return _chunkO6V2CMEFjs.execTyped.call(void 0, 
     errorSignatureRegex,
@@ -68,3 +67,3 @@ signature
 function execEventSignature(signature) {
-  return _chunk4C6XNPNKjs.execTyped.call(void 0, 
+  return _chunkO6V2CMEFjs.execTyped.call(void 0, 
     eventSignatureRegex,
@@ -79,3 +78,3 @@ signature
 function execFunctionSignature(signature) {
-  return _chunk4C6XNPNKjs.execTyped.call(void 0, functionSignatureRegex, signature);
+  return _chunkO6V2CMEFjs.execTyped.call(void 0, functionSignatureRegex, signature);
 }
@@ -87,3 +86,3 @@ var structSignatureRegex = /^struct (?<name>[a-zA-Z0-9_]+) \{(?<properties>.*?)\}$/;
 function execStructSignature(signature) {
-  return _chunk4C6XNPNKjs.execTyped.call(void 0, 
+  return _chunkO6V2CMEFjs.execTyped.call(void 0, 
     structSignatureRegex,
@@ -98,3 +97,3 @@ signature
 function execConstructorSignature(signature) {
-  return _chunk4C6XNPNKjs.execTyped.call(void 0, constructorSignatureRegex, signature);
+  return _chunkO6V2CMEFjs.execTyped.call(void 0, constructorSignatureRegex, signature);
 }
@@ -109,2 +108,14 @@ var fallbackSignatureRegex = /^fallback\(\)$/;
 }
+var modifiers = /* @__PURE__ */ new Set([
+  "memory",
+  "indexed",
+  "storage",
+  "calldata"
+]);
+var eventModifiers = /* @__PURE__ */ new Set(["indexed"]);
+var functionModifiers = /* @__PURE__ */ new Set([
+  "calldata",
+  "memory",
+  "storage"
+]);
 
@@ -186,4 +197,5 @@ // src/human-readable/runtime/cache.ts
         parseAbiParameter(inputParams[i], {
+          modifiers: functionModifiers,
           structs,
-          modifiers: ["calldata", "memory", "storage"]
+          type: "function"
         })
@@ -197,3 +209,9 @@ );
       for (let i = 0; i < outputLength; i++) {
-        outputs.push(parseAbiParameter(outputParams[i], { structs }));
+        outputs.push(
+          parseAbiParameter(outputParams[i], {
+            modifiers: functionModifiers,
+            structs,
+            type: "function"
+          })
+        );
       }
@@ -221,4 +239,4 @@ }
         parseAbiParameter(params[i], {
+          modifiers: eventModifiers,
           structs,
-          modifiers: ["indexed"],
           type: "event"
@@ -240,3 +258,5 @@ })
     for (let i = 0; i < length; i++) {
-      abiParameters.push(parseAbiParameter(params[i], { structs }));
+      abiParameters.push(
+        parseAbiParameter(params[i], { structs, type: "error" })
+      );
     }
@@ -255,3 +275,5 @@ return { name: match.name, type: "error", inputs: abiParameters };
     for (let i = 0; i < length; i++) {
-      abiParameters.push(parseAbiParameter(params[i], { structs }));
+      abiParameters.push(
+        parseAbiParameter(params[i], { structs, type: "constructor" })
+      );
     }
@@ -281,4 +303,4 @@ return {
     return parameterCache.get(parameterCacheKey);
-  const isTuple = _chunk4C6XNPNKjs.isTupleRegex.test(param);
-  const match = _chunk4C6XNPNKjs.execTyped.call(void 0, 
+  const isTuple = _chunkO6V2CMEFjs.isTupleRegex.test(param);
+  const match = _chunkO6V2CMEFjs.execTyped.call(void 0, 
     isTuple ? abiParameterWithTupleRegex : abiParameterWithoutTupleRegex,
@@ -291,11 +313,12 @@ param
     });
-  const hasIndexedModifier = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _4 => _4.modifiers, 'optionalAccess', _5 => _5.includes, 'call', _6 => _6("indexed")]), () => ( false));
-  const isIndexed = match.modifier === "indexed";
-  if (isIndexed && !hasIndexedModifier)
-    throw new BaseError("`indexed` keyword not allowed in param.", {
-      details: param
+  if (match.name && isProtectedSolidityKeyword(match.name))
+    throw new BaseError("Invalid ABI parameter.", {
+      details: param,
+      metaMessages: [
+        `"${match.name}" is a protected Solidity keyword. More info: https://docs.soliditylang.org/en/latest/cheatsheet.html`
+      ]
     });
   const name2 = match.name ? { name: match.name } : {};
-  const indexed = hasIndexedModifier && isIndexed ? { indexed: true } : {};
-  const structs = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _7 => _7.structs]), () => ( {}));
+  const indexed = match.modifier === "indexed" ? { indexed: true } : {};
+  const structs = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _4 => _4.structs]), () => ( {}));
   let type;
@@ -309,5 +332,3 @@ let components = {};
     for (let i = 0; i < length; i++) {
-      components_.push(
-        parseAbiParameter(params[i], { structs: _optionalChain([options, 'optionalAccess', _8 => _8.structs]) })
-      );
+      components_.push(parseAbiParameter(params[i], { structs }));
     }
@@ -320,3 +341,3 @@ components = { components: components_ };
     type = match.type;
-    if (!(_optionalChain([options, 'optionalAccess', _9 => _9.type]) === "struct") && !isSolidityType(type))
+    if (!(_optionalChain([options, 'optionalAccess', _5 => _5.type]) === "struct") && !isSolidityType(type))
       throw new BaseError("Unknown type.", {
@@ -326,2 +347,19 @@ metaMessages: [`Type "${type}" is not a valid ABI type.`]
   }
+  if (match.modifier) {
+    if (!_optionalChain([options, 'optionalAccess', _6 => _6.modifiers, 'optionalAccess', _7 => _7.has, 'optionalCall', _8 => _8(match.modifier)]))
+      throw new BaseError("Invalid ABI parameter.", {
+        details: param,
+        metaMessages: [
+          `Modifier "${match.modifier}" not allowed${_optionalChain([options, 'optionalAccess', _9 => _9.type]) ? ` in "${options.type}" type` : ""}.`
+        ]
+      });
+    if (functionModifiers.has(match.modifier) && !isValidDataLocation(type, !!match.array))
+      throw new BaseError("Invalid ABI parameter.", {
+        details: param,
+        metaMessages: [
+          `Modifier "${match.modifier}" not allowed${_optionalChain([options, 'optionalAccess', _10 => _10.type]) ? ` in "${options.type}" type` : ""}.`,
+          `Data location can only be specified for array, struct, or mapping types, but "${match.modifier}" was given.`
+        ]
+      });
+  }
   const abiParameter = {
@@ -340,2 +378,9 @@ type: `${type}${_nullishCoalesce(match.array, () => ( ""))}`,
       return result;
+    if (depth !== 0)
+      throw new BaseError("Unbalanced parentheses.", {
+        metaMessages: [
+          `"${current.trim()}" has too many ${depth > 0 ? "opening" : "closing"} parentheses.`
+        ],
+        details: `Depth "${depth}"`
+      });
     return [...result, current.trim()];
@@ -361,4 +406,11 @@ }
 function isSolidityType(type) {
-  return type === "address" || type === "bool" || type === "function" || type === "string" || type === "tuple" || _chunk4C6XNPNKjs.bytesRegex.test(type) || _chunk4C6XNPNKjs.integerRegex.test(type);
+  return type === "address" || type === "bool" || type === "function" || type === "string" || _chunkO6V2CMEFjs.bytesRegex.test(type) || _chunkO6V2CMEFjs.integerRegex.test(type);
 }
+var protectedKeywordsRegex = /^(?:after|alias|anonymous|apply|auto|byte|calldata|case|catch|constant|copyof|default|defined|error|event|external|false|final|function|immutable|implements|in|indexed|inline|internal|let|mapping|match|memory|mutable|null|of|override|partial|private|promise|public|pure|reference|relocatable|return|returns|sizeof|static|storage|struct|super|supports|switch|this|true|try|typedef|typeof|var|view|virtual)$/;
+function isProtectedSolidityKeyword(name2) {
+  return name2 === "address" || name2 === "bool" || name2 === "function" || name2 === "string" || name2 === "tuple" || _chunkO6V2CMEFjs.bytesRegex.test(name2) || _chunkO6V2CMEFjs.integerRegex.test(name2) || protectedKeywordsRegex.test(name2);
+}
+function isValidDataLocation(type, isArray) {
+  return isArray || type === "bytes" || type === "string" || type === "tuple";
+}
 
@@ -407,2 +459,3 @@ // src/human-readable/runtime/structs.ts
 }
+var typeWithoutTupleRegex = /^(?<type>[a-zA-Z0-9_]+?)(?<array>(?:\[\d*?\])+?)?$/;
 function resolveStructs(abiParameters, structs, ancestors = /* @__PURE__ */ new Set()) {
@@ -413,11 +466,11 @@ const components = [];
     const abiParameter = abiParameters[i];
-    const isTuple = _chunk4C6XNPNKjs.isTupleRegex.test(abiParameter.type);
+    const isTuple = _chunkO6V2CMEFjs.isTupleRegex.test(abiParameter.type);
     if (isTuple)
       components.push(abiParameter);
     else {
-      const match = _chunk4C6XNPNKjs.execTyped.call(void 0, 
-        _chunk4C6XNPNKjs.typeWithoutTupleRegex,
+      const match = _chunkO6V2CMEFjs.execTyped.call(void 0, 
+        typeWithoutTupleRegex,
         abiParameter.type
       );
-      if (!_optionalChain([match, 'optionalAccess', _10 => _10.type]))
+      if (!_optionalChain([match, 'optionalAccess', _11 => _11.type]))
         throw new BaseError("Invalid ABI parameter.", {
@@ -495,5 +548,2 @@ details: JSON.stringify(abiParameter, null, 2),
 
-// src/human-readable/types/signatures.ts
-var modifiers = ["calldata", "indexed", "memory", "storage"];
-
 // src/human-readable/parseAbiParameter.ts
@@ -500,0 +550,0 @@ function parseAbiParameter2(param) {

dist/zod/index.d.ts

 import { z } from 'zod';
-import { i as AbiParameter$1 } from '../abi-6b6a2f3b.js';
+import { i as AbiParameter$1 } from '../abi-aefa4da7.js';
 import '../config-8b48968c.js';
@@ -4,0 +4,0 @@

dist/zod/index.js

 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunk4C6XNPNKjs = require('../chunk-4C6XNPNK.js');
+var _chunkO6V2CMEFjs = require('../chunk-O6V2CMEF.js');
 require('../chunk-XXPGZHWZ.js');
@@ -11,7 +11,7 @@
 var SolidityBool = _zod.z.literal("bool");
-var SolidityBytes = _zod.z.string().regex(_chunk4C6XNPNKjs.bytesRegex);
+var SolidityBytes = _zod.z.string().regex(_chunkO6V2CMEFjs.bytesRegex);
 var SolidityFunction = _zod.z.literal("function");
 var SolidityString = _zod.z.literal("string");
 var SolidityTuple = _zod.z.literal("tuple");
-var SolidityInt = _zod.z.string().regex(_chunk4C6XNPNKjs.integerRegex);
+var SolidityInt = _zod.z.string().regex(_chunkO6V2CMEFjs.integerRegex);
 var SolidityArrayWithoutTuple = _zod.z.string().regex(
@@ -18,0 +18,0 @@ /^(address|bool|function|string|bytes([1-9]|1[0-9]|2[0-9]|3[0-2])?|u?int(8|16|24|32|40|48|56|64|72|80|88|96|104|112|120|128|136|144|152|160|168|176|184|192|200|208|216|224|232|240|248|256)?)(\[[0-9]{0,}\])+$/

package.json

@@ -5,3 +5,3 @@ {
   "license": "MIT",
-  "version": "0.6.7",
+  "version": "0.6.8",
   "repository": {
@@ -8,0 +8,0 @@ "type": "git",

No alert changes

Improved metrics

Total package byte prevSize

459795

1%

Lines of code

14154

0.78%

No dependency changes