IXKeeperMetadata

Git Source

Functions

automationVaultMetadata

Returns the metadata of the automation vault

function automationVaultMetadata(IAutomationVault _automationVault)
  external
  view
  returns (string calldata _name, string calldata _description);

Parameters

NameTypeDescription
_automationVaultIAutomationVaultThe automation vault

Returns

NameTypeDescription
_namestringThe name of the automation vault
_descriptionstringThe description of the automation vault

automationVaultsMetadata

Returns the metadata of the automation vault

function automationVaultsMetadata(IAutomationVault[] calldata _automationVault)
  external
  view
  returns (IXKeeperMetadata.AutomationVaultMetadata[] memory _metadata);

Parameters

NameTypeDescription
_automationVaultIAutomationVault[]The automation vaults

Returns

NameTypeDescription
_metadataIXKeeperMetadata.AutomationVaultMetadata[]The metadata of the automation vault

setAutomationVaultMetadata

Sets the metadata of the automation vault

function setAutomationVaultMetadata(
  IAutomationVault _automationVault,
  AutomationVaultMetadata calldata _automationVaultMetadata
) external;

Parameters

NameTypeDescription
_automationVaultIAutomationVaultThe automation vault
_automationVaultMetadataAutomationVaultMetadataThe metadata of the automation vault

Events

AutomationVaultMetadataSetted

Emitted when the metadata of an automation vault is set

event AutomationVaultMetadataSetted(IAutomationVault indexed _automationVault, string _name, string _description);

Parameters

NameTypeDescription
_automationVaultIAutomationVaultThe automation vault
_namestringThe name of the automation vault
_descriptionstringThe description of the automation vault

Errors

XKeeperMetadata_OnlyAutomationVaultOwner

The caller is not the owner of the automation vault

error XKeeperMetadata_OnlyAutomationVaultOwner();

Structs

AutomationVaultMetadata

The metadata of the automation vault

struct AutomationVaultMetadata {
  string name;
  string description;
}

Properties

NameTypeDescription
namestringThe name of the automation vault
descriptionstringThe description of the automation vault