Type alias ActionMetadataDetails

Type declaration

• authors: string[]

  List of authors email addresses.

• Optional configureParams?: ContractKeyValuePairDescriptor[]

  An optional list of ContractKeyValuePairDescriptor that describes the params argument of the configure function.

  function configure(address originalMsgSender, address feed, uint256 postId, KeyValue[] calldata params)
    external
    returns (bytes memory);
  Copy

  This will be used to know how to encode and decode the params for the configuration function.

  See

  https://abitype.dev/api/human

• description: Markdown

  Markdown formatted description of the Action.

  It should explain what this Action does, how to use it, examples just like you would if you were building an NPM package. The more detail the better to allow dApp to easily integrate it.

• Optional executeParams?: ContractKeyValuePairDescriptor[]

  A list of ContractKeyValuePairDescriptor that describes the params argument of the execute function.

  function execute(address originalMsgSender, address feed, uint256 postId, KeyValue[] calldata params)
    external
    returns (bytes memory);
  Copy

  This will be used to know how to encode the calldata for the execute function.

  See

  https://abitype.dev/api/human

• id: string

  A unique identifier that in storages like IPFS ensures the uniqueness of the metadata URI. Use a UUID if unsure.

• name: string

  A short name for the Action.

• Optional setDisabledParams?: ContractKeyValuePairDescriptor[]

  An optional list of ContractKeyValuePairDescriptor that describes the params argument of the setDisabledParams function.

  function setDisabled(
    address originalMsgSender,
    address feed,
    uint256 postId,
    bool isDisabled,
    KeyValue[] calldata params
  ) external returns (bytes memory);
  Copy

  This will be used to know how to encode the calldata for the setDisabled function.

  See

  https://abitype.dev/api/human

• source: URI

  The link to the Action source code. Typically a GitHub repository.