0.6.0 • Published 6 months ago

@chainsafe/metamask-polkadot-adapter v0.6.0

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
6 months ago

Metamask <> Polkadot snap adapter

npm.io npm.io npm.io Discord

Metamask <> Polkadot snap adapter is used to inject polkadot snap as web3 provider. It lists snap inside window.injectedWeb3["metamask-polkadot-snap"] so it can be enabled using @polkadot/extension-dapp package.

For more details on polkadot snap itself see snap repo or read full polkadot snap documentation.

Usage

Adapter has only one exposed function for injecting snap as web3 provider.

function injectMetamaskPolkadotSnapProvider(
  network: "westend"|"kusama",
  config?: SnapConfig,
  pluginOrigin?: string
): void

If only network argument is provided, predefined configuration for specific network will be used. By providing config as argument it is possible to override default configurations.

Configuration structure is shown below.

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

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