CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

8.4.1

Changed

• Bump @metamask/snaps-sandbox from ^1.0.0 to ^1.0.1 (#3894)

8.4.0

Added

• Add --manifest option for custom manifests (#3793, #3811)
  • This is currently only supported for the watch command, and build command for preinstalled Snaps (when used with the --preinstalled flag).
• Allow manifest to extend another manifest (#3802)
  • For example, you could have a snap.manifest.json file with common fields, and a snap.manifest.dev.json file that extends it with development-specific fields:

    // snap.manifest.json
    {
      "version": "1.0.0",
      "proposedName": "My Snap",
      "initialPermissions": {
        "endowment:network-access": {}
      }
    }

    and

    // snap.manifest.dev.json
    {
      "extends": "./snap.manifest.json",
      "proposedName": "My Snap (development)",
      "initialConnections": {
        "https://localhost:8000": {}
      }
    }

    When running mm-snap watch --manifest snap.manifest.dev.json, the resulting manifest will combine the fields from both files.
• Add --preinstalled flag to build command to create preinstalled Snap bundle (#3805)

8.3.0

Added

• Merge manifest validation reports to include latest validation errors and warnings (#3567)

8.2.0

Changed

• Add support for eval in watch mode (#3553)
  • This enables some extra validation checks in watch mode, which can help catch issues earlier in the development process.

8.1.1

Fixed

• Display CLI minimum version range properly (#3531)

8.1.0

Added

• Support scheduling cronjobs with an ISO 8601 duration (#3421)

8.0.0

Changed

• BREAKING: Drop support for Node.js 18 and 21 (#3447)
• Bump minimum supported browser versions (#3441)
  • The minimum supported browser versions are now:
    • Chrome 113
    • Firefox 115
• Bump @swc/core from 1.3.78 to 1.11.31 (#3442)
• Bump swc-loader from 0.2.3 to 0.2.6 (#3442)

7.2.0

Added

• Validate platform version against production (#3417)
• Detect unused permissions (#3335)

7.1.0

Added

• Add sandbox command to run sandbox tool (#3306)
  • This command allows you to run the Snaps sandbox tool, which is useful for quickly testing and debugging Snaps.

Changed

• Bump @metamask/utils from 11.2.0 to 11.4.0 (#3232)

7.0.0

Changed

• BREAKING: Remove deprecated Browserify configuration (#3313)
  • The Browserify bundler is no longer supported. Snaps using the Browserify bundler will need to be migrated to the new configuration format based on Webpack.
  • The bundler option in the Snap configuration file was removed, and the CLI will show an error if it's used in config.
  • Several command line flags that were used to configure the Browserify bundler were removed.
    • Use the config file to provide these options instead.
    • The removed options are:
      • --bundle
      • --dist
      • --eval
      • --manifest
      • --outfileName
      • --root
      • --sourceMaps
      • --src
      • --stripComments
      • --suppressWarnings
      • --transpilationMode
      • --depsToTranspile
      • --verboseErrors
      • --writeManifest
      • --serve

6.7.0

Added

• Add --analyze flag to build command to enable bundle analyzer (#3075)

6.6.1

Changed

• Bump MetaMask dependencies (#2946)

Fixed

• Disable nodeEnv optimization in Webpack (#2970)
  • This previously caused issues with overwriting NODE_ENV.

6.6.0

Added

• Allow async initialization logic (#2918)
  • Top-level-await is now available in Snaps.
  • WASM modules are instantiated asynchronously.
• Automatically add platformVersion to manifest (#2938)

6.5.4

Fixed

• Bundle and initialize WASM modules using Base64 encoding (#2913)

6.5.3

Fixed

• Ignore query strings when parsing URLs (#2883)

6.5.2

Changed

• Bump MetaMask dependencies (#2853)

6.5.1

Fixed

• Move fork-ts-checker-webpack-plugin to dependencies (#2862)

6.5.0

Added

• Add support for TypeScript type-checking (#2783)
  • This introduces a new configuration option, typescript.enabled, which can be set to true to enable TypeScript type-checking.
  • You can optionally specify a custom tsconfig.json file by setting typescript.configFile to the path of the file.

6.4.0

Changed

• Format Snap manifests with Prettier (#2787)

6.3.4

Changed

• Bump @metamask/snaps-sdk to ^6.7.0 (#2770)
• Bump @metamask/snaps-utils to ^8.3.0 (#2770)

6.3.3

Fixed

• Fix invalid types in type declaration in some cases (#2714)

6.3.2

Fixed

• Fix ESM version of the package (#2682)
  • This fixes the ESM version of the package to be fully compliant with the ESM standard.
• Bump @metamask/utils from ^9.1.0 to ^9.2.1 (#2680)

6.3.1

Fixed

• Hide browserlist warning where applicable (#2664)

6.3.0

Changed

• Improve manifest validation output (#2572)
• Replace superstruct with ESM-compatible fork @metamask/superstruct (#2445)

6.2.1

Fixed

• Improve validation of endowment:rpc (#2512)

6.2.0

Added

• Add support for building Snaps with JSX (#2258)
  • It's now possible to use JSX components from @metamask/snaps-sdk to build user interfaces for Snaps.

6.1.1

Fixed

• Disable topLevelAwait configuration option (#2358)
  • Before this the CLI would produce invalid builds when using top-level await.

6.1.0

Added

• Add support for importing SVG, PNG, and JPEG files directly (#2284)
  • You can now import these files using a regular import declaration when using the Webpack-based config.
  • To opt out of this feature (i.e., to use custom image loading logic), add the following to your config:

    {
      features: {
        images: false,
      },
    }

Changed

• Update CLI docs link (#2294)

Fixed

• Fix detection of minimum Node.js version (#2292)

6.0.2

Fixed

• Publish .browserslistrc (#2227)

6.0.1

Fixed

• Fix minor build configuration problems (#2220)

6.0.0

Changed

• BREAKING: Update ESM build to be fully compliant with the ESM standard (#2210)
• BREAKING: Change config to use Webpack by default (#2214)
  • You can still use Browserify by specifying bundler: 'browserify'.

5.1.1

Fixed

• Support new lines in CLI message formatting (#2194)

5.1.0

Changed

• Optimize CLI Webpack configuration (#2175)
  • This can reduce the size of Snaps in certain cases.
• Show Webpack compilation warnings in CLI (#2186, #2192)
• Add a warning when no icon is found and when icon is not square (#2185)

5.0.0

Changed

• BREAKING: Disable source maps by default (#2166)
  • This slightly speeds up the build process.
  • You can enable source maps again by setting sourceMap: true in your Snap config.
• Set output.chunkFormat to commonjs by default (#2136)

4.0.1

Fixed

• Fix missing global during snap evaluation (#2072)

4.0.0

Changed

• BREAKING: Synchronously initialize WASM modules (#2024)
  • When the experimental.wasm flag in the Snaps CLI is enabled, the WASM module will now be synchronously initialized, rather than being inlined as a Uint8Array.

3.0.5

Fixed

• Include Snap icon in allowed server paths (#2003)

3.0.4

Fixed

• Only serve Snap files from CLI (#1979)

3.0.3

Changed

• Bump several MetaMask dependencies (#1964)

Fixed

• Fix issues generating checksum with binary auxiliary files (#1975)

3.0.2

Changed

• Use @metamask/snaps-sdk package (#1951)
  • This package replaces the @metamask/snaps-types and @metamask/snaps-ui packages.

3.0.1

Changed

• Bump Babel packages from ^7.20.12 to ^7.23.2 (#1862)
• Update multiple MetaMask dependencies (#1841)

3.0.0

Changed

• BREAKING: Bump minimum Node.js version to ^18.16.0 (#1741)

2.0.2

Fixed

• Fix Webpack being unable to find swc-loader in some cases (#1798)
• Check minimum Node version in CLI (#1797)

2.0.1

Fixed

• Disable the fullySpecified rule for .js imports in the default Webpack config (#1780)

2.0.0

Changed

• Initial stable release from main branch (#1757)

0.38.4-flask.1

Changed

• Bump metamask/utils and metamask/snaps-registry (#1738, #1694)

0.38.3-flask.1

Fixed

• Remove unused dependencies (#1680)

0.38.2-flask.1

Added

• Add polyfills option to Webpack configuration (#1650)

Fixed

• Fix breaking change to SWC causing the CLI to break (#1677)

0.38.1-flask.1

Changed

• Update all examples to use Webpack (#1632)

0.38.0-flask.1

Added

• Add support for bundling with Webpack (#1521)
  • For backwards compatibility, the Webpack bundler is opt-in. To use it, add "bundler": "webpack" to your snap configuration file, and follow the new configuration format described in the documentation.
  • The new configuration format also adds support for:
    • Setting environment variables, which are set as process.env values in the bundled code.
    • Importing WebAssembly modules (if experimental.wasm is enabled in the snap configuration file).
• Support TypeScript snap configuration files (#1521)

Changed

• Release package independently (#1600)
  • The version of the package no longer needs to match the version of all other MetaMask Snaps packages.