JSPM

@chainsafe/metamask-polkadot-adapter

0.8.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 130
  • Score
    100M100P100Q100358F
  • License Apache-2.0

Package Exports

  • @chainsafe/metamask-polkadot-adapter
  • @chainsafe/metamask-polkadot-adapter/build/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@chainsafe/metamask-polkadot-adapter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Metamask <> Polkadot snap adapter

Discord

Metamask <> Polkadot snap adapter is used to inject polkadot snap 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 or read full polkadot snap documentation.

Usage

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

Usage to inject snap in injectedWeb3 object

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;
}