Skip to content

fix: Update name and symbol to be optional in a fungible asset type #3300

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 2 commits into from
Apr 4, 2025
Merged

fix: Update name and symbol to be optional in a fungible asset type #3300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a833d5
update `name` and `symbol` to be optional in a fungible asset type
GuillaumeRx Apr 4, 2025
b0c6bb1
rebuild after rebase
GuillaumeRx Apr 4, 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
2 changes: 1 addition & 1 deletion packages/examples/packages/browserify-plugin/snap.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "ipeiQKWLZEg5Snm73jZkQ7VeusFnAMPd4ws5zWo7/NI=",
"shasum": "2uIeFUIcHICTP107dLNcmwrygQ30DCecekANd1w8H5w=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/packages/browserify/snap.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "uPtVkZpOxZzVcTSWX40MuXbED38DLAf9hNiNAR88+10=",
"shasum": "IAqCgqZhLCgTRIjIzVwfBIMVDVoCjZNcefMp/Vlmsz8=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/snaps-controllers/coverage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"branches": 93.48,
"branches": 93.54,
"functions": 97.38,
"lines": 98.34,
"statements": 98.08
Expand Down
72 changes: 72 additions & 0 deletions packages/snaps-controllers/src/interface/utils.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1064,6 +1064,78 @@ describe('getAssetSelectorStateValue', () => {
),
).toBeNull();
});

it('sets the asset name to the symbol if the asset name is undefined in state', () => {
getAssetsState.mockReturnValue({
assetsMetadata: {
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
symbol: 'SOL',
},
},
accountsAssets: {
[MOCK_ACCOUNT_ID]: [],
},
});

expect(
getAssetSelectorStateValue(
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
getAssetsState,
),
).toStrictEqual({
asset: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
name: 'SOL',
symbol: 'SOL',
});
});

it('sets the asset symbol to "Unknown" if the asset symbol is undefined in state', () => {
getAssetsState.mockReturnValue({
assetsMetadata: {
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
name: 'Solana',
},
},
accountsAssets: {
[MOCK_ACCOUNT_ID]: [],
},
});

expect(
getAssetSelectorStateValue(
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
getAssetsState,
),
).toStrictEqual({
asset: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
name: 'Solana',
symbol: 'Unknown',
});
});

it('sets the asset symbol and name to "Unknown" if both are undefined in state', () => {
getAssetsState.mockReturnValue({
assetsMetadata: {
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501': {
fungible: true,
},
},
accountsAssets: {
[MOCK_ACCOUNT_ID]: [],
},
});

expect(
getAssetSelectorStateValue(
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
getAssetsState,
),
).toStrictEqual({
asset: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
name: 'Unknown',
symbol: 'Unknown',
});
});
});

describe('getDefaultAsset', () => {
Expand Down
4 changes: 2 additions & 2 deletions packages/snaps-controllers/src/interface/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,8 +280,8 @@ export function getAssetSelectorStateValue(

return {
asset: value,
name: asset.name,
symbol: asset.symbol,
name: asset.name ?? asset.symbol ?? 'Unknown',
symbol: asset.symbol ?? 'Unknown',
};
}

Expand Down
25 changes: 25 additions & 0 deletions packages/snaps-sdk/src/types/handlers/assets-lookup.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,31 @@ describe('FungibleAssetMetadataStruct', () => {
},
],
},
{
fungible: true,
iconUrl: 'https://metamask.io/sol.svg',
units: [
{
decimals: 9,
},
],
},
{
name: 'Solana',
symbol: 'SOL',
fungible: true,
iconUrl: 'https://metamask.io/sol.svg',
units: [
{
name: 'Solana',
symbol: 'SOL',
decimals: 9,
},
{
decimals: 10,
},
],
},
])('validates an object', (value) => {
expect(is(value, FungibleAssetMetadataStruct)).toBe(true);
});
Expand Down
9 changes: 5 additions & 4 deletions packages/snaps-sdk/src/types/handlers/assets-lookup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
string,
record,
nullable,
optional,
} from '@metamask/superstruct';
import {
assert,
Expand All @@ -17,8 +18,8 @@ import {
} from '@metamask/utils';

export const FungibleAssetUnitStruct = object({
name: string(),
symbol: string(),
name: optional(string()),
symbol: optional(string()),
decimals: number(),
});

Expand All @@ -39,8 +40,8 @@ export const AssetIconUrlStruct = refine(string(), 'Asset URL', (value) => {
});

export const FungibleAssetMetadataStruct = object({
name: string(),
symbol: string(),
name: optional(string()),
symbol: optional(string()),
fungible: literal(true),
iconUrl: AssetIconUrlStruct,
units: size(array(FungibleAssetUnitStruct), 1, Infinity),
Expand Down
Loading