SIP-29 Improvements #155
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,85 +35,147 @@ in uppercase in this document are to be interpreted as described in [RFC | |
| 2. Any time an asset needs to be identified, it MUST use the [CAIP-19][caip-19] | ||
| representation. | ||
|
|
||
| ### Snap Manifest | ||
|
|
||
| This SIP introduces a new permission named `endowment:assets`. | ||
| This permission grants a Snap the ability to provide asset information to the client. | ||
|
|
||
| This permission is specified as follows in `snap.manifest.json` files: | ||
|
|
||
| ```json | ||
| { | ||
| "initialPermissions": { | ||
| "endowment:assets": { | ||
| "chains": [ | ||
| "bip122:000000000019d6689c085ae165831e93" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| `chains` - A non-empty array of CAIP-2 chain IDs that the snap supports. This field is useful for a client in order to avoid unnecessary overhead. | ||
|
|
||
| ### Snap Implementation | ||
|
|
||
| Two methods are defined in the Snap Assets API: | ||
|
|
||
| Any Snap that wishes to provide asset information **MUST** implement the following API: | ||
|
|
||
| #### Get Asset Description | ||
|
|
||
| ```typescript | ||
| import { OnAssetDescriptionHandler } from "@metamask/snaps-sdk"; | ||
|
|
||
| export const onAssetDescription: OnAssetDescriptionHandler = async ({ | ||
GuillaumeRx marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. I'm guessing this will be covered in another doc, but I'm curious how data is added to this list provided by the caller. How are assets discovered originally? There was a problem hiding this comment. This is covered by the kering API with the There was a problem hiding this comment. Then the snap uses any API that provides asset metadata to create its token description |
||
| assets | ||
| }) => { | ||
| const description = /* Get description */; | ||
| return { description }; | ||
| }; | ||
| ``` | ||
|
|
||
| The type for an `onAssetDescription` handler function’s arguments is: | ||
|
|
||
| ```typescript | ||
| interface OnAssetDescriptionArgs { | ||
| assets: Caip19AssetType[]; | ||
| } | ||
| ``` | ||
| The type for an `onAssetDescription` handler function’s return value is: | ||
|
|
||
| ```typescript | ||
| // { | ||
| // name: 'Ether', | ||
| // ticker: 'ETH', | ||
| // isNative: true, | ||
| // iconBase64: 'data:image/png;base64,...', | ||
| // units: [ | ||
| // { | ||
| // name: 'Ether', | ||
| // ticker: 'ETH', | ||
| // decimals: 18 | ||
| // }, | ||
| // { | ||
| // name: 'Gwei', | ||
| // ticker: 'Gwei', | ||
| // decimals: 9 | ||
| // }, | ||
| // { | ||
| // name: 'wei', | ||
| // ticker: 'wei', | ||
| // decimals: 0 | ||
| // } | ||
| // ] | ||
| // } | ||
|
|
||
| // Represents a asset unit. | ||
| type AssetUnit = { | ||
| // Human-friendly name of the asset unit. | ||
| name: string; | ||
|
|
||
| // Ticker of the asset unit. | ||
| ticker: string; | ||
|
|
||
| // Number of decimals of the asset unit. | ||
| decimals: number; | ||
| }; | ||
|
|
||
| // Asset description. | ||
| type AssetDescription = { | ||
| // The CAIP-19 ID of the asset. | ||
| id: Caip19AssetType; | ||
|
|
||
| // Human-friendly name of the asset. | ||
| name: string; | ||
|
|
||
| // Ticker of the asset. | ||
| ticker: string; | ||
|
|
||
| // Whether the asset is native to the chain. | ||
| isNative: boolean; | ||
|
|
||
| // Base64 representation of the asset icon. | ||
| iconBase64: string; | ||
|
|
||
| // List of asset units. | ||
| units: AssetUnit[]; | ||
| }; | ||
|
|
||
|
|
||
| type OnAssetDescriptionReturn = { | ||
| description: Record<Caip19AssetType, AssetDescription>; | ||
| }; | ||
| ``` | ||
|
|
||
| #### Get Asset Conversion Rate | ||
|
|
||
| ```typescript | ||
| import { OnAssetConversionHandler } from "@metamask/snaps-sdk"; | ||
|
|
||
| export const onAssetConversion: OnAssetConversionHandler = async ({ | ||
GuillaumeRx marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| from, | ||
| to | ||
| }) => { | ||
| const conversionRate = /* Get conversion rate */; | ||
| return { conversionRate }; | ||
| }; | ||
| ``` | ||
| The type for an `onAssetDescription` handler function’s arguments is: | ||
|
|
||
| ```typescript | ||
| interface OnAssetConversionArgs { | ||
| from: Caip19AssetType[]; | ||
| to: Caip19AssetType; | ||
GuillaumeRx marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| ``` | ||
| The type for an `onAssetDescription` handler function’s return value is: | ||
|
|
||
| ```typescript | ||
| type AssetConversionRate = { | ||
| // The rate of conversion from the source asset to the target asset. It | ||
| // means that 1 unit of the `from` asset should be converted to this amount | ||
| // of the `to` asset. | ||
| rate: string; | ||
|
|
||
| // The UNIX timestamp of when the conversion rate was last updated. | ||
|
|
@@ -123,26 +185,16 @@ type TokenConversionRate = { | |
| expirationTime: number; | ||
| }; | ||
|
|
||
|
|
||
| // { | ||
| // rate: '3906.38', | ||
| // conversionTime: 1733389786, | ||
| // expirationTime: 1733389816, | ||
| // } | ||
|
|
||
| type OnAssetConversionReturn = { | ||
| conversionRate: Record<Caip19AssetType, AssetConversionRate>; | ||
| }; | ||
| ``` | ||
|
|
||
| ### Fiat currency representation | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we allow namespaces as well? And we should probably name it
scopesto be aligned with SIP-26, CAIP-25/27.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's your thinking for allowing namespaces ? I would prefer this to be granular and to have to define reference supported rather than defining namespaces that would probably introduce calls for reference that are not supported