@alphafi/alphafi-sdk 0.0.2 → 0.0.4

package/README.md

@@ -1 +1,97 @@
-# 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[] | undefined = await getVaults(address);
+```
+
+## `getSingleAssetVaults`
+
+Call this to get all Single Asset Vaults that a particular user has deposited in.
+
+```typescript
+import { getSingleAssetVaults, AlphaFiVault } from "alphafi-sdk";
+
+const vaults: AlphaFiVault[] | undefined = await getSingleAssetVaults(address);
+```
+
+## `getDoubleAssetVaults`
+
+Call this to get all Double Asset Vaults that a particular user has deposited in.
+
+```typescript
+import { getDoubleAssetVaults, AlphaFiVault } from "alphafi-sdk";
+
+const vaults: AlphaFiVault[] | undefined = await getDoubleAssetVaults(address);
+```
+
+## `getAlphaVaultBalance`
+
+Call this to get user balance in Alpha Vault.
+
+```typescript
+import { getAlphaVaultBalance, AlphaVaultBalance } from "alphafi-sdk";
+
+const balance: AlphaVaultBalance | undefined = await getAlphaVaultBalance(address);
+```
+
+## `getSingleAssetVaultBalance`
+
+Call this to get user balance in Single Asset Vaults.
+
+```typescript
+import { getSingleAssetVaultBalance, SingleAssetVaultBalance } from "alphafi-sdk";
+
+const balance: SingleAssetVaultBalance | undefined = 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 | undefined = await getDoubleAssetVaultBalance(address, poolName);
+```
+
+## `getAllVaults`
+
+Call this to get all Vaults on AlphaFi Protocol.
+
+```typescript
+import { getAllVaults } from "alphafi-sdk";
+
+const vaults: string[] = await getAllVaults();
+```
+
+## `getAllSingleAssetVaults`
+
+Call this to get all Single Asset Vaults on AlphaFi Protocol.
+
+```typescript
+import { getAllSingleAssetVaults } from "alphafi-sdk";
+
+const vaults: string[] = await getAllSingleAssetVaults();
+```
+
+## `getAllDoubleAssetVaults`
+
+Call this to get all Double Asset Vaults on AlphaFi Protocol.
+
+```typescript
+import { getAllDoubleAssetVaults } from "alphafi-sdk";
+
+const vaults: string[] = await getAllDoubleAssetVaults();
+```

package/dist/getAllVaults.d.ts

@@ -0,0 +1,4 @@
+export declare function getAllVaults(): Promise<string[]>;
+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,YAAY,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAMtD;AAED,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAQjE;AAED,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAQjE"}

package/dist/getVaults.d.ts

@@ -1,3 +1,5 @@
 import { AlphaFiVault } from "./common/types";
 export declare function getVaults(address: string): Promise<AlphaFiVault[] | undefined>;
+export declare function getSingleAssetVaults(address: string): Promise<AlphaFiVault[] | undefined>;
+export declare function getDoubleAssetVaults(address: string): Promise<AlphaFiVault[] | undefined>;
 //# sourceMappingURL=getVaults.d.ts.map

package/dist/getVaults.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getVaults.d.ts","sourceRoot":"","sources":["../src/getVaults.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAqB9C,wBAAsB,SAAS,CAC7B,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,CAoCrC"}
+{"version":3,"file":"getVaults.d.ts","sourceRoot":"","sources":["../src/getVaults.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAqB9C,wBAAsB,SAAS,CAC7B,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,CAoCrC;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,CAMrC;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,CAMrC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { getVaults } from "./getVaults";
+export { getVaults, getSingleAssetVaults, getDoubleAssetVaults, } from "./getVaults";
 export { getAlphaVaultBalance, getSingleAssetVaultBalance, getDoubleAssetVaultBalance, } from "./getVaultBalances";
+export { getAllVaults, getAllDoubleAssetVaults, getAllSingleAssetVaults, } from "./getAllVaults";
 export { AlphaFiVault, AlphaVaultBalance, DoubleAssetVaultBalance, SingleAssetVaultBalance, PoolName, } from "./common/types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,EACvB,QAAQ,GACT,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,YAAY,EACZ,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,EACvB,QAAQ,GACT,MAAM,gBAAgB,CAAC"}