@steerprotocol/sdk 0.1.4 → 1.1.0

package/dist/types/base/SmartRewards.d.ts

@@ -0,0 +1,291 @@
+import { Campaign, createClient } from '@steerprotocol/api-sdk';
+import type { Address, Hash, PublicClient, WalletClient } from 'viem';
+import { SteerResponse } from '../types';
+/**
+ * Represents a node in the claim proof data structure
+ * @property chainId - The ID of the chain where the claim exists
+ * @property lastBlockUpdatedTo - The last block number this claim was updated to
+ * @property user - The address of the user who can claim
+ * @property campaignId - The ID of the campaign this claim belongs to
+ * @property amount - The claimable amount as a string (may include decimals)
+ * @property proof - The merkle proof array required for claiming
+ */
+export interface ClaimProofNode {
+    chainId: number;
+    lastBlockUpdatedTo: number;
+    user: string;
+    campaignId: number;
+    amount: string;
+    proof: readonly string[];
+}
+export interface ClaimProofEdge {
+    node: ClaimProofNode;
+    cursor: string;
+}
+/**
+ * Represents a historical claim reward record
+ * @property id - Unique identifier for the claim
+ * @property user - Address of the user who claimed
+ * @property amount - Amount that was claimed (may include decimals)
+ * @property campaign - Campaign identifier
+ * @property chainId - Chain ID where the claim occurred
+ * @property timestamp - Unix timestamp of when the claim occurred
+ */
+export interface ClaimRewardNode {
+    id: string;
+    user: string;
+    amount: string;
+    campaign: string;
+    chainId: number;
+    timestamp: number;
+}
+export interface ClaimRewardEdge {
+    cursor: string;
+    node: ClaimRewardNode;
+}
+/**
+ * Pagination information for paginated queries
+ * @property hasNextPage - Whether there are more results available
+ * @property endCursor - Cursor to use for fetching next page, if available
+ */
+export interface PageInfo {
+    hasNextPage: boolean;
+    endCursor: string | null | undefined;
+}
+/**
+ * Connection type for claim rewards, following the Relay specification
+ * @property edges - Array of claim reward records with cursors
+ * @property pageInfo - Pagination information
+ * @property totalCount - Total number of records available
+ */
+export interface ClaimRewardsConnection {
+    edges: readonly ClaimRewardEdge[];
+    pageInfo: PageInfo;
+    totalCount: number;
+}
+export interface ClaimProofsPageInfo {
+    hasNextPage: boolean;
+    endCursor?: string;
+}
+export interface ClaimProofsResponse {
+    totalCount: number;
+    edges: readonly ClaimProofEdge[];
+    pageInfo: ClaimProofsPageInfo;
+}
+export interface SmartRewarderContract {
+    chainId: number;
+    address: string;
+}
+/**
+ * Parameters required for claiming rewards
+ * @property users - Array of user addresses who are claiming
+ * @property campaignIds - Array of campaign IDs corresponding to each claim
+ * @property amounts - Array of amounts to claim
+ * @property proofs - Array of merkle proofs for verification
+ * @property rewarderAddress - Address of the smart rewarder contract
+ */
+export interface ClaimRewardParams {
+    users: readonly Address[];
+    campaignIds: readonly bigint[];
+    amounts: readonly bigint[];
+    proofs: readonly (readonly `0x${string}`[])[];
+    rewarderAddress: Address;
+}
+/**
+ * Represents a reward balance with both native and formatted values
+ * @property formatted - Human-readable string format with proper decimals
+ * @property native - Raw bigint value
+ */
+export interface RewardBalance {
+    formatted: string;
+    native: bigint;
+}
+/**
+ * Comprehensive summary of a user's reward status
+ * @property totalEarned - Total rewards earned (claimed + claimable)
+ * @property totalClaimed - Total rewards already claimed
+ * @property claimable - Rewards available to claim
+ */
+export interface RewardSummary {
+    totalEarned: RewardBalance;
+    totalClaimed: RewardBalance;
+    claimable: RewardBalance;
+}
+export declare abstract class SmartRewards {
+    protected readonly client: ReturnType<typeof createClient>;
+    protected readonly publicClient: PublicClient;
+    protected readonly walletClient: WalletClient;
+    constructor(client: ReturnType<typeof createClient>, publicClient: PublicClient, walletClient: WalletClient);
+    getCampaigns(chainId: number): Promise<SteerResponse<Campaign[]>>;
+    /**
+     * Retrieves campaigns associated with a specific pool address
+     * @param poolAddress - The address of the pool to get campaigns for
+     * @param chainId - Chain ID where the pool exists
+     * @returns Promise resolving to an array of campaigns associated with the pool
+     *
+     * @example
+     * ```typescript
+     * // Get campaigns for a pool on a specific chain
+     * const campaigns = await smartRewards.campaignsByPool('0x...', 1);
+     * ```
+     */
+    campaignsByPool(poolAddress: string, chainId: number): Promise<SteerResponse<Campaign[]>>;
+    /**
+     * Retrieves claim proofs for a user that can be used to claim rewards
+     * @param user - Address of the user to get proofs for
+     * @param chainId - Chain ID where the claims exist
+     * @param campaignId - Optional campaign ID to filter claims
+     * @returns Promise resolving to claim proof data with pagination support
+     */
+    getClaimProofs(user: Address, chainId: number, campaignId?: number): Promise<SteerResponse<ClaimProofsResponse>>;
+    /**
+     * Retrieves historical claim data for a specific pool
+     * @param chainId - Chain ID where the pool exists
+     * @param pool - Address or identifier of the pool
+     * @param user - Optional user address to filter claims
+     * @returns Promise resolving to paginated claim history data
+     *
+     * @example
+     * ```typescript
+     * // Get all claims for a pool
+     * const allClaims = await smartRewards.getClaimRewardsByPool(1, poolAddress);
+     *
+     * // Get claims for a specific user in a pool
+     * const userClaims = await smartRewards.getClaimRewardsByPool(1, poolAddress, userAddress);
+     * ```
+     */
+    getClaimRewardsByPool(chainId: number, pool: string, user?: Address): Promise<SteerResponse<ClaimRewardsConnection>>;
+    /**
+     * Gets a comprehensive summary of a user's reward status
+     * @param user - Address of the user
+     * @param chainId - Chain ID to check rewards on
+     * @param campaignId - Optional campaign ID to filter rewards
+     * @param decimals - Number of decimals for formatting (default: 18)
+     * @returns Promise resolving to reward summary with both native and formatted values
+     *
+     * @example
+     * ```typescript
+     * const summary = await smartRewards.getRewardSummary(userAddress, chainId);
+     * console.log('Total earned:', summary.data.totalEarned.formatted);
+     * console.log('Available to claim:', summary.data.claimable.formatted);
+     * ```
+     */
+    getRewardSummary(user: Address, chainId: number, campaignId?: number, decimals?: number): Promise<SteerResponse<RewardSummary>>;
+    getSmartRewarderContracts(): Promise<SteerResponse<readonly SmartRewarderContract[]>>;
+    /**
+     * Claims rewards from the smart rewarder contract
+     * @param params - Parameters required for claiming rewards
+     * @returns Promise resolving to transaction hash if successful
+     *
+     * @remarks
+     * This method handles the low-level interaction with the smart contract.
+     * For a higher-level interface, consider using {@link claimCampaignRewards} instead.
+     *
+     * @example
+     * ```typescript
+     * // Get claim proofs
+     * const claimProofs = await smartRewards.getClaimProofs(userAddress, chainId, campaignId);
+     *
+     * // Get smart rewarder contract
+     * const rewarders = await smartRewards.getSmartRewarderContracts();
+     * const rewarder = rewarders.data?.find(r => r.chainId === chainId);
+     *
+     * if (claimProofs.data && rewarder) {
+     *   // Prepare claim data
+     *   const claimData = smartRewards.prepareClaimData(claimProofs.data);
+     *   claimData.rewarderAddress = rewarder.address as Address;
+     *
+     *   // Claim rewards
+     *   const tx = await smartRewards.claimReward(claimData);
+     * }
+     * ```
+     *
+     * @throws Will throw an error if no wallet account is found
+     * @throws Will throw an error if contract simulation fails
+     */
+    claimReward(params: ClaimRewardParams): Promise<SteerResponse<Hash>>;
+    /**
+     * Helper function to prepare claim data from claim proofs
+     * @param proofs - The claim proofs response from getClaimProofs
+     * @returns ClaimRewardParams object ready for use with claimReward
+     *
+     * @remarks
+     * This helper function transforms the claim proofs into the format required by the smart contract.
+     * Note that the returned object's rewarderAddress is empty and must be set before using with claimReward.
+     *
+     * @example
+     * ```typescript
+     * // Get claim proofs and rewarder contract
+     * const proofs = await smartRewards.getClaimProofs(userAddress, chainId);
+     * const rewarders = await smartRewards.getSmartRewarderContracts();
+     * const rewarder = rewarders.data?.find(r => r.chainId === chainId);
+     *
+     * if (proofs.data && rewarder) {
+     *   // Prepare the claim data
+     *   const claimData = smartRewards.prepareClaimData(proofs.data);
+     *
+     *   // Set the rewarder address (required)
+     *   claimData.rewarderAddress = rewarder.address as Address;
+     *
+     *   // Now the data is ready for claiming
+     *   const tx = await smartRewards.claimReward(claimData);
+     * }
+     * ```
+     */
+    prepareClaimData(proofs: ClaimProofsResponse): ClaimRewardParams;
+    /**
+     * Convenience function to handle the entire claim process
+     * @param userAddress The address of the user claiming rewards
+     * @param chainId The chain ID where the campaign exists
+     * @param campaignId Optional campaign ID to filter claims
+     * @returns Transaction hash if successful, or error details if failed
+     */
+    claimCampaignRewards(userAddress: Address, chainId: number, campaignId?: number): Promise<SteerResponse<Hash>>;
+    /**
+     * Prepares the claim rewards campaign object with all necessary data for contract interaction
+     * @param userAddress The address of the user claiming rewards
+     * @param chainId The chain ID where the campaign exists
+     * @param campaignId Optional campaign ID to filter claims
+     * @returns Promise resolving to an object containing all necessary data for claiming rewards
+     *
+     * @example
+     * ```typescript
+     * // Get the prepared claim data
+     * const claimData = await smartRewards.prepareClaimRewardsCampaign(userAddress, chainId, campaignId);
+     *
+     * if (claimData.success) {
+     *   // Use the data with your own contract interaction methods
+     *   const { address, abi, functionName, args } = claimData.data;
+     *   // Execute the contract call using your preferred method
+     * }
+     * ```
+     */
+    prepareClaimRewardsCampaign(userAddress: Address, chainId: number, campaignId?: number): Promise<SteerResponse<{
+        address: Address;
+        abi: {
+            type: string;
+            inputs: {
+                name: string;
+                internalType: string;
+                type: string;
+            }[];
+            name: string;
+            outputs: never[];
+            stateMutability: string;
+        }[];
+        functionName: string;
+        args: readonly [
+            readonly Address[],
+            readonly bigint[],
+            readonly bigint[],
+            readonly (readonly `0x${string}`[])[]
+        ];
+    }>>;
+    /**
+     * Checks if a chain is supported by checking if it has a subgraph URL
+     * @param chainId The chain ID to check
+     * @returns boolean indicating if the chain is supported
+     */
+    supportsChain(chainId: number): boolean;
+}
+//# sourceMappingURL=SmartRewards.d.ts.map

