Skip to content

Add getAssetMetadata action to MultichainAssetsController #5430

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.

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
merged 2 commits into from
Mar 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -773,4 +773,49 @@ describe('MultichainAssetsController', () => {
});
});
});

describe('getAssetMetadata', () => {
it('returns the metadata for a given asset', async () => {
const { messenger } = setupController({
state: {
accountsAssets: {
[mockSolanaAccount.id]: mockHandleRequestOnAssetsLookupReturnValue,
},
assetsMetadata: mockGetMetadataReturnValue.assets,
} as MultichainAssetsControllerState,
});

const assetId = 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1/slip44:501';

const metadata = messenger.call(
'MultichainAssetsController:getAssetMetadata',
assetId,
);

expect(metadata).toStrictEqual(
mockGetMetadataReturnValue.assets[assetId],
);
});

it('returns undefined if the asset metadata is not found', async () => {
const { messenger } = setupController({
state: {
accountsAssets: {
[mockSolanaAccount.id]: mockHandleRequestOnAssetsLookupReturnValue,
},
assetsMetadata: mockGetMetadataReturnValue.assets,
} as MultichainAssetsControllerState,
});

const assetId =
'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/token:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v';

const metadata = messenger.call(
'MultichainAssetsController:getAssetMetadata',
assetId,
);

expect(metadata).toBeUndefined();
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ export function getDefaultMultichainAssetsControllerState(): MultichainAssetsCon
return { accountsAssets: {}, assetsMetadata: {} };
}

export type MultichainAssetsControllerGetAssetMetadataAction = {
type: `${typeof controllerName}:getAssetMetadata`;
handler: MultichainAssetsController['getAssetMetadata'];
};

/**
* Returns the state of the {@link MultichainAssetsController}.
*/
Expand All @@ -90,7 +95,8 @@ export type MultichainAssetsControllerStateChangeEvent =
* Actions exposed by the {@link MultichainAssetsController}.
*/
export type MultichainAssetsControllerActions =
MultichainAssetsControllerGetStateAction;
| MultichainAssetsControllerGetStateAction
| MultichainAssetsControllerGetAssetMetadataAction;

/**
* Events emitted by {@link MultichainAssetsController}.
Expand Down Expand Up @@ -199,6 +205,8 @@ export class MultichainAssetsController extends BaseController<
'AccountsController:accountAssetListUpdated',
async (event) => await this.#handleAccountAssetListUpdatedEvent(event),
);

this.#registerMessageHandlers();
}

async #handleAccountAssetListUpdatedEvent(
Expand All @@ -215,6 +223,27 @@ export class MultichainAssetsController extends BaseController<
);
}

/**
* Constructor helper for registering the controller's messaging system
* actions.
*/
#registerMessageHandlers() {
this.messagingSystem.registerActionHandler(
'MultichainAssetsController:getAssetMetadata',
this.getAssetMetadata.bind(this),
);
}

/**
* Returns the metadata for the given asset
*
* @param asset - The asset to get metadata for
* @returns The metadata for the asset or undefined if not found.
*/
getAssetMetadata(asset: CaipAssetType): FungibleAssetMetadata | undefined {
return this.state.assetsMetadata[asset];
}

/**
* Function to update the assets list for an account
*
Expand Down
Loading