@gearbox-protocol/sdk 12.3.16 → 12.4.0

package/dist/cjs/permissionless/bindings/treasury-splitter.js

@@ -106,7 +106,11 @@ class TreasurySplitterContract extends import_sdk.BaseContract {
         const [receivers, proportions] = args;
         return {
           receivers: (0, import_sdk.json_stringify)(receivers),
-          proportions: (0, import_sdk.json_stringify)(proportions.map((proportion) => `${proportion / 100}% [${proportion}]`))
+          proportions: (0, import_sdk.json_stringify)(
+            proportions.map(
+              (proportion) => `${proportion / 100}% [${proportion}]`
+            )
+          )
         };
       }
       default:

package/dist/cjs/sdk/index.js

@@ -27,6 +27,7 @@ __reExport(sdk_exports, require("./market/index.js"), module.exports);
 __reExport(sdk_exports, require("./options.js"), module.exports);
 __reExport(sdk_exports, require("./plugins/index.js"), module.exports);
 __reExport(sdk_exports, require("./poolMigration/index.js"), module.exports);
+__reExport(sdk_exports, require("./pools/index.js"), module.exports);
 __reExport(sdk_exports, require("./router/index.js"), module.exports);
 __reExport(sdk_exports, require("./sdk-gov-legacy/index.js"), module.exports);
 __reExport(sdk_exports, require("./sdk-legacy/index.js"), module.exports);
@@ -47,6 +48,7 @@ __reExport(sdk_exports, require("./utils/viem/index.js"), module.exports);
   ...require("./options.js"),
   ...require("./plugins/index.js"),
   ...require("./poolMigration/index.js"),
+  ...require("./pools/index.js"),
   ...require("./router/index.js"),
   ...require("./sdk-gov-legacy/index.js"),
   ...require("./sdk-legacy/index.js"),

package/dist/cjs/sdk/pools/AbstractPoolService.js

@@ -0,0 +1,137 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var AbstractPoolService_exports = {};
+__export(AbstractPoolService_exports, {
+  AbstractPoolService: () => AbstractPoolService
+});
+module.exports = __toCommonJS(AbstractPoolService_exports);
+var import_iERC20ZapperDeposits = require("../../abi/iERC20ZapperDeposits.js");
+var import_iETHZapperDeposits = require("../../abi/iETHZapperDeposits.js");
+var import_iZapper = require("../../abi/iZapper.js");
+var import_v300 = require("../../abi/v300.js");
+var import_base = require("../base/index.js");
+class AbstractPoolService extends import_base.SDKConstruct {
+  #version;
+  constructor(sdk, version) {
+    super(sdk);
+    this.#version = version;
+    this.logger?.debug(`Created PoolService with version: ${this.#version}`);
+  }
+  addLiquidity({
+    collateral,
+    pool,
+    account,
+    zapper,
+    permit,
+    nativeTokenAddress,
+    referralCode = 0n,
+    migrate
+  }) {
+    if (zapper?.tokenIn === nativeTokenAddress) {
+      return [
+        {
+          target: zapper.zapper,
+          abi: import_iETHZapperDeposits.iethZapperDepositsAbi,
+          functionName: "depositWithReferral",
+          args: [account, referralCode],
+          value: collateral.balance
+        }
+      ];
+    } else if (zapper) {
+      return permit ? [
+        {
+          target: zapper.zapper,
+          abi: import_iERC20ZapperDeposits.ierc20ZapperDepositsAbi,
+          functionName: "depositWithReferralAndPermit",
+          args: [
+            collateral.balance,
+            account,
+            referralCode,
+            permit.deadline,
+            permit.v,
+            permit.r,
+            permit.s
+          ]
+        }
+      ] : [
+        {
+          target: zapper.zapper,
+          abi: import_iERC20ZapperDeposits.ierc20ZapperDepositsAbi,
+          functionName: "depositWithReferral",
+          args: [collateral.balance, account, referralCode]
+        }
+      ];
+    } else {
+      if (migrate) throw Error("No zapper for migration");
+      return [
+        {
+          target: pool,
+          abi: import_v300.iPoolV300Abi,
+          functionName: "depositWithReferral",
+          args: [collateral.balance, account, referralCode]
+        }
+      ];
+    }
+  }
+  removeLiquidity({
+    pool,
+    amount,
+    account,
+    zapper,
+    permit
+  }) {
+    if (zapper) {
+      return permit ? [
+        {
+          target: zapper.zapper,
+          abi: import_iZapper.iZapperAbi,
+          functionName: "redeemWithPermit",
+          args: [
+            amount,
+            account,
+            permit.deadline,
+            permit.v,
+            permit.r,
+            permit.s
+          ]
+        }
+      ] : [
+        {
+          target: zapper.zapper,
+          abi: import_iZapper.iZapperAbi,
+          functionName: "redeem",
+          args: [amount, account]
+        }
+      ];
+    } else {
+      return [
+        {
+          target: pool,
+          abi: import_v300.iPoolV300Abi,
+          functionName: "redeem",
+          args: [amount, account, account]
+        }
+      ];
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AbstractPoolService
+});

package/dist/cjs/sdk/pools/PoolServiceV300.js

@@ -0,0 +1,30 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var PoolServiceV300_exports = {};
+__export(PoolServiceV300_exports, {
+  PoolServiceV300: () => PoolServiceV300
+});
+module.exports = __toCommonJS(PoolServiceV300_exports);
+var import_AbstractPoolService = require("./AbstractPoolService.js");
+class PoolServiceV300 extends import_AbstractPoolService.AbstractPoolService {
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PoolServiceV300
+});