package/dist/types/base/SmartRewards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SmartRewards.d.ts","sourceRoot":"","sources":["../../../src/base/SmartRewards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAIzC;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACtC;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,SAAS,eAAe,EAAE,CAAC;IAClC,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,SAAS,cAAc,EAAE,CAAC;IACjC,QAAQ,EAAE,mBAAmB,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,SAAS,OAAO,EAAE,CAAC;IAC1B,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,MAAM,EAAE,SAAS,CAAC,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;IAC9C,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,aAAa,CAAC;IAC3B,YAAY,EAAE,aAAa,CAAC;IAC5B,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,8BAAsB,YAAY;IAChC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;IAC3D,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;gBAG5C,MAAM,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,EACvC,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY;IAOf,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;IAwB9E;;;;;;;;;;;OAWG;IACU,eAAe,CAC1B,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;IAgCrC;;;;;;OAMG;IACU,cAAc,CACzB,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAgD9C;;;;;;;;;;;;;;;OAeG;IACU,qBAAqB,CAChC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,GACb,OAAO,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;IA8CjD;;;;;;;;;;;;;;OAcG;IACU,gBAAgB,CAC3B,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,GAAE,MAAW,GACpB,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IAiD3B,yBAAyB,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,qBAAqB,EAAE,CAAC,CAAC;IAmBlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IA8CjF;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,gBAAgB,CAAC,MAAM,EAAE,mBAAmB,GAAG,iBAAiB;IAUvE;;;;;;OAMG;IACU,oBAAoB,CAC/B,WAAW,EAAE,OAAO,EACpB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAyC/B;;;;;;;;;;;;;;;;;;OAkBG;IACU,2BAA2B,CACtC,WAAW,EAAE,OAAO,EACpB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,aAAa,CAAC;QACvB,OAAO,EAAE,OAAO,CAAC;QACjB,GAAG,EAAE;YACH,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC;gBACb,YAAY,EAAE,MAAM,CAAC;gBACrB,IAAI,EAAE,MAAM,CAAC;aACd,EAAE,CAAC;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,CAAC;YACjB,eAAe,EAAE,MAAM,CAAC;SACzB,EAAE,CAAC;QACJ,YAAY,EAAE,MAAM,CAAC;QACrB,IAAI,EAAE,SAAS;YACb,SAAS,OAAO,EAAE;YAClB,SAAS,MAAM,EAAE;YACjB,SAAS,MAAM,EAAE;YACjB,SAAS,CAAC,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC,EAAE;SACtC,CAAC;KACH,CAAC,CAAC;IAiEH;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAG/C"}

