clanker-sdk 4.2.9 → 4.2.10

package/dist/v4/index.d.ts

@@ -5839,6 +5839,892 @@ declare class Clanker {
         txHash: undefined;
         error: ClankerError;
     }>;
+    /**
+     * Get the transaction config for reading token rewards information from the locker contract.
+     *
+     * @param token The token address to get rewards info for
+     * @param options Optional chain configuration
+     * @returns Abi transaction config for reading token rewards
+     */
+    getTokenRewardsTransaction({ token }: {
+        token: `0x${string}`;
+    }, options?: {
+        chain?: Chain;
+    }): Promise<{
+        readonly address: `0x${string}`;
+        readonly abi: readonly [{
+            readonly type: "constructor";
+            readonly inputs: readonly [{
+                readonly name: "owner_";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "factory_";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "feeLocker_";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "positionManager_";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "permit2_";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "universalRouter_";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "poolManager_";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "BASIS_POINTS";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "MAX_LP_POSITIONS";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "MAX_REWARD_PARTICIPANTS";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "collectRewards";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "collectRewardsWithoutUnlock";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "factory";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "feeLocker";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "address";
+                readonly internalType: "contract IClankerFeeLocker";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "feePreferences";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+            readonly outputs: readonly [{
+                readonly name: "feePreference";
+                readonly type: "uint8";
+                readonly internalType: "enum IClankerLpLockerFeeConversion.FeeIn";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "onERC721Received";
+            readonly inputs: readonly [{
+                readonly name: "";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "from";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "id";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "";
+                readonly type: "bytes";
+                readonly internalType: "bytes";
+            }];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "bytes4";
+                readonly internalType: "bytes4";
+            }];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "owner";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "permit2";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "address";
+                readonly internalType: "contract IPermit2";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "placeLiquidity";
+            readonly inputs: readonly [{
+                readonly name: "lockerConfig";
+                readonly type: "tuple";
+                readonly internalType: "struct IClanker.LockerConfig";
+                readonly components: readonly [{
+                    readonly name: "locker";
+                    readonly type: "address";
+                    readonly internalType: "address";
+                }, {
+                    readonly name: "rewardAdmins";
+                    readonly type: "address[]";
+                    readonly internalType: "address[]";
+                }, {
+                    readonly name: "rewardRecipients";
+                    readonly type: "address[]";
+                    readonly internalType: "address[]";
+                }, {
+                    readonly name: "rewardBps";
+                    readonly type: "uint16[]";
+                    readonly internalType: "uint16[]";
+                }, {
+                    readonly name: "tickLower";
+                    readonly type: "int24[]";
+                    readonly internalType: "int24[]";
+                }, {
+                    readonly name: "tickUpper";
+                    readonly type: "int24[]";
+                    readonly internalType: "int24[]";
+                }, {
+                    readonly name: "positionBps";
+                    readonly type: "uint16[]";
+                    readonly internalType: "uint16[]";
+                }, {
+                    readonly name: "lockerData";
+                    readonly type: "bytes";
+                    readonly internalType: "bytes";
+                }];
+            }, {
+                readonly name: "poolConfig";
+                readonly type: "tuple";
+                readonly internalType: "struct IClanker.PoolConfig";
+                readonly components: readonly [{
+                    readonly name: "hook";
+                    readonly type: "address";
+                    readonly internalType: "address";
+                }, {
+                    readonly name: "pairedToken";
+                    readonly type: "address";
+                    readonly internalType: "address";
+                }, {
+                    readonly name: "tickIfToken0IsClanker";
+                    readonly type: "int24";
+                    readonly internalType: "int24";
+                }, {
+                    readonly name: "tickSpacing";
+                    readonly type: "int24";
+                    readonly internalType: "int24";
+                }, {
+                    readonly name: "poolData";
+                    readonly type: "bytes";
+                    readonly internalType: "bytes";
+                }];
+            }, {
+                readonly name: "poolKey";
+                readonly type: "tuple";
+                readonly internalType: "struct PoolKey";
+                readonly components: readonly [{
+                    readonly name: "currency0";
+                    readonly type: "address";
+                    readonly internalType: "Currency";
+                }, {
+                    readonly name: "currency1";
+                    readonly type: "address";
+                    readonly internalType: "Currency";
+                }, {
+                    readonly name: "fee";
+                    readonly type: "uint24";
+                    readonly internalType: "uint24";
+                }, {
+                    readonly name: "tickSpacing";
+                    readonly type: "int24";
+                    readonly internalType: "int24";
+                }, {
+                    readonly name: "hooks";
+                    readonly type: "address";
+                    readonly internalType: "contract IHooks";
+                }];
+            }, {
+                readonly name: "poolSupply";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [{
+                readonly name: "positionId";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "poolManager";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "address";
+                readonly internalType: "contract IPoolManager";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "positionManager";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "address";
+                readonly internalType: "contract IPositionManager";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "renounceOwnership";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "supportsInterface";
+            readonly inputs: readonly [{
+                readonly name: "interfaceId";
+                readonly type: "bytes4";
+                readonly internalType: "bytes4";
+            }];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "bool";
+                readonly internalType: "bool";
+            }];
+            readonly stateMutability: "pure";
+        }, {
+            readonly type: "function";
+            readonly name: "tokenRewards";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "tuple";
+                readonly internalType: "struct IClankerLpLocker.TokenRewardInfo";
+                readonly components: readonly [{
+                    readonly name: "token";
+                    readonly type: "address";
+                    readonly internalType: "address";
+                }, {
+                    readonly name: "poolKey";
+                    readonly type: "tuple";
+                    readonly internalType: "struct PoolKey";
+                    readonly components: readonly [{
+                        readonly name: "currency0";
+                        readonly type: "address";
+                        readonly internalType: "Currency";
+                    }, {
+                        readonly name: "currency1";
+                        readonly type: "address";
+                        readonly internalType: "Currency";
+                    }, {
+                        readonly name: "fee";
+                        readonly type: "uint24";
+                        readonly internalType: "uint24";
+                    }, {
+                        readonly name: "tickSpacing";
+                        readonly type: "int24";
+                        readonly internalType: "int24";
+                    }, {
+                        readonly name: "hooks";
+                        readonly type: "address";
+                        readonly internalType: "contract IHooks";
+                    }];
+                }, {
+                    readonly name: "positionId";
+                    readonly type: "uint256";
+                    readonly internalType: "uint256";
+                }, {
+                    readonly name: "numPositions";
+                    readonly type: "uint256";
+                    readonly internalType: "uint256";
+                }, {
+                    readonly name: "rewardBps";
+                    readonly type: "uint16[]";
+                    readonly internalType: "uint16[]";
+                }, {
+                    readonly name: "rewardAdmins";
+                    readonly type: "address[]";
+                    readonly internalType: "address[]";
+                }, {
+                    readonly name: "rewardRecipients";
+                    readonly type: "address[]";
+                    readonly internalType: "address[]";
+                }];
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "transferOwnership";
+            readonly inputs: readonly [{
+                readonly name: "newOwner";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "universalRouter";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "address";
+                readonly internalType: "contract IUniversalRouter";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "updateFeePreference";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "rewardIndex";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "newFeePreference";
+                readonly type: "uint8";
+                readonly internalType: "enum IClankerLpLockerFeeConversion.FeeIn";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "updateRewardAdmin";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "rewardIndex";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "newAdmin";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "updateRewardRecipient";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "rewardIndex";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "newRecipient";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "version";
+            readonly inputs: readonly [];
+            readonly outputs: readonly [{
+                readonly name: "";
+                readonly type: "string";
+                readonly internalType: "string";
+            }];
+            readonly stateMutability: "view";
+        }, {
+            readonly type: "function";
+            readonly name: "withdrawERC20";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "recipient";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "function";
+            readonly name: "withdrawETH";
+            readonly inputs: readonly [{
+                readonly name: "recipient";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+            readonly outputs: readonly [];
+            readonly stateMutability: "nonpayable";
+        }, {
+            readonly type: "event";
+            readonly name: "ClaimedRewards";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "amount0";
+                readonly type: "uint256";
+                readonly indexed: false;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "amount1";
+                readonly type: "uint256";
+                readonly indexed: false;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "rewards0";
+                readonly type: "uint256[]";
+                readonly indexed: false;
+                readonly internalType: "uint256[]";
+            }, {
+                readonly name: "rewards1";
+                readonly type: "uint256[]";
+                readonly indexed: false;
+                readonly internalType: "uint256[]";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "event";
+            readonly name: "FeePreferenceUpdated";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "rewardIndex";
+                readonly type: "uint256";
+                readonly indexed: true;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "oldFeePreference";
+                readonly type: "uint8";
+                readonly indexed: false;
+                readonly internalType: "enum IClankerLpLockerFeeConversion.FeeIn";
+            }, {
+                readonly name: "newFeePreference";
+                readonly type: "uint8";
+                readonly indexed: true;
+                readonly internalType: "enum IClankerLpLockerFeeConversion.FeeIn";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "event";
+            readonly name: "FeesSwapped";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "rewardToken";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "amountSwapped";
+                readonly type: "uint256";
+                readonly indexed: false;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "swappedToken";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "amountOut";
+                readonly type: "uint256";
+                readonly indexed: false;
+                readonly internalType: "uint256";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "event";
+            readonly name: "InitialFeePreferences";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "feePreference";
+                readonly type: "uint8[]";
+                readonly indexed: false;
+                readonly internalType: "enum IClankerLpLockerFeeConversion.FeeIn[]";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "event";
+            readonly name: "OwnershipTransferred";
+            readonly inputs: readonly [{
+                readonly name: "previousOwner";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "newOwner";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "event";
+            readonly name: "Received";
+            readonly inputs: readonly [{
+                readonly name: "from";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "positionId";
+                readonly type: "uint256";
+                readonly indexed: false;
+                readonly internalType: "uint256";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "event";
+            readonly name: "RewardAdminUpdated";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "rewardIndex";
+                readonly type: "uint256";
+                readonly indexed: true;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "oldAdmin";
+                readonly type: "address";
+                readonly indexed: false;
+                readonly internalType: "address";
+            }, {
+                readonly name: "newAdmin";
+                readonly type: "address";
+                readonly indexed: false;
+                readonly internalType: "address";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "event";
+            readonly name: "RewardRecipientUpdated";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly indexed: true;
+                readonly internalType: "address";
+            }, {
+                readonly name: "rewardIndex";
+                readonly type: "uint256";
+                readonly indexed: true;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "oldRecipient";
+                readonly type: "address";
+                readonly indexed: false;
+                readonly internalType: "address";
+            }, {
+                readonly name: "newRecipient";
+                readonly type: "address";
+                readonly indexed: false;
+                readonly internalType: "address";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "event";
+            readonly name: "TokenRewardAdded";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly indexed: false;
+                readonly internalType: "address";
+            }, {
+                readonly name: "poolKey";
+                readonly type: "tuple";
+                readonly indexed: false;
+                readonly internalType: "struct PoolKey";
+                readonly components: readonly [{
+                    readonly name: "currency0";
+                    readonly type: "address";
+                    readonly internalType: "Currency";
+                }, {
+                    readonly name: "currency1";
+                    readonly type: "address";
+                    readonly internalType: "Currency";
+                }, {
+                    readonly name: "fee";
+                    readonly type: "uint24";
+                    readonly internalType: "uint24";
+                }, {
+                    readonly name: "tickSpacing";
+                    readonly type: "int24";
+                    readonly internalType: "int24";
+                }, {
+                    readonly name: "hooks";
+                    readonly type: "address";
+                    readonly internalType: "contract IHooks";
+                }];
+            }, {
+                readonly name: "poolSupply";
+                readonly type: "uint256";
+                readonly indexed: false;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "positionId";
+                readonly type: "uint256";
+                readonly indexed: false;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "numPositions";
+                readonly type: "uint256";
+                readonly indexed: false;
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "rewardBps";
+                readonly type: "uint16[]";
+                readonly indexed: false;
+                readonly internalType: "uint16[]";
+            }, {
+                readonly name: "rewardAdmins";
+                readonly type: "address[]";
+                readonly indexed: false;
+                readonly internalType: "address[]";
+            }, {
+                readonly name: "rewardRecipients";
+                readonly type: "address[]";
+                readonly indexed: false;
+                readonly internalType: "address[]";
+            }, {
+                readonly name: "tickLower";
+                readonly type: "int24[]";
+                readonly indexed: false;
+                readonly internalType: "int24[]";
+            }, {
+                readonly name: "tickUpper";
+                readonly type: "int24[]";
+                readonly indexed: false;
+                readonly internalType: "int24[]";
+            }, {
+                readonly name: "positionBps";
+                readonly type: "uint16[]";
+                readonly indexed: false;
+                readonly internalType: "uint16[]";
+            }];
+            readonly anonymous: false;
+        }, {
+            readonly type: "error";
+            readonly name: "InvalidPositionBps";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "InvalidRewardBps";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "MismatchedPositionInfos";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "MismatchedRewardArrays";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "NoPositions";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "NoRewardRecipients";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "OwnableInvalidOwner";
+            readonly inputs: readonly [{
+                readonly name: "owner";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+        }, {
+            readonly type: "error";
+            readonly name: "OwnableUnauthorizedAccount";
+            readonly inputs: readonly [{
+                readonly name: "account";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+        }, {
+            readonly type: "error";
+            readonly name: "ReentrancyGuardReentrantCall";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "SafeERC20FailedOperation";
+            readonly inputs: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+                readonly internalType: "address";
+            }];
+        }, {
+            readonly type: "error";
+            readonly name: "TickRangeLowerThanStartingTick";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "TicksBackwards";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "TicksNotMultipleOfTickSpacing";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "TicksOutOfTickBounds";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "TokenAlreadyHasRewards";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "TooManyPositions";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "TooManyRewardParticipants";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "Unauthorized";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "ZeroRewardAddress";
+            readonly inputs: readonly [];
+        }, {
+            readonly type: "error";
+            readonly name: "ZeroRewardAmount";
+            readonly inputs: readonly [];
+        }];
+        readonly functionName: "tokenRewards";
+        readonly args: readonly [`0x${string}`];
+    }>;
+    /**
+     * Get the token rewards information from the locker contract.
+     * This is useful for obtaining the rewardIndex needed for updateRewardRecipient and updateRewardAdmin.
+     *
+     * The returned object contains:
+     * - token: The token address
+     * - poolKey: The Uniswap V4 pool key
+     * - positionId: The LP position ID
+     * - numPositions: Number of LP positions
+     * - rewardBps: Array of reward basis points for each recipient
+     * - rewardAdmins: Array of admin addresses (index = rewardIndex)
+     * - rewardRecipients: Array of recipient addresses (index = rewardIndex)
+     *
+     * @param token The token address to get rewards info for
+     * @returns Token rewards information including rewardAdmins and rewardRecipients arrays
+     */
+    getTokenRewards({ token }: {
+        token: `0x${string}`;
+    }): Promise<{
+        token: `0x${string}`;
+        poolKey: {
+            currency0: `0x${string}`;
+            currency1: `0x${string}`;
+            fee: number;
+            tickSpacing: number;
+            hooks: `0x${string}`;
+        };
+        positionId: bigint;
+        numPositions: bigint;
+        rewardBps: readonly number[];
+        rewardAdmins: readonly `0x${string}`[];
+        rewardRecipients: readonly `0x${string}`[];
+    }>;
 }
 
 export { Clanker };

package/dist/v4/index.js

@@ -7787,6 +7787,48 @@ var Clanker = class {
     const input = await this.getUpdateMetadataTransaction({ token, metadata });
     return writeClankerContract(this.publicClient, this.wallet, input);
   }
+  /**
+   * Get the transaction config for reading token rewards information from the locker contract.
+   *
+   * @param token The token address to get rewards info for
+   * @param options Optional chain configuration
+   * @returns Abi transaction config for reading token rewards
+   */
+  async getTokenRewardsTransaction({ token }, options) {
+    const chain = this.publicClient?.chain || options?.chain || base3;
+    const config = clankerConfigFor(
+      chain.id,
+      "clanker_v4"
+    );
+    if (!config) throw new Error(`Clanker is not ready on ${chain.id}`);
+    return {
+      address: config.related.locker,
+      abi: ClankerLocker_v4_abi,
+      functionName: "tokenRewards",
+      args: [token]
+    };
+  }
+  /**
+   * Get the token rewards information from the locker contract.
+   * This is useful for obtaining the rewardIndex needed for updateRewardRecipient and updateRewardAdmin.
+   *
+   * The returned object contains:
+   * - token: The token address
+   * - poolKey: The Uniswap V4 pool key
+   * - positionId: The LP position ID
+   * - numPositions: Number of LP positions
+   * - rewardBps: Array of reward basis points for each recipient
+   * - rewardAdmins: Array of admin addresses (index = rewardIndex)
+   * - rewardRecipients: Array of recipient addresses (index = rewardIndex)
+   *
+   * @param token The token address to get rewards info for
+   * @returns Token rewards information including rewardAdmins and rewardRecipients arrays
+   */
+  async getTokenRewards({ token }) {
+    if (!this.publicClient) throw new Error("Public client required");
+    const tx = await this.getTokenRewardsTransaction({ token });
+    return this.publicClient.readContract(tx);
+  }
 };
 export {
   Clanker,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clanker-sdk",
-  "version": "4.2.9",
+  "version": "4.2.10",
   "description": "SDK for deploying tokens using Clanker",
   "type": "module",
   "main": "./dist/index.js",