Requests for Insights Integrations

[hugomrdias]

Metamask Snaps supports Transaction and Signature Insights.

Filsnap has support for multiple insights both for transactions and signatures and we would like to integrate with other projects to provide extra Filecoin specific information to users.

Important

We are asking anyone using smart contracts, custom signatures or any custom transactions to suggest an integration in this discussion.

We can build new insights and provide extra information inside the Metamask UI like in the examples below.

At this point we are looking to gather interest in this feature, we will try to implement a couple more insights from this discussion and in the future open for direct PRs from the community.

Post your use case we will keep an eye out and pick some to be included in the next snap version.

Check out this wagmi example using filsnap-adapter to enable insights.

Handler Examples

Transaction Insights for FilForwarder calls. source

Signatures Insights showing the Filecoin addresses for the 0x address requesting a signature. source

Interfaces

Insight handlers have the following interface:

export interface TransactionInsightsProps {
  transaction: Transaction
  chainId: CaipChainId
  transactionOrigin?: string
}

export type TransactionInsightsHandler = (
  props: TransactionInsightsProps,
  config: SnapConfig
) => Promisable<OnTransactionResponse | null>

export interface SignatureInsightsProps {
  signature: Signature
  signatureOrigin?: string
}

export type SignatureInsightsHandler = (
  props: SignatureInsightsProps,
  config: SnapConfig
) => Promisable<OnSignatureResponse | null>

/**
 * The response from a Snap's `onSignature` handler.
 *
 * @property component - A custom UI component, that will be shown in MetaMask.
 * @property id - A Snap interface ID.
 * @property severity - The severity level of the content. Currently only one
 * level is supported: `critical`.
 */
export type OnSignatureResponse = {
    content: Component;
    severity?: EnumToUnion<SeverityLevel>;
} | {
    id: string;
    severity?: EnumToUnion<SeverityLevel>;
};

/**
 * The response from a Snap's `onTransaction` handler.
 *
 * @property component - A custom UI component, that will be shown in MetaMask.
 * @property id - A Snap interface ID.
 * @property severity - The severity level of the content. Currently only one
 * level is supported: `critical`.
 */
export type OnTransactionResponse = {
    content: ComponentOrElement;
    severity?: EnumToUnion<SeverityLevel>;
} | {
    id: string;
    severity?: EnumToUnion<SeverityLevel>;
};

New Transaction handlers should be added here

filsnap/packages/snap/src/index.tsx

Line 309 in 5e2c58c

const handlers = [handleFilFowarder]

and Signature handlers here

filsnap/packages/snap/src/index.tsx

Line 342 in 5e2c58c

const handlers = [handleBaseSignature]

each handler can return a JSX Component or null if the transaction or signature is not supported.

Warning

Keep in mind first handler to return a Component wins no other handlers in the list will run.