1.0.0-rc.1 (#148)

* 1.0.0-rc.1

* chore: update changelog

---------

Co-authored-by: github-actions <[email protected]>
Co-authored-by: Daniel Rocha <[email protected]>

.github/workflows/build-lint-test.yml

@@ -61,10 +61,10 @@ jobs:
       - run: yarn lint
       - name: Validate RC changelog
         if: ${{ startsWith(github.head_ref, 'release/') }}
-        run: yarn auto-changelog validate --rc
+        run: yarn auto-changelog validate --prettier --rc
       - name: Validate changelog
         if: ${{ !startsWith(github.head_ref, 'release/') }}
-        run: yarn auto-changelog validate
+        run: yarn auto-changelog validate --prettier
       - name: Require clean working directory
         shell: bash
         run: |

CHANGELOG.md

@@ -1,37 +1,60 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [1.0.0-rc.1]
+
+### Added
+
+- Document how to migrate from API 0.1.x to 0.2.x ([#124](https://github.com/MetaMask/keyring-api/pull/124)).
+
+### Changed
+
+- **BREAKING:** Use the `onKeyringRequest` snap export ([#145](https://github.com/MetaMask/keyring-api/pull/145)).
+- **BREAKING:** Change the events' prefix to `notify:` ([#139](https://github.com/MetaMask/keyring-api/pull/139)).
+
 ## [0.2.7]
+
 ### Added
+
 - Export events types ([#125](https://github.com/MetaMask/keyring-api/pull/125))
 
 ## [0.2.6]
+
 ### Changed
+
 - Remove unused lavamoat allowed scripts ([#122](https://github.com/MetaMask/keyring-api/pull/122)).
 - Update events in sequence diagram ([#121](https://github.com/MetaMask/keyring-api/pull/121)).
 - Update Snap and ESLint dependencies ([#117](https://github.com/MetaMask/keyring-api/pull/117)).
 - Bump @metamask/rpc-methods from 0.38.1-flask.1 to 2.0.0 ([#120](https://github.com/MetaMask/keyring-api/pull/120)).
 
 ## [0.2.5]
+
 ### Changed
+
 - Remove `buildHandlersChain` ([#114](https://github.com/MetaMask/keyring-api/pull/114)).
 - Update doc for `eth_signTransaction` ([#111](https://github.com/MetaMask/keyring-api/pull/111)).
 - Remove un-versioned `eth_signTypedData` method ([#113](https://github.com/MetaMask/keyring-api/pull/113)).
 
 ## [0.2.4]
+
 ### Changed
+
 - Fix linting and compatibility with older `tsc` ([#108](https://github.com/MetaMask/keyring-api/pull/108)).
 
 ## [0.2.3]
+
 ### Added
+
 - Add redirection message to snap async response ([#102](https://github.com/MetaMask/keyring-api/pull/102)).
 
 ### Changed
+
 - Use `Omit` instead of `OmitUnion` ([#106](https://github.com/MetaMask/keyring-api/pull/106)).
 - Update `KeyringResponse` comment ([#103](https://github.com/MetaMask/keyring-api/pull/103)).
 - Use `KeyringRpcMethod` enum instead of string ([#105](https://github.com/MetaMask/keyring-api/pull/105)).
@@ -41,28 +64,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bump @metamask/providers from 11.1.1 to 11.1.2 ([#98](https://github.com/MetaMask/keyring-api/pull/98)).
 
 ## [0.2.2]
+
 ### Added
+
 - Add architecture and EVM methods docs ([#86](https://github.com/MetaMask/keyring-api/pull/86)).
 - Add `lastSelected` and `lastActive` to metadata ([#92](https://github.com/MetaMask/keyring-api/pull/92)).
 
 ### Changed
+
 - Make request `params` optional ([#96](https://github.com/MetaMask/keyring-api/pull/96)).
 - Remove `lastActive` field from internal account model ([#95](https://github.com/MetaMask/keyring-api/pull/95)).
 - Move request ID to outer request ([#94](https://github.com/MetaMask/keyring-api/pull/94)).
 
 ## [0.2.1]
+
 ### Changed
+
 - Set `snap` object keys to be mandatory and move `name` to `metadata` ([#87](https://github.com/MetaMask/keyring-api/pull/87)).
 
 ## [0.2.0]
+
 ### Added
+
 - Add `InternalAccount` type and create submodule `internal` ([#65](https://github.com/MetaMask/keyring-api/pull/65)).
 - Add keyring events and helper functions ([#74](https://github.com/MetaMask/keyring-api/pull/74)).
 - Add a `redirect` field to asynchronous request responses ([#75](https://github.com/MetaMask/keyring-api/pull/75)).
 - Add `exportAccount` method ([#60](https://github.com/MetaMask/keyring-api/pull/60)).
 - Add `getController` to client ([#43](https://github.com/MetaMask/keyring-api/pull/43)).
 
 ### Changed
+
 - Rename `erc4337` -> `eip4337` ([#42](https://github.com/MetaMask/keyring-api/pull/42)).
 - Make `options` a mandatory field of `KeyringAccount` ([#30](https://github.com/MetaMask/keyring-api/pull/30)).
 - Make `approveRequest` and `rejectRequest` optional ([#63](https://github.com/MetaMask/keyring-api/pull/63)).
@@ -74,29 +105,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Rename `supportedMethods` to `methods` ([#35](https://github.com/MetaMask/keyring-api/pull/35)).
 
 ## [0.1.3]
+
 ### Changed
+
 - Downgrade snaps dependencies to `0.35.2-flask.1` ([#25](https://github.com/MetaMask/keyring-api/pull/25)).
 
 ## [0.1.2]
+
 ### Changed
+
 - Update snaps dependencies ([#21](https://github.com/MetaMask/keyring-api/pull/21)).
 
 ## [0.1.1]
+
 ### Added
+
 - Validate snap responses for type correctness ([#15](https://github.com/MetaMask/keyring-api/pull/15)).
 
 ### Changed
+
 - Rename RPC handling functions ([#16](https://github.com/MetaMask/keyring-api/pull/16)).
 
 ## [0.1.0] - 2023-06-20
+
 ### Added
+
 - Usage examples to [`README.md`](./README.md).
 - Keyring API definition.
 - JSON-RPC snap keyring client. It is intended to be used by a snap's companion dapp to send requests to the snap.
 - SnapController keyring client. It is intended to be used by MetaMask to talk to the snap.
 - Helper functions to create keyring handler in the snap.
 
-[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v0.2.7...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v1.0.0-rc.1...HEAD
+[1.0.0-rc.1]: https://github.com/MetaMask/keyring-api/compare/v0.2.7...v1.0.0-rc.1
 [0.2.7]: https://github.com/MetaMask/keyring-api/compare/v0.2.6...v0.2.7
 [0.2.6]: https://github.com/MetaMask/keyring-api/compare/v0.2.5...v0.2.6
 [0.2.5]: https://github.com/MetaMask/keyring-api/compare/v0.2.4...v0.2.5

README.md

@@ -224,7 +224,7 @@ The project follows the same release process as the other libraries in the MetaM
    - Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
    - Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
    - Consolidate related changes into one change entry if it makes it easier to explain.
-   - Run `yarn auto-changelog validate --rc` to check that the changelog is correctly formatted.
+   - Run `yarn auto-changelog validate --prettier --rc` to check that the changelog is correctly formatted.
 
 5. Review and QA the release.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-api",
-  "version": "0.2.7",
+  "version": "1.0.0-rc.1",
   "description": "MetaMask Keyring API",
   "keywords": [
     "metamask",
@@ -25,7 +25,7 @@
     "build:clean": "rimraf dist && yarn build",
     "build:docs": "typedoc",
     "lint": "yarn lint:eslint && yarn lint:constraints && yarn lint:misc --check && yarn lint:dependencies --check && yarn lint:changelog",
-    "lint:changelog": "auto-changelog validate",
+    "lint:changelog": "auto-changelog validate --prettier",
     "lint:constraints": "yarn constraints",
     "lint:dependencies": "depcheck && yarn dedupe",
     "lint:eslint": "eslint . --cache --ext js,ts",