Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@metaplex-foundation/mpl-token-auth-rules

metaplex-foundation96.8kApache-2.03.0.3TypeScript support: included

Javascript SDK for MPL Token Authorization Rules. MPL Token Authorization Rules can be used to restrict common token operations

readme

JavaScript client for Mpl Token Auth Rules

A Umi-compatible JavaScript library for the project.

Getting started

  1. First, if you're not already using Umi, follow these instructions to install the Umi framework.
  2. Next, install this library using the package manager of your choice.
    npm install @metaplex-foundation/mpl-token-auth-rules
  3. Finally, register the library with your Umi instance like so.
    import { mplTokenAuthRules } from '@metaplex-foundation/mpl-token-auth-rules';
umi.use(mplTokenAuthRules());

You can learn more about this library's API by reading its generated TypeDoc documentation.

Contributing

Check out the Contributing Guide the learn more about how to contribute to this library.