Skip to content
Alchemy Logo

installPlugin

function installPlugin<TTransport, TChain, TAccount, TContext>(
  client,
  params,
): Promise<any>;

Defined in: account-kit/smart-contracts/src/msca/plugin-manager/installPlugin.ts:65

Installs a plugin on a smart account via the client, sending the user operation with the appropriate parameters. NOTE: it's recommended to just use the installPlugin action returned from generated plugins

import { installPlugin, createModularAccountAlchemyClient } from "@account-kit/smart-contracts";
 
const client = createModularAccountAlchemyClient(...);
 
const hash = await installPlugin(client, {
 pluginAddress: "0x...",
 manifestHash: "0x...",
 dependencies: [], // this is defined by the plugin you're installing
});

Type ParameterDefault type

TTransport extends Transport

Transport

TChain extends undefined | Chain

undefined | Chain

TAccount extends undefined | SmartContractAccount

undefined | SmartContractAccount

TContext extends undefined | Record<string, unknown>

undefined | Record<string, unknown>

ParameterTypeDescription

client

Client<TTransport, TChain, TAccount>

The client configured to the smart account on which the plugin will be installed

params

InstallPluginParams<TAccount, TContext>

The parameters required to install the plugin, including overrides, context, and account information

Promise<any>

A promise that resolves once the plugin installation operation is sent

Was this page helpful?