Skip to content

CHANGELOG.md

Latest commit

 

History

History
358 lines (216 loc) · 11.8 KB

CHANGELOG.md

File metadata and controls

358 lines (216 loc) · 11.8 KB

Changelog

0.4.61 (2025-09-05)

  • Added EnumValue.documentation, available since Solidity 0.8.30.

0.4.60 (2025-03-15)

  • Added ContractDefinition.storageLayout, available since Solidity 0.8.29, corresponding to layout at.

0.4.59 (2024-09-06)

  • Added 'transient' as a possible value for VariableDeclaration.storageLocation, available since Solidity 0.8.27.
  • Added 'prague' as a possible value for InlineAssembly.evmVersion.

0.4.58 (2024-08-29)

  • Fixed YulFunctionDefinition.parameters and returnVariables: made optional, used when empty.
  • Fixed InlineAssembly.externalReferences[].suffix: added 'length' option.

0.4.57 (2024-07-16)

  • Fixed ModifierDefinition.body: made nullable to support Solidity 0.6.7 virtual modifiers with empty body.

0.4.56 (2024-03-14)

  • Added 'cancun' as a possible value for InlineAssembly.evmVersion.

0.4.55 (2023-11-25)

  • Fixed TupleExpression.components: array members are nullable.

0.4.54 (2023-11-23)

  • Fixed Literal.subdenomination, previously typed as null, now typed with values 'seconds', 'minutes', etc.
  • Added EnumDefinition.documentation.

0.4.53 (2023-11-10)

  • Added ForStatement.isSimpleCounterLoop, available since Solidity 0.8.22.

0.4.52 (2023-08-24)

  • Fixed behavior of findAll('*', ...) around UsingForDirective.functionList and ImportDirective.symbolAliases, which missed some identifiers and returned non-nodes.

0.4.51 (2023-08-19)

  • Fixed bug in AST dereferencer reading a property of null.

0.4.50 (2023-08-19)

  • Fixed findAll exhaustivity around objects in the AST that are not AST nodes. Affected queries for IdentifierPath nodes under UsingForDirective.functionList and for Identifier nodes under ImportDirective.symbolAliases.foreign.
  • Significantly optimized findAll and astDereferencer.
  • Added ability to enumerate all nodes with findAll('*', node) or dereference an unknown node type with deref('*', id).
  • Added SourceUnit.experimentalSolidity, available since Solidity 0.8.21.
  • Added ContractDefinition.usedEvents and ContractDefinition.internalFunctionIDs, available since Solidity 0.8.20.
  • Added StructDefinition.documentation, available since Solidity 0.8.20.
  • Added 'shanghai' as a possible value for InlineAssembly.evmVersion.
  • Added nativeSrc to Yul AST nodes.

0.4.49 (2023-05-04)

  • Added a custom Error subclass for ASTDereferencer errors.

0.4.48 (2023-05-04)

  • Fixed return type of ASTDereferencer.withSourceUnit.

0.4.47 (2023-05-04)

  • Added ASTDereferencer.withSourceUnit to be able to obtain the source unit that contains a node with a given id.

0.4.46 (2023-02-22)

  • Added new variant of UsingForDirective for user-defined operators.
  • Added BinaryOperation.function and UnaryOperation.function for user-defined operators.

0.4.45 (2023-02-01)

  • Added 'paris' as a possible value for InlineAssembly.evmVersion.
  • Added new Mapping fields keyName, keyNameLocation, valueName, valueNameLocation from Solidity 0.8.18.

0.4.44 (2023-01-30)

  • Added '~' as a possible value for UnaryOperation.operator.

0.4.43 (2023-01-20)

  • Added FunctionCall.nameLocations and IdentifierPath.nameLocations from Solidity 0.8.16.
  • Added MemberAccess.memberLocation from Solidity 0.8.16.

0.4.42 (2023-01-20)

  • Reverted optimizations to findAll from 0.4.40.

0.4.41 (2023-01-20)

  • Optimized AST dereferencer.

0.4.40 (2022-12-29)

  • Further optimized findAll for multiple wanted node types.

0.4.39 (2022-12-16)

  • Optimized findAll for multiple wanted node types.