package/dist/types/base/SubgraphClient.d.ts

@@ -9,7 +9,7 @@ export declare abstract class SubgraphClient {
      * @param variables Optional variables for the query
      * @returns Promise with the query result
      */
-    protected executeSubgraphQuery<T>(query: string, variables?: Record<string, any>): Promise<SteerResponse<T>>;
+    protected executeSubgraphQuery<T>(query: string, variables?: Record<string, unknown>): Promise<SteerResponse<T>>;
     /**
      * Gets the subgraph URL for a given chain ID
      * @param chainId The chain ID to get the subgraph URL for

package/dist/types/base/SubgraphClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SubgraphClient.d.ts","sourceRoot":"","sources":["../../../src/base/SubgraphClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,8BAAsB,cAAc;IAClC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEtB,MAAM,EAAE,MAAM;IAI1B;;;;;OAKG;cACa,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC9B,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAiD5B;;;;OAIG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI7D;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAG/C"}
+{"version":3,"file":"SubgraphClient.d.ts","sourceRoot":"","sources":["../../../src/base/SubgraphClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,8BAAsB,cAAc;IAClC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEtB,MAAM,EAAE,MAAM;IAI1B;;;;;OAKG;cACa,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAiD5B;;;;OAIG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI7D;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAG/C"}

package/dist/types/base/VaultClient.d.ts

@@ -42,6 +42,7 @@ export declare class VaultClient extends SubgraphClient {
      * @param params The deposit parameters
      */
     deposit(params: VaultDepositParams): Promise<SteerResponse<Hash>>;
+    getDepositRatio(vaultAddress: Address): Promise<SteerResponse<bigint>>;
     /**
      * Withdraws tokens from a vault
      * @param params The withdrawal parameters
@@ -82,5 +83,6 @@ export declare class VaultClient extends SubgraphClient {
      * @param vaultAddress The vault address
      */
     name(vaultAddress: Address): Promise<SteerResponse<string>>;
+    pool(vaultAddress: Address): Promise<SteerResponse<Address>>;
 }
 //# sourceMappingURL=VaultClient.d.ts.map

