Simple Account Abstraction Snap

This repository contains the official Account Abstraction - Hybrid Compute snap.

Hybrid Compute utilizes Account Abstraction on Boba Network to engage with off-chain APIs seamlessly. Account Abstraction authenticates your transactions with ECDSA private keys (as well as lowering your costs by bundling your transactions). Hybrid Compute enables you to engage with GenAI or any other off-chain data, increasing the power and interoperability of your smart contracts.

Unlock the power of real-world data for Web3 with the Account Abstraction - Hybrid Compute snap; a single line of code is all it takes.

Install the Snap

To install the snap, follow this link (only Boba Sepolia as of 21 Nov 2024) and select "Install Snap & Connect." This will also connect your MetaMask to the Boba Sepolia Network. You can then create your "AA HC Wallet" account; we recommend creating it deterministically, though you have the option to import a private key instead. If you choose that option, please ensure you back up and save your private key.

Recover your Wallet Address

If you created your new wallet deterministically, you can recover your account in the same way as your MetaMask with the same pass phrase. If you created your the wallet with your own private key, you will need access to the private key you created it with.

Run the Snap Locally

Prerequisites

Snaps is pre-release software. To interact with your Snaps, install:

• MetaMask Flask, a canary distribution for developers that provides access to upcoming features
• yarn
• npm

Get Started

First, clone this repository locally.

Next, install the snap:

cd <name-of-your-repo-root-dir>
yarn install

Compile your types:

cd packages/snap && yarn compile

Start the application:

cd <name-of-your-repo-root-dir>
yarn start

Contribute

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.

Release & Publish

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.

1. 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.

2. If this release is backporting changes onto a previous release, make sure there is a major version branch for that version (e.g. 1.x for a v1 backport release).

   • The major version branch should be set to the most recent release with that major version. For example, when backporting a v1.0.2 release, you'd want to ensure there was a 1.x branch that was set to the v1.0.1 tag.

3. Trigger the workflow_dispatch event manually for the "Create Release Pull Request" action 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-pr workflow to create the release PR.

4. 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).

   • 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.).

   • Make sure the changelog edits are understandable for package users (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.

5. Review and QA the release.

   • If changes are made to the base branch, you will need to update the release branch 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.

6. Squash and merge the release.

   • This should trigger the action-publish-release workflow to tag the final release commit and publish the release on GitHub.

7. Publish the release on npm.

   • Be very careful to use a clean, local environment to publish the release. Follow the exact same steps used during CI.

   • Run npm publish --dry-run to examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. using https://unpkg.com/browse/[package name]@[package version]/).

   • Once you are confident the release contents are correct, publish the release by running npm publish.

Notes

We use Babel for transpiling TypeScript to JavaScript. Therefore, when building with the CLI, transpilationMode must be set to localOnly (default) or localAndDeps.

Audit

The snap has been audited by Sayfer. You can find the report here.