levr-sdk 0.3.0 → 0.4.0

package/dist/types/stake.d.ts

@@ -1,6 +1,6 @@
 import type { TransactionReceipt } from 'viem';
 import type { Project } from '.';
-import type { BalanceResult, PopPublicClient, PopWalletClient } from './types';
+import type { PopPublicClient, PopWalletClient } from './types';
 export type StakeConfig = {
     wallet: PopWalletClient;
     publicClient: PopPublicClient;
@@ -14,31 +14,6 @@ export type ClaimParams = {
     tokens?: `0x${string}`[];
     to?: `0x${string}`;
 };
-export type StakePoolData = {
-    totalStaked: BalanceResult;
-    escrowBalance: BalanceResult;
-    streamParams: {
-        windowSeconds: number;
-        streamStart: bigint;
-        streamEnd: bigint;
-        isActive: boolean;
-    };
-    rewardRatePerSecond: BalanceResult;
-};
-export type StakeUserData = {
-    stakedBalance: BalanceResult;
-    aprBps: {
-        raw: bigint;
-        percentage: number;
-    };
-};
-export type StakeOutstandingRewards = {
-    available: BalanceResult;
-    pending: BalanceResult;
-};
-export type StakeClaimableRewards = {
-    claimable: BalanceResult;
-};
 export type VotingPowerResult = {
     tokenDays: bigint;
     formatted: string;
@@ -48,6 +23,7 @@ export declare class Stake {
     private publicClient;
     private stakingAddress;
     private tokenAddress;
+    private stakedTokenAddress;
     private tokenDecimals;
     private chainId;
     private userAddress;
@@ -75,10 +51,18 @@ export declare class Stake {
      */
     claimRewards(params: ClaimParams | void): Promise<TransactionReceipt>;
     /**
-     * Accrue rewards by triggering manual accrual from balance delta detection
+     * Accrue rewards for a single token using forwarder multicall
+     *
+     * SECURITY FIX (External Audit 2): Fee collection now handled via SDK using executeMulticall
+     * This prevents arbitrary code execution risk from external contract calls in contracts
+     *
+     * Flow:
+     * 1. Call LP locker collectRewards() via forwarder.executeTransaction (wrapped external call)
+     * 2. Call fee locker claim() via forwarder.executeTransaction (wrapped external call)
+     * 3. If fee splitter: call distribute() (distributes to receivers including staking)
+     * 4. Call accrueRewards() on staking contract (detects balance increase)
      *
-     * NOTE: If fee splitter is configured, call distributeFromFeeSplitter() FIRST.
-     * The fee splitter transfers tokens to staking, then accrueRewards() detects the balance increase.
+     * @param tokenAddress The reward token to accrue (defaults to clankerToken)
      */
     accrueRewards(tokenAddress?: `0x${string}`): Promise<TransactionReceipt>;
     /**
@@ -93,12 +77,14 @@ export declare class Stake {
     /**
      * Accrue rewards for multiple tokens in a single transaction using forwarder multicall
      *
-     * If fee splitter is configured and active, this will:
-     * 1. Call distribute() on fee splitter for each token
-     * 2. Fee splitter automatically calls accrueRewards() after distribution
+     * SECURITY FIX (External Audit 2): Fee collection now handled via SDK using executeMulticall
+     * This prevents arbitrary code execution risk from external contract calls in contracts
      *
-     * If fee splitter is NOT configured, this will:
-     * 1. Directly call accrueRewards() for each token on staking contract
+     * Flow:
+     * 1. Call LP locker collectRewards() via factory.executeTransaction (wrapped external call)
+     * 2. Call fee locker claim() via factory.executeTransaction (wrapped external call)
+     * 3. If fee splitter: call distribute() (distributes to receivers including staking)
+     * 4. Call accrueRewards() on staking contract (detects balance increase)
      *
      * @param params.tokens - Array of token addresses to accrue (defaults to [clankerToken, WETH])
      * @param params.useFeeSplitter - If true, uses fee splitter distribute (auto-detected if not provided)

package/dist/types/stake.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stake.d.ts","sourceRoot":"","sources":["../../src/stake.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAA;AAG9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,GAAG,CAAA;AAGhC,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9E,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,eAAe,CAAA;IACvB,YAAY,EAAE,eAAe,CAAA;IAC7B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IAChC,EAAE,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAA;IACxB,EAAE,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,aAAa,CAAA;IAC1B,aAAa,EAAE,aAAa,CAAA;IAC5B,YAAY,EAAE;QACZ,aAAa,EAAE,MAAM,CAAA;QACrB,WAAW,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,OAAO,CAAA;KAClB,CAAA;IACD,mBAAmB,EAAE,aAAa,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,aAAa,CAAA;IAC5B,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,aAAa,CAAA;IACxB,OAAO,EAAE,aAAa,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,aAAa,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,cAAc,CAAe;IACrC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,gBAAgB,CAAC,CAAe;IACxC,OAAO,CAAC,mBAAmB,CAAS;gBAExB,MAAM,EAAE,WAAW;IAe/B;;OAEG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAqB5E;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAqB1E;;;OAGG;IACG,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC;QACpD,OAAO,EAAE,kBAAkB,CAAA;QAC3B,cAAc,EAAE,MAAM,CAAA;KACvB,CAAC;IAgEF;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAyB3E;;;;;OAKG;IACG,aAAa,CAAC,YAAY,CAAC,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAkB9E;;;;;OAKG;IACG,yBAAyB,CAAC,MAAM,CAAC,EAAE;QACvC,MAAM,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAA;KACzB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmC/B;;;;;;;;;;;;OAYG;IACG,gBAAgB,CAAC,MAAM,CAAC,EAAE;QAC9B,MAAM,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAA;QACxB,cAAc,CAAC,EAAE,OAAO,CAAA;KACzB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAiG/B;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAI7B;;;;OAIG;IACG,oBAAoB,CACxB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAChC,WAAW,CAAC,EAAE,KAAK,MAAM,EAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC;CAqB9B"}
+{"version":3,"file":"stake.d.ts","sourceRoot":"","sources":["../../src/stake.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAA;AAG9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,GAAG,CAAA;AAShC,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAG/D,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,eAAe,CAAA;IACvB,YAAY,EAAE,eAAe,CAAA;IAC7B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IAChC,EAAE,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAA;IACxB,EAAE,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,cAAc,CAAe;IACrC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,kBAAkB,CAAe;IACzC,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,WAAW,CAAe;IAClC,OAAO,CAAC,gBAAgB,CAAC,CAAe;IACxC,OAAO,CAAC,mBAAmB,CAAS;gBAExB,MAAM,EAAE,WAAW;IAgB/B;;OAEG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAuB5E;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAuB1E;;;OAGG;IACG,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC;QACpD,OAAO,EAAE,kBAAkB,CAAA;QAC3B,cAAc,EAAE,MAAM,CAAA;KACvB,CAAC;IAgEF;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAyB3E;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,YAAY,CAAC,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA0B9E;;;;;OAKG;IACG,yBAAyB,CAAC,MAAM,CAAC,EAAE;QACvC,MAAM,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAA;KACzB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmC/B;;;;;;;;;;;;;;OAcG;IACG,gBAAgB,CAAC,MAAM,CAAC,EAAE;QAC9B,MAAM,CAAC,EAAE,KAAK,MAAM,EAAE,EAAE,CAAA;QACxB,cAAc,CAAC,EAAE,OAAO,CAAA;KACzB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAuJ/B;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAI7B;;;;OAIG;IACG,oBAAoB,CACxB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAChC,WAAW,CAAC,EAAE,KAAK,MAAM,EAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC;CAuB9B"}