Skip to content

feat: Add non-fungible assets support to endowment:assets #3527

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

Merged
GuillaumeRx merged 10 commits into from
Jul 8, 2025
Merged

feat: Add non-fungible assets support to endowment:assets #3527

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b12cd7b
[WIP] Adding NFT
GuillaumeRx Jun 27, 2025
ddeeac8
Update types and fix errors
GuillaumeRx Jul 3, 2025
412e4cd
Add tests for non-fungible assets in `SnapController`
GuillaumeRx Jul 3, 2025
a62a222
use `selectiveUnion`
GuillaumeRx Jul 3, 2025
eb16618
improve usage of `selectiveUnion` and fix tests
GuillaumeRx Jul 3, 2025
2b8e872
simplify selectiveUnions
GuillaumeRx Jul 4, 2025
cb22331
add JSDocs
GuillaumeRx Jul 8, 2025
589bc39
add link to jsdoc
GuillaumeRx Jul 8, 2025
915ac50
fix jsdoc
GuillaumeRx Jul 8, 2025
0c4d61d
update `OnAssetsMarketDataResponse` JSDoc
GuillaumeRx Jul 8, 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
250 changes: 246 additions & 4 deletions packages/snaps-controllers/src/snaps/SnapController.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4118,7 +4118,7 @@ describe('SnapController', () => {
},
}),
).rejects.toThrow(
`Assertion failed: At path: assets.foo -- Expected a value of type \`CaipAssetType\`, but received: \`"foo"\`.`,
`Assertion failed: At path: assets.foo -- Expected a value of type \`CaipAssetTypeOrId\`, but received: \`"foo"\`.`,
);

snapController.destroy();
Expand Down Expand Up @@ -4200,7 +4200,7 @@ describe('SnapController', () => {
snapController.destroy();
});

