Release v2.5.10

fix

• outputFormat all not writing dot files

Release v2.5.9

Feature

• Added -hx, --hideExpand <variables> option to storage command to not expand specified arrays, structs, strings or bytes.

Examples

# Implementation with all variables expanded
sol2uml storage 0x8a3b6D3739461137d20825c36ED6016803d3104F

# Implementation with no expended _reserved, ______gap or __gap variables
sol2uml storage 0x8a3b6D3739461137d20825c36ED6016803d3104F --hideExpand _reserved,______gap,__gap

# Proxy with data, no expended _reserved, ______gap or __gap variables
sol2uml storage 0x8a3b6D3739461137d20825c36ED6016803d3104F \
  -hx _reserved,______gap,__gap \
  --data --storage 0x6b69B755C629590eD59618A2712d8a2957CA98FC

Release v2.5.8

Fixes

• Contract types were incorrectly reporting 32 bytes instead of 20 bytes. Issue #162

Release v2.5.7

Features

• diff of multiple verified files
• diff of contracts on different chains

New cross-chain diff options

  -bn, --bNetwork <network>  Ethereum network which maps to a blockchain explorer for contract B if on a different blockchain to contract A. Contract A uses the `network` option (default: value of `network` option) (choices: "mainnet", "goerli", "sepolia", "polygon",
                             "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo")
  -be, --bExplorerUrl <url>  Override the `bNetwork` option with custom blockchain explorer API URL for contract B if on a different blockchain to contract A. Contract A uses the `explorerUrl` (default: value of `explorerUrl` option)
  -bk, --bApiKey <key>       Blockchain explorer API key for contract B if on a different blockchain to contract A. Contract A uses the `apiKey` option (default: value of `apiKey` option)

The previous diff would flatten multiple files and then compare the code. The new diff compares each file separately. The --flatten option will use this old comparison method.

  --flatten                  Flatten into a single file before comparing (default: false)

The other new option is

  -s, --summary              Only show a summary of the file differences. (default: false)

Examples

Origin OETH VaultCore

# Summary of change files
sol2uml diff 0x1091588Cc431275F99DC5Df311fd8E1Ab81c89F3 0xEA24e9Bac006DE9635Ac7fA4D767fFb64FB5645c --summary

# Code differences of VaultStorage file
sol2uml diff 0x1091588Cc431275F99DC5Df311fd8E1Ab81c89F3 0xEA24e9Bac006DE9635Ac7fA4D767fFb64FB5645c --aFile VaultStorage

Origin OUSD Vault

# OUSD VaultCore upgrade
sol2uml diff 0x48Cf14DeA2f5dD31c57218877195913412D3278A 0x997c35A0bf8E21404aE4379841E0603C957138c3 -v

Aave V3 Pool Mainnet v Optimism

# Cross chain contract compare
sol2uml diff 0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2 0x794a61358d6845594f94dc1db02a252b5b4814ad --bNetwork optimism

Release v2.5.6

• added -e --explorerUrl option for testnet block explorers.

  -e, --explorerUrl <url>   Override network with custom blockchain explorer API URL. eg Polygon Mumbai testnet https://api-testnet.polygonscan.com/api (env: EXPLORER_URL)

Release v2.5.5

• Added support for the Celo blockchain
• diff at source file level using the --aFile option
• diff renamed source files using --aFile and --bFIle options

For example, diff two deployed contracts where the source file was renamed from SeriesV2 to SeriesV3

sol2uml diff --aFile SeriesV2 --bFile SeriesV3 0xe79850AaCD3AD0b50b747837410Ae5D7C38D5Caa 0x82c623270fB3C4E95A36d35E21A95ff328531dC5

Release v2.5.4

• Fixed commenting out imports that span multiple lines when flattening contracts #145

Release v2.5.3

• Class diagrams can now hide contracts
• Added sol2uml example diagrams of the ERC-4337 account abstraction contracts

Release v2.5.2

Fixes

• Fix the depth of squashed contracts by squashing before filtering to base contracts

Maintenance

• Updated usage and argument descriptions
• Removed test chains

Release v2.5.1

Features

• Added -hv, --hideValue option for storage diagrams to hide the slot value column.

Fixes

• Storage diagrams now handle aliased imports #142

Maintenance

• Updated dependencies