@strkfarm/sdk 2.0.0-staging.7 → 2.0.0-staging.71

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@strkfarm/sdk",
-    "version": "2.0.0-staging.7",
+    "version": "2.0.0-staging.71",
     "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",
@@ -25,9 +25,6 @@
         "dist",
         "src"
     ],
-    "publishConfig": {
-      "tag": "staging"
-    },
     "scripts": {
         "test": "jest",
         "build": "tsup --clean && pnpm run build:esm && npm run build:dts && npm run build:iife && npm run build-cli && pnpm run build:iife-esm",
@@ -59,6 +56,9 @@
         "react": "19.1.2",
         "starknet": "9.2.1"
     },
+    "publishConfig": {
+      "tag": "staging"
+    },
     "dependencies": {
         "@apollo/client": "3.11.8",
         "@avnu/avnu-sdk": "3.0.2",

package/src/data/universal-vault.abi.json

@@ -2,11 +2,11 @@
   {
     "type": "impl",
     "name": "UpgradeableImpl",
-    "interface_name": "openzeppelin_upgrades::interface::IUpgradeable"
+    "interface_name": "openzeppelin_interfaces::upgrades::IUpgradeable"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_upgrades::interface::IUpgradeable",
+    "name": "openzeppelin_interfaces::upgrades::IUpgradeable",
     "items": [
       {
         "type": "function",
@@ -25,7 +25,7 @@
   {
     "type": "impl",
     "name": "VaultMetadataImpl",
-    "interface_name": "openzeppelin_token::erc20::interface::IERC20Metadata"
+    "interface_name": "openzeppelin_interfaces::token::erc20::IERC20Metadata"
   },
   {
     "type": "struct",
@@ -47,7 +47,7 @@
   },
   {
     "type": "interface",
-    "name": "openzeppelin_token::erc20::interface::IERC20Metadata",
+    "name": "openzeppelin_interfaces::token::erc20::IERC20Metadata",
     "items": [
       {
         "type": "function",
@@ -431,17 +431,95 @@
           }
         ],
         "state_mutability": "view"
+      },
+      {
+        "type": "function",
+        "name": "due_assets_from_id",
+        "inputs": [
+          {
+            "name": "id",
+            "type": "core::integer::u256"
+          }
+        ],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
+      },
+      {
+        "type": "function",
+        "name": "due_assets_from_owner",
+        "inputs": [
+          {
+            "name": "owner",
+            "type": "core::starknet::contract_address::ContractAddress"
+          }
+        ],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
+      },
+      {
+        "type": "function",
+        "name": "set_deposit_limit",
+        "inputs": [
+          {
+            "name": "limit",
+            "type": "core::integer::u256"
+          }
+        ],
+        "outputs": [],
+        "state_mutability": "external"
+      },
+      {
+        "type": "function",
+        "name": "set_mint_limit",
+        "inputs": [
+          {
+            "name": "limit",
+            "type": "core::integer::u256"
+          }
+        ],
+        "outputs": [],
+        "state_mutability": "external"
+      },
+      {
+        "type": "function",
+        "name": "get_deposit_limit",
+        "inputs": [],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
+      },
+      {
+        "type": "function",
+        "name": "get_mint_limit",
+        "inputs": [],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
       }
     ]
   },
   {
     "type": "impl",
     "name": "ERC4626Impl",
-    "interface_name": "openzeppelin_token::erc20::extensions::erc4626::interface::IERC4626"
+    "interface_name": "openzeppelin_interfaces::token::erc4626::IERC4626"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_token::erc20::extensions::erc4626::interface::IERC4626",
+    "name": "openzeppelin_interfaces::token::erc4626::IERC4626",
     "items": [
       {
         "type": "function",
@@ -718,7 +796,7 @@
   {
     "type": "impl",
     "name": "ERC20Impl",
-    "interface_name": "openzeppelin_token::erc20::interface::IERC20"
+    "interface_name": "openzeppelin_interfaces::token::erc20::IERC20"
   },
   {
     "type": "enum",
@@ -736,7 +814,7 @@
   },
   {
     "type": "interface",
-    "name": "openzeppelin_token::erc20::interface::IERC20",
+    "name": "openzeppelin_interfaces::token::erc20::IERC20",
     "items": [
       {
         "type": "function",
@@ -854,11 +932,11 @@
   {
     "type": "impl",
     "name": "ERC20CamelOnlyImpl",
-    "interface_name": "openzeppelin_token::erc20::interface::IERC20CamelOnly"
+    "interface_name": "openzeppelin_interfaces::token::erc20::IERC20CamelOnly"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_token::erc20::interface::IERC20CamelOnly",
+    "name": "openzeppelin_interfaces::token::erc20::IERC20CamelOnly",
     "items": [
       {
         "type": "function",
@@ -916,11 +994,11 @@
   {
     "type": "impl",
     "name": "AccessControlImpl",
-    "interface_name": "openzeppelin_access::accesscontrol::interface::IAccessControl"
+    "interface_name": "openzeppelin_interfaces::access::accesscontrol::IAccessControl"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_access::accesscontrol::interface::IAccessControl",
+    "name": "openzeppelin_interfaces::access::accesscontrol::IAccessControl",
     "items": [
       {
         "type": "function",
@@ -1011,11 +1089,11 @@
   {
     "type": "impl",
     "name": "PausableImpl",
-    "interface_name": "openzeppelin_security::interface::IPausable"
+    "interface_name": "openzeppelin_interfaces::security::pausable::IPausable"
   },
   {
     "type": "interface",
-    "name": "openzeppelin_security::interface::IPausable",
+    "name": "openzeppelin_interfaces::security::pausable::IPausable",
     "items": [
       {
         "type": "function",
@@ -1139,7 +1217,7 @@
   },
   {
     "type": "event",
-    "name": "vault::oz_4626::ERC4626Component::Deposit",
+    "name": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit",
     "kind": "struct",
     "members": [
       {
@@ -1166,7 +1244,7 @@
   },
   {
     "type": "event",
-    "name": "vault::oz_4626::ERC4626Component::Withdraw",
+    "name": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw",
     "kind": "struct",
     "members": [
       {
@@ -1198,17 +1276,17 @@
   },
   {
     "type": "event",
-    "name": "vault::oz_4626::ERC4626Component::Event",
+    "name": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Event",
     "kind": "enum",
     "variants": [
       {
         "name": "Deposit",
-        "type": "vault::oz_4626::ERC4626Component::Deposit",
+        "type": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit",
         "kind": "nested"
       },
       {
         "name": "Withdraw",
-        "type": "vault::oz_4626::ERC4626Component::Withdraw",
+        "type": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw",
         "kind": "nested"
       }
     ]
@@ -1510,6 +1588,38 @@
       }
     ]
   },
+  {
+    "type": "event",
+    "name": "vault::vault::vault::Vault::BringLiquidity",
+    "kind": "struct",
+    "members": [
+      {
+        "name": "caller",
+        "type": "core::starknet::contract_address::ContractAddress",
+        "kind": "data"
+      },
+      {
+        "name": "amount",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "new_buffer",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "new_aum",
+        "type": "core::integer::u256",
+        "kind": "data"
+      },
+      {
+        "name": "epoch",
+        "type": "core::integer::u256",
+        "kind": "data"
+      }
+    ]
+  },
   {
     "type": "event",
     "name": "vault::vault::vault::Vault::Event",
@@ -1518,32 +1628,32 @@
       {
         "name": "ERC20Event",
         "type": "openzeppelin_token::erc20::erc20::ERC20Component::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "ERC4626Event",
-        "type": "vault::oz_4626::ERC4626Component::Event",
-        "kind": "nested"
+        "type": "openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Event",
+        "kind": "flat"
       },
       {
         "name": "SRC5Event",
         "type": "openzeppelin_introspection::src5::SRC5Component::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "AccessControlEvent",
         "type": "openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "UpgradeableEvent",
         "type": "openzeppelin_upgrades::upgradeable::UpgradeableComponent::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "PausableEvent",
         "type": "openzeppelin_security::pausable::PausableComponent::Event",
-        "kind": "nested"
+        "kind": "flat"
       },
       {
         "name": "RedeemRequested",
@@ -1559,7 +1669,13 @@
         "name": "Report",
         "type": "vault::vault::vault::Vault::Report",
         "kind": "nested"
+      },
+      {
+        "name": "BringLiquidity",
+        "type": "vault::vault::vault::Vault::BringLiquidity",
+        "kind": "nested"
       }
     ]
   }
-]
+]
+

package/src/dataTypes/_bignumber.ts

@@ -1,5 +1,6 @@
 import { logger } from "@/utils/logger";
 import BigNumber from "bignumber.js";
+import { uint256 } from "starknet";
 
 export class _Web3Number<T extends _Web3Number<T>> extends BigNumber {
   decimals: number;
@@ -107,6 +108,10 @@ export class _Web3Number<T extends _Web3Number<T>> extends BigNumber {
       sign: sign,
     }
   }
+
+  toUint256() {
+    return uint256.bnToUint256(this.toWei());
+  }
 }
 
 BigNumber.config({ DECIMAL_PLACES: 18, ROUNDING_MODE: BigNumber.ROUND_DOWN });

package/src/dataTypes/bignumber.browser.ts

@@ -1,3 +1,4 @@
+import { Uint256, uint256 } from "starknet";
 import { _Web3Number } from "./_bignumber";
 
 export class Web3Number extends _Web3Number<Web3Number> {
@@ -5,4 +6,8 @@ export class Web3Number extends _Web3Number<Web3Number> {
         const bn = (new Web3Number(weiNumber, decimals)).dividedBy(10 ** decimals)
         return new Web3Number(bn.toString(), decimals);
     }
+
+    static fromUint256(uint256Value: Uint256): Web3Number {
+        return this.fromWei(uint256.uint256ToBN(uint256Value).toString(), 18);
+    }
 }

package/src/dataTypes/bignumber.node.ts

@@ -1,5 +1,6 @@
 import util from 'util';
 import { _Web3Number } from "./_bignumber";
+import { Uint256, uint256 } from 'starknet';
 
 export class Web3Number extends _Web3Number<Web3Number> {
 
@@ -8,6 +9,10 @@ export class Web3Number extends _Web3Number<Web3Number> {
         return new Web3Number(bn.toString(), decimals);
     }
 
+    static fromUint256(uint256Value: Uint256): Web3Number {
+        return this.fromWei(uint256.uint256ToBN(uint256Value).toString(), 18);
+    }
+
     [util.inspect.custom](depth: any, opts: any): string {
         return this.toString();
     }

package/src/global.ts

@@ -22,7 +22,8 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 18,
     coingeckId: 'starknet',
     displayDecimals: 2,
-    priceCheckAmount: 1000, 
+    priceCheckAmount: 5000, 
+    priceMethod: 'Avnu'
 }, {
     name: 'xSTRK',
     symbol: 'xSTRK',
@@ -30,8 +31,9 @@ const defaultTokens: TokenInfo[] = [{
     address: ContractAddr.from('0x028d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a'),
     decimals: 18,
     coingeckId: undefined,
-    priceCheckAmount: 1000, 
+    priceCheckAmount: 5000, 
     displayDecimals: 2,
+    priceMethod: 'Avnu'
 }, {
     name: 'ETH',
     symbol: 'ETH',
@@ -114,8 +116,8 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 8,
     coingeckId: undefined,
     displayDecimals: 6,
-    priceProxySymbol: 'WBTC',
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    priceMethod: 'Avnu'
 }, {
     name: 'xsBTC',
     symbol: 'xsBTC',
@@ -124,10 +126,9 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 18,
     coingeckId: undefined,
     displayDecimals: 6,
-    priceProxySymbol: 'WBTC',
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+    priceMethod: 'Avnu'
 }, {
-    // todo upgrade proxy tokens once feeds are available
     name: 'xtBTC',
     symbol: 'xtBTC',
     logo: 'https://assets.strkfarm.com/integrations/tokens/xtbtc.svg',
@@ -136,7 +137,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
-    priceProxySymbol: 'WBTC',
+    priceMethod: 'Avnu'
 }, {
     name: 'xLBTC',
     symbol: 'xLBTC',
@@ -145,8 +146,8 @@ const defaultTokens: TokenInfo[] = [{
     decimals: 8,
     coingeckId: undefined,
     displayDecimals: 6,
-    priceProxySymbol: 'WBTC',
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+    priceMethod: 'Avnu'
 }, {
     name: 'mRe7BTC',
     symbol: 'mRe7BTC',
@@ -156,6 +157,7 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 6,
     priceCheckAmount: 0.0001, // 112000 * 0.0001 = $11.2
+    dontPrice: true,
 }, {
     name: 'mRe7YIELD',
     symbol: 'mRe7YIELD',
@@ -165,7 +167,58 @@ const defaultTokens: TokenInfo[] = [{
     coingeckId: undefined,
     displayDecimals: 2,
     priceCheckAmount: 100,
-}]
+    dontPrice: true,
+}, {
+    name: "fyeWBTC",
+    symbol: "fyeWBTC",
+    logo: 'https://assets.strkfarm.com/integrations/tokens/wbtc.svg',
+    address: ContractAddr.from('0x04dd39de0a588f5e1c7a8377e1bef2c49caaee49a11433429d2c48f587b3a492'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    dontPrice: true,
+}, {
+    name: "fyETH",
+    symbol: "fyETH",
+    logo: 'https://assets.strkfarm.com/integrations/tokens/eth.svg',
+    address: ContractAddr.from('0x050707bC3b8730022F10530C2c6f6b9467644129C50C2868Ad0036c5e4E9e616'),
+    decimals: 18,
+    coingeckId: undefined,
+    displayDecimals: 4,
+    priceCheckAmount: 0.1,
+    dontPrice: true,
+}, {
+    name: "fyeUSDC",
+    symbol: "fyeUSDC",
+    logo: 'https://assets.strkfarm.com/integrations/tokens/usdc.svg',
+    address: ContractAddr.from('0x07fdcec0cef01294c9c3d52415215949805c77bae8003702a7928fd6d2c36bc1'),
+    decimals: 6,
+    coingeckId: undefined,
+    displayDecimals: 2,
+    priceCheckAmount: 100,
+    dontPrice: true,
+}, {
+    name: 'strkBTC',
+    symbol: 'strkBTC',
+    logo: 'https://assets.troves.fi/integrations/tokens/strkbtc.svg',
+    address: ContractAddr.from('0x0787150e306e6eae6e3f79dea881770e8bbff2c1b8eb490f969669ee945b3135'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceCheckAmount: 0.001, // 112000 * 0.0001 = $110.2
+    priceMethod: 'Avnu'
+}, {
+    name: 'xstrkBTC',
+    symbol: 'xstrkBTC',
+    logo: 'https://assets.troves.fi/integrations/tokens/xstrkbtc.svg',
+    address: ContractAddr.from('0x047751b3532fabca89b0f2e35ca1cb45e5a7b11d5e3d3663dfa1f4406b45fd88'),
+    decimals: 8,
+    coingeckId: undefined,
+    displayDecimals: 6,
+    priceCheckAmount: 0.001,
+    priceMethod: 'Avnu'
+},]
 const tokens: TokenInfo[] = defaultTokens;
 
 /** Contains globally useful functions.