Skip to content

README.md

Latest commit

 

History

History
37 lines (23 loc) · 1.08 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.08 KB
Raw

@metamask/gator-permissions-controller

A dedicated controller for reading gator permissions from profile sync storage. This controller fetches data from the encrypted user storage database and caches it locally, providing fast access to permissions across devices while maintaining privacy through client-side encryption.

Installation

yarn add @metamask/gator-permissions-controller

or

npm install @metamask/gator-permissions-controller

Usage

Basic Setup

import { GatorPermissionsController } from '@metamask/gator-permissions-controller';

// Create the controller
const gatorPermissionsController = new GatorPermissionsController({
  messenger: yourMessenger,
});

// Enable the feature (requires authentication)
gatorPermissionsController.enableGatorPermissions();

Fetch from Profile Sync

const permissions = await gatorPermissionsController.fetchAndUpdateGatorPermissions();

Contributing

This package is part of a monorepo. Instructions for contributing can be found in the monorepo README.