Home

Welcome to Solana snap wiki!

Solana snap (plugin) enables Solana network inside Metamask and by doing this provides dApps easy integration.

Wiki covers snap architecture and integration steps, as well as detailed API documentation.

Contents

• Architecture
• Integration
• API Documentation

Architecture

Solana Metamask snap is installed using @solana-tools/solsnap-adapter. More details inside integration steps.

Integration

Prerequisites

• Add @solana-tools/solsnap-adapter package to your project.

yarn add @solana-tools/solsnap-adapter

• [Optional] Add types for the adapter to your project in case you will interact with snap specific API.

yarn add @solana-tools/solsnap-types

---

Integration steps

1. Install snap by calling enableSolanaSnap from @solana-tools/solsnap-adapter package.

This will prompt the user to:

• accept the snap installation
• accept all snap permissions

This function accepts the configuration object for defining network properties, the same as configure method from Solana Snap API. After successful installation, it will return a MetamaskSolanaSnap object.

2. Invoke Solana Snap API

MetamaskSolanaSnap object has an exposed method for obtaining API getSolanaSnapApi. For more details about exposed API see API documentation.