Plugins

The mplx core plugins commands allow you to manage plugins for MPL Core Assets and Collections. Plugins extend the functionality of assets and collections with additional features and capabilities.

Add Plugin

Add a plugin to an asset or collection.

Basic Usage

mplx core plugins add <assetId> [options]

Options

• --wizard: Interactive wizard mode to select and configure plugins
• --collection: Flag to indicate if the target is a collection (default: false)

Methods

1. Using Wizard Mode

mplx core plugins add <assetId> --wizard

This will:

1. Launch an interactive wizard to select the plugin type
2. Guide you through plugin configuration
3. Add the configured plugin to the asset/collection

2. Using JSON File

mplx core plugins add <assetId> ./plugin.json

The JSON file should contain the plugin configuration in the following format:

[
  {
    "pluginType": {
      "property1": "value1",
      "property2": "value2"
    }
  }
]

Examples

Add Plugin to Asset

mplx core plugins add 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --wizard

Add Plugin to Collection

mplx core plugins add 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --wizard --collection

Add Plugin Using JSON

mplx core plugins add 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa ./my-plugin.json

Output

After a successful plugin addition, the command will display:

--------------------------------
  Asset: <assetId>
  Signature: <transactionSignature>
  Explorer: <explorerUrl>
  Core Explorer: https://core.metaplex.com/explorer/<assetId>
--------------------------------

Notes

• The wizard mode provides an interactive way to select and configure plugins
• Different plugins are available for assets and collections
• Plugin configuration must be valid according to the plugin's requirements
• You must have the appropriate authority to add plugins to the asset or collection
• The command will automatically handle:
  • Plugin type validation
  • Configuration validation
  • Transaction signing and confirmation
  • Authority verification

Update Plugin

Update existing plugins on an asset or collection.

Basic Usage

mplx core plugins update <assetId> [options]

Options

• --wizard: Interactive wizard mode to select and configure plugins to update
• --collection: Flag to indicate if the target is a collection (default: false)

Methods

1. Using Wizard Mode

mplx core plugins update <assetId> --wizard

This will:

1. Launch an interactive wizard to select which plugin(s) to update
2. Guide you through the updated plugin configuration
3. Apply the changes to the asset/collection

2. Using JSON File

mplx core plugins update <assetId> ./plugin.json

The JSON file should contain the updated plugin configuration in the same format as the JSON file used for adding plugins.

### Examples

#### Update Plugin on Asset
```bash
mplx core plugins update 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --wizard

Update Plugin on Collection

mplx core plugins update 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --wizard --collection

Update Plugin Using JSON

mplx core plugins update 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa ./updated-plugin.json

Example: Update Royalties Plugin on Collection

mplx core plugins update collectionPublicKey ./royalties.json --collection

Where royalties.json contains:

[
  {
    "type": "Royalties",
    "authority": {
      "type": "UpdateAuthority"
    },
    "basisPoints": 1000,
    "creators": [
      {
        "address": "4xbJp9sjeTEhheUDg8M1nJUomZcGmFZsjt9Gg3RQZAWp",
        "percentage": 100
      }
    ],
    "ruleSet": {"type": "None"}
  }
]

Output (Update)

After a successful plugin update, the command will display:

--------------------------------
  Asset: <assetId>
  Signature: <transactionSignature>
  Explorer: <explorerUrl>
  Core Explorer: https://core.metaplex.com/explorer/<assetId>
--------------------------------