hashgraph@hashgraph/hedera-wallet-snap
This repository contains code for Hedera Wallet Snap that offers various features such as sending HBAR to another HBAR account id and EVM address, retrieving account info from either the Hedera Ledger node or Hedera Mirror node. Refer to the Hedera Wallet Snap Wiki for more info on how the snap works and how to integrate it into your own application.
MetaMask Snaps is a system that allows anyone to safely expand the capabilities of MetaMask. A snap is a program that we run in an isolated environment that can customize the wallet experience.
DISCLAIMER This snap is developed by Tuum Tech while the code for the snap is managed by Swirlds Labs. Furthermore, this wallet is neither created nor sponsored by Hedera and is built specifically for Metamask
Github Actions
Linting, static analysis and testing via Jest are configured via Github Actions in the repository. Replication of these steps locally is covered below.
Getting Started
Setup the development environment
yarn install && yarn startUnit Testing and Linting
Run yarn test to run the tests once.
Run yarn lint to run the linter, or run yarn lint:fix to run the linter and fix any automatically fixable issues.
Note that linting currently will run through ESLint and Prettier rules.
Releasing & Publishing
The project follows the same release process as the other libraries in the MetaMask organization. The GitHub
Actions action-create-release-pr
and action-publish-release are used to automate the release
process; see those repositories for more information about how they work.
Choose a release version.
- The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See the SemVer specification for more information.
If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g.
1.xfor av1backport release).- The major version branch should be set to the most recent release with that major version. For example, when
backporting a
v1.0.2release, you'd want to ensure there was a1.xbranch that was set to thev1.0.1tag.
- The major version branch should be set to the most recent release with that major version. For example, when
backporting a
Trigger the
workflow_dispatchevent manually for theCreate Release Pull Requestaction to create the release PR.- For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).
- This should trigger the
action-create-release-prworkflow to create the release PR.
Update the changelog to move each change entry into the appropriate change category (See here for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.
- 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 --rcto check that the changelog is correctly formatted.
Review and QA the release.
- If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.
Squash & Merge the release.
- This should trigger the
action-publish-releaseworkflow to tag the final release commit and publish the release on GitHub.
- This should trigger the
Publish the release on npm.
- Be very careful to use a clean local environment to publish the release, and follow exactly the same steps used during CI.
- Use
npm publish --dry-runto examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. usinghttps://unpkg.com/browse/[package name]@[package version]/). - Once you are confident the release contents are correct, publish the release using
npm publish.