Asset descriptions should be matching user locale

gomesalexandre commented 2 years ago

@shapeshift/operations Reserved for @sebfk

Overview

Currently in lib, we are using the asset descriptions from Coingecko API and getting only the en description from it. Similarly, our overriden descriptions are only in English.

We should make it so that descriptions are dynamic according to the user language.

Since we are calling asset-service's description, lib would be the best place to handle it and we could make this method accept a locale parameter to pick the right translation from Coingecko, or fallback to English if it isn't available for that language (empty string). See the Ethereum Coingecko API call.

For the overriden description, there are two ways to implement this:

Keep the naive descriptions.json implementation and index translations by locale: {[assetId: AssetId]: {[locale: string]: string} vs. {[assetId: AssetId]: string} currently
Make the overriden descriptions dynamic using a similar i18n logic as we have in web, and split them by language. This way, we could call polyglot.t() to get the description for the specific language, or fallback to English as we do in web currently

A web PR should also be made to bump the @shapeshiftoss/asset-service dependency and consume the updated description(assetId, locale) signature.

References and additional details

asset-service's description descriptions.json for the overriden descriptions Polyglot.js (node-polyglot in npm) web translations logic

Acceptance Criteria

The Coingecko description matching the user locale is returned from asset-service's description, or English as a fallback if unavailable
Overriden descriptions are implemented with internationalization and the overriden description matching the user local is returned, or English as a fallback

Need By Date

No response

Screenshots/Mockups

No response

Estimated effort

3 hours

Lychbot commented 2 years ago

Done listing in Dework here . Assigned to @sebfk and put you as a reviewer @gomesalexandre :)

gomesalexandre commented 2 years ago

Fixed by https://github.com/shapeshift/web/pull/2098

shapeshift / lib