Rules overview

This page describes each of the rules. To see how to synchronise them go to synchronising rules section.

Here is the list of already defined rules. New rules are added on community requests. If you would like to use a rule that is not written yet, please create an issue and add #enhancement tag.

Available rules:

Format of rules.yml file

Rules file can be a JSON or a Yaml file. To read about these formats please see: JSON and Yaml. Yaml is more human friendly and error tolerant.

The file contains an array of voter-rulesets pairs. Each item of the array has a voter field which contains steem username and a rulesets field which is an array of the rulesets. Here is how it looks like:

- voter: noisy # steem account name
  rulesets:
    - (... ruleset 1 ...)
    - (... ruleset 2 ...)
- voter: perduta
  rulesets:
    - (... first ruleset for perduta ...)
    - (... second ruleset for perduta ...)
    - (... thirs ruleset for perduta ...)
- voter: jblew
  rulesets: # there are no rulesets for jblew

Each ruleset is an object that has a name (the voter chooses the ruleset by this name in a voteorder) and a list of rules. Optionally it can have a description, but it is not required.

A rule is one of the rules that are listed above. Each rule has a rule parameter which indicated the type of a rule. Other parameters are specific for each type of the rule. Please refer to the above links to separate pages of the rules.

Joining rules: you can use as many rules as you want. You can use several rules with same type (but different parameters). Rules are joined using AND logic operator. It means that all rules must be fulfilled in order for the voteorder to be valid.

Example rulesets

Here are example rules defined for a single voter @jblew:

- voter: jblew
  rulesets:
    - name: Vote only before payout for poor posts
      description: "You can use my full vote for \
        any post, that is not older than 7 days and \
        has payout less than 9.5 SBD"
      rules:
        - rule: weight
          min: 0
          max: 10000
        - rule: age_of_post
          mode: younger_than
          unit: day
          value: 7
        - rule: payout
          mode: less_than
          value: 9.5

A voteorder is valid only if validation of all rules is positive. You can devine more than one ruleset for a single user, and you can define rulesets for as many users as you wish. Here are some examples:

# Two rulesets for a single voter
- voter: noisy
  rulesets:
    - name: Ruleset A
      description: A message for the voter
      rules:
        - rule: a
          ...
        - rule: b
          ...
    - name: Ruleset B
      description: A message for the voter
      rules:
        - rule: c
          ...
        - rule: d
          ...

# Same rulesets for two voters
- voter: andrej.cibik
  rulesets:
    - name: Ruleset A
      description: A message for the voter
      rules:
        - rule: a
          ...
        - rule: b
          ...
- voter: perduta
  rulesets:
    - name: Ruleset A
      description: A message for the voter
      rules:
        - rule: a
          ...
        - rule: b
          ...

# Four different rulesets for two users
- voter: noisy
  rulesets:
    - name: Ruleset A
      description: A message for the voter
      rules:
        - rule: a
          ...
        - rule: b
          ...
    - name: Ruleset B
      description: A message for the voter
      rules:
        - rule: c
          ...
        - rule: d
          ...
- voter: nicniezgrublem
  rulesets:
    - name: Ruleset C
      description: A message for the voter
      rules:
        - rule: e
          ...
        - rule: f
          ...
    - name: Ruleset D
      description: A message for the voter
      rules:
        - rule: g
          ...
        - rule: h
          ...