0.4.38 (2022-11-15)

  • Added missing types for srcDecoder.

0.4.37 (2022-11-15)

  • Added srcDecoder, a new util to decode source locations in AST nodes.

0.4.36 (2022-11-14)

  • Fixed error in findAll when the code contains user defined value types.

0.4.35 (2022-06-23)

  • Made IndexAccess.indexExpression nullable, which shows up when array types are used with abi.decode.

0.4.34 (2022-06-11)

  • Added missing files to package.

0.4.33 (2022-06-11)

  • Removed circular dependency from utils.

0.4.32 (2022-04-24)

  • Added EventDefinition.eventSelector and ErrorDefinition.errorSelector.
  • Added InlineAssembly.flags which can now indicate assembly as memory safe.
  • Added UsingForDirective.global.
  • In UsingForDirective added functionList and made libraryName optional. These properties are exclusive: exactly one of them should be present, though this is not encoded in the type.
  • Fixed UsingForDirective.typeName: it should have always been nullable to account for using ... for *.

0.4.31 (2022-03-20)

  • Added SolcInput interface.

0.4.30 (2022-01-27)

  • Added support for an array of node types in isNodeType.

0.4.29 (2021-12-24)

  • Made input array types readonly in utils module.

0.4.28 (2021-10-27)

  • Added DoWhileStatement, Continue, and Break. All of them kinds of Statement.

0.4.27 (2021-06-25)

  • Added UserDefinedValueTypeDefinition which can appear in SourceUnit and ContractDefinition.
  • Added ContractDefinition.canonicalName from Solidity 0.8.9.
  • Added new EVM version 'london'.

0.4.26 (2021-06-25)

  • Added a new utility for looking up AST nodes based on their id and type.

0.4.25 (2021-06-01)

  • Removed Yul nodes from Node and NodeType, export them separately as YulNode and YulNodeType.

0.4.24 (2021-06-01)

  • Fixed duplicate type name in generated declaration file.

0.4.23 (2021-05-30)

  • Added missing values for Assignment.operator: >>=, <<=
  • Added missing values for BinaryOperation.operator: &, |
  • Added missing kind of Expression: IndexRangeAccess (e.g. msg.data[start:end])
  • Added missing field in members of InlineAssembly.externalReferences: suffix ('slot' and 'offset')

0.4.22 (2021-05-30)

  • Added Yul types for typing InlineAssembly.AST.
  • Fixed Identifier.overloadedDeclarations: was unknown and is now number.

0.4.21 (2021-05-23)

  • Rewrote schema in JavaScript in a more modular way.
  • Fixed IndexAccess.baseExpression: was optional but is required.
  • Added missing values for Assignment.operator: -=, *=, %=, |=, &=, ^=.
  • Added statement-level documentation available since Solidity 0.8.2.

0.4.20 (2021-04-22)

  • Added new Solidity 0.8.4 constructs:
    • ErrorDefinition as a new child of SourceUnit and ContractDefinition
    • RevertStatement as a new kind of statement
    • ContractDefinition.usedErrors

0.4.19 (2021-03-23)

  • Added new Solidity 0.8.3 field ModifierInvocation.kind.

Note that there is a bug in 0.8.3 where kind never actually has the value "baseConstructorSpecifier". This will presumably be fixed in the next release.

0.4.18 (2021-03-21)

  • Added new Solidity 0.8.2 field nameLocation in:
    • EnumValue
    • EnumDefinition
    • EventDefinition
    • FunctionDefinition
    • ModifierDefinition
    • ImportDirective (and entries of ImportDirective.symbolAliases)
    • ContractDefinition
    • StructDefinition
    • VariableDeclaration

0.4.17 (2021-01-05)

  • Added missing override-related types and fields:
    • ModifierDefinition.baseModifiers: number[]
    • ModifierDefinition.overrides?: OverrideSpecifier
    • VariableDeclaration.baseFunctions: number[]
    • VariableDeclaration.overrides?: OverrideSpecifier