package/dist/cjs/sdk/pools/PoolServiceV310.js

@@ -0,0 +1,30 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var PoolServiceV310_exports = {};
+__export(PoolServiceV310_exports, {
+  PoolServiceV310: () => PoolServiceV310
+});
+module.exports = __toCommonJS(PoolServiceV310_exports);
+var import_AbstractPoolService = require("./AbstractPoolService.js");
+class PoolServiceV310 extends import_AbstractPoolService.AbstractPoolService {
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PoolServiceV310
+});

package/dist/cjs/sdk/pools/createPoolService.js

@@ -0,0 +1,39 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var createPoolService_exports = {};
+__export(createPoolService_exports, {
+  createPoolService: () => createPoolService
+});
+module.exports = __toCommonJS(createPoolService_exports);
+var import_constants = require("../constants/index.js");
+var import_PoolServiceV300 = require("./PoolServiceV300.js");
+var import_PoolServiceV310 = require("./PoolServiceV310.js");
+function createPoolService(sdk, version) {
+  if ((0, import_constants.isV300)(version)) {
+    return new import_PoolServiceV300.PoolServiceV300(sdk, version);
+  }
+  if ((0, import_constants.isV310)(version)) {
+    return new import_PoolServiceV310.PoolServiceV310(sdk, version);
+  }
+  throw new Error(`Unsupported Pool Service version ${version}`);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createPoolService
+});

package/dist/cjs/sdk/pools/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var pools_exports = {};
+module.exports = __toCommonJS(pools_exports);
+__reExport(pools_exports, require("./AbstractPoolService.js"), module.exports);
+__reExport(pools_exports, require("./createPoolService.js"), module.exports);
+__reExport(pools_exports, require("./types.js"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./AbstractPoolService.js"),
+  ...require("./createPoolService.js"),
+  ...require("./types.js")
+});

package/dist/cjs/sdk/pools/types.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/dist/esm/permissionless/bindings/treasury-splitter.js

@@ -85,7 +85,11 @@ class TreasurySplitterContract extends BaseContract {
         const [receivers, proportions] = args;
         return {
           receivers: json_stringify(receivers),
-          proportions: json_stringify(proportions.map((proportion) => `${proportion / 100}% [${proportion}]`))
+          proportions: json_stringify(
+            proportions.map(
+              (proportion) => `${proportion / 100}% [${proportion}]`
+            )
+          )
         };
       }
       default:

package/dist/esm/sdk/index.js

@@ -10,6 +10,7 @@ export * from "./market/index.js";
 export * from "./options.js";
 export * from "./plugins/index.js";
 export * from "./poolMigration/index.js";
+export * from "./pools/index.js";
 export * from "./router/index.js";
 export * from "./sdk-gov-legacy/index.js";
 export * from "./sdk-legacy/index.js";

package/dist/esm/sdk/pools/AbstractPoolService.js

