jiminy-staking 0.11.0

Staking reward accumulators for Jiminy: MasterChef-style reward-per-token, emission rates, reward debt tracking. Zero-copy, no_std, no_alloc, BPF-safe.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# jiminy-staking


MasterChef-style staking math. Global reward-per-token accumulator, per-user
pending rewards, reward debt snapshots, emission rates. The standard pattern,
done once, done right.

`#![no_std]` · `no_alloc` · BPF-safe · Built on [pinocchio](https://github.com/anza-xyz/pinocchio)

Part of the [jiminy](https://crates.io/crates/jiminy) toolkit.

## Install


```toml
[dependencies]
jiminy-staking = "0.11"
```

## What's inside


| Function | What it does |
|---|---|
| `update_reward_per_token` | Advance the global accumulator given elapsed time and total staked |
| `pending_rewards` | Unclaimed rewards for a user position |
| `update_reward_debt` | Snapshot reward debt after claim or stake change |
| `emission_rate` | Per-second rate from total rewards and duration |
| `rewards_earned` | Total rewards emitted over an elapsed period |

Precision constant: `REWARD_PRECISION = 1_000_000_000_000` (10^12)

## Quick start


```rust,ignore
use jiminy_staking::*;

let new_rpt = update_reward_per_token(
    current_rpt, last_update, now, rate_per_second, total_staked,
)?;
let pending = pending_rewards(user_staked, new_rpt, user_reward_debt)?;
```

## About


Built by [MoonManQuark](https://x.com/moonmanquark) / [Bluefoot Labs](https://github.com/BluefootLabs).

If jiminy saved you some CU, donations welcome at `solanadevdao.sol`
(`F42ZovBoRJZU4av5MiESVwJWnEx8ZQVFkc1RM29zMxNT`).

## License


Apache-2.0