# @bifrost-finance/metamask-bifrost-adapter

> ![](https://github.com/chainsafe/metamask-snap-polkadot/workflows/ci/badge.svg) ![](https://img.shields.io/github/license/chainsafe/metamask-snap-polkadot) ![](https://img.shields.io/badge/yarn-%3E%3D1.17.0-orange.svg?style=flat-square) ![Discord](https:/

Latest version **0.6.0** (published 2023-11-27) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @bifrost-finance/metamask-bifrost-adapter
pnpm add @bifrost-finance/metamask-bifrost-adapter
yarn add @bifrost-finance/metamask-bifrost-adapter
bun add @bifrost-finance/metamask-bifrost-adapter
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2023-11-27 |
| First published | 2023-11-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 19.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ChainSafe |
| Maintainers | ark930, herryheyi, janpo, sorvik, chencheng_bifrost |
| Keywords | polkadot, metamask, snap, substrate |

## Links

- npm: https://www.npmjs.com/package/@bifrost-finance/metamask-bifrost-adapter
- Homepage: https://github.com/chainsafe/metamask-snap-polkadot/tree/master/packages/adapter
- npm.io page: https://npm.io/package/@bifrost-finance/metamask-bifrost-adapter

## Dependencies (3)

- [@polkadot/api](https://npm.io/package/@polkadot/api.md) ^10.9.1
- [@polkadot/types-augment](https://npm.io/package/@polkadot/types-augment.md) ^10.9.1
- [@polkadot/extension-inject](https://npm.io/package/@polkadot/extension-inject.md) ^0.46.5

## Recent versions

- 0.6.0 (latest) — 2023-11-27

## README

# Metamask <> Polkadot snap adapter
![](https://github.com/chainsafe/metamask-snap-polkadot/workflows/ci/badge.svg)
![](https://img.shields.io/github/license/chainsafe/metamask-snap-polkadot)
![](https://img.shields.io/badge/yarn-%3E%3D1.17.0-orange.svg?style=flat-square)
![Discord](https://img.shields.io/discord/608204864593461248?color=blue&label=Discord&logo=discord)

Metamask <> Polkadot snap adapter is used to inject [polkadot snap](https://github.com/chainsafe/metamask-snap-polkadot) as web3 provider. It lists snap inside `window.injectedWeb3[injectedSnapId]`(*) so it can be enabled using `@polkadot/extension-dapp` package.  

*injectedSnapId default is "metamask-polkadot-snap"

For more details on polkadot snap itself see [snap repo](https://github.com/chainsafe/metamask-snap-polkadot) or read full [polkadot snap documentation](https://github.com/chainsafe/metamask-snap-polkadot/wiki).

## Usage

```typescript
function enablePolkadotSnap(
  config?: SnapConfig,
  snapOrigin?: string,
  snapInstallationParams?: Record<SnapInstallationParamNames, unknown> = {}
): Promise<MetamaskPolkadotSnap>
```

## Usage to inject snap in injectedWeb3 object

```typescript
function initPolkadotSnap(
  {
    config?: SnapConfig,
    snapOrigin?: string,
    snapInstallationParams?: Record<SnapInstallationParamNames, unknown> = {}
  },
  injectedSnapId?: string
): Promise<MetamaskPolkadotSnap>
```

By providing `config` as argument it is possible to override default configurations.

Default config:
```
{
  networkName: 'westend'
}
```

Configuration structure is shown below.

```
SnapConfig {
  networkName: SnapNetworks;
  wsRpcUrl?: string;
  addressPrefix?: number;
  unit?: UnitConfiguration;
}

SnapNetworks = "polkadot" | "kusama" | "westend";

UnitConfiguration {
  symbol: string;
  decimals: number;
  image?: string;
  customViewUrl?: string;
}
```

---
_Source: https://npm.io/package/@bifrost-finance/metamask-bifrost-adapter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._