@alphafi/alphafi-sdk 0.0.10 → 0.0.11

package/.envrc

@@ -0,0 +1 @@
+export AWS_PROFILE=alphafi-mgmt-admin

package/.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "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"
+  },
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "off",
+    "prettier/prettier": "error" // Ensures that Prettier mismatches are shown as errors
+  },
+  "plugins": [
+    "prettier" // Ensure this plugin is installed and included
+  ]
+}

package/.github/workflows/static.yml

@@ -0,0 +1,51 @@
+# Simple workflow for deploying docs to GitHub Pages
+name: Deploy Documentation to GitHub Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install dependencies
+        run: npm install
+      - name: Generate Documentation
+        run: npm run docs
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: "./docs"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.prettierrc.json

@@ -0,0 +1,27 @@
+{
+  "semi": true,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "endOfLine": "lf",
+
+  "overrides": [
+    {
+      "files": "*.ts",
+      "options": {
+        "parser": "typescript"
+      }
+    },
+    {
+      "files": "*.tsx",
+      "options": {
+        "parser": "typescript"
+      }
+    },
+    {
+      "files": "*.graphql",
+      "options": {
+        "parser": "graphql"
+      }
+    }
+  ]
+}

package/.prettierrc.json~

@@ -0,0 +1,30 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "bracketSpacing": true,
+  "overrides": [
+    {
+      "files": "*.ts",
+      "options": {
+        "parser": "typescript"
+      }
+    },
+    {
+      "files": "*.tsx",
+      "options": {
+        "parser": "typescript"
+      }
+    },
+    {
+      "files": "*.graphql",
+      "options": {
+        "parser": "graphql"
+      }
+    }
+  ]
+}

package/__tests__/getAprs.test.ts~

@@ -0,0 +1,9 @@
+import { getApr, getAprs } from "../dist";
+
+describe("getApr", () => {
+  it("should return the correct value", async () => {
+    return getApr("USDT-USDC").then((apr) => {
+      expect(apr).toBeDefined();
+    });
+  });
+});

package/__tests__/getRebalanceHistory.test.ts~

@@ -0,0 +1,19 @@
+import { getRebalanceHistory, getRebalanceHistories } from "../dist";
+
+describe("getRebalanceHistory", () => {
+  it("should return the correct value", async () => {
+    return getRebalanceHistory("USDT-USDC").then((history) => {
+      console.log(history);
+      expect(history).toBeDefined();
+    });
+  });
+});
+
+describe("getRebalanceHistories", () => {
+  it("should return the correct value", async () => {
+    return getRebalanceHistories(["USDT-USDC"]).then((historyMap) => {
+      console.log(historyMap);
+      expect(historyMap).toBeDefined();
+    });
+  });
+});

package/apr.org

@@ -0,0 +1,11 @@
+If g1, g2, ..., gn are growths in intervals t1, t2, ..., tn. Here t1, t2, ..., tn are fraction of a day in milliseconds. Then which one is the best way to calculate APR. Assume that T is number of milliseconds in a day.
+
+Option-1
+--------
+
+(g1*t1 + g2*t2 + ... + gn*tn) / (t1 + t2 + ... + tn)
+
+Option-2
+--------
+
+(g1*t1/T + g2*t2/T + ... + gn*t2/T) / (t1/T + t2/T + ... + tn/T)

package/babel.config.json

@@ -0,0 +1,11 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": "> 0.25%, not dead"
+      }
+    ],
+    "@babel/preset-typescript"
+  ]
+}