0.4.16 (2020-12-17)

  • Added Block as a possible kind of Statement.
  • Added new Solidity 0.8 constructs:
    • UncheckedBlock is a new kind of Statement.
    • IdentifierPath is a new node type that replaces some instances of UserDefinedTypeName and Identifier, used in the following places:
      • InheritanceSpecifier.baseName
      • ModifierInvocation.modifierName
      • OverrideSpecifier.overrides
      • UsingForDirective.libraryName
      • UserDefinedTypeName.pathNode (new)

0.4.15 (2020-12-11)

  • Extended findAll to enumerate multiple node types simultaneously.

0.4.14 (2020-11-18)

  • Added hexString, unicodeString as possible values for Literal.kind. Available since Solidity 0.7.0.

0.4.13 (2020-11-02)

  • Fixed findAll crash when used with node type 'SourceUnit'.

0.4.12 (2020-10-22)

  • Added an optional argument prune to findAll.

If the optional prune: (node: Node) => boolean argument is specified, findAll will apply the function to each node, if the return value is truthy the node will be ignored, neither yielding the node nor recursing into it. Note that prune is not available when curried.

0.4.11 (2020-10-19)

  • Added support for file-level constant VariableDeclaration nodes, available since Solidity 0.7.4.

0.4.10 (2020-10-15)

  • Added VariableDeclaration.documentation, which is available since Solidity 0.6.9.

0.4.9 (2020-10-15)

  • Added TryStatement as a new type of statement node.

0.4.8 (2020-10-15)

  • Fixed types of ForStatement properties condition, initializationExpression, loopExpression, allowing them to be empty.
  • Fixed type of ForStatement.initializationExpression to also potentially contain an ExpressionStatement.

0.4.7 (2020-10-14)

  • NewExpression.isLValue and FunctionCallOptions.isLValue are now optional.

Due to a bug in Solidity 0.7.2, these two properties are missing in the ASTs produced by that version. In order for the types to remain accurate, they have been made optional. When the property is missing its value should be assumed to be false (see ethereum/solidity#9953).

0.4.6 (2020-10-14)

  • Fixed type of ModifierInvocation.arguments.

0.4.5 (2020-10-14)

  • Disabled additionalProperties in Conditional node.
  • Fixed Return node for empty return statements.

0.4.4 (2020-09-02)

  • Fixed body property of ForStatement: was Block, can also be Statement.
  • Added support for Solidity 0.7.1.
    • Made nullable properties optional. For TypeScript this means that null values can now be undefined.
    • Added support for free functions: FunctionDefinition is now a potential child in SourceUnit.nodes.

0.4.3 (2020-07-02)

  • Fixed body property of WhileStatement: was Block, can also be Statement.

0.4.2 (2020-07-02)

  • Fixed length property of ArrayTypeName: was null, can be any Expression.

0.4.1 (2020-06-18)

  • Added all EVM versions to InlineAssembly node.
  • Fixed findAll to check for null property values.

0.4.0 (2020-06-12)

  • Added solidity-ast/utils with the following utility functions:
    • isNodeType(nodeType, node): a type predicate for type-safe filtering or any kind of narrowing.
    • findAll(nodeType, node): a generator function that recursively enumerates all of a node's descendents of type nodeType.
    • Both of these functions can be partially applied by supplying only the nodeType argument. This is useful for higher order functions like filter or map, as in nodes.filter(isNodeType('ContractDefinition')).
  • Removed solidity-ast/predicates. Use isNodeType from solidity-ast/utils instead.

0.3.2 (2020-06-12)

  • Fixed type for ImportDirective.symbolAliases.

0.3.1 (2020-06-09)

  • Added missing type for ImportDirective.symbolAliases.

0.3.0 (2020-06-04)

  • Added solidity-ast/predicates with type guards for type-safe filtering.
import { isContractDefinition } from "solidity-ast/predicates";
const contractDefs = sourceUnit.nodes.filter(isContractDefinition);
// : ContractDefinition[]
  • Removed ParameterTypes, which was a duplicate of ParameterList. The latter should be used instead.
  • Removed ParameterTypeName, which wasn't referenced anywhere.

0.2.1 (2020-06-01)

  • Added missing >> operator.

0.2.0 (2020-05-18)

  • Completed schema to successfully validate OpenZeppelin Contracts.

0.1.0 (2020-05-15)

  • Initial release with incomplete schema.