@alphafi/alphafi-sdk 0.0.2 → 0.0.3

package/README.md

@@ -1 +1,47 @@
-# alphafi-sdk
+# ALPHAFI TypeScript SDK
+
+## Installation
+
+```bash
+npm i @alphafi/alphafi-sdk
+```
+
+## `getVaults`
+
+Call this to get all Vaults that a particular user has deposited in.
+
+```typescript
+import { getVaults, AlphaFiVault } from "alphafi-sdk";
+
+const vaults: AlphaFiVault = await getVaults(address);
+```
+
+## `getAlphaVaultBalance`
+
+Call this to get user balance in Alpha Vault.
+
+```typescript
+import { getAlphaVaultBalance, AlphaVaultBalance } from "alphafi-sdk";
+
+const balance: AlphaVaultBalance = await getAlphaVaultBalance(address);
+```
+
+## `getSingleAssetVaultBalance`
+
+Call this to get user balance in Single Asset Vaults.
+
+```typescript
+import { getSingleAssetVaultBalance, SingleAssetVaultBalance } from "alphafi-sdk";
+
+const balance: SingleAssetVaultBalance = await getSingleAssetVaultBalance(address, poolName);
+```
+
+## `getDoubleAssetVaultBalance`
+
+Call this to get user balance in Double Asset Vaults.
+
+```typescript
+import { getDoubleAssetVaultBalance, DoubleAssetVaultBalance } from "alphafi-sdk";
+
+const balance: DoubleAssetVaultBalance = await getDoubleAssetVaultBalance(address, poolName);
+```

package/dist/getAllVaults.d.ts

@@ -0,0 +1,3 @@
+export declare function getAllSingleAssetVaults(): Promise<string[]>;
+export declare function getAllDoubleAssetVaults(): Promise<string[]>;
+//# sourceMappingURL=getAllVaults.d.ts.map

package/dist/getAllVaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAllVaults.d.ts","sourceRoot":"","sources":["../src/getAllVaults.ts"],"names":[],"mappings":"AAEA,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAQjE;AAED,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAQjE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alphafi/alphafi-sdk",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "AlphaFi SDK",
   "main": "dist/index.js",
   "scripts": {
@@ -47,5 +47,8 @@
     "bn.js": "^5.2.1",
     "ts-node": "^10.9.2",
     "tsx": "^4.16.3"
-  }
+  },
+  "files": [
+    "dist"
+  ]
 }

package/.babelrc

@@ -1,6 +0,0 @@
-{
-  "presets": [
-    ["@babel/preset-env", { "targets": { "node": "current" } }],
-    "@babel/preset-typescript"
-  ]
-}

package/.eslintrc.json

@@ -1,30 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings",
-    "plugin:import/typescript",
-    "plugin:prettier/recommended" // Adds Prettier plugin recommendations at the end
-  ],
-  "parserOptions": {
-    "ecmaVersion": 2020,
-    "sourceType": "module",
-    "project": "./tsconfig.json"
-  },
-  "rules": {
-    "prettier/prettier": "error", // Ensures that Prettier mismatches are shown as errors
-    "@typescript-eslint/explicit-function-return-type": "off",
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      { "argsIgnorePattern": "^_" }
-    ]
-  },
-  "plugins": [
-    "@typescript-eslint",
-    "import",
-    "prettier" // Ensure this plugin is installed and included
-  ]
-}

package/jest.config.js

@@ -1,14 +0,0 @@
-module.exports = {
-  preset: "ts-jest",
-  testEnvironment: "node",
-  transform: {
-    "^.+\\.tsx?$": "babel-jest",
-    "^.+\\.jsx?$": "babel-jest",
-  },
-  moduleFileExtensions: ["ts", "tsx", "js", "jsx"],
-  globals: {
-    "ts-jest": {
-      tsconfig: "tsconfig.json",
-    },
-  },
-};

package/src/common/cetus_mainnet_config.ts