@@ -0,0 +1,113 @@
+import { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
+import { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
+import { iZapperAbi } from "../../abi/iZapper.js";
+import { iPoolV300Abi } from "../../abi/v300.js";
+import { SDKConstruct } from "../base/index.js";
+class AbstractPoolService extends SDKConstruct {
+  #version;
+  constructor(sdk, version) {
+    super(sdk);
+    this.#version = version;
+    this.logger?.debug(`Created PoolService with version: ${this.#version}`);
+  }
+  addLiquidity({
+    collateral,
+    pool,
+    account,
+    zapper,
+    permit,
+    nativeTokenAddress,
+    referralCode = 0n,
+    migrate
+  }) {
+    if (zapper?.tokenIn === nativeTokenAddress) {
+      return [
+        {
+          target: zapper.zapper,
+          abi: iethZapperDepositsAbi,
+          functionName: "depositWithReferral",
+          args: [account, referralCode],
+          value: collateral.balance
+        }
+      ];
+    } else if (zapper) {
+      return permit ? [
+        {
+          target: zapper.zapper,
+          abi: ierc20ZapperDepositsAbi,
+          functionName: "depositWithReferralAndPermit",
+          args: [
+            collateral.balance,
+            account,
+            referralCode,
+            permit.deadline,
+            permit.v,
+            permit.r,
+            permit.s
+          ]
+        }
+      ] : [
+        {
+          target: zapper.zapper,
+          abi: ierc20ZapperDepositsAbi,
+          functionName: "depositWithReferral",
+          args: [collateral.balance, account, referralCode]
+        }
+      ];
+    } else {
+      if (migrate) throw Error("No zapper for migration");
+      return [
+        {
+          target: pool,
+          abi: iPoolV300Abi,
+          functionName: "depositWithReferral",
+          args: [collateral.balance, account, referralCode]
+        }
+      ];
+    }
+  }
+  removeLiquidity({
+    pool,
+    amount,
+    account,
+    zapper,
+    permit
+  }) {
+    if (zapper) {
+      return permit ? [
+        {
+          target: zapper.zapper,
+          abi: iZapperAbi,
+          functionName: "redeemWithPermit",
+          args: [
+            amount,
+            account,
+            permit.deadline,
+            permit.v,
+            permit.r,
+            permit.s
+          ]
+        }
+      ] : [
+        {
+          target: zapper.zapper,
+          abi: iZapperAbi,
+          functionName: "redeem",
+          args: [amount, account]
+        }
+      ];
+    } else {
+      return [
+        {
+          target: pool,
+          abi: iPoolV300Abi,
+          functionName: "redeem",
+          args: [amount, account, account]
+        }
+      ];
+    }
+  }
+}
+export {
+  AbstractPoolService
+};

package/dist/esm/sdk/pools/PoolServiceV300.js

@@ -0,0 +1,6 @@
+import { AbstractPoolService } from "./AbstractPoolService.js";
+class PoolServiceV300 extends AbstractPoolService {
+}
+export {
+  PoolServiceV300
+};

package/dist/esm/sdk/pools/PoolServiceV310.js

@@ -0,0 +1,6 @@
+import { AbstractPoolService } from "./AbstractPoolService.js";
+class PoolServiceV310 extends AbstractPoolService {
+}
+export {
+  PoolServiceV310
+};

package/dist/esm/sdk/pools/createPoolService.js

@@ -0,0 +1,15 @@
+import { isV300, isV310 } from "../constants/index.js";
+import { PoolServiceV300 } from "./PoolServiceV300.js";
+import { PoolServiceV310 } from "./PoolServiceV310.js";
+function createPoolService(sdk, version) {
+  if (isV300(version)) {
+    return new PoolServiceV300(sdk, version);
+  }
+  if (isV310(version)) {
+    return new PoolServiceV310(sdk, version);
+  }
+  throw new Error(`Unsupported Pool Service version ${version}`);
+}
+export {
+  createPoolService
+};

package/dist/esm/sdk/pools/index.js

@@ -0,0 +1,3 @@
+export * from "./AbstractPoolService.js";
+export * from "./createPoolService.js";
+export * from "./types.js";

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

@@ -10,6 +10,7 @@ export * from "./market/index.js";
 export * from "./options.js";
 export * from "./plugins/index.js";
 export * from "./poolMigration/index.js";
+export * from "./pools/index.js";
 export * from "./router/index.js";
 export * from "./sdk-gov-legacy/index.js";
 export * from "./sdk-legacy/index.js";

package/dist/types/sdk/pools/AbstractPoolService.d.ts

@@ -0,0 +1,9 @@
+import { SDKConstruct } from "../base/index.js";
+import type { GearboxSDK } from "../GearboxSDK.js";
+import type { AddLiquidityCall, AddLiquidityProps, RemoveLiquidityCall, RemoveLiquidityProps } from "./types.js";
+export declare abstract class AbstractPoolService extends SDKConstruct {
+    #private;
+    constructor(sdk: GearboxSDK, version: number);
+    addLiquidity({ collateral, pool, account, zapper, permit, nativeTokenAddress, referralCode, migrate, }: AddLiquidityProps): AddLiquidityCall;
+    removeLiquidity({ pool, amount, account, zapper, permit, }: RemoveLiquidityProps): RemoveLiquidityCall;
+}

package/dist/types/sdk/pools/PoolServiceV300.d.ts

@@ -0,0 +1,4 @@
+import { AbstractPoolService } from "./AbstractPoolService.js";
+import type { IPoolsService } from "./types.js";
+export declare class PoolServiceV300 extends AbstractPoolService implements IPoolsService {
+}

package/dist/types/sdk/pools/PoolServiceV310.d.ts

@@ -0,0 +1,4 @@
+import { AbstractPoolService } from "./AbstractPoolService.js";
+import type { IPoolsService } from "./types.js";
+export declare class PoolServiceV310 extends AbstractPoolService implements IPoolsService {
+}

package/dist/types/sdk/pools/createPoolService.d.ts

@@ -0,0 +1,8 @@
+import type { GearboxSDK } from "../GearboxSDK.js";
+import type { AbstractPoolService } from "./AbstractPoolService.js";
+/**
+ * @sdk
+ * @version version of desired pool service; either v300 or v310
+ * @returns
+ */
+export declare function createPoolService(sdk: GearboxSDK, version: number): AbstractPoolService;

package/dist/types/sdk/pools/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./AbstractPoolService.js";
+export * from "./createPoolService.js";
+export * from "./types.js";

package/dist/types/sdk/pools/types.d.ts

@@ -0,0 +1,92 @@
+import type { Address } from "viem";
+import type { ierc20ZapperDepositsAbi } from "../../abi/iERC20ZapperDeposits.js";
+import type { iethZapperDepositsAbi } from "../../abi/iETHZapperDeposits.js";
+import type { iZapperAbi } from "../../abi/iZapper.js";
+import type { iPoolV300Abi } from "../../abi/v300.js";
+import type { PoolData_Legacy } from "../index.js";
+import type { Asset } from "../router/index.js";
+interface PermitResult {
+    r: Address;
+    s: Address;
+    v: number;
+    token: Address;
+    owner: Address;
+    spender: Address;
+    value: bigint;
+    deadline: bigint;
+    nonce: bigint;
+}
+export interface AddLiquidityProps {
+    collateral: Asset;
+    pool: Address;
+    account: Address;
+    migrate: boolean;
+    zapper: PoolData_Legacy["zappers"][Address][Address] | undefined;
+    permit: PermitResult | undefined;
+    nativeTokenAddress: Address;
+    referralCode: bigint | undefined;
+}
+export type AddLiquidityCall = [
+    {
+        target: Address;
+        abi: typeof iethZapperDepositsAbi;
+        functionName: "depositWithReferral";
+        args: [Address, bigint];
+        value: bigint;
+    } | {
+        target: Address;
+        abi: typeof ierc20ZapperDepositsAbi;
+        functionName: "depositWithReferralAndPermit";
+        args: [bigint, Address, bigint, bigint, number, Address, Address];
+    } | {
+        target: Address;
+        abi: typeof ierc20ZapperDepositsAbi;
+        functionName: "depositWithReferral";
+        args: [bigint, Address, bigint];
+    } | {
+        target: Address;
+        abi: typeof iPoolV300Abi;
+        functionName: "depositWithReferral";
+        args: [bigint, Address, bigint];
+    }
+];
+export interface RemoveLiquidityProps {
+    pool: Address;
+    amount: bigint;
+    account: Address;
+    permit: PermitResult | undefined;
+    zapper: PoolData_Legacy["zappers"][Address][Address];
+}
+export type RemoveLiquidityCall = [
+    {
+        target: Address;
+        abi: typeof iZapperAbi;
+        functionName: "redeemWithPermit";
+        args: [bigint, Address, bigint, number, Address, Address];
+    } | {
+        target: Address;
+        abi: typeof iZapperAbi;
+        functionName: "redeem";
+        args: [bigint, Address];
+    } | {
+        target: Address;
+        abi: typeof iPoolV300Abi;
+        functionName: "redeem";
+        args: [bigint, Address, Address];
+    }
+];
+export interface IPoolsService {
+    /**
+     * Add liquidity to a pool
+     * @param props - {@link AddLiquidityProps}
+     * @returns - {@link AddLiquidityCall}
+     */
+    addLiquidity(props: AddLiquidityProps): AddLiquidityCall;
+    /**
+     * Remove liquidity from a pool
+     * @param props - {@link RemoveLiquidityProps}
+     * @returns - {@link RemoveLiquidityCall}
+     */
+    removeLiquidity(props: RemoveLiquidityProps): RemoveLiquidityCall;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "12.3.16",
+  "version": "12.4.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",