rndquu / conversation-rewards

@ubiquibot/conversation-rewards

This is intended to be the proper implementation of comment incentives, based on our learnings from the first go-around.

As of 28 February: test driven development to aggregate all necessary information based on a URL to an issue.

• pass in closed as complete issue URL and receive all the timeline events and activities of all humans who helped close the issue as complete.
• most importantly: this can inherit bot authentication and link pull requests to issues in private repositories.

Be sure to review all *.test.* files for implementation details.

Data structure

{
  "userName": {
    "total": 40.5,
    "task": {
      "reward": 37.5,
      "multiplier": 1
    },
    "comments": [
      {
        "content": "comment content",
        "url": "https://url-to-item",
        "type": 18,
        "score": {
          "formatting": {
            "content": {
              "p": {
                "count": 16,
                "score": 1
              }
            },
            "wordValue": 0.1,
            "formattingMultiplier": 1
          },
          "reward": 0.8,
          "relevance": 0.5
      }
    }]
  }
}

Reward formula: ((count * wordValue) * (score * formattingMultiplier) * n) * relevance + task.reward = total

Plugin configuration

Here is a possible valid configuration to enable this plugin.

plugin: ubiquibot/conversation-rewards
with:
    evmNetworkId: 100
    evmPrivateEncrypted: "encrypted-key"
    erc20RewardToken: "0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d"
    incentives:
      enabled: true
      requirePriceLabel: true
      contentEvaluator:
        enabled: true
      userExtractor:
        enabled: true
        redeemTask: true
      dataPurge:
        enabled: true
      formattingEvaluator:
        enabled: true
        scores:
          br: 0
          code: 1
          p: 1
          em: 0
          img: 0
          strong: 0
          blockquote: 0
          h1: 1
          h2: 1
          h3: 1
          h4: 1
          h5: 1
          h6: 1
          a: 1
          li: 1
          td: 1
          hr: 0
        multipliers:
          - targets: [ ISSUE, ISSUER, SPECIFICATION ]
            formattingMultiplier: 1
            wordValue: 0.1
          - targets: [ ISSUE, ISSUER, COMMENTED ]
            formattingMultiplier: 1
            wordValue: 0.2
          - targets: [ ISSUE, ASSIGNEE, COMMENTED ]
            formattingMultiplier: 0
            wordValue: 0
          - targets: [ ISSUE, COLLABORATOR, COMMENTED ]
            formattingMultiplier: 1
            wordValue: 0.1
          - targets: [ ISSUE, CONTRIBUTOR, COMMENTED ]
            formattingMultiplier: 0.25
            wordValue: 0.1
          - targets: [ REVIEW, ISSUER, TASK ]
            formattingMultiplier: 0
            wordValue: 0
          - targets: [ REVIEW, ISSUER, COMMENTED ]
            formattingMultiplier: 2
            wordValue: 0.2
          - targets: [ REVIEW, ASSIGNEE, COMMENTED ]
            formattingMultiplier: 1
            wordValue: 0.1
          - targets: [ REVIEW, COLLABORATOR, COMMENTED ]
            formattingMultiplier: 1
            wordValue: 0.1
          - targets: [ REVIEW, CONTRIBUTOR, COMMENTED ]
            formattingMultiplier: 0.25
            wordValue: 0.1
      permitGeneration:
        enabled: true
      githubComment:
        enabled: true
        post: true
        debug: false