hive-react-kit 0.11.11 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -199,23 +199,26 @@ export interface GrowthAnalyticsResult {
199
199
  }
200
200
  export interface KERatioResult {
201
201
  username: string;
202
- /** Effective Hive Power = own HP + received HP delegated HP. */
202
+ /** Own staked HP (vesting_shares only excludes received and delegated). */
203
203
  currentHP: number;
204
+ /** Posting rewards in HP. */
204
205
  postingRewards: number;
206
+ /** Curation rewards in HP. */
205
207
  curationRewards: number;
208
+ /** Total lifetime rewards in HP. */
206
209
  totalRewards: number;
207
- /** ke = (postingRewards + curationRewards) / currentHP / 1000 */
210
+ /** ke = (postingRewardsHP + curationRewardsHP) / ownHP */
208
211
  ke: number;
209
212
  }
210
213
  /**
211
- * KE ("Kuriyaki Effective") ratio for a Hive account — a rough indicator of
212
- * how much an account has earned relative to its own effective Hive Power.
214
+ * KE ratio for a Hive account — lifetime rewards divided by own staked HP.
215
+ * Matches the value shown on peakd.com and mirrors the server-side calculator
216
+ * at curation-marketing/Server/utils/ke-ratio-of-account.js.
213
217
  *
214
- * ke = (posting_rewards + curation_rewards) / currentHP / 1000
218
+ * ke = (posting_rewards + curation_rewards in HP) / own_HP
215
219
  *
216
- * Where `currentHP` is the account's *effective* HP after subtracting
217
- * delegated-out HP and adding delegated-in HP. Mirrors the server-side
218
- * calculator at curation-marketing/server/utils/ke-ratio-of-account.js.
220
+ * Own HP only received delegations and delegations-out are excluded so the
221
+ * ratio reflects whether the account keeps its earnings staked.
219
222
  */
220
223
  export declare function calculateKERatio(username: string, signal?: AbortSignal): Promise<KERatioResult>;
221
224
  export declare const userService: UserService;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "hive-react-kit",
3
3
  "private": false,
4
- "version": "0.11.11",
4
+ "version": "1.0.12",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs.js",
7
7
  "module": "./dist/index.esm.js",