@ubiquibot/conversation-rewards
As of 28 February: test driven development to aggregate all necessary information based on a URL to an issue.
Be sure to review all *.test.*
files for implementation details.
{
"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,
"multiplier": 1
},
"reward": 0.8,
"relevance": 0.5
}
}
]
}
}
Reward formula:
\sum_{i=0}^{n} \left( \sum_{j=0}^{n} \left(\text{wordCount}^{exponent} \times \text{wordValue} \times \text{relevance}\right) + \left(\text{score} \times \text{elementCount}\right) \right) \times multiplier + \text{task.reward} = \text{total}
Here is a possible valid configuration to enable this plugin. See these files for more details.
plugin: ubiquibot/conversation-rewards
with:
logLevel: "info"
evmNetworkId: 100
evmPrivateEncrypted: "encrypted-key"
erc20RewardToken: "0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d"
dataCollection:
maxAttempts: 10
delayMs: 10000
incentives:
requirePriceLabel: true
contentEvaluator:
openAi:
model: "gpt-4o"
endpoint: "https://api.openai.com/v1"
multipliers:
- role: [ISSUE_SPECIFICATION]
relevance: 1
- role: [PULL_AUTHOR]
relevance: 1
- role: [PULL_ASSIGNEE]
relevance: 1
- role: [PULL_COLLABORATOR]
relevance: 1
- role: [PULL_CONTRIBUTOR]
relevance: 1
userExtractor:
redeemTask: true
dataPurge: {}
formattingEvaluator:
multipliers:
- role: [ ISSUE_SPECIFICATION ]
multiplier: 1
rewards:
regex:
"\\b\\w+\\b": 0.1
scores: # Scores can be set for each item differently
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
ul: 1
td: 1
hr: 0
- role: [ISSUE_AUTHOR]
multiplier: 1
rewards:
regex:
"\\b\\w+\\b": 0.2
- role: [ISSUE_ASSIGNEE]
multiplier: 0
rewards:
regex:
"\\b\\w+\\b": 0
- role: [ISSUE_COLLABORATOR]
multiplier: 1
rewards:
regex:
"\\b\\w+\\b": 0.1
- role: [ISSUE_CONTRIBUTOR]
multiplier: 0.25
rewards:
regex:
"\\b\\w+\\b": 0.1
- role: [PULL_SPECIFICATION]
multiplier: 0
rewards:
regex:
"\\b\\w+\\b": 0
- role: [PULL_AUTHOR]
multiplier: 2
rewards:
regex:
"\\b\\w+\\b": 0.2
- role: [PULL_ASSIGNEE]
multiplier: 1
rewards:
regex:
"\\b\\w+\\b": 0.1
- role: [PULL_COLLABORATOR]
multiplier: 1
rewards:
regex:
"\\b\\w+\\b": 0.1
- role: [PULL_CONTRIBUTOR]
multiplier: 0.25
rewards:
regex:
"\\b\\w+\\b": 0.1
permitGeneration: {}
githubComment:
post: true
debug: false
evmPrivateEncrypted
parameterPartner private key (evmPrivateEncrypted
config param in conversation-rewards
plugin) supports 2 formats:
PRIVATE_KEY:GITHUB_OWNER_ID
PRIVATE_KEY:GITHUB_OWNER_ID:GITHUB_REPOSITORY_ID
Here GITHUB_OWNER_ID
can be:
Format PRIVATE_KEY:GITHUB_OWNER_ID
restricts in which particular organization (or user related repositories)
this private key can be used. It can be set either in the organization wide config either in the repository wide one.
Format PRIVATE_KEY:GITHUB_OWNER_ID:GITHUB_REPOSITORY_ID
restricts organization (or user related repositories) and a particular repository where private key is allowed to be used.
How to encrypt for you local organization for testing purposes:
curl -H "Accept: application/json" -H "Authorization: token GITHUB_PAT_TOKEN" https://api.github.com/orgs/ubiquity
x25519_PRIVATE_KEY
(which will be used in the conversation-rewards
plugin to decrypt encrypted wallet private key)PRIVATE_KEY:GITHUB_OWNER_ID
in the PLAIN_TEXT
UI text input where:
PRIVATE_KEY
: your ethereum wallet private key without the 0x
prefixGITHUB_OWNER_ID
: your github organization id or user id (which you got from step 1)CIPHER_TEXT
fieldevmPrivateEncrypted
config parameterX25519_PRIVATE_KEY
environment variable in github secrets of your forked instance of the conversation-rewards
plugin