PluginManager
Plugins this deployment serves — client.plugins. A plugin runs only for a consumer that installed it, and installing is consenting to exactly the capabilities…
Plugins this deployment serves — client.plugins. A plugin runs only for a consumer that installed it, and installing is consenting to exactly the capabilities it declares: pass them back as grantCapabilities.
Constructor
PluginManager
constructor(client: Client)Parameters
client:Client
Properties
client
readonly client: ClientType Client
Methods
list()
list(): Promise<PluginData[]>Returns Promise<PluginData[]>
fetch()
fetch(slug: string): Promise<PluginData>Parameters
slug:string
Returns Promise<PluginData>
install()
Install (or re-consent to) a plugin.
install(slug: string, options: InstallPluginOptions): Promise<PluginData>Parameters
slug:stringoptions:InstallPluginOptions
Returns Promise<PluginData>
uninstall()
uninstall(slug: string): Promise<PluginUninstalledData>Parameters
slug:string
Returns Promise<PluginUninstalledData>
query()
Run a read-only action the plugin declares.
query<T = unknown>(slug: string, action: string, input?: Record<string, unknown>): Promise<PluginActionResultData<T>>Parameters
slug:stringaction:stringinput(optional):Record<string, unknown>
Returns Promise<PluginActionResultData<T>>
command()
Run an action that may change the plugin's state.
command<T = unknown>(slug: string, action: string, input?: Record<string, unknown>): Promise<PluginActionResultData<T>>Parameters
slug:stringaction:stringinput(optional):Record<string, unknown>
Returns Promise<PluginActionResultData<T>>
Related
DefindexManager
DeFindex vaults on Stellar — client.defindex. Served only where the deployment enables the DeFindex native plugin (PLUGINS_ENABLED=defindex); elsewhere every…
PublicKeyManager
The shared public API key — client.publicKey. It is what an open-source wallet embeds to reach the few routes anonymous callers may use; the route that serves…