@steerprotocol/sdk 1.31.0 → 2.0.0

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

@@ -1,244 +0,0 @@
-import type { Address, Hash, PublicClient, WalletClient } from 'viem';
-import { SteerResponse } from '../types.js';
-import { SubgraphClient } from './SubgraphClient.js';
-import { StakingProtocol } from '../const/protocol.js';
-export interface StakingPool {
-    allSymbols?: string;
-    rewardToken: Address;
-    rewardTokenDetail?: Reward;
-    rewardTokenA: Address;
-    rewardTokenADetail: Reward;
-    rewardTokenB?: Address;
-    rewardTokenBDetail?: Reward;
-    dailyEmissionRewardA: number;
-    dailyEmissionRewardB?: number;
-    chainId: number;
-    stakingPool: string;
-    stakingToken: string;
-    protocol: string;
-    staking: Staking;
-    reward: Reward;
-    isSteerVault: boolean;
-    beaconName?: string;
-    vaultTokens?: VaultTokens;
-    periodFinish: string;
-    isDualFactory?: boolean;
-    feeTier?: string;
-    rewardsDuration: string;
-    strategyId?: string;
-    isActive?: boolean;
-    postGeneratedTotalStaked?: number;
-    postGeneratedApr?: number;
-    stakedAmount?: bigint;
-    locked?: boolean;
-}
-export interface VaultTokens {
-    token0: Token0;
-    token1: Token1;
-}
-export interface Token0 {
-    name: string;
-    address: Address;
-    symbol: string;
-}
-export interface Token1 {
-    name: string;
-    address: Address;
-    symbol: string;
-}
-export interface Reward {
-    symbol: string;
-    name: string;
-    address: Address;
-    decimals: number;
-}
-export interface Staking {
-    symbol: string;
-    name: string;
-    address: Address;
-    decimals: number;
-}
-export interface StakingPoolFilter {
-    chainId?: number;
-    protocol?: StakingProtocol;
-    isLive?: boolean;
-    includeExpired?: boolean;
-    minDailyEmissionA?: number;
-    minDailyEmissionB?: number;
-    isDualRewards?: boolean;
-}
-export interface StakeParams {
-    stakingPool: Address;
-    amount: bigint;
-}
-export interface WithdrawParams {
-    stakingPool: Address;
-    amount: bigint;
-}
-export interface GetRewardParams {
-    stakingPool: Address;
-}
-export interface TokenValueParams {
-    stakingPool: StakingPool;
-    amount: bigint;
-    token0UsdPrice: number;
-    token1UsdPrice: number;
-}
-export interface TokenValueResponse {
-    totalValueUsd: number;
-    token0Value?: number;
-    token1Value?: number;
-    tokenValue?: number;
-}
-export declare class StakingClient extends SubgraphClient {
-    protected readonly publicClient: PublicClient;
-    protected readonly walletClient: WalletClient;
-    private readonly stakingPoolsEndpoint;
-    private readonly withdrawClient;
-    constructor(client: PublicClient & WalletClient);
-    /**
-     * Fetches and filters staking pools based on provided criteria
-     * @param filter Optional filter object to filter the pools
-     */
-    getStakingPools(filter?: StakingPoolFilter): Promise<SteerResponse<StakingPool[]>>;
-    /**
-     * Gets only currently active staking pools
-     * @param chainId Optional chain ID to filter pools
-     * @param protocol Optional protocol name to filter pools
-     */
-    getLiveStakingPools(chainId?: number, protocol?: StakingProtocol): Promise<SteerResponse<StakingPool[]>>;
-    /**
-     * Gets all dual rewards staking pools
-     * @param chainId Optional chain ID to filter pools
-     * @param protocol Optional protocol name to filter pools
-     * @param isLive Optional flag to only get live pools
-     */
-    getDualRewardsStakingPools(chainId?: number, protocol?: StakingProtocol, isLive?: boolean): Promise<SteerResponse<StakingPool[]>>;
-    /**
-     * Gets high yield staking pools based on minimum daily emissions
-     * @param minDailyEmissionA Minimum daily emission for reward A
-     * @param minDailyEmissionB Optional minimum daily emission for reward B
-     * @param chainId Optional chain ID to filter pools
-     */
-    getHighYieldStakingPools(minDailyEmissionA: number, minDailyEmissionB?: number, chainId?: number): Promise<SteerResponse<StakingPool[]>>;
-    /**
-     * Internal helper to filter pools based on criteria
-     */
-    private filterPools;
-    /**
-     * Stakes tokens in a staking pool
-     * @param params The staking parameters
-     */
-    stake(params: StakeParams): Promise<SteerResponse<Hash>>;
-    /**
-     * Withdraws tokens from a staking pool
-     * @param params The withdrawal parameters
-     */
-    withdraw(params: WithdrawParams): Promise<SteerResponse<Hash>>;
-    /**
-     * Claims rewards from a staking pool
-     * @param params The reward claim parameters
-     */
-    getReward(params: GetRewardParams): Promise<SteerResponse<Hash>>;
-    /**
-     * Gets the earned rewards for an account in a staking pool
-     * @param stakingPool The staking pool address
-     * @param account The account to check rewards for
-     */
-    earned(stakingPool: Address, account: Address): Promise<SteerResponse<{
-        rewardA: bigint;
-        rewardB?: bigint;
-    }>>;
-    /**
-     * Gets the total supply of staked tokens in a pool
-     * @param stakingPool The staking pool address
-     */
-    totalSupply(stakingPool: Address): Promise<SteerResponse<bigint>>;
-    /**
-     * Gets the staked balance of an account in a pool
-     * @param stakingPool The staking pool address
-     * @param account The account to check balance for
-     */
-    balanceOf(stakingPool: Address, account: Address): Promise<SteerResponse<bigint>>;
-    /**
-     * Calculates the APR for a staking pool
-     * @param pool The staking pool data
-     * @param rewardTokenPriceUSD The price of the reward token in USD
-     * @param totalStakedUSD The total value staked in USD
-     */
-    calculateAPR(pool: StakingPool, rewardTokenPriceUSD: number, totalStakedUSD: number): number;
-    /**
-     * Calculates the USD value of tokens in a staking pool
-     * Handles both regular staking pools and Steer vaults
-     * @param params Parameters for token value calculation
-     */
-    getSteerLpTokenValue(params: TokenValueParams): Promise<SteerResponse<TokenValueResponse>>;
-    /**
-     * Gets the total staking amount in USD for a pool
-     * @param stakingPool The staking pool
-     * @param token0UsdPrice Price of token0 in USD
-     * @param token1UsdPrice Price of token1 in USD (required for Steer vaults)
-     */
-    getTotalStakingAmountInUsd(stakingPool: StakingPool, token0UsdPrice: number, token1UsdPrice?: number): Promise<SteerResponse<number>>;
-    /**
-     * Prepares the transaction data for staking tokens without executing it
-     * @param params The staking parameters
-     */
-    prepareStakeTx(params: StakeParams): Promise<SteerResponse<{
-        address: Address;
-        abi: {
-            type: string;
-            inputs: {
-                name: string;
-                internalType: string;
-                type: string;
-            }[];
-            name: string;
-            outputs: never[];
-            stateMutability: string;
-        }[];
-        functionName: string;
-        args: readonly [bigint];
-    }>>;
-    /**
-     * Prepares the transaction data for withdrawing tokens without executing it
-     * @param params The withdrawal parameters
-     */
-    prepareWithdrawTx(params: WithdrawParams): Promise<SteerResponse<{
-        address: Address;
-        abi: {
-            type: string;
-            inputs: {
-                name: string;
-                internalType: string;
-                type: string;
-            }[];
-            name: string;
-            outputs: never[];
-            stateMutability: string;
-        }[];
-        functionName: string;
-        args: readonly [bigint];
-    }>>;
-    /**
-     * Prepares the transaction data for claiming rewards without executing it
-     * @param params The reward claim parameters
-     */
-    prepareGetRewardTx(params: GetRewardParams): Promise<SteerResponse<{
-        address: Address;
-        abi: {
-            type: string;
-            inputs: {
-                name: string;
-                internalType: string;
-                type: string;
-            }[];
-            name: string;
-            outputs: never[];
-            stateMutability: string;
-        }[];
-        functionName: string;
-        args: readonly [];
-    }>>;
-}
-//# sourceMappingURL=StakingClient.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"StakingClient.d.ts","sourceRoot":"","sources":["../../../src/base/StakingClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,eAAe,EAA6C,MAAM,sBAAsB,CAAC;AAIlG,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,OAAO,CAAA;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,YAAY,EAAE,OAAO,CAAA;IACrB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,OAAO,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAC,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAC,OAAO,CAAA;IACjB,wBAAwB,CAAC,EAAC,MAAM,CAAA;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,YAAY,CAAC,EAAC,MAAM,CAAC;IACrB,MAAM,CAAC,EAAC,OAAO,CAAA;CAChB;AAGD,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAGD,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AA0HD,qBAAa,aAAc,SAAQ,cAAc;IAC/C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAC9C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA8E;IACnH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAsB;gBAEzC,MAAM,EAAE,YAAY,GAAG,YAAY;IAO/C;;;OAGG;IACU,eAAe,CAC1B,MAAM,CAAC,EAAE,iBAAiB,GACzB,OAAO,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IAqCxC;;;;OAIG;IACU,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IASrH;;;;;OAKG;IACU,0BAA0B,CACrC,OAAO,CAAC,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,eAAe,EAC1B,MAAM,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IASxC;;;;;OAKG;IACU,wBAAwB,CACnC,iBAAiB,EAAE,MAAM,EACzB,iBAAiB,CAAC,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IASxC;;OAEG;IACH,OAAO,CAAC,WAAW;IA4CnB;;;OAGG;IACU,KAAK,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IA8BrE;;;OAGG;IACU,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IA8B3E;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IA8B7E;;;;OAIG;IACU,MAAM,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAiD1H;;;OAGG;IACU,WAAW,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAuB9E;;;;OAIG;IACU,SAAS,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAwB9F;;;;;OAKG;IACI,YAAY,CACjB,IAAI,EAAE,WAAW,EACjB,mBAAmB,EAAE,MAAM,EAC3B,cAAc,EAAE,MAAM,GACrB,MAAM;IAgBT;;;;OAIG;IACU,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;IA+FvG;;;;;OAKG;IACU,0BAA0B,CACrC,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,MAAM,EACtB,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAoCjC;;;OAGG;IACU,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;QACtE,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,CAAC,MAAM,CAAC,CAAC;KACzB,CAAC,CAAC;IA+BH;;;OAGG;IACU,iBAAiB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;QAC5E,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,CAAC,MAAM,CAAC,CAAC;KACzB,CAAC,CAAC;IA+BH;;;OAGG;IACU,kBAAkB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;QAC9E,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,EAAE,CAAC;KACnB,CAAC,CAAC;CA4BJ"}

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

@@ -1,26 +0,0 @@
-import type { Client } from 'viem';
-import { SteerResponse } from '../types.js';
-export declare abstract class SubgraphClient {
-    protected readonly client: Client;
-    constructor(client: Client);
-    /**
-     * Executes a GraphQL query against the subgraph
-     * @param query The GraphQL query string
-     * @param variables Optional variables for the query
-     * @returns Promise with the query result
-     */
-    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
-     * @returns The subgraph URL or undefined if not found
-     */
-    protected getSubgraphUrl(chainId: number): string | undefined;
-    /**
-     * 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=SubgraphClient.d.ts.map

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

@@ -1 +0,0 @@
-{"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,aAAa,CAAC;AAG5C,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;IAU7D;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CAG/C"}