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: create merger and factory for the Caip25Permission #5283

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
+548 −24
Open

feat: create merger and factory for the Caip25Permission #5283

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d240951
feat: add merger function to caip25 specification builder
ffmcgee725 Feb 4, 2025
6fc8f08
refactor: code clean up
ffmcgee725 Feb 4, 2025
a057674
refactor: minor change
ffmcgee725 Feb 4, 2025
19d8725
test: unit tests for merger
ffmcgee725 Feb 5, 2025
de396ba
feat: add factory method to caip25 specification builder
ffmcgee725 Feb 5, 2025
058a08c
address code review
ffmcgee725 Feb 5, 2025
29965df
test: fix nested describe block
ffmcgee725 Feb 5, 2025
beda24f
test: fix builds the expected permission specification after factory …
ffmcgee725 Feb 5, 2025
99939da
test: add test for factory method
ffmcgee725 Feb 6, 2025
145cc29
refactor: code review changes
ffmcgee725 Feb 11, 2025
c2d3d9d
Merge branch 'main' into jc/merger-caip25-permission
ffmcgee725 Feb 11, 2025
40bec46
lint
ffmcgee725 Feb 11, 2025
1f9e0de
lint:eslint
ffmcgee725 Feb 11, 2025
dbaeb6e
code review changes
ffmcgee725 Feb 12, 2025
c32d5c7
ci
ffmcgee725 Feb 12, 2025
8d56917
fix
ffmcgee725 Feb 12, 2025
7fa8016
lint:eslint
ffmcgee725 Feb 12, 2025
0bb6877
code review
ffmcgee725 Feb 12, 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
4 changes: 2 additions & 2 deletions packages/multichain/src/adapters/caip-permission-adapter-session-scopes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
KnownWalletNamespaceRpcMethods,
KnownWalletRpcMethods,
} from '../scope/constants';
import { mergeScopes } from '../scope/transform';
import { mergeNormalizedScopes } from '../scope/transform';
import type {
InternalScopesObject,
NonWalletKnownCaipNamespace,
Expand Down Expand Up @@ -94,7 +94,7 @@ export const getSessionScopes = (
'requiredScopes' | 'optionalScopes'
>,
) => {
return mergeScopes(
return mergeNormalizedScopes(
getNormalizedScopesObject(caip25CaveatValue.requiredScopes),
getNormalizedScopesObject(caip25CaveatValue.optionalScopes),
);
Expand Down
245 changes: 244 additions & 1 deletion packages/multichain/src/caip25Permission.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import {
CaveatMutatorOperation,
type PermissionConstraint,
type PermissionOptions,
PermissionType,
constructPermission,
} from '@metamask/permission-controller';

import type { Caip25CaveatValue } from './caip25Permission';
Expand All @@ -20,6 +23,11 @@ jest.mock('./scope/supported', () => ({
}));
const MockScopeSupported = jest.mocked(ScopeSupported);

jest.mock('@metamask/permission-controller', () => ({
...jest.requireActual('@metamask/permission-controller'),
constructPermission: jest.fn(),
}));

jiexi marked this conversation as resolved.
Show resolved Hide resolved
const { removeAccount, removeScope } = Caip25CaveatMutators[Caip25CaveatType];

describe('caip25EndowmentBuilder', () => {
Expand All @@ -37,10 +45,40 @@ describe('caip25EndowmentBuilder', () => {
endowmentGetter: expect.any(Function),
allowedCaveats: [Caip25CaveatType],
validator: expect.any(Function),
factory: expect.any(Function),
});

expect(specification.endowmentGetter()).toBeNull();
});

describe('factory', () => {
const { factory } = caip25EndowmentBuilder.specificationBuilder({
methodHooks: {
findNetworkClientIdByChainId: jest.fn(),
listAccounts: jest.fn(),
},
});

it('should call `constructPermission` with provided options', () => {
const mockRequestData = { origin: 'test.com' };
const mockOptions: PermissionOptions<PermissionConstraint> = {
caveats: [
{
type: Caip25CaveatType,
value: {
requiredScopes: {},
optionalScopes: {},
isMultichainOrigin: true,
},
},
],
target: Caip25EndowmentPermissionName,
invoker: 'test.com',
};
factory(mockOptions, mockRequestData);
expect(constructPermission).toHaveBeenCalledWith({ ...mockOptions });
});
});
});

describe('createCaip25Caveat', () => {
Expand Down Expand Up @@ -475,7 +513,7 @@ describe('caip25EndowmentBuilder', () => {
describe('caip25CaveatBuilder', () => {
const findNetworkClientIdByChainId = jest.fn();
const listAccounts = jest.fn();
const { validator } = caip25CaveatBuilder({
const { validator, merger } = caip25CaveatBuilder({
findNetworkClientIdByChainId,
listAccounts,
});
Expand Down Expand Up @@ -698,4 +736,209 @@ describe('caip25CaveatBuilder', () => {
}),
).toBeUndefined();
});

describe('permission merger', () => {
const initLeftValue: Caip25CaveatValue = {
optionalScopes: {
'eip155:1': {
accounts: ['eip155:1:0xdead'],
},
},
requiredScopes: {},
isMultichainOrigin: false,
};

it.each<{
rightValue: Caip25CaveatValue;
expectedMergedValue: Caip25CaveatValue;
expectedDiff: Caip25CaveatValue;
}>([
{
jiexi marked this conversation as resolved.
Show resolved Hide resolved
rightValue: {
optionalScopes: {
'eip155:1': {
accounts: ['eip155:1:0xbeef'],
},
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedMergedValue: {
optionalScopes: {
'eip155:1': { accounts: ['eip155:1:0xdead', 'eip155:1:0xbeef'] },
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedDiff: {
optionalScopes: {
'eip155:1': {
accounts: ['eip155:1:0xbeef'],
},
},
isMultichainOrigin: false,
requiredScopes: {},
},
},
{
rightValue: {
optionalScopes: {
'eip155:10': {
accounts: [],
},
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedMergedValue: {
optionalScopes: {
'eip155:1': { accounts: ['eip155:1:0xdead'] },
'eip155:10': {
accounts: [],
},
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedDiff: {
optionalScopes: {
'eip155:10': {
accounts: [],
},
},
isMultichainOrigin: false,
requiredScopes: {},
},
},
{
rightValue: {
optionalScopes: {
'eip155:10': {
accounts: ['eip155:10:0xbeef'],
},
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedMergedValue: {
optionalScopes: {
'eip155:1': { accounts: ['eip155:1:0xdead'] },
'eip155:10': { accounts: ['eip155:10:0xbeef'] },
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedDiff: {
optionalScopes: {
'eip155:10': {
accounts: ['eip155:10:0xbeef'],
},
},
isMultichainOrigin: false,
requiredScopes: {},
},
},
{
rightValue: {
optionalScopes: {
'eip155:1': {
accounts: ['eip155:1:0xdead', 'eip155:1:0xbeef'],
},
'eip155:10': {
accounts: ['eip155:10:0xdead', 'eip155:10:0xbeef'],
},
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedMergedValue: {
optionalScopes: {
'eip155:1': { accounts: ['eip155:1:0xdead', 'eip155:1:0xbeef'] },
'eip155:10': {
accounts: ['eip155:10:0xdead', 'eip155:10:0xbeef'],
},
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedDiff: {
optionalScopes: {
'eip155:1': {
accounts: ['eip155:1:0xbeef'],
},
'eip155:10': {
accounts: ['eip155:10:0xdead', 'eip155:10:0xbeef'],
},
},
isMultichainOrigin: false,
requiredScopes: {},
},
},
{
rightValue: {
optionalScopes: {
'eip155:1': {
accounts: ['eip155:1:0xdead', 'eip155:1:0xbadd'],
},
'eip155:10': {
accounts: ['eip155:10:0xbeef', 'eip155:10:0xbadd'],
},
'eip155:426161': {
accounts: [
'eip155:426161:0xdead',
'eip155:426161:0xbeef',
'eip155:426161:0xbadd',
],
},
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedMergedValue: {
optionalScopes: {
'eip155:1': { accounts: ['eip155:1:0xdead', 'eip155:1:0xbadd'] },
'eip155:10': {
accounts: ['eip155:10:0xbeef', 'eip155:10:0xbadd'],
},
'eip155:426161': {
accounts: [
'eip155:426161:0xdead',
'eip155:426161:0xbeef',
'eip155:426161:0xbadd',
],
},
},
requiredScopes: {},
isMultichainOrigin: false,
},
expectedDiff: {
optionalScopes: {
'eip155:1': { accounts: ['eip155:1:0xbadd'] },
'eip155:10': {
accounts: ['eip155:10:0xbeef', 'eip155:10:0xbadd'],
},
'eip155:426161': {
accounts: [
'eip155:426161:0xdead',
'eip155:426161:0xbeef',
'eip155:426161:0xbadd',
],
},
},
isMultichainOrigin: false,
requiredScopes: {},
},
},
])(
'should return the expected merged value $expectedMergedValue and expected diff $expectedDiff',
async ({ rightValue, expectedMergedValue, expectedDiff }) => {
const [newValue, diff] = merger(initLeftValue, rightValue);

expect(newValue).toStrictEqual(
expect.objectContaining(expectedMergedValue),
);
expect(diff).toStrictEqual(expect.objectContaining(expectedDiff));
},
);
});
});
Loading
Loading