@@ -1,72 +0,0 @@
-import { SdkOptions } from "@cetusprotocol/cetus-sui-clmm-sdk";
-import { getFullnodeUrl } from "@mysten/sui/client";
-
-export const cetusMainnetSDKOptions: SdkOptions = {
-  fullRpcUrl: getFullnodeUrl("mainnet"),
-  swapCountUrl: "https://api-sui.cetus.zone/v2/sui/swap/count",
-  simulationAccount: {
-    address:
-      "0x4260738f0f7341adc79a8edaa62f8a4681ebd27c595aecab1f322f47bfc52c5e",
-  },
-  cetus_config: {
-    package_id:
-      "0x95b8d278b876cae22206131fb9724f701c9444515813042f54f0a426c9a3bc2f",
-    published_at:
-      "0x95b8d278b876cae22206131fb9724f701c9444515813042f54f0a426c9a3bc2f",
-    config: {
-      coin_list_id:
-        "0x8cbc11d9e10140db3d230f50b4d30e9b721201c0083615441707ffec1ef77b23",
-      launchpad_pools_id:
-        "0x1098fac992eab3a0ab7acf15bb654fc1cf29b5a6142c4ef1058e6c408dd15115",
-      clmm_pools_id:
-        "0x15b6a27dd9ae03eb455aba03b39e29aad74abd3757b8e18c0755651b2ae5b71e",
-      admin_cap_id:
-        "0x39d78781750e193ce35c45ff32c6c0c3f2941fa3ddaf8595c90c555589ddb113",
-      global_config_id:
-        "0x0408fa4e4a4c03cc0de8f23d0c2bbfe8913d178713c9a271ed4080973fe42d8f",
-      coin_list_handle:
-        "0x49136005e90e28c4695419ed4194cc240603f1ea8eb84e62275eaff088a71063",
-      launchpad_pools_handle:
-        "0x5e194a8efcf653830daf85a85b52e3ae8f65dc39481d54b2382acda25068375c",
-      clmm_pools_handle:
-        "0x37f60eb2d9d227949b95da8fea810db3c32d1e1fa8ed87434fc51664f87d83cb",
-    },
-  },
-  clmm_pool: {
-    package_id:
-      "0x1eabed72c53feb3805120a081dc15963c204dc8d091542592abaf7a35689b2fb",
-    published_at:
-      "0x70968826ad1b4ba895753f634b0aea68d0672908ca1075a2abdf0fc9e0b2fc6a",
-    config: {
-      pools_id:
-        "0xf699e7f2276f5c9a75944b37a0c5b5d9ddfd2471bf6242483b03ab2887d198d0",
-      global_config_id:
-        "0xdaa46292632c3c4d8f31f23ea0f9b36a28ff3677e9684980e4438403a67a3d8f",
-      global_vault_id:
-        "0xce7bceef26d3ad1f6d9b6f13a953f053e6ed3ca77907516481ce99ae8e588f2b",
-      admin_cap_id:
-        "0x89c1a321291d15ddae5a086c9abc533dff697fde3d89e0ca836c41af73e36a75",
-      partners_id:
-        "0xac30897fa61ab442f6bff518c5923faa1123c94b36bd4558910e9c783adfa204",
-    },
-  },
-  integrate: {
-    package_id:
-      "0x996c4d9480708fb8b92aa7acf819fb0497b5ec8e65ba06601cae2fb6db3312c3",
-    published_at:
-      "0x6f5e582ede61fe5395b50c4a449ec11479a54d7ff8e0158247adfda60d98970b",
-  },
-  deepbook: {
-    package_id:
-      "0x000000000000000000000000000000000000000000000000000000000000dee9",
-    published_at:
-      "0x000000000000000000000000000000000000000000000000000000000000dee9",
-  },
-  deepbook_endpoint_v2: {
-    package_id:
-      "0x0dd416959739e1db3a4c6f9cac7f9e7202678f3b067d6d419e569a124fc35e0e",
-    published_at:
-      "0x0dd416959739e1db3a4c6f9cac7f9e7202678f3b067d6d419e569a124fc35e0e",
-  },
-  aggregatorUrl: "https://api-sui.cetus.zone/router",
-};

package/src/common/coins.ts

