@strkfarm/sdk 1.1.7 → 1.1.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strkfarm/sdk",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "STRKFarm TS SDK (Meant for our internal use, but feel free to use it)",
   "typings": "dist/index.d.ts",
   "types": "dist/index.d.ts",

package/src/data/vesu-multiple.abi.json

@@ -0,0 +1,475 @@
+[
+  {
+    "type": "impl",
+    "name": "LockerImpl",
+    "interface_name": "ekubo::interfaces::core::ILocker"
+  },
+  {
+    "type": "struct",
+    "name": "core::array::Span::<core::felt252>",
+    "members": [
+      {
+        "name": "snapshot",
+        "type": "@core::array::Array::<core::felt252>"
+      }
+    ]
+  },
+  {
+    "type": "interface",
+    "name": "ekubo::interfaces::core::ILocker",
+    "items": [
+      {
+        "type": "function",
+        "name": "locked",
+        "inputs": [
+          {
+            "name": "id",
+            "type": "core::integer::u32"
+          },
+          {
+            "name": "data",
+            "type": "core::array::Span::<core::felt252>"
+          }
+        ],
+        "outputs": [
+          {
+            "type": "core::array::Span::<core::felt252>"
+          }
+        ],
+        "state_mutability": "external"
+      }
+    ]
+  },
+  {
+    "type": "impl",
+    "name": "MultiplyImpl",
+    "interface_name": "vesu_periphery::multiply::IMultiply"
+  },
+  {
+    "type": "struct",
+    "name": "ekubo::types::keys::PoolKey",
+    "members": [
+      {
+        "name": "token0",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "token1",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "fee",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "tick_spacing",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "extension",
+        "type": "core::starknet::contract_address::ContractAddress"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "core::integer::u256",
+    "members": [
+      {
+        "name": "low",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "high",
+        "type": "core::integer::u128"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "vesu_periphery::swap::RouteNode",
+    "members": [
+      {
+        "name": "pool_key",
+        "type": "ekubo::types::keys::PoolKey"
+      },
+      {
+        "name": "sqrt_ratio_limit",
+        "type": "core::integer::u256"
+      },
+      {
+        "name": "skip_ahead",
+        "type": "core::integer::u128"
+      }
+    ]
+  },
+  {
+    "type": "enum",
+    "name": "core::bool",
+    "variants": [
+      {
+        "name": "False",
+        "type": "()"
+      },
+      {
+        "name": "True",
+        "type": "()"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "ekubo::types::i129::i129",
+    "members": [
+      {
+        "name": "mag",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "sign",
+        "type": "core::bool"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "vesu_periphery::swap::TokenAmount",
+    "members": [
+      {
+        "name": "token",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "amount",
+        "type": "ekubo::types::i129::i129"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "vesu_periphery::swap::Swap",
+    "members": [
+      {
+        "name": "route",
+        "type": "core::array::Array::<vesu_periphery::swap::RouteNode>"
+      },
+      {
+        "name": "token_amount",
+        "type": "vesu_periphery::swap::TokenAmount"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "vesu_periphery::multiply::IncreaseLeverParams",
+    "members": [
+      {
+        "name": "pool_id",
+        "type": "core::felt252"
+      },
+      {
+        "name": "collateral_asset",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "debt_asset",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "user",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "add_margin",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "margin_swap",
+        "type": "core::array::Array::<vesu_periphery::swap::Swap>"
+      },
+      {
+        "name": "margin_swap_limit_amount",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "lever_swap",
+        "type": "core::array::Array::<vesu_periphery::swap::Swap>"
+      },
+      {
+        "name": "lever_swap_limit_amount",
+        "type": "core::integer::u128"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "vesu_periphery::multiply::DecreaseLeverParams",
+    "members": [
+      {
+        "name": "pool_id",
+        "type": "core::felt252"
+      },
+      {
+        "name": "collateral_asset",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "debt_asset",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "user",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "sub_margin",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "recipient",
+        "type": "core::starknet::contract_address::ContractAddress"
+      },
+      {
+        "name": "lever_swap",
+        "type": "core::array::Array::<vesu_periphery::swap::Swap>"
+      },
+      {
+        "name": "lever_swap_limit_amount",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "lever_swap_weights",
+        "type": "core::array::Array::<core::integer::u128>"
+      },
+      {
+        "name": "withdraw_swap",
+        "type": "core::array::Array::<vesu_periphery::swap::Swap>"
+      },
+      {
+        "name": "withdraw_swap_limit_amount",
+        "type": "core::integer::u128"
+      },
+      {
+        "name": "withdraw_swap_weights",
+        "type": "core::array::Array::<core::integer::u128>"
+      },
+      {
+        "name": "close_position",
+        "type": "core::bool"
+      }
+    ]
+  },
+  {
+    "type": "enum",
+    "name": "vesu_periphery::multiply::ModifyLeverAction",
+    "variants": [
+      {
+        "name": "IncreaseLever",
+        "type": "vesu_periphery::multiply::IncreaseLeverParams"
+      },
+      {
+        "name": "DecreaseLever",
+        "type": "vesu_periphery::multiply::DecreaseLeverParams"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "vesu_periphery::multiply::ModifyLeverParams",
+    "members": [
+      {
+        "name": "action",
+        "type": "vesu_periphery::multiply::ModifyLeverAction"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "alexandria_math::i257::i257",
+    "members": [
+      {
+        "name": "abs",
+        "type": "core::integer::u256"
+      },
+      {
+        "name": "is_negative",
+        "type": "core::bool"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "vesu_periphery::multiply::ModifyLeverResponse",
+    "members": [
+      {
+        "name": "collateral_delta",
+        "type": "alexandria_math::i257::i257"
+      },
+      {
+        "name": "debt_delta",
+        "type": "alexandria_math::i257::i257"
+      },
+      {
+        "name": "margin_delta",
+        "type": "alexandria_math::i257::i257"
+      }
+    ]
+  },
+  {
+    "type": "interface",
+    "name": "vesu_periphery::multiply::IMultiply",
+    "items": [
+      {
+        "type": "function",
+        "name": "modify_lever",
+        "inputs": [
+          {
+            "name": "modify_lever_params",
+            "type": "vesu_periphery::multiply::ModifyLeverParams"
+          }
+        ],
+        "outputs": [
+          {
+            "type": "vesu_periphery::multiply::ModifyLeverResponse"
+          }
+        ],
+        "state_mutability": "external"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "ekubo::interfaces::core::ICoreDispatcher",
+    "members": [
+      {
+        "name": "contract_address",
+        "type": "core::starknet::contract_address::ContractAddress"
+      }
+    ]
+  },
+  {
+    "type": "struct",
+    "name": "vesu::singleton::ISingletonDispatcher",
+    "members": [
+      {
+        "name": "contract_address",
+        "type": "core::starknet::contract_address::ContractAddress"
+      }
+    ]
+  },
+  {
+    "type": "constructor",
+    "name": "constructor",
+    "inputs": [
+      {
+        "name": "core",
+        "type": "ekubo::interfaces::core::ICoreDispatcher"
+      },
+      {
+        "name": "singleton",
+        "type": "vesu::singleton::ISingletonDispatcher"
+      }
+    ]
+  },
+  {
+    "type": "event",
+    "name": "vesu_periphery::multiply::Multiply::IncreaseLever",
+    "kind": "struct",
+    "members": [
+      {
+        "name": "pool_id",
+        "type": "core::felt252",
+        "kind": "key"
+      },
+      {
+        "name": "collateral_asset",
+        "type": "core::starknet::contract_address::ContractAddress",
+        "kind": "key"
+      },
+      {
+        "name": "debt_asset",
+        "type": "core::starknet::contract_address::ContractAddress",
+        "kind": "key"
+      },
+      {
+        "name": "user",
+        "type": "core::starknet::contract_address::ContractAddress",
+        "kind": "key"
+      },
+      {
+        "name": "margin",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "collateral_delta",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "debt_delta",
+        "type": "core::integer::u256",
+        "kind": "data"
+      }
+    ]
+  },
+  {
+    "type": "event",
+    "name": "vesu_periphery::multiply::Multiply::DecreaseLever",
+    "kind": "struct",
+    "members": [
+      {
+        "name": "pool_id",
+        "type": "core::felt252",
+        "kind": "key"
+      },
+      {
+        "name": "collateral_asset",
+        "type": "core::starknet::contract_address::ContractAddress",
+        "kind": "key"
+      },
+      {
+        "name": "debt_asset",
+        "type": "core::starknet::contract_address::ContractAddress",
+        "kind": "key"
+      },
+      {
+        "name": "user",
+        "type": "core::starknet::contract_address::ContractAddress",
+        "kind": "key"
+      },
+      {
+        "name": "margin",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "collateral_delta",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "debt_delta",
+        "type": "core::integer::u256",
+        "kind": "data"
+      }
+    ]
+  },
+  {
+    "type": "event",
+    "name": "vesu_periphery::multiply::Multiply::Event",
+    "kind": "enum",
+    "variants": [
+      {
+        "name": "IncreaseLever",
+        "type": "vesu_periphery::multiply::Multiply::IncreaseLever",
+        "kind": "nested"
+      },
+      {
+        "name": "DecreaseLever",
+        "type": "vesu_periphery::multiply::Multiply::DecreaseLever",
+        "kind": "nested"
+      }
+    ]
+  }
+]

package/src/dataTypes/_bignumber.ts

@@ -76,6 +76,19 @@ export class _Web3Number<T extends _Web3Number<T>> extends BigNumber {
     const answer = _value.greaterThanOrEqualTo(_valueMe) ? _value : _valueMe;
     return this.construct(answer.toString(), this.decimals);
   }
+
+  abs(): T {
+    console.warn(`abs: this: ${this}`);
+    return this.construct(Math.abs(this.toNumber()).toFixed(12), this.decimals);
+  }
+
+  toI129(): { mag: bigint, sign: 0 | 1 } {
+    const sign = this.isNegative() ? 1 : 0;
+    return {
+      mag: BigInt(this.toWei()) * (this.isNegative() ? -1n : 1n),
+      sign: sign,
+    }
+  }
 }
 
 BigNumber.config({ DECIMAL_PLACES: 18, ROUNDING_MODE: BigNumber.ROUND_DOWN });

package/src/modules/avnu.ts

@@ -1,7 +1,7 @@
 import { uint256 } from "starknet";
 
 import { Call, Uint256 } from "starknet";
-import { fetchBuildExecuteTransaction, fetchQuotes, Quote } from "@avnu/avnu-sdk";
+import { AvnuOptions, fetchBuildExecuteTransaction, fetchQuotes, Quote } from "@avnu/avnu-sdk";
 import { assert } from "../utils";
 import { logger } from "@/utils/logger";
 import { ContractAddr } from "@/dataTypes";
@@ -68,9 +68,10 @@ export class AvnuWrapper {
     taker: string,
     integratorFeeBps: number,
     integratorFeeRecipient: string,
-    minAmount?: string
+    minAmount?: string,
+    options?: AvnuOptions
   ) {
-    const calldata = await fetchBuildExecuteTransaction(quote.quoteId);
+    const calldata = await fetchBuildExecuteTransaction(quote.quoteId, taker, undefined, undefined, options);
     // its the multi swap function call
     const call: Call = calldata.calls[1];
     const callData: string[] = call.calldata as string[];

package/src/modules/ekubo-quoter.ts

@@ -0,0 +1,127 @@
+import { ContractAddr, Web3Number } from "@/dataTypes";
+import { IConfig, TokenInfo } from "@/interfaces/common";
+import { Swap } from "@/strategies";
+import axios from "axios";
+
+export interface EkuboRouteNode {
+  pool_key: {
+    token0: string;
+    token1: string;
+    fee: string;
+    tick_spacing: number;
+    extension: string;
+  };
+  sqrt_ratio_limit: string; // hex
+  skip_ahead: number;
+}
+export interface EkuboSplit {
+  amount_specified: string;
+  amount_calculated: string;
+  route: EkuboRouteNode[];
+}
+
+export interface EkuboQuote {
+  total_calculated: string; // raw amount in string num
+  price_impact: number; // in non-decimal form
+  splits:  EkuboSplit[];
+}
+
+
+export class EkuboQuoter {
+  ENDPOINT = 'https://quoter-mainnet-api.ekubo.org/{{AMOUNT}}/{{TOKEN_FROM_ADDRESS}}/{{TOKEN_TO_ADDRESS}}'; // e.g. ETH/USDC'
+  
+  constructor(private readonly config: IConfig) {}
+
+  /**
+   * 
+   * @param fromToken 
+   * @param toToken 
+   * @param amount Can be negative too, which would mean to get exact amount out
+   * @returns 
+   */
+  async getQuote(fromToken: string, toToken: string, amount: Web3Number): Promise<EkuboQuote> {
+    let _fromToken = amount.gt(0) ? fromToken : toToken;
+    let _toToken = amount.gt(0) ? toToken : fromToken;
+
+    const quote = await axios.get(this.ENDPOINT.replace("{{AMOUNT}}", amount.toWei()).replace("{{TOKEN_FROM_ADDRESS}}", _fromToken).replace("{{TOKEN_TO_ADDRESS}}", _toToken));
+    console.log(`Ekubo quote from ${_fromToken} to ${_toToken} for ${amount.toString()}: ${JSON.stringify(quote.data)}`);
+    return quote.data as EkuboQuote;
+  }
+
+  /**
+   * Formats Ekubo response for Vesu multiple use
+   * @param quote 
+   * @param fromTokenInfo 
+   * @returns 
+   */
+  getVesuMultiplyQuote(quote: EkuboQuote, fromTokenInfo: TokenInfo, toTokenInfo: TokenInfo): Swap[] {
+    return quote.splits.map(split => {
+      const isNegativeAmount = BigInt(split.amount_specified) < 0n;
+      const token = isNegativeAmount ? toTokenInfo : fromTokenInfo;
+      return {
+        route: split.route.map(_route => ({
+          pool_key: {
+            token0: ContractAddr.from(_route.pool_key.token0),
+            token1: ContractAddr.from(_route.pool_key.token1),
+            fee: _route.pool_key.fee,
+            tick_spacing: _route.pool_key.tick_spacing.toString(),
+            extension: _route.pool_key.extension
+          },
+          sqrt_ratio_limit: Web3Number.fromWei(_route.sqrt_ratio_limit, 18), // just for use, any decimal works
+          skip_ahead: Web3Number.fromWei(_route.skip_ahead, 0) // no decimal for this
+        })),
+        token_amount: {
+          token: token.address,
+          amount: Web3Number.fromWei(split.amount_specified, token.decimals)
+        }
+      };
+    });
+  }
+}
+
+// {
+//   "total_calculated": "828686582951171934715731",
+//   "price_impact": 0.0402043860710308,
+//   "splits": [
+//     {
+//       "amount_specified": "500000000000000000",
+//       "amount_calculated": "416221102677759239180488",
+//       "route": [
+//         {
+//           "pool_key": {
+//             "token0": "0x4daa17763b286d1e59b97c283c0b8c949994c361e426a28f743c67bdfe9a32f",
+//             "token1": "0x53c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
+//             "fee": "0x20c49ba5e353f80000000000000000",
+//             "tick_spacing": 1000,
+//             "extension": "0x0"
+//           },
+//           "sqrt_ratio_limit": "0x13284b8acc81b88350a0144d679130",
+//           "skip_ahead": 25
+//         },
+//         {
+//           "pool_key": {
+//             "token0": "0x4718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d",
+//             "token1": "0x53c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8",
+//             "fee": "0x0",
+//             "tick_spacing": 1028,
+//             "extension": "0x0"
+//           },
+//           "sqrt_ratio_limit": "0x6b8ec3c36efc69f79fa760b7bfd",
+//           "skip_ahead": 0
+//         },
+//         {
+//           "pool_key": {
+//             "token0": "0x28d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a",
+//             "token1": "0x4718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d",
+//             "fee": "0x68db8bac710cb4000000000000000",
+//             "tick_spacing": 200,
+//             "extension": "0x0"
+//           },
+//           "sqrt_ratio_limit": "0x111ef62dbb6cbdc45f9d47a1014cd6dd9",
+//           "skip_ahead": 0
+//         }
+//       ]
+//     },
+//     ...otherSplits
+//   ]
+// }

package/src/modules/index.ts

@@ -4,3 +4,4 @@ export * from './zkLend';
 export * from './pricer-from-api';
 export * from './erc20';
 export * from './avnu';
+export * from './ekubo-quoter';