Type alias GraphRuleMetadataDetails

GraphRuleMetadataDetails: {
    authors: string[];
    configureParams: ContractKeyValuePairDescriptor[];
    description: Markdown;
    id: string;
    name: string;
    processFollowParams: ContractKeyValuePairDescriptor[];
    processFollowRuleChangesParams: ContractKeyValuePairDescriptor[];
    processUnfollowParams: 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.

  • processFollowParams: ContractKeyValuePairDescriptor[]

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

    function processFollow(
    bytes32 configSalt,
    address originalMsgSender,
    address followerAccount,
    address accountToFollow,
    KeyValue[] calldata primitiveParams,
    KeyValue[] calldata ruleParams
) external;

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

    See

    https://abitype.dev/api/human

  • processFollowRuleChangesParams: ContractKeyValuePairDescriptor[]

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

    function processFollowRuleChanges(
    bytes32 configSalt,
    address account,
    RuleChange[] calldata ruleChanges,
    KeyValue[] calldata ruleParams
) external;

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

    See

    https://abitype.dev/api/human

  • processUnfollowParams: ContractKeyValuePairDescriptor[]

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

    function processUnfollow(
    bytes32 configSalt,
    address originalMsgSender,
    address followerAccount,
    address accountToUnfollow,
    KeyValue[] calldata primitiveParams,
    KeyValue[] calldata ruleParams
) external;

    This will be used to know how to encode the calldata for the processUnfollow 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