Skip to content

fix(cardano-services-client): enhance token metadata mapping to include on-chain metadata fields [LW-13249] #1641

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
merged 1 commit into from
Jul 14, 2025
Merged

fix(cardano-services-client): enhance token metadata mapping to include on-chain metadata fields [LW-13249] #1641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 9 additions & 6 deletions packages/cardano-services-client/src/AssetInfoProvider/BlockfrostAssetProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,16 +116,19 @@ export class BlockfrostAssetProvider extends BlockfrostProvider implements Asset
private mapTokenMetadata(assetId: Cardano.AssetId, asset: Responses['asset']): Asset.TokenMetadata {
return {
assetId,
decimals: asset.metadata?.decimals || undefined,
decimals:
(typeof asset.onchain_metadata?.decimals === 'number'
? asset.onchain_metadata.decimals
: asset.metadata?.decimals) || undefined,
desc: this.metadatumToString(
asset.metadata?.description || (asset.onchain_metadata?.description as string | string[] | undefined)
(asset.onchain_metadata?.description as string | string[] | undefined) || asset.metadata?.description
),
icon: this.metadatumToString(
asset.metadata?.logo || (asset.onchain_metadata?.image as string | string[] | undefined)
(asset.onchain_metadata?.image as string | string[] | undefined) || asset.metadata?.logo
),
name: asset.metadata?.name || (asset.onchain_metadata?.name as string | undefined),
ticker: asset.metadata?.ticker || undefined,
url: asset.metadata?.url || undefined,
name: (asset.onchain_metadata?.name as string | undefined) || asset.metadata?.name,
ticker: (asset.onchain_metadata?.ticker as string | undefined) || asset.metadata?.ticker || undefined,
url: (asset.onchain_metadata?.url as string | undefined) || asset.metadata?.url || undefined,
version: '1.0'
};
}
Expand Down
96 changes: 94 additions & 2 deletions packages/cardano-services-client/test/AssetInfoProvider/BlockfrostAssetProvider.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ describe('BlockfrostAssetProvider', () => {
assetId: mockedAssetId,
decimals: 6,
desc: 'The Nut Coin',
icon: 'iVBORw0KGgoAAAANSUhEUgAAADAAAAAoCAYAAAC4h3lxAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAAB3RJTUUH5QITCDUPjqwFHwAAB9xJREFUWMPVWXtsU9cZ/8499/r6dZ3E9rUdO7ZDEgglFWO8KaOsJW0pCLRKrN1AqqYVkqoqrYo0ja7bpElru1WairStFKY9WzaE1E1tx+jokKqwtqFNyhKahEJJyJNgJ37E9r1+3HvO/sFR4vhx7SBtfH/F3/l93/f7ne/4PBxEKYU72dj/ZfH772v1TU+HtqbTaX8wOO01GPQpRVH7JEm+vGHDuq6z7/8jUSoHKtaBKkEUFUXdajDy1hUrmrs6zn/wWS7m7pZVjMUirKGUTnzc+e9xLcTrPPVfZzDz06Sc2lyQGEIyAPzT7Xa+dvE/3e+XLaCxoflHsVj8MAAYs74aa/WHoenwvpkZKeFy2Z5NJlOPUkqXZccFwSSrKjlyffjLH+TL6XTUGTGL/6hklD3ldIrj2M5MRmkLBMcvaRLQ1Nj88sxM/HCBfMP+eu/OYGDqe6l0WmpoqJ/88upgrU7HrQNA/cFg6MlkKiLlBtVUO40cx54BgHvLIT/HJLvdeqh/4NKxogKWN7fsCoUi7xTLxLJ4vLq6ak//wKVOrdXtttrTDMPsqJA8AAAwDErdu3VL3alTf5ma9eWCpoKhn5dKpCiqJxicPucQPVu0FHaInn35yHMcKwPAa4SQ3QCwFgDWUko3qSr5vqqSgTypuEg4Mo/zvA74/Y0rZSnZU8akSHV17k2fXfy0txjI5224kEym1s/1EUI7LBbztweHrkzkizn49LP6U6feepFSeggAQK/n04SQZ8bGrxdeQjZrbRvGzLH5hcibRqOhPplMfS1fIY5jz4xPDBdcGggho2h3z9sOLRazdG3wqp9SMgUlzGZ17SSEPsRx7J8CwfGu3PF57WhqqjfN/VxVJUxKUrIdITAXKpDJKFscosdfaFy0u+/K9aXTmXe0kAcAmA5Nng5Hbj6Tj/wCAYFAcN7uEY3GXGazMSHLqVVFapgBoMPna9yqhRAAgCTJMa3YUjZPgNFkSlWYx5eUkx+0tKx83V3rF+cVYJjruWCe133DIXqMmrNrFSDabRcWkywYmG5XFOW6aHcfb9324CoAgMmbo9MIoXkneCajiAihV/c/8eSiBSw4BxyiZxQA6m7H7FBKT2CMn2MY5jFFUX6ZO+5w2j8aHZ7YH40FByrJD5DnHGAY5uTtIA8AgBDaR4F2Yxb3WizCgmtA4ObUPSazodduqz3Suu0hf0U1cjvgdNSJ1dWWveFwdDUAtAiC2Uopdcdi8c9Zlh3GmDGl05mtAKAvo47EcdwThJCjqqpWFxALlNITomg73tff21GRAJez7iVK4WGGYfoJIQduBsbm7UrLm1ueCoUiv65kpiilw1ZbzcFoZOYoIcRTAn6eYZgXJm+Oni+Vd3YJbdyweSch9HlK6SpVVfcyDDq7Yf3m2XPBIXraKyV/a4b9UkLawbLsZgB4rwR8CyGkw13r+5fX27BckwBAEJ47oKpk8+DgUIdod7fV1vqOAMDrlZLPmqKoB+rrvXIgOP6w0WjYy3Ls5RL4bUk52bVm9fqnCk7M3CXU2ND8+MxM7BcIIftiyRYyntcdHh0bmr0wfmXl6p2SJB2KRmP3l4j7zejYUFtRAQAAgslm1Bv4nyGEDpYiIwjmjw0G/RjP866JiclNqqqWfKLq9fyZkdHBBXcnl9O71GDgD8bj0ncRQqZ8sRgzL9yYHH2pqICsOUTPLgA4CXNeZFmzWIS/YhYfjUZmvqPjuceSckrz25pS2h2cmlhbaBwhzr6kfsnL8Xhif55YYFl23Y3Jkdl7EVMoUSA4/q6qqNsBIPd11e52u45FwtG3CSH7yiEPAGC1Vt9dXGBmanDoygFLlbAjtzZCCMyC6VeaOpA1l9N7l1kwtauKaozHE28YTQaQpeR7+TqjxXheR0fHhhgt2CX1S3clEtKC16HL5djYe+niBU0CcmYA2W21/Qih5ZqDcoxlMZ24MaJJAABA87IVJ8Lh6N65Pr1B/+LIyLUfAhRZQvnM6ah7ZDHkAQB0vK6/HHxNTc2ruT5Zkldn/y5LACFk+2LIAwAwCGl6yGSt88KHXbmrBCHkqEgAz+vWLFZALJb4qNwYhFDhCSknkSwnQ4sVgDFeWg7+gQe2r1tAmkGTFQlACHWVg89nhJA9ot3dphV/eeCLp/Pw6K5IQP0S39uLFXCLwDG7zf1cKZxD9LSlUunHc/12u/2t2Vzl/rzu8zb8PZlM7bwdQgDgPK/nX2nddt+53//ht3LW2dS0fF0iLj2vquojuQFmwXRucPBKa8UCmpe1iOFwpAsAfLdJBFBKwVIlXJ2JxqKCxbwyHkvoCkAlv9/71U+7Oq+UJWDZ0hViJBL1cRynbNq0sSeeiPl6ei4NqIqq6TSmlB7X6bjuTEY5pgWfzwxGPZhMpt39/b3vzvWXFGCzulZjjM/DrauDwcAr8bjcgzGjZUuVBMH8k2uDX7wCAFDr8n2LEPI7SqmhTP6SzVbz6MDlz0/nDpT8EmOM22HOvUeWU2wp8iyLgRL6hk7Hrc2SBwC4MTlykmXZRozxn00mbVcphNA5jJmV+chr6oDd5l6jN/A/TqfSuwEAGITGMIsvGo3GTwTB3Dc2NjGSxdZYq4VIOOoNBANnKE0XPXE3brjHOTQ08k2MmVZOxzVJCbkFIQSCYEphzPaFQuGzTpfjb319PZ8UFXin/5OvrHPg/9HueAH/BSUqOuNZm4fyAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIxLTAyLTE5VDA4OjUyOjI1KzAwOjAwCmFGlgAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMS0wMi0xOVQwODo1MjoyMyswMDowMBjsyxAAAAAASUVORK5CYII=',
name: 'nutcoin',
icon: mockedAssetResponse.onchain_metadata?.image as string,
name: mockedAssetResponse.onchain_metadata?.name as string,
ticker: 'nutc',
url: 'https://www.stakenuts.com/'
}
Expand Down Expand Up @@ -214,5 +214,97 @@ describe('BlockfrostAssetProvider', () => {

expect(response.nftMetadata!.version).toBe('2.0');
});

describe('onchain_metadata undefined values', () => {
const mockedAssetIdOnChainMetadata = Cardano.AssetId(
'ecbe846aa1a535579d67f9480fa6173b64d7e239df0460eba36e3ad00014df1053617475726e'
);

const baseResponse = {
asset: mockedAssetIdOnChainMetadata,
asset_name: '0014df1053617475726e',
fingerprint: 'asset1lnu3hw2pjw8xfprg7722mh0yu2vfzvk8ta60h0',
initial_mint_tx_hash: 'dcdd8ed32a71523a8393caab9d657964e50648fe0277de77add22b839e6fdb88',
metadata: null,
mint_or_burn_count: 1,
onchain_metadata: {
decimals: 6,
description:
'Saturn is the governance token for the Saturn Swap protocol, a fast and simple decentralized exchange on the Cardano blockchain. https://saturnswap.io/',
logo: 'ipfs://Qmc2RWQxCmAaXn7YGZsXCcs2J5uwW8qQwYzmjh1gUiZBWA',
mediaType: '49696d6167652f706e67',
name: 'Saturn',
ticker: 'SATURN',
url: 'ipfs://Qmc2RWQxCmAaXn7YGZsXCcs2J5'
},
onchain_metadata_extra: 'd8799fff',
onchain_metadata_standard: 'CIP68v1',
policy_id: 'ecbe846aa1a535579d67f9480fa6173b64d7e239df0460eba36e3ad0',
quantity: '100000000000000'
} as Responses['asset'];

test('handles undefined onchain_metadata.decimals', async () => {
const responseWithUndefinedDecimals = {
...baseResponse,
onchain_metadata: {
...baseResponse.onchain_metadata,
decimals: undefined
}
};

mockResponses(request, [[`assets/${mockedAssetIdOnChainMetadata}`, responseWithUndefinedDecimals]]);

const response = await provider.getAsset({
assetId: mockedAssetIdOnChainMetadata,
extraData: { tokenMetadata: true }
});

expect(response.tokenMetadata!.decimals).toBeUndefined();
expect(response.tokenMetadata!.ticker).toBe('SATURN');
expect(response.tokenMetadata!.url).toBe('ipfs://Qmc2RWQxCmAaXn7YGZsXCcs2J5');
});

test('handles undefined onchain_metadata.ticker', async () => {
const responseWithUndefinedTicker = {
...baseResponse,
onchain_metadata: {
...baseResponse.onchain_metadata,
ticker: undefined
}
};

mockResponses(request, [[`assets/${mockedAssetIdOnChainMetadata}`, responseWithUndefinedTicker]]);

const response = await provider.getAsset({
assetId: mockedAssetIdOnChainMetadata,
extraData: { tokenMetadata: true }
});

expect(response.tokenMetadata!.decimals).toBe(6);
expect(response.tokenMetadata!.ticker).toBeUndefined();
expect(response.tokenMetadata!.url).toBe('ipfs://Qmc2RWQxCmAaXn7YGZsXCcs2J5');
});

test('handles undefined onchain_metadata.url', async () => {
const responseWithUndefinedUrl = {
...baseResponse,
onchain_metadata: {
...baseResponse.onchain_metadata,
url: undefined
}
};

mockResponses(request, [[`assets/${mockedAssetIdOnChainMetadata}`, responseWithUndefinedUrl]]);

const response = await provider.getAsset({
assetId: mockedAssetIdOnChainMetadata,
extraData: { tokenMetadata: true }
});

expect(response.tokenMetadata!.decimals).toBe(6);
expect(response.tokenMetadata!.ticker).toBe('SATURN');
expect(response.tokenMetadata!.url).toBeUndefined();
});
});
});
});
Loading