@steerprotocol/sdk 1.30.8 → 2.0.0

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

@@ -1,257 +0,0 @@
-import type { PublicClient, WalletClient } from 'viem';
-import { PoolData, SteerResponse } from '../types.js';
-import { SubgraphClient } from './SubgraphClient.js';
-import { Protocol } from '../const/chain.js';
-/**
- * GraphQL token data interface representing token information from subgraph responses
- * @interface GraphQLTokenData
- */
-export interface GraphQLTokenData {
-    /** Token symbol (e.g., "ETH", "USDC") */
-    symbol: string;
-    /** Token contract address */
-    id: string;
-    /** Number of decimal places for the token */
-    decimals: string;
-    /** Human-readable token name */
-    name: string;
-}
-/**
- * GraphQL pool data interface representing pool information from subgraph responses
- * @interface GraphQLPoolData
- */
-export interface GraphQLPoolData {
-    /** Pool contract address */
-    id: string;
-    /** First token in the pool */
-    token0: GraphQLTokenData;
-    /** Second token in the pool */
-    token1: GraphQLTokenData;
-    /** 24-hour trading volume in USD */
-    volumeUSD: string;
-    /** Current tick of the pool */
-    tick: string;
-    /** Total liquidity in the pool */
-    liquidity: string;
-    /** Fee tier for the pool (optional) */
-    feeTier?: string;
-    /** 24-hour volume of token0 (optional) */
-    volumeToken0?: string;
-    /** 24-hour volume of token1 (optional) */
-    volumeToken1?: string;
-    /** Total value locked in ETH (optional) */
-    totalValueLockedETH?: string;
-    /** Alternative field name for volume USD (optional) */
-    volumeUsd?: string;
-    /** Alternative field name for TVL in ETH (optional) */
-    totalValueLockedEth?: string;
-}
-/**
- * Filter criteria for querying pools
- * @interface PoolFilter
- */
-export interface PoolFilter {
-    /** Chain ID to filter pools by */
-    chainId?: number;
-    /** Protocol to filter pools by */
-    protocol?: Protocol;
-    /** Minimum volume in USD to filter pools */
-    minVolumeUSD?: number;
-    /** Token address to find pools containing this token */
-    tokenAddress?: string;
-    /** Maximum number of pools to return */
-    limit?: number;
-}
-/**
- * Client for fetching pool data from various DEX protocol subgraphs
- *
- * @example
- * ```typescript
- * import { createPublicClient, createWalletClient, http } from 'viem';
- * import { mainnet } from 'viem/chains';
- * import { PoolClient } from '@steerprotocol/sdk';
- *
- * const client = createPublicClient({
- *   chain: mainnet,
- *   transport: http()
- * }) as PublicClient & WalletClient;
- *
- * const poolClient = new PoolClient(client, 'your-subgraph-studio-key');
- *
- * // Fetch top pools
- * const topPools = await poolClient.getTopPools(100, Protocol.UniswapV3, 1);
- * ```
- *
- * @extends SubgraphClient
- * @group Pool
- */
-export declare class PoolClient extends SubgraphClient {
-    /** Public client for blockchain interactions */
-    protected readonly publicClient: PublicClient;
-    /** Default timeout for GraphQL queries in milliseconds */
-    private readonly defaultTimeout;
-    /** Counter for tracking API call metrics */
-    private apiCallCount;
-    /** Subgraph Studio API key for rate limiting */
-    private readonly subgraphStudioKey;
-    /**
-     * Creates a new PoolClient instance
-     *
-     * @param client - Combined public and wallet client for blockchain interactions
-     * @param subgraphStudioKey - Optional Subgraph Studio API key for higher rate limits
-     *
-     * @example
-     * ```typescript
-     * const poolClient = new PoolClient(client, 'your-api-key');
-     * ```
-     */
-    constructor(client: PublicClient & WalletClient, subgraphStudioKey?: string);
-    /**
-     * Resets the API call counter for metrics tracking
-     *
-     * @example
-     * ```typescript
-     * poolClient.resetMetrics();
-     * ```
-     */
-    resetMetrics(): void;
-    /**
-     * Gets current metrics for monitoring API usage
-     *
-     * @returns Object containing current metrics
-     *
-     * @example
-     * ```typescript
-     * const metrics = poolClient.getMetrics();
-     * console.log(`API calls made: ${metrics.apiCallCount}`);
-     * ```
-     */
-    getMetrics(): {
-        apiCallCount: number;
-    };
-    /**
-     * Fetches data from GraphQL endpoint with retry logic for rate limits
-     *
-     * @param query - GraphQL query string
-     * @param variables - Variables for the GraphQL query
-     * @param protocol - Protocol to query
-     * @param chainId - Chain ID to query
-     * @returns Promise containing the response data
-     *
-     * @throws {Error} When subgraph endpoint is not available
-     * @throws {Error} When rate limit is exceeded after max retries
-     * @throws {Error} When GraphQL query times out
-     *
-     * @internal
-     */
-    private fetchFromGraph;
-    /**
-     * Fetches the top pools for a specific protocol by trading volume
-     *
-     * @param count - Number of pools to fetch (default: 500)
-     * @param protocol - Protocol to fetch pools from
-     * @param chainId - Chain ID to fetch pools from
-     * @returns Promise containing an array of top pools
-     *
-     * @example
-     * ```typescript
-     * // Get top 100 Uniswap V3 pools on Ethereum
-     * const topPools = await poolClient.getTopPools(100, Protocol.UniswapV3, 1);
-     * if (topPools.success) {
-     *   console.log(`Found ${topPools.data.length} pools`);
-     * }
-     * ```
-     *
-     * @throws {Error} When failed to fetch pools from subgraph
-     */
-    getTopPools(count: number | undefined, protocol: Protocol, chainId: number): Promise<SteerResponse<GraphQLPoolData[]>>;
-    /**
-     * Fetches detailed information for a specific pool by its ID
-     *
-     * @param poolId - Pool contract address to fetch
-     * @param protocol - Protocol the pool belongs to
-     * @param chainId - Chain ID where the pool exists
-     * @returns Promise containing pool details or null if not found
-     *
-     * @example
-     * ```typescript
-     * // Get specific pool details
-     * const poolDetails = await poolClient.getPoolById(
-     *   '0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640',
-     *   Protocol.UniswapV3,
-     *   1
-     * );
-     * if (poolDetails.success && poolDetails.data) {
-     *   console.log(`Pool: ${poolDetails.data.token0.symbol}/${poolDetails.data.token1.symbol}`);
-     * }
-     * ```
-     *
-     * @throws {Error} When failed to fetch pool from subgraph
-     */
-    getPoolById(poolId: string, protocol: Protocol, chainId: number): Promise<SteerResponse<GraphQLPoolData | null>>;
-    /**
-     * Fetches pools containing multiple tokens in batches for better performance
-     *
-     * @param tokenAddresses - Array of token contract addresses
-     * @param protocol - Protocol to fetch pools from
-     * @param chainId - Chain ID to fetch pools from
-     * @param batchSize - Number of tokens to process in each batch (default: 10)
-     * @returns Promise containing all pools found for the tokens
-     *
-     * @example
-     * ```typescript
-     * // Get pools for multiple tokens
-     * const tokenAddresses = [
-     *   '0xa0b86a33e6f8b07b71c3a39ef77a6b6e8f1b7b7e', // USDC
-     *   '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'  // WETH
-     * ];
-     * const pools = await poolClient.fetchPoolsForTokensBatch(
-     *   tokenAddresses,
-     *   Protocol.UniswapV3,
-     *   1,
-     *   5
-     * );
-     * ```
-     *
-     * @throws {Error} When batch processing fails
-     */
-    fetchPoolsForTokensBatch(tokenAddresses: string[], protocol: Protocol, chainId: number, batchSize?: number): Promise<SteerResponse<GraphQLPoolData[]>>;
-    /**
-     * Fetches all pools containing a specific token
-     *
-     * @param tokenAddress - Token contract address
-     * @param protocol - Protocol to fetch pools from
-     * @param chainId - Chain ID to fetch pools from
-     * @returns Promise containing pools that include the specified token
-     *
-     * @example
-     * ```typescript
-     * // Get all USDC pools on Uniswap V3
-     * const usdcPools = await poolClient.fetchPoolsForToken(
-     *   '0xa0b86a33e6f8b07b71c3a39ef77a6b6e8f1b7b7e',
-     *   Protocol.UniswapV3,
-     *   1
-     * );
-     * if (usdcPools.success) {
-     *   console.log(`Found ${usdcPools.data.length} USDC pools`);
-     * }
-     * ```
-     *
-     * @throws {Error} When failed to fetch pools for token
-     */
-    fetchPoolsForToken(tokenAddress: string, protocol: Protocol, chainId: number): Promise<SteerResponse<GraphQLPoolData[]>>;
-    /**
-     * Filters pools based on validity criteria such as tick range and liquidity
-     *
-     * @param pools - Array of pools to filter
-     * @returns Array of valid pools that meet the criteria
-     *
-     * @example
-     * ```typescript
-     * const validPools = poolClient.filterValidPools(allPools);
-     * console.log(`Filtered down to ${validPools.length} valid pools`);
-     * ```
-     */
-    filterValidPools(pools: PoolData[]): PoolData[];
-}
-//# sourceMappingURL=PoolClient.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"PoolClient.d.ts","sourceRoot":"","sources":["../../../src/base/PoolClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EACL,QAAQ,EAET,MAAM,mBAAmB,CAAC;AAQ3B;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,MAAM,EAAE,gBAAgB,CAAC;IACzB,+BAA+B;IAC/B,MAAM,EAAE,gBAAgB,CAAC;IACzB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAoDD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,UAAW,SAAQ,cAAc;IAC5C,gDAAgD;IAChD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAC9C,0DAA0D;IAC1D,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,4CAA4C;IAC5C,OAAO,CAAC,YAAY,CAAa;IACjC,gDAAgD;IAChD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAE3C;;;;;;;;;;OAUG;gBAED,MAAM,EAAE,YAAY,GAAG,YAAY,EACnC,iBAAiB,GAAE,MAAW;IAOhC;;;;;;;OAOG;IACI,YAAY,IAAI,IAAI;IAI3B;;;;;;;;;;OAUG;IACI,UAAU,IAAI;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE;IAM7C;;;;;;;;;;;;;;OAcG;YACW,cAAc;IA4E5B;;;;;;;;;;;;;;;;;;OAkBG;IACU,WAAW,CACtB,KAAK,EAAE,MAAM,YAAM,EACnB,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,CAAC,CAAC;IA8C5C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,WAAW,CACtB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC;IAqCjD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,wBAAwB,CACnC,cAAc,EAAE,MAAM,EAAE,EACxB,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAW,GACrB,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,CAAC,CAAC;IAqG5C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,kBAAkB,CAC7B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,CAAC,CAAC;IA4C5C;;;;;;;;;;;OAWG;IACI,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE;CA6BvD"}

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

