Skip to content

Commit

Permalink
added ability to update config for a registered denom
Browse files Browse the repository at this point in the history
  • Loading branch information
@NoahSaso
NoahSaso committed Jul 19, 2024
1 parent a6a4f86 commit d8ab863
Show file tree
Hide file tree
Showing 7 changed files with 311 additions and 123 deletions.
136 changes: 90 additions & 46 deletions contracts/distribution/dao-rewards-distributor/schema/dao-rewards-distributor.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,20 +61,66 @@
"additionalProperties": false
},
{
"description": "Claims rewards for the sender.",
"description": "registers a new reward denom",
"type": "object",
"required": [
"claim"
"register_denom"
],
"properties": {
"claim": {
"register_denom": {
"$ref": "#/definitions/RegisterDenomMsg"
}
},
"additionalProperties": false
},
{
"description": "updates the config for a registered denom",
"type": "object",
"required": [
"update_denom"
],
"properties": {
"update_denom": {
"type": "object",
"required": [
"denom"
],
"properties": {
"denom": {
"description": "denom to update",
"type": "string"
},
"emission_rate": {
"description": "reward emission rate",
"anyOf": [
{
"$ref": "#/definitions/RewardEmissionRate"
},
{
"type": "null"
}
]
},
"hook_caller": {
"description": "address that will update the reward split when the voting power distribution changes",
"type": [
"string",
"null"
]
},
"vp_contract": {
"description": "address to query the voting power",
"type": [
"string",
"null"
]
},
"withdraw_destination": {
"description": "destination address for reward clawbacks. defaults to owner",
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
Expand Down Expand Up @@ -110,13 +156,13 @@
"additionalProperties": false
},
{
"description": "shuts down the rewards distributor. withdraws all future staking rewards back to the treasury. members can claim whatever they earned until this point.",
"description": "Claims rewards for the sender.",
"type": "object",
"required": [
"shutdown"
"claim"
],
"properties": {
"shutdown": {
"claim": {
"type": "object",
"required": [
"denom"
Expand All @@ -132,37 +178,20 @@
"additionalProperties": false
},
{
"description": "registers a new reward denom",
"description": "shuts down the rewards distributor for a denom. withdraws all future staking rewards back to the treasury. members can claim whatever they earned until this point.",
"type": "object",
"required": [
"register_reward_denom"
],
"properties": {
"register_reward_denom": {
"$ref": "#/definitions/RegisterRewardDenomMsg"
}
},
"additionalProperties": false
},
{
"description": "updates the reward emission rate for a registered denom",
"type": "object",
"required": [
"update_reward_emission_rate"
"shutdown"
],
"properties": {
"update_reward_emission_rate": {
"shutdown": {
"type": "object",
"required": [
"denom",
"emission_rate"
"denom"
],
"properties": {
"denom": {
"type": "string"
},
"emission_rate": {
"$ref": "#/definitions/RewardEmissionRate"
}
},
"additionalProperties": false
Expand Down Expand Up @@ -449,7 +478,7 @@
}
]
},
"RegisterRewardDenomMsg": {
"RegisterDenomMsg": {
"type": "object",
"required": [
"denom",
Expand All @@ -459,18 +488,31 @@
],
"properties": {
"denom": {
"$ref": "#/definitions/UncheckedDenom"
"description": "denom to register",
"allOf": [
{
"$ref": "#/definitions/UncheckedDenom"
}
]
},
"emission_rate": {
"$ref": "#/definitions/RewardEmissionRate"
"description": "reward emission rate",
"allOf": [
{
"$ref": "#/definitions/RewardEmissionRate"
}
]
},
"hook_caller": {
"description": "address that will update the reward split when the voting power distribution changes",
"type": "string"
},
"vp_contract": {
"description": "address to query the voting power",
"type": "string"
},
"withdraw_destination": {
"description": "destination address for reward clawbacks. defaults to owner",
"type": [
"string",
"null"
Expand Down Expand Up @@ -715,7 +757,7 @@
"active_epoch",
"denom",
"funded_amount",
"historic_epochs",
"historical_earned_puvp",
"hook_caller",
"last_update",
"vp_contract",
Expand Down Expand Up @@ -746,12 +788,13 @@
}
]
},
"historic_epochs": {
"description": "historic denom distribution epochs",
"type": "array",
"items": {
"$ref": "#/definitions/Epoch"
}
"historical_earned_puvp": {
"description": "historical rewards earned per unit voting power from past epochs due to changes in the emission rate. each time emission rate is changed, this value is increased by the `active_epoch`'s rewards earned puvp.",
"allOf": [
{
"$ref": "#/definitions/Uint256"
}
]
},
"hook_caller": {
"description": "address that will update the reward split when the voting power distribution changes",
Expand All @@ -778,7 +821,7 @@
]
},
"withdraw_destination": {
"description": "optional destination address for reward clawbacks",
"description": "destination address for reward clawbacks",
"allOf": [
{
"$ref": "#/definitions/Addr"
Expand Down Expand Up @@ -1283,7 +1326,7 @@
"active_epoch",
"denom",
"funded_amount",
"historic_epochs",
"historical_earned_puvp",
"hook_caller",
"last_update",
"vp_contract",
Expand Down Expand Up @@ -1314,12 +1357,13 @@
}
]
},
"historic_epochs": {
"description": "historic denom distribution epochs",
"type": "array",
"items": {
"$ref": "#/definitions/Epoch"
}
"historical_earned_puvp": {
"description": "historical rewards earned per unit voting power from past epochs due to changes in the emission rate. each time emission rate is changed, this value is increased by the `active_epoch`'s rewards earned puvp.",
"allOf": [
{
"$ref": "#/definitions/Uint256"
}
]
},
"hook_caller": {
"description": "address that will update the reward split when the voting power distribution changes",
Expand All @@ -1346,7 +1390,7 @@
]
},
"withdraw_destination": {
"description": "optional destination address for reward clawbacks",
"description": "destination address for reward clawbacks",
"allOf": [
{
"$ref": "#/definitions/Addr"
Expand Down
Loading

0 comments on commit d8ab863

Please sign in to comment.