GemWallet API

Introduction

This packages builds a wrapper around the messaging system used to interact with the GemWallet extension. Client applications will be able to install this package from npm or via CDN. It also contains constants that may need to be imported into other repositories in the GemWallet project.

For instructions on how to integrate with GemWallet API, visit: https://gemwallet.app/docs/user-guide/introduction

Architecture

The API and the extension are communicating via Message events via cross-document messaging.

Architecture diagram

graph TD
    A[Browser event - Create a promise on the client] -->|Uses the GemWallet API| B[Browser Content Script]
    B --> |Uses the GemWallet API| C[Browser Background Script]
    C --> |Open GemWallet Extension with payload| D[Browser Background Script]
    D --> |Uses the GemWallet API| E[Browser Content Script]
    E[Browser Promise resolved]