Type alias GroupRuleMetadataDetails

GroupRuleMetadataDetails: {
    authors: string[];
    configureParams: ContractKeyValuePairDescriptor[];
    description: Markdown;
    id: string;
    name: string;
    processAdditionParams: ContractKeyValuePairDescriptor[];
    processJoiningParams: ContractKeyValuePairDescriptor[];
    processLeavingParams: ContractKeyValuePairDescriptor[];
    processRemovalParams: ContractKeyValuePairDescriptor[];
    source: URI;
    title: string;
}

Type declaration

  • authors: string[]

    List of authors email addresses.

  • configureParams: ContractKeyValuePairDescriptor[]

    A list of ContractKeyValuePairDescriptor that describes the ruleParams argument of the configure function.

    function configure(bytes32 configSalt, KeyValue[] calldata ruleParams) external;

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

    See

    https://abitype.dev/api/human

  • description: Markdown

    Markdown formatted description of the Rule.

    It should explain what this Rule 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.

  • 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 Rule.

  • processAdditionParams: ContractKeyValuePairDescriptor[]

    A list of ContractKeyValuePairDescriptor that describes the ruleParams argument of the processAddition function.

    function processAddition(
  bytes32 configSalt,
  address originalMsgSender,
  address account,
  KeyValue[] calldata primitiveParams,
  KeyValue[] calldata ruleParams
) external;

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

    See

    https://abitype.dev/api/human

  • processJoiningParams: ContractKeyValuePairDescriptor[]

    A list of ContractKeyValuePairDescriptor that describes the ruleParams argument of the processJoining function.

    function processJoining(
  bytes32 configSalt,
  address account,
  KeyValue[] calldata primitiveParams,
  KeyValue[] calldata ruleParams
) external;

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

    See

    https://abitype.dev/api/human

  • processLeavingParams: ContractKeyValuePairDescriptor[]

    A list of ContractKeyValuePairDescriptor that describes the ruleParams argument of the processLeaving function.

    function processLeaving(
  bytes32 configSalt,
  address account,
  KeyValue[] calldata primitiveParams,
  KeyValue[] calldata ruleParams
) external;

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

    See

    https://abitype.dev/api/human

  • processRemovalParams: ContractKeyValuePairDescriptor[]

    A list of ContractKeyValuePairDescriptor that describes the ruleParams argument of the processRemoval function.

    function processRemoval(
  bytes32 configSalt,
  address originalMsgSender,
  address account,
  KeyValue[] calldata primitiveParams,
  KeyValue[] calldata ruleParams
) external;

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

    See

    https://abitype.dev/api/human

  • source: URI

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

  • title: string

    The human-friendly title for the Rule.

Settings

Member Visibility

Theme