package/dist/types/base/VaultClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VaultClient.d.ts","sourceRoot":"","sources":["../../../src/base/VaultClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAMlD,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,OAAO,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,OAAO,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,qBAAa,WAAY,SAAQ,cAAc;IAC7C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;gBAElC,MAAM,EAAE,YAAY,GAAG,YAAY;IAM/C;;OAEG;IACU,eAAe,CAAC,CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IA8B5D;;;OAGG;IACU,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAyC9E;;;OAGG;IACU,QAAQ,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAmChF;;;OAGG;IACU,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IA8B9E;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAwBpF;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAwBlF;;;OAGG;IACU,WAAW,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAuB/E;;;OAGG;IACU,QAAQ,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAuB5E;;;OAGG;IACU,MAAM,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAuB1E;;;OAGG;IACU,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;CAsBzE"}
+{"version":3,"file":"VaultClient.d.ts","sourceRoot":"","sources":["../../../src/base/VaultClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAOlD,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,OAAO,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,OAAO,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,qBAAa,WAAY,SAAQ,cAAc;IAC7C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;gBAElC,MAAM,EAAE,YAAY,GAAG,YAAY;IAM/C;;OAEG;IACU,eAAe,CAAC,CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IA8B5D;;;OAGG;IACU,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAyCjE,eAAe,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IA8EnF;;;OAGG;IACU,QAAQ,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAmChF;;;OAGG;IACU,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IA8B9E;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAwBpF;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAwBlF;;;OAGG;IACU,WAAW,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAuB/E;;;OAGG;IACU,QAAQ,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAuB5E;;;OAGG;IACU,MAAM,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAuB1E;;;OAGG;IACU,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAuB3D,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;CAsB1E"}

package/dist/types/client.d.ts

@@ -1,12 +1,67 @@
 import { SteerConfig, SteerResponse } from './types';
 import { SubgraphClient } from './base/SubgraphClient';
 import { VaultClient } from './base/VaultClient';
+import { SmartRewardsClient } from './base/SmartRewardClient';
+/**
+ * The main client for interacting with the Steer Protocol.
+ * This client provides access to vault operations and smart rewards functionality.
+ *
+ * @example
+ * ```typescript
+ * import { createPublicClient, createWalletClient, http } from 'viem';
+ * import { mainnet } from 'viem/chains';
+ * import { SteerClient } from '@steerprotocol/sdk';
+ *
+ * // Create viem clients
+ * const publicClient = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http()
+ * });
+ *
+ * const walletClient = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http()
+ * });
+ *
+ * // Initialize the Steer client
+ * const steerClient = new SteerClient({
+ *   environment: 'production',
+ *   client: publicClient,
+ *   walletClient: walletClient
+ * });
+ *
+ * // Use vault operations
+ * const vaults = await steerClient.vaults.getLatestVaults();
+ *
+ * // Use rewards functionality
+ * const campaigns = await steerClient.rewards.getCampaigns(1);
+ * const summary = await steerClient.rewards.getRewardSummary(userAddress, chainId);
+ * ```
+ *
+ * @group Client
+ */
 export declare class SteerClient extends SubgraphClient {
+    /** The environment the client is configured for */
     private readonly environment;
+    /** The vault client instance for interacting with Steer vaults */
     readonly vaults: VaultClient;
+    /** The rewards client instance for interacting with Smart Rewards */
+    readonly rewards: SmartRewardsClient;
+    /**
+     * Creates a new instance of the SteerClient
+     * @param config - The configuration object for the client
+     */
     constructor(config: SteerConfig);
     /**
      * Gets the active chain ID from the client
+     * @returns A promise that resolves to the active chain ID
+     * @throws Error if no active chain is found
+     *
+     * @example
+     * ```typescript
+     * const chainId = await steerClient.getActiveChain();
+     * console.log(chainId.data); // e.g., 1 for Ethereum mainnet
+     * ```
      */
     getActiveChain<T>(): Promise<SteerResponse<T>>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,qBAAa,WAAY,SAAQ,cAAc;IAE7C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+B;IAC3D,SAAgB,MAAM,EAAE,WAAW,CAAC;gBAExB,MAAM,EAAE,WAAW;IAO/B;;OAEG;IACU,cAAc,CAAC,CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAa5D"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAG9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,qBAAa,WAAY,SAAQ,cAAc;IAC7C,mDAAmD;IACnD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+B;IAE3D,kEAAkE;IAClE,SAAgB,MAAM,EAAE,WAAW,CAAC;IAEpC,qEAAqE;IACrE,SAAgB,OAAO,EAAE,kBAAkB,CAAC;IAE5C;;;OAGG;gBACS,MAAM,EAAE,WAAW;IA+B/B;;;;;;;;;;OAUG;IACU,cAAc,CAAC,CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAa5D"}

package/dist/types/const/abis/UniswapPool.d.ts

@@ -0,0 +1,36 @@
+export declare const UniswapV3PoolABI: ({
+    inputs: never[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+    name?: undefined;
+    outputs?: undefined;
+} | {
+    anonymous: boolean;
+    inputs: {
+        indexed: boolean;
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    type: string;
+    stateMutability?: undefined;
+    outputs?: undefined;
+} | {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+})[];
+//# sourceMappingURL=UniswapPool.d.ts.map

package/dist/types/const/abis/UniswapPool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UniswapPool.d.ts","sourceRoot":"","sources":["../../../../src/const/abis/UniswapPool.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAA2qX,CAAA"}

package/dist/types/const/api.d.ts

@@ -0,0 +1,17 @@
+/**
+ * API URLs for different environments and versions
+ */
+export declare const API_URLS: {
+    readonly v1: {
+        readonly production: "https://s55qpiwei1.execute-api.us-east-1.amazonaws.com";
+        readonly development: "https://s55qpiwei1.execute-api.us-east-1.amazonaws.com";
+    };
+};
+/**
+ * Get the API URL for a specific environment and version
+ * @param environment - The environment to get the URL for
+ * @param version - The API version to use (defaults to v1)
+ * @returns The API URL for the specified environment and version
+ */
+export declare function getApiUrl(environment: 'production' | 'development', version?: keyof typeof API_URLS): string;
+//# sourceMappingURL=api.d.ts.map

package/dist/types/const/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/const/api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,QAAQ;;;;;CAUX,CAAC;AAEX;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,WAAW,EAAE,YAAY,GAAG,aAAa,EACzC,OAAO,GAAE,MAAM,OAAO,QAAe,GACpC,MAAM,CAER"}

package/dist/types/index.d.ts

@@ -1,4 +1,71 @@
+export * from './base/SmartRewards';
 export * from './client';
 export * from './types';
 export * from './const';
+export * from './const/subgraph';
+export * from './const/api';
+/**
+ * @packageDocumentation
+ *
+ * The Steer Protocol SDK provides a comprehensive interface for interacting with Steer Protocol's smart contracts and services.
+ *
+ * ## Key Features
+ *
+ * - Smart Rewards Management
+ * - Campaign Interactions
+ * - Claim Management
+ * - Multi-chain Support
+ *
+ * ## Quick Start
+ *
+ * ```typescript
+ * import { createPublicClient, createWalletClient, http } from 'viem';
+ * import { mainnet } from 'viem/chains';
+ * import { SteerClient } from '@steerprotocol/sdk';
+ *
+ * // Create viem clients
+ * const publicClient = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http()
+ * });
+ *
+ * const walletClient = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http()
+ * });
+ *
+ * // Initialize the Steer client with both public and wallet clients
+ * const steerClient = new SteerClient({
+ *   environment: 'production',
+ *   client: publicClient,
+ *   walletClient: walletClient // Optional: Provide for write operations
+ * });
+ *
+ * // Use vault operations (read-only if no wallet client)
+ * const vaults = await steerClient.vaults.getLatestVaults();
+ *
+ * // Use rewards functionality (read-only if no wallet client)
+ * const campaigns = await steerClient.rewards.getCampaigns(1);
+ * const summary = await steerClient.rewards.getRewardSummary(userAddress, chainId);
+ *
+ * // Write operations (requires wallet client)
+ * if (steerClient.rewards) {
+ *   const tx = await steerClient.rewards.claimCampaignRewards(userAddress, chainId);
+ * }
+ * ```
+ *
+ * ## Smart Rewards
+ *
+ * The Smart Rewards functionality is accessible through the SteerClient's rewards property.
+ * It provides comprehensive functionality for managing rewards:
+ *
+ * - View reward balances and claim history (read-only operations)
+ * - Claim rewards across multiple campaigns (requires wallet client)
+ * - Track historical claims
+ * - Get comprehensive reward summaries
+ *
+ * For write operations like claiming rewards, make sure to provide a wallet client when initializing the SteerClient.
+ *
+ * See {@link SmartRewards} for detailed API documentation.
+ */
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG"}

package/dist/types/types.d.ts

@@ -1,7 +1,8 @@
 import type { Client, TestClient, WalletClient } from 'viem';
 export interface SteerConfig {
     environment?: 'production' | 'development';
-    client: Client | TestClient | WalletClient;
+    client: Client | TestClient;
+    walletClient?: WalletClient;
 }
 export interface SteerResponse<T> {
     data: T | null;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAE7D,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;IAC3C,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC;CAC5C;AAED,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAE7D,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;IAC3C,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC;IAC5B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@steerprotocol/sdk",
-  "version": "0.1.4",
+  "version": "1.1.0",
   "description": "Steer Protocol SDK",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -25,7 +25,13 @@
     "lint": "eslint . --ext .ts",
     "format": "prettier --write \"src/**/*.ts\"",
     "prepare": "npm run build",
-    "prepack": "tsx src/scripts/processDeployments.ts"
+    "prepack": "tsx src/scripts/processDeployments.ts",
+    "docs": "typedoc --out docs --entryPoints src/index.ts src/client.ts src/base/SmartRewards.ts src/base/SubgraphClient.ts src/base/VaultClient.ts --name \"Steer Protocol SDK\" --readme README.md --excludePrivate --excludeProtected",
+    "docs:watch": "typedoc --out docs --entryPoints src/index.ts src/base/SmartRewards.ts src/generated/sdk.ts --name \"Steer Protocol SDK\" --readme README.md --excludePrivate --excludeProtected --plugin none --watch",
+    "docs:serve": "npx serve docs",
+    "commit": "git-cz",
+    "typecheck": "tsc --noEmit",
+    "check-all": "yarn typecheck && yarn lint"
   },
   "keywords": [
     "steer",
@@ -50,13 +56,27 @@
     "rimraf": "^5.0.5",
     "ts-jest": "^29.2.5",
     "tsx": "^4.19.2",
+    "typedoc": "^0.27.6",
     "typescript": "^5.3.3",
-    "viem": "^2.22.0"
+    "viem": "^2.22.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.3",
+    "@semantic-release/npm": "^11.0.1",
+    "semantic-release": "^22.0.8",
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "commitizen": "^4.3.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "husky": "^8.0.3"
   },
   "engines": {
     "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@steerprotocol/api-sdk": "^1.0.2"
   }
 }