@@ -1,126 +0,0 @@
-// import { CONF_ENV, conf } from "../constants";
-// import { Coin, CoinName, CoinType } from "./types";
-
-import { conf, CONF_ENV } from "./constants";
-import { Coin, CoinName, CoinType } from "./types";
-
-export const coins: { [key in CoinName]: Coin } = {
-  ALPHA: {
-    name: "ALPHA",
-    type: conf[CONF_ENV].ALPHA_COIN_TYPE as CoinType,
-    icon: "https://7taj6jfau6n3dri7agspzfnva7qbj5sizz5xc3lb56nmxpsyoiba.arweave.net/_MCfJKCnm7HFHwGk_JW1B-AU9kjOe3FtYe-ay75YcgI",
-    expo: 9,
-  },
-  SUI: {
-    name: "SUI",
-    type: "0x2::sui::SUI",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x0000000000000000000000000000000000000000000000000000000000000002-sui-SUI.svg",
-    expo: 9,
-  },
-  USDC: {
-    name: "USDC",
-    type: "0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf-coin-COIN.webp",
-    expo: 6,
-  },
-  USDT: {
-    name: "USDT",
-    type: "0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c::coin::COIN",
-    icon: "https://coinmeta.polymedia.app/img/coins/0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c-coin-COIN.webp",
-    expo: 6,
-  },
-  VSUI: {
-    name: "VSUI",
-    type: "0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55-cert-CERT.webp",
-    expo: 9,
-  },
-  NAVX: {
-    name: "NAVX",
-    type: "0xa99b8952d4f7d947ea77fe0ecdcc9e5fc0bcab2841d6e2a5aa00c3044e5544b5::navx::NAVX",
-    icon: "https://coinmeta.polymedia.app/img/coins/0xa99b8952d4f7d947ea77fe0ecdcc9e5fc0bcab2841d6e2a5aa00c3044e5544b5-navx-NAVX.webp",
-    expo: 9,
-  },
-  SCA: {
-    name: "SCA",
-    type: "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6-sca-SCA.webp",
-    expo: 9,
-  },
-  CETUS: {
-    name: "CETUS",
-    type: "0x6864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b-cetus-CETUS.webp",
-    expo: 9,
-  },
-  TURBOS: {
-    name: "TURBOS",
-    type: "0x5d1f47ea69bb0de31c313d7acf89b890dbb8991ea8e03c6c355171f84bb1ba4a::turbos::TURBOS",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x5d1f47ea69bb0de31c313d7acf89b890dbb8991ea8e03c6c355171f84bb1ba4a-turbos-TURBOS.svg",
-    expo: 9,
-  },
-  AFSUI: {
-    name: "AFSUI",
-    type: "0xf325ce1300e8dac124071d3152c5c5ee6174914f8bc2161e88329cf579246efc::afsui::AFSUI",
-    icon: "https://coinmeta.polymedia.app/img/coins/0xf325ce1300e8dac124071d3152c5c5ee6174914f8bc2161e88329cf579246efc-afsui-AFSUI.webp",
-    expo: 9,
-  },
-  WETH: {
-    name: "WETH",
-    type: "0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5::coin::COIN",
-    icon: "https://coinmeta.polymedia.app/img/coins/0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5-coin-COIN.webp",
-    expo: 8,
-  },
-  APT: {
-    name: "APT",
-    type: "0x3a5143bb1196e3bcdfab6203d1683ae29edd26294fc8bfeafe4aaa9d2704df37::coin::COIN",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x3a5143bb1196e3bcdfab6203d1683ae29edd26294fc8bfeafe4aaa9d2704df37-coin-COIN.webp",
-    expo: 8,
-  },
-  SOL: {
-    name: "SOL",
-    type: "0xb7844e289a8410e50fb3ca48d69eb9cf29e27d223ef90353fe1bd8e27ff8f3f8::coin::COIN",
-    icon: "https://coinmeta.polymedia.app/img/coins/0xb7844e289a8410e50fb3ca48d69eb9cf29e27d223ef90353fe1bd8e27ff8f3f8-coin-COIN.webp",
-    expo: 8,
-  },
-  SLP: {
-    name: "SLP",
-    type: "0xc44d97a4bc4e5a33ca847b72b123172c88a6328196b71414f32c3070233604b2::slp::SLP",
-    icon: "https://coinmeta.polymedia.app/img/coins/0xc44d97a4bc4e5a33ca847b72b123172c88a6328196b71414f32c3070233604b2-slp-SLP.webp",
-    expo: 6,
-  },
-  WBTC: {
-    name: "WBTC",
-    type: "0x027792d9fed7f9844eb4839566001bb6f6cb4804f66aa2da6fe1ee242d896881::coin::COIN",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x027792d9fed7f9844eb4839566001bb6f6cb4804f66aa2da6fe1ee242d896881-coin-COIN.webp",
-    expo: 8,
-  },
-  CELO: {
-    name: "CELO",
-    type: "0xa198f3be41cda8c07b3bf3fee02263526e535d682499806979a111e88a5a8d0f::coin::COIN",
-    icon: "https://coinmeta.polymedia.app/img/coins/0xa198f3be41cda8c07b3bf3fee02263526e535d682499806979a111e88a5a8d0f-coin-COIN.webp",
-    expo: 8,
-  },
-  HASUI: {
-    name: "HASUI",
-    type: "0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d::hasui::HASUI",
-    icon: "https://coinmeta.polymedia.app/img/coins/0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d-hasui-HASUI.svg",
-    expo: 9,
-  },
-  USDY: {
-    name: "USDY",
-    type: "0x960b531667636f39e85867775f52f6b1f220a058c4de786905bdf761e06a56bb::usdy::USDY",
-    icon: "https://coinmeta.polymedia.app/img/coins/0x960b531667636f39e85867775f52f6b1f220a058c4de786905bdf761e06a56bb-usdy-USDY.svg",
-    expo: 6,
-  },
-};
-
-export const poolTokenMap: {
-  [key in string]: { coinName: CoinName; coinType: CoinType };
-} = {
-  "NAVI-SUI": { coinName: "SUI", coinType: coins["SUI"].type },
-  "NAVI-VSUI": { coinName: "VSUI", coinType: coins["VSUI"].type },
-  "NAVI-WETH": { coinName: "WETH", coinType: coins["WETH"].type },
-  "NAVI-USDT": { coinName: "USDT", coinType: coins["USDT"].type },
-  "NAVI-USDC": { coinName: "USDC", coinType: coins["USDC"].type },
-};