mimir-apps-sdk

This SDK enables seamless integration between third-party applications and Mimir Wallet (https://app.mimir.global/).

The SDK maintains high compatibility with polkadot-js/extension methods, making it straightforward to integrate into existing applications.

Introduction

The Mimir Apps SDK provides a robust solution for integrating third-party applications with the Mimir Wallet. It offers high compatibility with the polkadot-js/extension, allowing developers to leverage existing methods and seamlessly integrate with Mimir's multisig features.

Installation

To install the SDK, you can use either yarn or npm:

Using Yarn

yarn add @mimirdev/apps-inject @mimirdev/apps-sdk

Using NPM

npm install @mimirdev/apps-inject @mimirdev/apps-sdk

Usage

Injecting the SDK

To inject the SDK into your application, ensure it is opened within Mimir's iframe. Use the following code snippet:

import { inject, isMimirReady, MIMIR_REGEXP } from '@mimirdev/apps-inject';

const origin = await isMimirReady();

if (MIMIR_REGEXP.test(origin)) {
  inject();
  // Now you can use polkadot extension functions
}

Security Considerations

When using Mimir's multisig feature, ensure that transactions are verified for safety. Mimir wraps transactions in AsMulti, so it's crucial to confirm that the wrapped transaction matches the expected transaction. Mimir's code is open source, ensuring transparency and security.

Overview

Package	Stable	Beta	Size
@mimirdev/apps-sdk
@mimirdev/apps-inject

Contributing

Please refer to our CONTRIBUTING.md guide.

Getting Started

• Integrating Mimir SDK into Existing Applications
• Upgrading to Version v1 for up to date integration with mimir