@@ -1,46 +0,0 @@
-import type { PublicClient, WalletClient } from 'viem';
-import { SmartRewards } from './SmartRewards.js';
-/**
- * Client for interacting with Steer Protocol's Smart Rewards system.
- * This client provides functionality for managing rewards, claims, and campaigns.
- *
- * @example
- * ```typescript
- * import { createPublicClient, createWalletClient, http } from 'viem';
- * import { mainnet } from 'viem/chains';
- * import { SmartRewardsClient } from '@steerprotocol/sdk';
- *
- * // Create viem clients
- * const publicClient = createPublicClient({
- *   chain: mainnet,
- *   transport: http()
- * });
- *
- * const walletClient = createWalletClient({
- *   chain: mainnet,
- *   transport: http()
- * });
- *
- * // Initialize the Smart Rewards client
- * const rewardsClient = new SmartRewardsClient(publicClient, walletClient, 'production');
- *
- * // Get user's reward summary
- * const summary = await rewardsClient.getRewardSummary(userAddress, chainId);
- *
- * // Claim rewards
- * const tx = await rewardsClient.claimCampaignRewards(userAddress, chainId);
- * ```
- *
- * @group Client
- */
-export declare class SmartRewardsClient extends SmartRewards {
-    /**
-     * Creates a new instance of SmartRewardsClient
-     * @param publicClient - The public client for reading from the blockchain
-     * @param walletClient - The wallet client for writing to the blockchain
-     * @param environment - The environment to use ('production' or 'development')
-     * @param version - Optional API version to use (defaults to 'v1')
-     */
-    constructor(publicClient: PublicClient, walletClient: WalletClient, environment: 'production' | 'development', version?: 'v1');
-}
-//# sourceMappingURL=SmartRewardClient.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"SmartRewardClient.d.ts","sourceRoot":"","sources":["../../../src/base/SmartRewardClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAClD;;;;;;OAMG;gBAED,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,EAC1B,WAAW,EAAE,YAAY,GAAG,aAAa,EACzC,OAAO,GAAE,IAAW;CAMvB"}

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

@@ -1,291 +0,0 @@
-import { Campaign, createClient } from '@steerprotocol/api-sdk';
-import type { Address, Hash, PublicClient, WalletClient } from 'viem';
-import { SteerResponse } from '../types.js';
-/**
- * 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);
-     * ```
-     */
-    getClaimedRewardsByPool(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, poolAddress: string, 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

@@ -1 +0,0 @@
-{"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;AAEtE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C;;;;;;;;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;IAiD9C;;;;;;;;;;;;;;;OAeG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,GACb,OAAO,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;IAmDjD;;;;;;;;;;;;;;OAcG;IACU,gBAAgB,CAC3B,IAAI,EAAE,OAAO,EACb,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,MAAW,GACpB,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IAiE3B,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;IAqDjF;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IA8D/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;IAsFH;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAG/C"}