https://github.com/volumefi/palomadex-incentives
https://github.com/volumefi/palomadex-incentives
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/volumefi/palomadex-incentives
- Owner: VolumeFi
- License: apache-2.0
- Created: 2025-06-04T13:47:02.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-07T21:12:34.000Z (11 months ago)
- Last Synced: 2025-07-07T23:19:09.834Z (11 months ago)
- Language: Rust
- Size: 478 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Palomadex VePADEX and Incentives contracts
# Palomadex VePADEX
The Voting Escrow contract for PADEX coin.
---
## InstantiateMsg
Initializes the contract with the denom of the PADEX token.
```json
{
"lock_denom": "factory/paloma...",
}
```
### `receive`
CW20 receive msg.
```json
{
"receive": {
"sender": "paloma...",
"amount": "123",
"msg": ""
}
}
```
### `create_lock`
Lock PADEX and get VePADEX with end lock timestamp.
```json
{
"create_lock": {
"end_lock_time": 10000
}
}
```
### `increase_lock_amount`
Lock more PADEX and get VePADEX.
```json
{
"increase_lock_amount": {
}
}
```
### `withdraw`
Withdraw locked PADEX
```json
{
"withdraw": {
}
}
```
## QueryMsg
All query messages are described below. A custom struct is defined for each query response.
### `config`
Returns the vesting token contract address (the PADEX token address).
```json
{
"config": {}
}
```
# Palomadex Incentives
The Palomadex Incentives contract allocates token rewards for various Paloma tokens or LP tokens and distributes them pro-rata to LP stakers.
We support both cw20 and native Paloma tokens or LP tokens.
One more improvement is that PADEX emissions are counted by seconds instead of blocks which makes more sense since Palomadex is multichain protocol.
## Endpoints Description
Contract supports following execute endpoints:
- `setup_pools` - is meant to be called either by owner or generator controller. Reset previous active pools and set new alloc points.
- `deposit` - stake Paloma tokens or LP tokens in the generator in order to receive rewards. Rewards are updated and withdrawn automatically. All pools registered the Palomadex factory are stakable. However, it doesn't mean that the pool is incentivized.
- `withdraw` - withdraw part or all Paloma tokens or LP tokens from the generator. Rewards are updated and withdrawn automatically.
- `claim_rewards` - update and withdraw all rewards associated with the Paloma tokens or LP tokens. This endpoint accepts multiple Paloma tokens or LP tokens.
- `set_tokens_per_second` - set new number of PADEX emissions per second. Only owner can call this endpoint.
- `incentivize` - add new reward schedule to a specific pool. All overlapped schedules are thoroughly considered and summed up. This is permissonless endpoint. However, it requires to pay incentivization fee in case this reward is new.
- `remove_reward_from_pool` - completely remove reward from pool. However, all accrued rewards will be considered at current point. This endpoint can be called only by owner. One must supply remaining rewards receiver address.
- `update_config` - is meant to update general contract settings. Only owner can call this endpoint.
- `update_blocked_tokens_list` - update list of tokens that are not allowed to be incentivized with PADEX as well as can't be used as external rewards. Only owner can call this endpoint.
- `deactivate_pool` - only factory can call this endpoint. Called from deregistration context in factory.
- `propose_new_owner`, `drop_ownership_proposal`, `claim_ownership` - endpoints to change ownership. Only current owner can propose new owner or drop proposal and only proposed owner can claim ownership.
### Deposit
Anyone can deposit either through direct `deposit` call with native Paloma tokens or LP tokens supplied or via cw20 send hook.
Contract checks if LP token corresponds to a pair registered in factory. Any LP token is stakable by default although it doesn't mean that it is incentivized in generator.
### Withdraw
Partially or fully withdraw Paloma tokens or LP tokens from the generator. Rewards are updated and withdrawn automatically.
### Incentivize
Add new reward schedule to a specific pool. All overlapped schedules are thoroughly considered and summed up.
This is permissonless endpoint. However, it requires to pay incentivization fee in case this reward is new.
Reward schedules are counted by periods where period is one week. Each period starts on Monday 00:00 UTC and ends on Sunday 23:59 UTC.
New reward schedule always starts right away and lasts **till the next Monday + X weeks**, where X - number of weeks specified in the schedule.
### Update pool rewards
This is internal logic which is launched whenever Paloma tokens or LP tokens amount changes, new reward schedule is added or rewards are claimed.
Each time _update_rewards_ is called, accrued rewards / total LP staked value is added to the current reward index.
_rps_ - rewards per second