Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
89032df
wip: Add Multichain API support
FrederikBolding Dec 1, 2025
337af3c
Add example Snap
FrederikBolding Dec 1, 2025
c769623
Support signing messages with Solana
FrederikBolding Dec 1, 2025
f77100e
Restructure example
FrederikBolding Dec 2, 2025
06b724f
Add permission boilerplate
FrederikBolding Dec 3, 2025
79cf399
Add execution env test
FrederikBolding Dec 3, 2025
d142d5b
Update snapshots
FrederikBolding Dec 3, 2025
52a4b1e
Fix lint
FrederikBolding Dec 3, 2025
dac06a5
wip: Partial simulation support
FrederikBolding Dec 8, 2025
40e2559
Tweak version
FrederikBolding Jan 5, 2026
0f84c1e
Fix lint
FrederikBolding Jan 6, 2026
8ae0dee
Add genesis hash method
FrederikBolding Jan 6, 2026
19ba04b
Support creating and using multichain API sessions
FrederikBolding Jan 7, 2026
0c6e0f6
Sync versions
FrederikBolding Jan 7, 2026
a6e1563
Fix some more tests
FrederikBolding Jan 7, 2026
6a0aaa1
Move multichain methods to multichain middleware
FrederikBolding Jan 7, 2026
56baddb
Inject accounts into session
FrederikBolding Jan 7, 2026
5d50100
Fix import
FrederikBolding Jan 7, 2026
24e9231
Tweak test-snaps layout and implementation
FrederikBolding Jan 7, 2026
324a1f1
Properly manage session scopes + request.scope
FrederikBolding Jan 8, 2026
b401f8d
Improve typing
FrederikBolding Jan 8, 2026
4929581
More type and docs fixes
FrederikBolding Jan 8, 2026
6c51adb
Fix array assertion
FrederikBolding Jan 8, 2026
617f7a2
Add some tests
FrederikBolding Jan 8, 2026
4217c49
Simplify example
FrederikBolding Jan 9, 2026
2ced6a4
Add ScopedJsonRpcRequest type
FrederikBolding Jan 9, 2026
6d95882
Add more tests
FrederikBolding Jan 9, 2026
bd63387
Add more tests
FrederikBolding Jan 12, 2026
e14c4c5
More tests
FrederikBolding Jan 12, 2026
e7c7def
Add wallet_revokeSession simulation
FrederikBolding Jan 12, 2026
a13c29d
Add struct for wallet_invokeMethod
FrederikBolding Jan 12, 2026
a56c9bd
Add struct for wallet_createSession
FrederikBolding Jan 12, 2026
1c7044a
Add remaining tests
FrederikBolding Jan 13, 2026
a73f284
Resolve a bunch of comments
FrederikBolding Jan 14, 2026
ec08e8c
Update README
FrederikBolding Jan 14, 2026
bab46e4
More JSDocs
FrederikBolding Jan 14, 2026
792fbcf
Change account injection approach
FrederikBolding Jan 16, 2026
17f514f
Add tests
FrederikBolding Jan 16, 2026
4ad67ba
Address PR comments
FrederikBolding Jan 16, 2026
a35de5f
Revert getAccountsHandler changes
FrederikBolding Jan 16, 2026
81c22e6
Fix PR comment
FrederikBolding Jan 16, 2026
8f299d3
Fix a type
FrederikBolding Jan 16, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions packages/examples/packages/multichain-provider/.depcheckrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"ignore-patterns": ["dist", "coverage"],
"ignores": [
"@lavamoat/allow-scripts",
"@lavamoat/preinstall-always-fail",
"@metamask/auto-changelog",
"@metamask/eslint-*",
"@types/*",
"@typescript-eslint/*",
"eslint-config-*",
"eslint-plugin-*",
"jest-silent-reporter",
"prettier-plugin-packagejson",
"ts-node",
"typedoc",
"typescript"
]
}
10 changes: 10 additions & 0 deletions packages/examples/packages/multichain-provider/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# 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]

[Unreleased]: https://github.com/MetaMask/snaps/
201 changes: 201 additions & 0 deletions packages/examples/packages/multichain-provider/LICENSE.APACHE2
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2026 Consensys Software Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
16 changes: 16 additions & 0 deletions packages/examples/packages/multichain-provider/LICENSE.MIT0
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
MIT No Attribution

Copyright 2026 Consensys Software Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 changes: 36 additions & 0 deletions packages/examples/packages/multichain-provider/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# `@metamask/multichain-provider-example-snap`

This Snap demonstrates the use of the `endowment:multichain-provider` permission.

The permission grants the Snap access to CAIP-25 provider methods via `snap.request`.

## Snap manifest

Along with other permissions, the manifest of this snap includes the
`endowment:multichain-provider` permission:

```json
{
"initialPermissions": {
"endowment:mulitchain-provider": {}
}
}
```

This permission does not require any additional configuration.

## Snap usage