it('returns the value when `onAssetsLookup` returns a valid response', async () => {
it('returns the value when `onAssetsLookup` returns a valid response for fungible assets', async () => {
const rootMessenger = getControllerMessenger();
const messenger = getSnapControllerMessenger(rootMessenger);
const snapController = getSnapController(
Expand Down Expand Up @@ -4291,6 +4291,126 @@ describe('SnapController', () => {

snapController.destroy();
});

it('returns the value when `onAssetsLookup` returns a valid response for non-fungible assets', async () => {
const rootMessenger = getControllerMessenger();
const messenger = getSnapControllerMessenger(rootMessenger);
const snapController = getSnapController(
getSnapControllerOptions({
messenger,
state: {
snaps: getPersistedSnapsState(),
},
}),
);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
() => ({
[SnapEndowments.Assets]: {
caveats: [
{
type: SnapCaveatType.ChainIds,
value: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'],
},
],
date: 1664187844588,
id: 'izn0WGUO8cvq_jqvLQuQP',
invoker: MOCK_SNAP_ID,
parentCapability: SnapEndowments.Assets,
},
}),
);

rootMessenger.registerActionHandler(
'SubjectMetadataController:getSubjectMetadata',
() => MOCK_SNAP_SUBJECT_METADATA,
);

rootMessenger.registerActionHandler(
'ExecutionService:handleRpcRequest',
async () =>
Promise.resolve({
assets: {
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w':
{
fungible: false,
name: 'Persky Penguins #398',
symbol: 'PENGUIN',
imageUrl: `https://metamask.io/pinguin.svg`,
description:
'A nice penguin from the Persky Penguins collection.',
acquiredAt: 1750941834,
isPossibleSpam: false,
attributes: {
type: 'Alien',
accessories: 'Headband',
age: 32,
},
collection: {
name: 'Persky Penguins',
address:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvd:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w',
symbol: 'PENGUIN',
tokenCount: 10000,
creator:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvd:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w',
imageUrl: `https://metamask.io/pinguin.svg`,
},
},
},
}),
);

expect(
await snapController.handleRequest({
snapId: MOCK_SNAP_ID,
origin: METAMASK_ORIGIN,
handler: HandlerType.OnAssetsLookup,
request: {
jsonrpc: '2.0',
method: ' ',
params: {
assets: [
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w',
],
},
id: 1,
},
}),
).toStrictEqual({
assets: {
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w':
{
fungible: false,
name: 'Persky Penguins #398',
symbol: 'PENGUIN',
imageUrl: `https://metamask.io/pinguin.svg`,
description:
'A nice penguin from the Persky Penguins collection.',
acquiredAt: 1750941834,
isPossibleSpam: false,
attributes: {
type: 'Alien',
accessories: 'Headband',
age: 32,
},
collection: {
name: 'Persky Penguins',
address:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvd:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w',
symbol: 'PENGUIN',
tokenCount: 10000,
creator:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvd:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w',
imageUrl: `https://metamask.io/pinguin.svg`,
},
},
},
});

snapController.destroy();
});
});

describe('onAssetsConversion', () => {
Expand Down Expand Up @@ -4571,7 +4691,7 @@ describe('SnapController', () => {
},
}),
).rejects.toThrow(
`Assertion failed: At path: marketData.foo -- Expected a value of type \`CaipAssetType\`, but received: \`"foo"\`.`,
`Assertion failed: At path: marketData.foo -- Expected a value of type \`CaipAssetTypeOrId\`, but received: \`"foo"\`.`,
);

snapController.destroy();
Expand Down Expand Up @@ -4650,7 +4770,7 @@ describe('SnapController', () => {
snapController.destroy();
});

it('returns the value when `onAssetsMarketData` returns a valid response', async () => {
it('returns the value when `onAssetsMarketData` returns a valid response for fungible assets', async () => {
const rootMessenger = getControllerMessenger();
const messenger = getSnapControllerMessenger(rootMessenger);
const snapController = getSnapController(
Expand Down Expand Up @@ -4734,6 +4854,128 @@ describe('SnapController', () => {

snapController.destroy();
});

it('returns the value when `onAssetsMarketData` returns a valid response for non-fungible assets', async () => {
const rootMessenger = getControllerMessenger();
const messenger = getSnapControllerMessenger(rootMessenger);
const snapController = getSnapController(
getSnapControllerOptions({
messenger,
state: {
snaps: getPersistedSnapsState(),
},
}),
);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
() => ({
[SnapEndowments.Assets]: {
caveats: [
{
type: SnapCaveatType.ChainIds,
value: ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'],
},
],
date: 1664187844588,
id: 'izn0WGUO8cvq_jqvLQuQP',
invoker: MOCK_SNAP_ID,
parentCapability: SnapEndowments.Assets,
},
}),
);

rootMessenger.registerActionHandler(
'SubjectMetadataController:getSubjectMetadata',
() => MOCK_SNAP_SUBJECT_METADATA,
);

rootMessenger.registerActionHandler(
'ExecutionService:handleRpcRequest',
async () =>
Promise.resolve({
marketData: {
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w':
{
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
fungible: false,
lastSale: {
asset:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
amount: '123',
},
topBid: {
asset:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
amount: '123',
},
floorPrice: {
asset:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
amount: '123',
},
rarity: {
ranking: { source: 'source', rank: 1 },
metadata: { attribute1: 1, attribute2: 2 },
},
},
},
},
}),
);

expect(
await snapController.handleRequest({
snapId: MOCK_SNAP_ID,
origin: METAMASK_ORIGIN,
handler: HandlerType.OnAssetsMarketData,
request: {
jsonrpc: '2.0',
method: ' ',
params: {
assets: [
{
asset:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w',
unit: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
},
],
},
id: 1,
},
}),
).toStrictEqual({
marketData: {
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:Fz6LxeUg5qjesYX3BdmtTwyyzBtMxk644XiTqU5W3w9w':
{
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
fungible: false,
lastSale: {
asset:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
amount: '123',
},
topBid: {
asset:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
amount: '123',
},
floorPrice: {
asset:
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/nft:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
amount: '123',
},
rarity: {
ranking: { source: 'source', rank: 1 },
metadata: { attribute1: 1, attribute2: 2 },
},
},
},
},
});

snapController.destroy();
});
});

describe('onAssetHistoricalPrice', () => {
Expand Down
11 changes: 6 additions & 5 deletions packages/snaps-controllers/src/snaps/SnapController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ import type {
ComponentOrElement,
ContentType,
OnAssetsLookupResponse,
FungibleAssetMetadata,
OnAssetsConversionResponse,
OnAssetsConversionArguments,
AssetConversion,
OnAssetsLookupArguments,
OnAssetsMarketDataArguments,
FungibleAssetMarketData,
OnAssetsMarketDataResponse,
AssetMarketData,
AssetMetadata,
} from '@metamask/snaps-sdk';
import {
AuxiliaryFileEncoding,
Expand Down Expand Up @@ -118,6 +118,7 @@ import type {
JsonRpcRequest,
Hex,
SemVerVersion,
CaipAssetTypeOrId,
} from '@metamask/utils';
import {
hexToNumber,
Expand Down Expand Up @@ -3854,9 +3855,9 @@ export class SnapController extends BaseController<
const { assets: requestedAssets } = requestedParams;

const filteredAssets = Object.keys(assets).reduce<
Record<CaipAssetType, FungibleAssetMetadata | null>
Record<CaipAssetType, AssetMetadata | null>
>((accumulator, assetType) => {
const castAssetType = assetType as CaipAssetType;
const castAssetType = assetType as CaipAssetTypeOrId;
const isValid =
scopes.some((scope) => castAssetType.startsWith(scope)) &&
requestedAssets.includes(castAssetType);
Expand Down Expand Up @@ -3920,7 +3921,7 @@ export class SnapController extends BaseController<
const { assets: requestedAssets } = requestedParams;

const filteredMarketData = requestedAssets.reduce<
Record<CaipAssetType, Record<CaipAssetType, FungibleAssetMarketData>>
Record<CaipAssetTypeOrId, Record<CaipAssetType, AssetMarketData | null>>
>((accumulator, assets) => {
const result = marketData[assets.asset]?.[assets.unit];
// Only include rates that were actually requested.
Expand Down
14 changes: 14 additions & 0 deletions packages/snaps-execution-environments/src/common/validation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,12 @@ describe('assertIsOnAssetsLookupRequestArguments', () => {
'bip122:000000000019d6689c085ae165831e93/slip44:0',
],
},
{
assets: [
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
'hedera:mainnet/nft:0.0.55492/12',
],
},
])('does not throw for a valid assets lookup param object', (value) => {
expect(() => assertIsOnAssetsLookupRequestArguments(value)).not.toThrow();
});
Expand Down Expand Up @@ -326,6 +332,14 @@ describe('assertIsOnAssetsMarketDataRequestArguments', () => {
},
],
},
{
assets: [
{
asset: 'hedera:mainnet/nft:0.0.55492/12',
unit: 'swift:0/iso4217:USD',
},
],
},
])('does not throw for a valid assets market data param object', (value) => {
expect(() =>
assertIsOnAssetsMarketDataRequestArguments(value),
Expand Down
5 changes: 3 additions & 2 deletions packages/snaps-execution-environments/src/common/validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import type {
} from '@metamask/utils';
import {
assertStruct,
CaipAssetTypeOrIdStruct,
CaipAssetTypeStruct,
CaipChainIdStruct,
JsonRpcIdStruct,
Expand Down Expand Up @@ -259,7 +260,7 @@ export const OnAssetsMarketDataRequestArgumentsStruct = object({
assets: size(
array(
object({
asset: CaipAssetTypeStruct,
asset: CaipAssetTypeOrIdStruct,
unit: CaipAssetTypeStruct,
}),
),
Expand Down Expand Up @@ -287,7 +288,7 @@ export function assertIsOnAssetsMarketDataRequestArguments(
}

export const OnAssetsLookupRequestArgumentsStruct = object({
assets: size(array(CaipAssetTypeStruct), 1, Infinity),
assets: size(array(CaipAssetTypeOrIdStruct), 1, Infinity),
});

export type OnAssetsLookupRequestArguments = Infer<
Expand Down
Loading
Loading