Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Integrate non-evm SIP-26 support into @metamask/multichain #5191

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open

feat: Integrate non-evm SIP-26 support into @metamask/multichain #5191

Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
98d11e7
Trigger
jiexi Jan 22, 2025
6779689
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Jan 23, 2025
ed5a2e1
rename isChainIdSupported to isEvmChainIdSupported. add isNonEvmScope…
jiexi Jan 23, 2025
cba3b99
add getNonEvmSupportedMethods and getNonEvmAccountAddresses
jiexi Jan 23, 2025
e35b2da
Add getNonEvmSupportedMethods hook to session scopes adapt er
jiexi Jan 24, 2025
03dd687
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Jan 24, 2025
abb6702
Add getNonEvmSupportedMethods hook to wallet_getSession and wallet_in…
jiexi Jan 24, 2025
4f28f9c
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Jan 29, 2025
3fc797a
add handleNonEvmRequest to wallet_invokeMethod
jiexi Jan 29, 2025
f6a1a92
remove json type coercion
jiexi Jan 29, 2025
b6ada13
add getNonEvmSupportedMethods to wallet_invokeMethod hookNames
jiexi Jan 29, 2025
5dfebad
use unwraped request
jiexi Jan 29, 2025
dd767d4
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Jan 31, 2025
e5243c6
add non-evm account support checks to caip25 caveat validator
jiexi Jan 31, 2025
09ac303
Fix supported specs
jiexi Jan 31, 2025
8fa9774
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Jan 31, 2025
94ced5c
fix assert tests
jiexi Jan 31, 2025
ae225bf
Fix authorization test
jiexi Jan 31, 2025
7a8c752
fix wallet-getSession
jiexi Jan 31, 2025
01d7ac3
fix filter tests
jiexi Jan 31, 2025
4c8e993
fix adapter session scopes
jiexi Jan 31, 2025
ef12a89
fix wallet-invokeMethod
jiexi Feb 1, 2025
082735b
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Feb 1, 2025
39dad34
lint
jiexi Feb 3, 2025
17f4643
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Feb 3, 2025
7a91393
lint
jiexi Feb 4, 2025
9fdbbeb
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Feb 4, 2025
400d1d5
update thresholds
jiexi Feb 4, 2025
7bd4620
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Feb 4, 2025
9f599d4
update thresholds
jiexi Feb 4, 2025
46b4634
update thresholds
jiexi Feb 4, 2025
0d0d258
loosen jest coverage
jiexi Feb 4, 2025
511ee79
fix wallet-invokeMethod hook name
jiexi Feb 5, 2025
958adf5
Merge branch 'main' into adapt-multichain-api-for-sip-26
jiexi Feb 5, 2025
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
32 changes: 13 additions & 19 deletions eslint-warning-thresholds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,29 +327,26 @@
"jsdoc/tag-lines": 5
},
"packages/multichain/src/adapters/caip-permission-adapter-session-scopes.test.ts": {
"import-x/order": 1
"@typescript-eslint/no-unused-vars": 2
},
"packages/multichain/src/adapters/caip-permission-adapter-session-scopes.ts": {
"jsdoc/tag-lines": 3
"@typescript-eslint/no-unsafe-enum-comparison": 1
},
"packages/multichain/src/caip25Permission.test.ts": {
"@typescript-eslint/no-unused-vars": 3
"@typescript-eslint/no-unused-vars": 5
},
"packages/multichain/src/caip25Permission.ts": {
"@typescript-eslint/no-unused-vars": 1,
"jsdoc/tag-lines": 1
},
"packages/multichain/src/handlers/wallet-getSession.test.ts": {
"import-x/order": 1
"@typescript-eslint/no-unused-vars": 3
},
"packages/multichain/src/handlers/wallet-getSession.ts": {
"@typescript-eslint/no-unused-vars": 2,
"@typescript-eslint/no-unused-vars": 1,
"jsdoc/require-returns": 1
},
"packages/multichain/src/handlers/wallet-invokeMethod.test.ts": {
"import-x/order": 2
"no-empty-function": 1
},
"packages/multichain/src/handlers/wallet-invokeMethod.ts": {
"@typescript-eslint/no-unsafe-enum-comparison": 1,
"@typescript-eslint/no-unused-vars": 1,
"jsdoc/require-returns": 1
},
Expand All @@ -375,26 +372,23 @@
"@typescript-eslint/no-unused-vars": 3
},
"packages/multichain/src/scope/assert.ts": {
"@typescript-eslint/no-unsafe-enum-comparison": 1,
"jsdoc/tag-lines": 8
"@typescript-eslint/no-unsafe-enum-comparison": 1
},
"packages/multichain/src/scope/authorization.ts": {
"jsdoc/tag-lines": 2
"packages/multichain/src/scope/authorization.test.ts": {
"@typescript-eslint/no-unused-vars": 2
},
"packages/multichain/src/scope/errors.ts": {
"jsdoc/tag-lines": 5
},
"packages/multichain/src/scope/filter.test.ts": {
"jest/no-conditional-in-test": 9,
"prettier/prettier": 1
"jest/no-conditional-in-test": 9
},
"packages/multichain/src/scope/filter.ts": {
"@typescript-eslint/no-unused-vars": 1,
"jsdoc/tag-lines": 3
"jsdoc/require-returns": 1
},
"packages/multichain/src/scope/supported.ts": {
"@typescript-eslint/no-unsafe-enum-comparison": 4,
"jsdoc/tag-lines": 4
"@typescript-eslint/no-unsafe-enum-comparison": 7
},
"packages/multichain/src/scope/transform.ts": {
"jsdoc/tag-lines": 3
Expand Down
6 changes: 3 additions & 3 deletions packages/multichain/jest.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ module.exports = merge(baseConfig, {
// An object that configures minimum threshold enforcement for coverage results
coverageThreshold: {
global: {
branches: 100,
branches: 97.55,
functions: 100,
lines: 100,
statements: 100,
lines: 99.83,
statements: 99.84,
},
},
});
147 changes: 109 additions & 38 deletions packages/multichain/src/adapters/caip-permission-adapter-session-scopes.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import {
getInternalScopesObject,
getSessionScopes,
} from './caip-permission-adapter-session-scopes';
import {
KnownNotifications,
KnownRpcMethods,
KnownWalletNamespaceRpcMethods,
KnownWalletRpcMethods,
} from '../scope/constants';
import {
getInternalScopesObject,
getSessionScopes,
} from './caip-permission-adapter-session-scopes';

describe('CAIP-25 session scopes adapters', () => {
describe('getInternalScopesObject', () => {
Expand Down Expand Up @@ -37,15 +37,22 @@ describe('CAIP-25 session scopes adapters', () => {
});

describe('getSessionScopes', () => {
const getNonEvmSupportedMethods = jest.fn();

it('returns a NormalizedScopesObject for the wallet scope', () => {
const result = getSessionScopes({
requiredScopes: {},
optionalScopes: {
wallet: {
accounts: [],
const result = getSessionScopes(
{
requiredScopes: {},
optionalScopes: {
wallet: {
accounts: [],
},
},
},
});
{
getNonEvmSupportedMethods,
},
);

expect(result).toStrictEqual({
wallet: {
Expand All @@ -57,14 +64,19 @@ describe('CAIP-25 session scopes adapters', () => {
});

it('returns a NormalizedScopesObject for the wallet:eip155 scope', () => {
const result = getSessionScopes({
requiredScopes: {},
optionalScopes: {
'wallet:eip155': {
accounts: ['wallet:eip155:0xdeadbeef'],
const result = getSessionScopes(
{
requiredScopes: {},
optionalScopes: {
'wallet:eip155': {
accounts: ['wallet:eip155:0xdeadbeef'],
},
},
},
});
{
getNonEvmSupportedMethods,
},
);

expect(result).toStrictEqual({
'wallet:eip155': {
Expand All @@ -75,53 +87,112 @@ describe('CAIP-25 session scopes adapters', () => {
});
});

it('returns a NormalizedScopesObject with empty methods and notifications for scope with wallet namespace and unknown reference', () => {
const result = getSessionScopes({
requiredScopes: {},
optionalScopes: {
'wallet:foobar': {
accounts: ['wallet:foobar:0xdeadbeef'],
it('gets methods from getNonEvmSupportedMethods for scope with wallet namespace and non-evm reference', () => {
getNonEvmSupportedMethods.mockReturnValue(['nonEvmMethod']);

const result = getSessionScopes(
{
requiredScopes: {},
optionalScopes: {
'wallet:foobar': {
accounts: ['wallet:foobar:0xdeadbeef'],
},
},
},
});
{
getNonEvmSupportedMethods,
},
);

expect(getNonEvmSupportedMethods).toHaveBeenCalledWith('wallet:foobar');
});

it('returns a NormalizedScopesObject with methods from getNonEvmSupportedMethods and empty notifications for scope with wallet namespace and non-evm reference', () => {
getNonEvmSupportedMethods.mockReturnValue(['nonEvmMethod']);

const result = getSessionScopes(
{
requiredScopes: {},
optionalScopes: {
'wallet:foobar': {
accounts: ['wallet:foobar:0xdeadbeef'],
},
},
},
{
getNonEvmSupportedMethods,
},
);

expect(result).toStrictEqual({
'wallet:foobar': {
methods: [],
methods: ['nonEvmMethod'],
notifications: [],
accounts: ['wallet:foobar:0xdeadbeef'],
},
});
});

it('returns a NormalizedScopesObject with empty methods and notifications for scope not wallet namespace and unknown reference', () => {
const result = getSessionScopes({
requiredScopes: {},
optionalScopes: {
'foo:1': {
accounts: ['foo:1:0xdeadbeef'],
it('gets methods from getNonEvmSupportedMethods for scope non-evm namespace', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
it('gets methods from getNonEvmSupportedMethods for scope non-evm namespace', () => {
it('gets methods from getNonEvmSupportedMethods for non-evm (not `eip155`, `wallet` or `wallet:eip155`) scopes', () => {

getNonEvmSupportedMethods.mockReturnValue(['nonEvmMethod']);

const result = getSessionScopes(
{
requiredScopes: {},
optionalScopes: {
'foo:1': {
accounts: ['foo:1:0xdeadbeef'],
},
},
},
});
{
getNonEvmSupportedMethods,
},
);

expect(getNonEvmSupportedMethods).toHaveBeenCalledWith('foo:1');
});

it('returns a NormalizedScopesObject with methods from getNonEvmSupportedMethods and empty notifications for scope non-evm namespace', () => {
getNonEvmSupportedMethods.mockReturnValue(['nonEvmMethod']);

const result = getSessionScopes(
{
requiredScopes: {},
optionalScopes: {
'foo:1': {
accounts: ['foo:1:0xdeadbeef'],
},
},
},
{
getNonEvmSupportedMethods,
},
);

expect(result).toStrictEqual({
'foo:1': {
methods: [],
methods: ['nonEvmMethod'],
notifications: [],
accounts: ['foo:1:0xdeadbeef'],
},
});
});

it('returns a NormalizedScopesObject for a eip155 namespaced scope', () => {
const result = getSessionScopes({
requiredScopes: {},
optionalScopes: {
'eip155:1': {
accounts: ['eip155:1:0xdeadbeef'],
const result = getSessionScopes(
{
requiredScopes: {},
optionalScopes: {
'eip155:1': {
accounts: ['eip155:1:0xdeadbeef'],
},
},
},
});
{
getNonEvmSupportedMethods,
},
);

expect(result).toStrictEqual({
'eip155:1': {
Expand Down
Loading
Loading