@stacks/codec 2.0.0-pox5.1 → 2.0.0-pox5.3

package/index.d.ts

@@ -728,6 +728,7 @@ export interface Pox4EventRevokeDelegateStx extends Pox4EventBase {
 }
 export type Pox4Event = Pox4EventHandleUnlock | Pox4EventStackStx | Pox4EventStackIncrease | Pox4EventStackExtend | Pox4EventDelegateStx | Pox4EventDelegateStackStx | Pox4EventDelegateStackIncrease | Pox4EventDelegateStackExtend | Pox4EventStackAggregationCommit | Pox4EventStackAggregationCommitIndexed | Pox4EventStackAggregationIncrease | Pox4EventRevokeDelegateStx;
 export declare enum Pox5EventName {
+    SetBondAdmin = "set-bond-admin",
     SetupBond = "setup-bond",
     AddToAllowlist = "add-to-allowlist",
     RegisterForBond = "register-for-bond",
@@ -740,7 +741,12 @@ export declare enum Pox5EventName {
     Unstake = "unstake",
     CalculateRewards = "calculate-rewards",
     BondDistribution = "bond-distribution",
-    ClaimRewards = "claim-rewards"
+    ClaimRewards = "claim-rewards",
+    ClaimStakerRewardsForSigner = "claim-staker-rewards-for-signer",
+    GrantSignerKey = "grant-signer-key",
+    RevokeSignerGrant = "revoke-signer-grant",
+    DisallowContractCaller = "disallow-contract-caller",
+    AllowContractCaller = "allow-contract-caller"
 }
 export interface Pox5EventBase {
     /**
@@ -750,6 +756,15 @@ export interface Pox5EventBase {
      */
     pox_version: 'pox5';
 }
+export interface Pox5EventSetBondAdmin extends Pox5EventBase {
+    name: Pox5EventName.SetBondAdmin;
+    data: {
+        /** c32 principal of the previous bond admin. */
+        old_admin: string;
+        /** c32 principal of the new bond admin. */
+        new_admin: string;
+    };
+}
 export interface Pox5EventSetupBond extends Pox5EventBase {
     name: Pox5EventName.SetupBond;
     data: {
@@ -762,12 +777,11 @@ export interface Pox5EventSetupBond extends Pox5EventBase {
         /** String-quoted unsigned integer */
         min_ustx_ratio: string;
         /**
-         * `(buff 683)` hex string. Opaque early-unlock authorization script
-         * (e.g. `<pubkey> OP_CHECKSIGVERIFY`, or an M-of-N multisig template).
+         * `(buff 683)` hex string. Bitcoin script subscript guarding the
+         * early-exit (`OP_ELSE`) branch of the L1 lockup (e.g. `<pubkey>
+         * OP_CHECKSIG`, or an M-of-N `CHECKMULTISIG` template).
          */
         early_unlock_bytes: string;
-        /** c32 principal allowed to call `announce-l1-early-exit` for stakers in this bond. */
-        early_unlock_admin: string;
         /** String-quoted unsigned integer */
         first_reward_cycle: string;
         /** String-quoted unsigned integer */
@@ -934,17 +948,8 @@ export interface Pox5EventUnstake extends Pox5EventBase {
     };
 }
 /**
- * Logged by `calculate-rewards`. The contract emits this topic **twice** per
- * call: a phase-1 (pre-distribution) print carrying `stranded_staker_cut`,
- * and a phase-2 (post-distribution) print carrying `new_reserve`. Exactly
- * one of those two fields is populated per event; the other is `null`.
- *
- * Phase-1 fires before reserve and accounting state are updated; useful for
- * inspecting whether the staker cut was folded into the reserve because no
- * STX was staked.
- *
- * Phase-2 fires after state is committed and matches the value returned to
- * the caller.
+ * Logged once per `calculate-rewards` call, after all per-bond distributions
+ * have been folded and the STX reward cycle accounting has been committed.
  */
 export interface Pox5EventCalculateRewards extends Pox5EventBase {
     name: Pox5EventName.CalculateRewards;
@@ -953,29 +958,24 @@ export interface Pox5EventCalculateRewards extends Pox5EventBase {
         bond_periods: string[];
         /** String-quoted unsigned integer */
         calculation_height: string;
-        /** String-quoted unsigned integer */
-        remaining_rewards: string;
-        /** String-quoted unsigned integer */
-        accrued_rewards: string;
-        /**
-         * Phase-2 only. String-quoted unsigned integer — portion of accrued
-         * rewards retained in the reserve. `null` on the phase-1 event.
-         */
-        new_reserve: string | null;
-        /**
-         * Phase-1 only. String-quoted unsigned integer — the would-be STX
-         * staker cut that gets folded into the reserve when no STX is staked
-         * for the cycle. `null` on the phase-2 event.
-         */
-        stranded_staker_cut: string | null;
-        /** String-quoted unsigned integer */
-        stx_staker_rewards: string;
+        /** String-quoted unsigned integer — total new rewards accrued since the last calculation. */
+        gross_accrued_rewards: string;
+        /** String-quoted unsigned integer — portion of `gross_accrued_rewards` paid out to bonds. */
+        total_bond_rewards: string;
+        /** String-quoted unsigned integer — amount added to the reserve this calculation. */
+        reserve_deposit: string;
+        /** String-quoted unsigned integer — reserve balance after `reserve_deposit` was applied. */
+        reserve_balance: string;
         /** String-quoted unsigned integer */
         stx_cycle: string;
+        /** String-quoted unsigned integer — rewards allocated to STX stakers for the cycle. */
+        total_stx_staker_rewards: string;
         /** String-quoted unsigned integer */
         cycle_staked_ustx: string;
-        /** String-quoted unsigned integer */
-        next_rewards_per_ustx: string;
+        /** String-quoted unsigned integer — per-uSTX rewards accrued this calculation (zero when no STX is staked). */
+        accrued_rewards_per_ustx: string;
+        /** String-quoted unsigned integer — running per-uSTX reward total for the cycle after this calculation. */
+        cumulative_rewards_per_ustx: string;
     };
 }
 export interface Pox5EventBondDistribution extends Pox5EventBase {
@@ -985,8 +985,14 @@ export interface Pox5EventBondDistribution extends Pox5EventBase {
         bond_index: string;
         /** String-quoted unsigned integer */
         target_yield: string;
-        /** String-quoted unsigned integer */
-        earned: string;
+        /** String-quoted unsigned integer — rewards earned by this bond this calculation. */
+        bond_rewards: string;
+        /** String-quoted unsigned integer */
+        bond_staked_sats: string;
+        /** String-quoted unsigned integer — per-sat rewards accrued this calculation. */
+        accrued_rewards_per_sat: string;
+        /** String-quoted unsigned integer — running per-sat reward total for the bond after this calculation. */
+        cumulative_rewards_per_sat: string;
     };
 }
 /** Sub-tuple emitted under `stx_rewards` in `claim-rewards` events. */
@@ -1004,6 +1010,10 @@ export interface Pox5BondRewardsInfo extends Pox5ClaimRewardsInfo {
 export interface Pox5EventClaimRewards extends Pox5EventBase {
     name: Pox5EventName.ClaimRewards;
     data: {
+        /** c32 principal of the signer manager that claimed. */
+        signer_manager: string;
+        /** String-quoted unsigned integer */
+        reward_cycle: string;
         stx_rewards: Pox5ClaimRewardsInfo;
         bond_rewards: Pox5BondRewardsInfo[];
         /** String-quoted unsigned integer */
@@ -1012,7 +1022,68 @@ export interface Pox5EventClaimRewards extends Pox5EventBase {
         total_rewards: string;
     };
 }
-export type Pox5Event = Pox5EventSetupBond | Pox5EventAddToAllowlist | Pox5EventRegisterForBond | Pox5EventUpdateBondRegistration | Pox5EventRegisterSigner | Pox5EventStake | Pox5EventStakeUpdate | Pox5EventAnnounceL1EarlyExit | Pox5EventUnstakeSbtc | Pox5EventUnstake | Pox5EventCalculateRewards | Pox5EventBondDistribution | Pox5EventClaimRewards;
+export interface Pox5EventClaimStakerRewardsForSigner extends Pox5EventBase {
+    name: Pox5EventName.ClaimStakerRewardsForSigner;
+    data: {
+        /** c32 principal of the signer manager. */
+        signer_manager: string;
+        /** c32 principal of the staker. */
+        staker: string;
+        /** String-quoted unsigned integer */
+        reward_cycle: string;
+        /**
+         * String-quoted unsigned integer for bond rewards, or `null` for
+         * STX-only staking rewards.
+         */
+        bond_index: string | null;
+        /** String-quoted unsigned integer */
+        rewards_claimed: string;
+    };
+}
+export interface Pox5EventGrantSignerKey extends Pox5EventBase {
+    name: Pox5EventName.GrantSignerKey;
+    data: {
+        /** `(buff 33)` hex string — compressed secp256k1 public key. */
+        signer_key: string;
+        /** c32 principal of the signer manager. */
+        signer_manager: string;
+        /** String-quoted unsigned integer */
+        auth_id: string;
+    };
+}
+export interface Pox5EventRevokeSignerGrant extends Pox5EventBase {
+    name: Pox5EventName.RevokeSignerGrant;
+    data: {
+        /** `(buff 33)` hex string — compressed secp256k1 public key. */
+        signer_key: string;
+        /** c32 principal of the signer manager. */
+        signer_manager: string;
+    };
+}
+export interface Pox5EventDisallowContractCaller extends Pox5EventBase {
+    name: Pox5EventName.DisallowContractCaller;
+    data: {
+        /** c32 principal of the tx-sender that revoked the allowance. */
+        sender: string;
+        /** c32 principal of the contract-caller whose allowance was removed. */
+        contract_caller: string;
+    };
+}
+export interface Pox5EventAllowContractCaller extends Pox5EventBase {
+    name: Pox5EventName.AllowContractCaller;
+    data: {
+        /** c32 principal of the tx-sender that granted the allowance. */
+        sender: string;
+        /** c32 principal of the allowed contract-caller. */
+        contract_caller: string;
+        /**
+         * String-quoted unsigned integer burn height at which the allowance
+         * expires, or `null` if it never expires.
+         */
+        until_burn_ht: string | null;
+    };
+}
+export type Pox5Event = Pox5EventSetBondAdmin | Pox5EventSetupBond | Pox5EventAddToAllowlist | Pox5EventRegisterForBond | Pox5EventUpdateBondRegistration | Pox5EventRegisterSigner | Pox5EventStake | Pox5EventStakeUpdate | Pox5EventAnnounceL1EarlyExit | Pox5EventUnstakeSbtc | Pox5EventUnstake | Pox5EventCalculateRewards | Pox5EventBondDistribution | Pox5EventClaimRewards | Pox5EventClaimStakerRewardsForSigner | Pox5EventGrantSignerKey | Pox5EventRevokeSignerGrant | Pox5EventDisallowContractCaller | Pox5EventAllowContractCaller;
 /**
  * Any decoded PoX synthetic event, regardless of the source contract version.
  *

package/index.js

@@ -249,6 +249,7 @@ var Pox4EventName;
 // ============================================================================
 var Pox5EventName;
 (function (Pox5EventName) {
+    Pox5EventName["SetBondAdmin"] = "set-bond-admin";
     Pox5EventName["SetupBond"] = "setup-bond";
     Pox5EventName["AddToAllowlist"] = "add-to-allowlist";
     Pox5EventName["RegisterForBond"] = "register-for-bond";
@@ -262,4 +263,9 @@ var Pox5EventName;
     Pox5EventName["CalculateRewards"] = "calculate-rewards";
     Pox5EventName["BondDistribution"] = "bond-distribution";
     Pox5EventName["ClaimRewards"] = "claim-rewards";
+    Pox5EventName["ClaimStakerRewardsForSigner"] = "claim-staker-rewards-for-signer";
+    Pox5EventName["GrantSignerKey"] = "grant-signer-key";
+    Pox5EventName["RevokeSignerGrant"] = "revoke-signer-grant";
+    Pox5EventName["DisallowContractCaller"] = "disallow-contract-caller";
+    Pox5EventName["AllowContractCaller"] = "allow-contract-caller";
 })(Pox5EventName || (exports.Pox5EventName = Pox5EventName = {}));

package/index.mjs

@@ -158,6 +158,7 @@ var Pox4EventName = /* @__PURE__ */ ((Pox4EventName2) => {
   return Pox4EventName2;
 })(Pox4EventName || {});
 var Pox5EventName = /* @__PURE__ */ ((Pox5EventName2) => {
+  Pox5EventName2["SetBondAdmin"] = "set-bond-admin";
   Pox5EventName2["SetupBond"] = "setup-bond";
   Pox5EventName2["AddToAllowlist"] = "add-to-allowlist";
   Pox5EventName2["RegisterForBond"] = "register-for-bond";
@@ -171,6 +172,11 @@ var Pox5EventName = /* @__PURE__ */ ((Pox5EventName2) => {
   Pox5EventName2["CalculateRewards"] = "calculate-rewards";
   Pox5EventName2["BondDistribution"] = "bond-distribution";
   Pox5EventName2["ClaimRewards"] = "claim-rewards";
+  Pox5EventName2["ClaimStakerRewardsForSigner"] = "claim-staker-rewards-for-signer";
+  Pox5EventName2["GrantSignerKey"] = "grant-signer-key";
+  Pox5EventName2["RevokeSignerGrant"] = "revoke-signer-grant";
+  Pox5EventName2["DisallowContractCaller"] = "disallow-contract-caller";
+  Pox5EventName2["AllowContractCaller"] = "allow-contract-caller";
   return Pox5EventName2;
 })(Pox5EventName || {});
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/codec",
-  "version": "2.0.0-pox5.1",
+  "version": "2.0.0-pox5.3",
   "author": "Stacks Labs",
   "license": "GPL-3.0",
   "description": "Encoding & decoding functions for the Stacks blockchain exposed as a fast native Node.js addon",