This snap exposes an `onRpcRequest` handler, which supports the following
JSON-RPC methods:

- `createSession`: Create the multichain API session.
- `revokeSession`: Revoke the current multichain API session.
- `getChainId`: Get the current Ethereum chain ID as a string.
- `getAccounts`: Get the accounts for the selected scope.
- `signMessage`: Sign a message using an Ethereum or Solana account.
- `signTypedData`: Sign a struct using an Ethereum account.
- `getGenesisHash`: Get the genesis hash for the selected scope.

For more information, you can refer to
[the end-to-end tests](./src/index.test.ts).
36 changes: 36 additions & 0 deletions packages/examples/packages/multichain-provider/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
const deepmerge = require('deepmerge');

const baseConfig = require('../../../../jest.config.base');

module.exports = deepmerge(baseConfig, {
preset: '@metamask/snaps-jest',

// `@metamask/snaps-jest` currently doesn't support collecting
// coverage information.
collectCoverage: false,

// This is required for the tests to run inside the `MetaMask/snaps`
// repository. You don't need this in your own project.
moduleNameMapper: {
'^@metamask/(.+)/production/jsx-runtime': [
'<rootDir>/../../../$1/src/jsx/production/jsx-runtime',
'<rootDir>/../../../../node_modules/@metamask/$1/jsx/production/jsx-runtime',
'<rootDir>/node_modules/@metamask/$1/jsx/production/jsx-runtime',
],
'^@metamask/(.+)/jsx': [
'<rootDir>/../../../$1/src/jsx',
'<rootDir>/../../../../node_modules/@metamask/$1/jsx',
'<rootDir>/node_modules/@metamask/$1/jsx',
],
'^@metamask/(.+)/node$': [
'<rootDir>/../../../$1/src/node',
'<rootDir>/../../../../node_modules/@metamask/$1/node',
'<rootDir>/node_modules/@metamask/$1/node',
],
'^@metamask/(.+)$': [
'<rootDir>/../../../$1/src',
'<rootDir>/../../../../node_modules/@metamask/$1',
'<rootDir>/node_modules/@metamask/$1',
],
},
});
74 changes: 74 additions & 0 deletions packages/examples/packages/multichain-provider/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
{
"name": "@metamask/multichain-provider-example-snap",
"version": "0.0.0",
"description": "MetaMask example Snap demonstrating the use of the Multichain Provider API and `endowment:multichain-provider` permission",
"keywords": [
"MetaMask",
"Snaps",
"Ethereum"
],
"homepage": "https://github.com/MetaMask/snaps/tree/main/packages/examples/packages/multichain-provider#readme",
"bugs": {
"url": "https://github.com/MetaMask/snaps/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/MetaMask/snaps.git"
},
"license": "(MIT-0 OR Apache-2.0)",
"sideEffects": false,
"main": "./dist/bundle.js",
"files": [
"dist",
"snap.manifest.json"
],
"scripts": {
"build": "mm-snap build",
"build:clean": "yarn clean && yarn build",
"changelog:update": "../../../../scripts/update-changelog.sh @metamask/multichain-provider-example-snap",
"changelog:validate": "../../../../scripts/validate-changelog.sh @metamask/multichain-provider-example-snap",
"clean": "rimraf \"dist\"",
"lint": "yarn lint:eslint && yarn lint:misc --check && yarn changelog:validate && yarn lint:dependencies",
"lint:ci": "yarn lint",
"lint:dependencies": "depcheck",
"lint:eslint": "eslint . --cache",
"lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
"lint:misc": "prettier --no-error-on-unmatched-pattern --log-level warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" \"!snap.manifest.json\" --ignore-path ../../../../.gitignore",
"publish:preview": "yarn npm publish --tag preview",
"since-latest-release": "../../../../scripts/since-latest-release.sh",
"start": "mm-snap watch",
"test": "jest --reporters=jest-silent-reporter",
"test:clean": "jest --clearCache",
"test:verbose": "jest --verbose",
"test:watch": "jest --watch"
},
"dependencies": {
"@metamask/snaps-sdk": "workspace:^",
"@metamask/utils": "^11.9.0"
},
"devDependencies": {
"@jest/globals": "^29.5.0",
"@lavamoat/allow-scripts": "^3.4.1",
"@metamask/auto-changelog": "^5.0.2",
"@metamask/snaps-cli": "workspace:^",
"@metamask/snaps-jest": "workspace:^",
"@swc/core": "1.11.31",
"@swc/jest": "^0.2.38",
"@types/node": "18.14.2",
"deepmerge": "^4.2.2",
"depcheck": "^1.4.7",
"eslint": "^9.11.0",
"jest": "^29.0.2",
"jest-silent-reporter": "^0.6.0",
"prettier": "^3.3.3",
"ts-node": "^10.9.1",
"typescript": "~5.3.3"
},
"engines": {
"node": "^20 || >=22"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
}
}
Loading
Loading