@steerprotocol/sdk 1.3.0 → 1.4.0

package/dist/types/types.d.ts

@@ -1,4 +1,5 @@
-import type { Client, TestClient, WalletClient } from 'viem';
+import type { Address, Client, TestClient, WalletClient } from 'viem';
+import { Protocol } from './const/chain';
 export interface SteerConfig {
     environment?: 'production' | 'development';
     client: Client | TestClient;
@@ -10,4 +11,103 @@ export interface SteerResponse<T> {
     success: boolean;
     error?: string;
 }
+export interface BaseVaultDetails {
+    vaultType: string;
+    token0: Address;
+    token1: Address;
+    name: string;
+    symbol: string;
+    decimals: bigint;
+    token0Name: string;
+    token1Name: string;
+    token0Symbol: string;
+    token1Symbol: string;
+    token0Decimals: bigint;
+    token1Decimals: bigint;
+    totalLPTokensIssued: bigint;
+    token0Balance: bigint;
+    token1Balance: bigint;
+    vaultCreator: Address;
+}
+export interface VaultDetails extends BaseVaultDetails {
+    feeTier: bigint;
+}
+export interface AlgebraVaultDetails extends BaseVaultDetails {
+}
+export interface VaultDetailsResponse {
+    details: VaultDetails | AlgebraVaultDetails;
+    ratio: number | bigint | string;
+}
+export interface TokenData {
+    id: Address;
+    decimals: string;
+    symbol: string;
+    name: string;
+}
+export interface PoolData {
+    id: Address;
+    token0: TokenData;
+    token1: TokenData;
+    chainId: number;
+    feeTier: number;
+    tickSpacing: number | bigint;
+}
+export interface Slot0 {
+    price?: bigint;
+    sqrtPriceX96?: bigint;
+    tick: number;
+    observationIndex: number | bigint;
+    observationCardinality: number;
+    observationCardinalityNext: number;
+    feeProtocol: number;
+    unlocked: boolean;
+}
+export interface PoolsharkStructs {
+    samples: {
+        index: number;
+        count: number;
+        countMax: number;
+    };
+    feeGrowthGlobal0: bigint;
+    feeGrowthGlobal1: bigint;
+    secondsPerLiquidityAccum: bigint;
+    price: bigint;
+    liquidity: bigint;
+    tickSecondsAccum: number;
+    tickAtPrice: number;
+    protocolSwapFee0: number;
+    protocolSwapFee1: number;
+}
+export interface LimitPoolState {
+    price: bigint;
+    liquidity: bigint;
+    protocolFees: bigint;
+    protocolFillFee: number;
+    tickAtPrice: number;
+}
+export interface PoolSharkGlobalState {
+    pool: PoolsharkStructs;
+    pool0: LimitPoolState;
+    pool1: LimitPoolState;
+    liquidityGlobal: bigint;
+    positionIdNext: number;
+    epoch: number;
+    unlocked: number;
+}
+export interface GlobalStateABI {
+    price: bigint;
+    tick: number;
+    prevInitializedTick?: number;
+    fee?: number;
+    feeZto?: number;
+    feeOtz?: number;
+    timepointIndex: number;
+    communityFee?: number;
+    communityFeeToken0?: number;
+    communityFeeToken1?: number;
+    unlocked: boolean;
+}
+export type SupportedProtocol = keyof {
+    [chain in Protocol]: string;
+};
 //# sourceMappingURL=types.d.ts.map

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,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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,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;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;CAE5D;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,YAAY,GAAG,mBAAmB,CAAC;IAC5C,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,KAAK;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,0BAA0B,EAAE,MAAM,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,wBAAwB,EAAE,MAAM,CAAC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,gBAAgB,CAAC;IACvB,KAAK,EAAE,cAAc,CAAC;IACtB,KAAK,EAAE,cAAc,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM;KAAG,KAAK,IAAI,QAAQ,GAAG,MAAM;CAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@steerprotocol/sdk",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Steer Protocol SDK",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -44,31 +44,31 @@
     "viem": "^2.22.0"
   },
   "devDependencies": {
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.3",
+    "@semantic-release/npm": "^11.0.1",
     "@steerprotocol/contracts": "^3.1.7",
     "@types/jest": "^29.5.11",
     "@types/node": "^20.10.6",
     "@typescript-eslint/eslint-plugin": "^6.17.0",
     "@typescript-eslint/parser": "^6.17.0",
+    "commitizen": "^4.3.0",
+    "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
+    "husky": "^8.0.3",
     "jest": "^29.7.0",
     "prettier": "^3.4.2",
     "rimraf": "^5.0.5",
+    "semantic-release": "^22.0.8",
     "ts-jest": "^29.2.5",
     "tsx": "^4.19.2",
     "typedoc": "^0.27.6",
     "typescript": "^5.3.3",
-    "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"
+    "viem": "^2.22.0"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -77,6 +77,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@steerprotocol/api-sdk": "^1.0.2"
+    "@steerprotocol/api-sdk": "^1.0.2",
+    "decimal.js": "^10.5.0"
   }
 }