@compass-labs/api-sdk 2.1.16 → 2.1.17-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -5
- package/codeSamples_typescript.yaml +1 -7
- package/dist/commonjs/funcs/earnEarnVaults.d.ts +6 -3
- package/dist/commonjs/funcs/earnEarnVaults.d.ts.map +1 -1
- package/dist/commonjs/funcs/earnEarnVaults.js +7 -3
- package/dist/commonjs/funcs/earnEarnVaults.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/components/index.d.ts +1 -2
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +1 -2
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/vaultinfo.d.ts +22 -110
- package/dist/commonjs/models/components/vaultinfo.d.ts.map +1 -1
- package/dist/commonjs/models/components/vaultinfo.js +19 -58
- package/dist/commonjs/models/components/vaultinfo.js.map +1 -1
- package/dist/commonjs/models/components/{vaultslistresponse.d.ts → vaultsresponse.d.ts} +5 -5
- package/dist/commonjs/models/components/vaultsresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/{vaultslistresponse.js → vaultsresponse.js} +6 -6
- package/dist/commonjs/models/components/vaultsresponse.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +0 -1
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +0 -1
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/v2earnvaults.d.ts +5 -0
- package/dist/commonjs/models/operations/v2earnvaults.d.ts.map +1 -1
- package/dist/commonjs/models/operations/v2earnvaults.js +2 -0
- package/dist/commonjs/models/operations/v2earnvaults.js.map +1 -1
- package/dist/commonjs/sdk/earn.d.ts +5 -9
- package/dist/commonjs/sdk/earn.d.ts.map +1 -1
- package/dist/commonjs/sdk/earn.js +4 -11
- package/dist/commonjs/sdk/earn.js.map +1 -1
- package/dist/esm/funcs/earnEarnVaults.d.ts +6 -3
- package/dist/esm/funcs/earnEarnVaults.d.ts.map +1 -1
- package/dist/esm/funcs/earnEarnVaults.js +7 -3
- package/dist/esm/funcs/earnEarnVaults.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/components/index.d.ts +1 -2
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +1 -2
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/vaultinfo.d.ts +22 -110
- package/dist/esm/models/components/vaultinfo.d.ts.map +1 -1
- package/dist/esm/models/components/vaultinfo.js +19 -58
- package/dist/esm/models/components/vaultinfo.js.map +1 -1
- package/dist/esm/models/components/{vaultslistresponse.d.ts → vaultsresponse.d.ts} +5 -5
- package/dist/esm/models/components/vaultsresponse.d.ts.map +1 -0
- package/dist/esm/models/components/{vaultslistresponse.js → vaultsresponse.js} +4 -4
- package/dist/esm/models/components/vaultsresponse.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +0 -1
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +0 -1
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/v2earnvaults.d.ts +5 -0
- package/dist/esm/models/operations/v2earnvaults.d.ts.map +1 -1
- package/dist/esm/models/operations/v2earnvaults.js +2 -0
- package/dist/esm/models/operations/v2earnvaults.js.map +1 -1
- package/dist/esm/sdk/earn.d.ts +5 -9
- package/dist/esm/sdk/earn.d.ts.map +1 -1
- package/dist/esm/sdk/earn.js +4 -11
- package/dist/esm/sdk/earn.js.map +1 -1
- package/docs/models/components/vaultinfo.md +19 -43
- package/docs/models/components/{vaultslistresponse.md → vaultsresponse.md} +15 -8
- package/docs/models/operations/v2earnvaultsrequest.md +4 -3
- package/docs/sdks/earn/README.md +8 -84
- package/examples/node_modules/@types/node/README.md +1 -1
- package/examples/node_modules/@types/node/package.json +2 -2
- package/examples/node_modules/@types/node/process.d.ts +5 -0
- package/examples/package-lock.json +3 -3
- package/package.json +1 -1
- package/src/funcs/earnEarnVaults.ts +10 -6
- package/src/lib/config.ts +2 -2
- package/src/models/components/index.ts +1 -2
- package/src/models/components/vaultinfo.ts +41 -168
- package/src/models/components/{vaultslistresponse.ts → vaultsresponse.ts} +8 -8
- package/src/models/operations/index.ts +0 -1
- package/src/models/operations/v2earnvaults.ts +7 -0
- package/src/sdk/earn.ts +5 -20
- package/dist/commonjs/funcs/earnEarnPositionsPositionId.d.ts +0 -19
- package/dist/commonjs/funcs/earnEarnPositionsPositionId.d.ts.map +0 -1
- package/dist/commonjs/funcs/earnEarnPositionsPositionId.js +0 -129
- package/dist/commonjs/funcs/earnEarnPositionsPositionId.js.map +0 -1
- package/dist/commonjs/models/components/earnpositionresponse.d.ts +0 -25
- package/dist/commonjs/models/components/earnpositionresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/earnpositionresponse.js +0 -64
- package/dist/commonjs/models/components/earnpositionresponse.js.map +0 -1
- package/dist/commonjs/models/components/vaultslistresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/vaultslistresponse.js.map +0 -1
- package/dist/commonjs/models/operations/v2earnpositionspositionid.d.ts +0 -25
- package/dist/commonjs/models/operations/v2earnpositionspositionid.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2earnpositionspositionid.js +0 -57
- package/dist/commonjs/models/operations/v2earnpositionspositionid.js.map +0 -1
- package/dist/esm/funcs/earnEarnPositionsPositionId.d.ts +0 -19
- package/dist/esm/funcs/earnEarnPositionsPositionId.d.ts.map +0 -1
- package/dist/esm/funcs/earnEarnPositionsPositionId.js +0 -93
- package/dist/esm/funcs/earnEarnPositionsPositionId.js.map +0 -1
- package/dist/esm/models/components/earnpositionresponse.d.ts +0 -25
- package/dist/esm/models/components/earnpositionresponse.d.ts.map +0 -1
- package/dist/esm/models/components/earnpositionresponse.js +0 -26
- package/dist/esm/models/components/earnpositionresponse.js.map +0 -1
- package/dist/esm/models/components/vaultslistresponse.d.ts.map +0 -1
- package/dist/esm/models/components/vaultslistresponse.js.map +0 -1
- package/dist/esm/models/operations/v2earnpositionspositionid.d.ts +0 -25
- package/dist/esm/models/operations/v2earnpositionspositionid.d.ts.map +0 -1
- package/dist/esm/models/operations/v2earnpositionspositionid.js +0 -20
- package/dist/esm/models/operations/v2earnpositionspositionid.js.map +0 -1
- package/docs/models/components/earnpositionresponse.md +0 -26
- package/docs/models/components/positionunion.md +0 -32
- package/docs/models/operations/v2earnpositionspositionidrequest.md +0 -21
- package/src/funcs/earnEarnPositionsPositionId.ts +0 -183
- package/src/models/components/earnpositionresponse.ts +0 -74
- package/src/models/operations/v2earnpositionspositionid.ts +0 -54
|
@@ -3,9 +3,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
|
|
|
3
3
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
4
4
|
import { VaultInfo } from "./vaultinfo.js";
|
|
5
5
|
/**
|
|
6
|
-
* Response model for a paginated list of
|
|
6
|
+
* Response model for a paginated list of ERC-4626 vaults.
|
|
7
7
|
*/
|
|
8
|
-
export type
|
|
8
|
+
export type VaultsResponse = {
|
|
9
9
|
total: number;
|
|
10
10
|
offset: number;
|
|
11
11
|
limit: number;
|
|
@@ -15,6 +15,6 @@ export type VaultsListResponse = {
|
|
|
15
15
|
vaults: Array<VaultInfo>;
|
|
16
16
|
};
|
|
17
17
|
/** @internal */
|
|
18
|
-
export declare const
|
|
19
|
-
export declare function
|
|
20
|
-
//# sourceMappingURL=
|
|
18
|
+
export declare const VaultsResponse$inboundSchema: z.ZodType<VaultsResponse, z.ZodTypeDef, unknown>;
|
|
19
|
+
export declare function vaultsResponseFromJSON(jsonString: string): SafeParseResult<VaultsResponse, SDKValidationError>;
|
|
20
|
+
//# sourceMappingURL=vaultsresponse.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"vaultsresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/vaultsresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,SAAS,EAA2B,MAAM,gBAAgB,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC1B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD"}
|
|
@@ -5,13 +5,13 @@ import * as z from "zod/v3";
|
|
|
5
5
|
import { safeParse } from "../../lib/schemas.js";
|
|
6
6
|
import { VaultInfo$inboundSchema } from "./vaultinfo.js";
|
|
7
7
|
/** @internal */
|
|
8
|
-
export const
|
|
8
|
+
export const VaultsResponse$inboundSchema = z.object({
|
|
9
9
|
total: z.number().int(),
|
|
10
10
|
offset: z.number().int(),
|
|
11
11
|
limit: z.number().int(),
|
|
12
12
|
vaults: z.array(VaultInfo$inboundSchema),
|
|
13
13
|
});
|
|
14
|
-
export function
|
|
15
|
-
return safeParse(jsonString, (x) =>
|
|
14
|
+
export function vaultsResponseFromJSON(jsonString) {
|
|
15
|
+
return safeParse(jsonString, (x) => VaultsResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'VaultsResponse' from JSON`);
|
|
16
16
|
}
|
|
17
|
-
//# sourceMappingURL=
|
|
17
|
+
//# sourceMappingURL=vaultsresponse.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"vaultsresponse.js","sourceRoot":"","sources":["../../../../src/models/components/vaultsresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGjD,OAAO,EAAa,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAepE,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACxB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;CACzC,CAAC,CAAC;AAEH,MAAM,UAAU,sBAAsB,CACpC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxD,4CAA4C,CAC7C,CAAC;AACJ,CAAC"}
|
|
@@ -39,6 +39,5 @@ export * from "./v1wildcatmarket.js";
|
|
|
39
39
|
export * from "./v2cctpmint.js";
|
|
40
40
|
export * from "./v2earnaavetokenrates.js";
|
|
41
41
|
export * from "./v2earnpositions.js";
|
|
42
|
-
export * from "./v2earnpositionspositionid.js";
|
|
43
42
|
export * from "./v2earnvaults.js";
|
|
44
43
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/index.ts"],"names":[],"mappings":"AAIA,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uDAAuD,CAAC;AACtE,cAAc,qCAAqC,CAAC;AACpD,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mCAAmC,CAAC;AAClD,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/index.ts"],"names":[],"mappings":"AAIA,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uDAAuD,CAAC;AACtE,cAAc,qCAAqC,CAAC;AACpD,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mCAAmC,CAAC;AAClD,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC"}
|
|
@@ -42,6 +42,5 @@ export * from "./v1wildcatmarket.js";
|
|
|
42
42
|
export * from "./v2cctpmint.js";
|
|
43
43
|
export * from "./v2earnaavetokenrates.js";
|
|
44
44
|
export * from "./v2earnpositions.js";
|
|
45
|
-
export * from "./v2earnpositionspositionid.js";
|
|
46
45
|
export * from "./v2earnvaults.js";
|
|
47
46
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/operations/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uDAAuD,CAAC;AACtE,cAAc,qCAAqC,CAAC;AACpD,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mCAAmC,CAAC;AAClD,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/operations/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uDAAuD,CAAC;AACtE,cAAc,qCAAqC,CAAC;AACpD,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mCAAmC,CAAC;AAClD,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC"}
|
|
@@ -35,6 +35,10 @@ export type V2EarnVaultsRequest = {
|
|
|
35
35
|
*/
|
|
36
36
|
limit?: number | undefined;
|
|
37
37
|
chain: V2EarnVaultsChain;
|
|
38
|
+
/**
|
|
39
|
+
* Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH').
|
|
40
|
+
*/
|
|
41
|
+
assetSymbol?: string | null | undefined;
|
|
38
42
|
};
|
|
39
43
|
/** @internal */
|
|
40
44
|
export declare const Direction$outboundSchema: z.ZodNativeEnum<typeof Direction>;
|
|
@@ -47,6 +51,7 @@ export type V2EarnVaultsRequest$Outbound = {
|
|
|
47
51
|
offset?: number | undefined;
|
|
48
52
|
limit?: number | undefined;
|
|
49
53
|
chain: string;
|
|
54
|
+
asset_symbol?: string | null | undefined;
|
|
50
55
|
};
|
|
51
56
|
/** @internal */
|
|
52
57
|
export declare const V2EarnVaultsRequest$outboundSchema: z.ZodType<V2EarnVaultsRequest$Outbound, z.ZodTypeDef, V2EarnVaultsRequest>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"v2earnvaults.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/v2earnvaults.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,SAAS;;;CAGZ,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC;AAErD,eAAO,MAAM,iBAAiB;;;;CAIpB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErE,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,KAAK,EAAE,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"v2earnvaults.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/v2earnvaults.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,SAAS;;;CAGZ,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC;AAErD,eAAO,MAAM,iBAAiB;;;;CAIpB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErE,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,KAAK,EAAE,iBAAiB,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,SAAS,CAC/C,CAAC;AAEzB,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,aAAa,CAC5D,OAAO,iBAAiB,CACS,CAAC;AAEpC,gBAAgB;AAChB,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAC1C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,CAAC,CAAC,OAAO,CACxD,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,mBAAmB,CAanB,CAAC;AAEH,wBAAgB,yBAAyB,CACvC,mBAAmB,EAAE,mBAAmB,GACvC,MAAM,CAIR"}
|
|
@@ -27,9 +27,11 @@ export const V2EarnVaultsRequest$outboundSchema = z.object({
|
|
|
27
27
|
offset: z.number().int().optional(),
|
|
28
28
|
limit: z.number().int().optional(),
|
|
29
29
|
chain: V2EarnVaultsChain$outboundSchema,
|
|
30
|
+
assetSymbol: z.nullable(z.string()).optional(),
|
|
30
31
|
}).transform((v) => {
|
|
31
32
|
return remap$(v, {
|
|
32
33
|
orderBy: "order_by",
|
|
34
|
+
assetSymbol: "asset_symbol",
|
|
33
35
|
});
|
|
34
36
|
});
|
|
35
37
|
export function v2EarnVaultsRequestToJSON(v2EarnVaultsRequest) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"v2earnvaults.js","sourceRoot":"","sources":["../../../../src/models/operations/v2earnvaults.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAG1D;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AAMX,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;CACZ,CAAC;
|
|
1
|
+
{"version":3,"file":"v2earnvaults.js","sourceRoot":"","sources":["../../../../src/models/operations/v2earnvaults.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAG1D;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AAMX,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;CACZ,CAAC;AA2BX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAAsC,CAAC;KACzE,UAAU,CAAC,SAAS,CAAC,CAAC;AAEzB,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAEzC,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAYpC,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAI3C,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACnC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,gCAAgC;IACvC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,OAAO,EAAE,UAAU;QACnB,WAAW,EAAE,cAAc;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,yBAAyB,CACvC,mBAAwC;IAExC,OAAO,IAAI,CAAC,SAAS,CACnB,kCAAkC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAC9D,CAAC;AACJ,CAAC"}
|
package/dist/esm/sdk/earn.d.ts
CHANGED
|
@@ -10,19 +10,15 @@ export declare class Earn extends ClientSDK {
|
|
|
10
10
|
*/
|
|
11
11
|
earnPositions(request: operations.V2EarnPositionsRequest, options?: RequestOptions): Promise<components.EarnPositionsResponse>;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* List Vaults
|
|
14
14
|
*
|
|
15
15
|
* @remarks
|
|
16
|
-
*
|
|
17
|
-
*/
|
|
18
|
-
earnPositionsPositionId(request: operations.V2EarnPositionsPositionIdRequest, options?: RequestOptions): Promise<components.EarnPositionResponse>;
|
|
19
|
-
/**
|
|
20
|
-
* List vaults
|
|
16
|
+
* Fetch ERC-4626 vaults from the database with TVL and APY stats.
|
|
21
17
|
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
18
|
+
* Returns a paginated list of ERC-4626 vaults indexed from various chains, joined with
|
|
19
|
+
* their current statistics (TVL in USD, 7d/30d/90d APY).
|
|
24
20
|
*/
|
|
25
|
-
earnVaults(request: operations.V2EarnVaultsRequest, options?: RequestOptions): Promise<components.
|
|
21
|
+
earnVaults(request: operations.V2EarnVaultsRequest, options?: RequestOptions): Promise<components.VaultsResponse>;
|
|
26
22
|
/**
|
|
27
23
|
* Get token rates on Aave
|
|
28
24
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"earn.d.ts","sourceRoot":"","sources":["../../../src/sdk/earn.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"earn.d.ts","sourceRoot":"","sources":["../../../src/sdk/earn.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,IAAK,SAAQ,SAAS;IACjC;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;;;;OAQG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;IAQrC;;;;;OAKG;IACG,kBAAkB,CACtB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;;;;;;;;;;;OAeG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;;;;;;;;OAYG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C;;;;;;;;;;;;;;;;;;;OAmBG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAQzC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAQvC;;;;;;;;;;;;;;;;;;OAkBG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;CAOxC"}
|
package/dist/esm/sdk/earn.js
CHANGED
|
@@ -6,7 +6,6 @@ import { earnEarnBundle } from "../funcs/earnEarnBundle.js";
|
|
|
6
6
|
import { earnEarnCreateAccount } from "../funcs/earnEarnCreateAccount.js";
|
|
7
7
|
import { earnEarnManage } from "../funcs/earnEarnManage.js";
|
|
8
8
|
import { earnEarnPositions } from "../funcs/earnEarnPositions.js";
|
|
9
|
-
import { earnEarnPositionsPositionId } from "../funcs/earnEarnPositionsPositionId.js";
|
|
10
9
|
import { earnEarnSwap } from "../funcs/earnEarnSwap.js";
|
|
11
10
|
import { earnEarnTransfer } from "../funcs/earnEarnTransfer.js";
|
|
12
11
|
import { earnEarnVaults } from "../funcs/earnEarnVaults.js";
|
|
@@ -23,19 +22,13 @@ export class Earn extends ClientSDK {
|
|
|
23
22
|
return unwrapAsync(earnEarnPositions(this, request, options));
|
|
24
23
|
}
|
|
25
24
|
/**
|
|
26
|
-
*
|
|
25
|
+
* List Vaults
|
|
27
26
|
*
|
|
28
27
|
* @remarks
|
|
29
|
-
*
|
|
30
|
-
*/
|
|
31
|
-
async earnPositionsPositionId(request, options) {
|
|
32
|
-
return unwrapAsync(earnEarnPositionsPositionId(this, request, options));
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* List vaults
|
|
28
|
+
* Fetch ERC-4626 vaults from the database with TVL and APY stats.
|
|
36
29
|
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
30
|
+
* Returns a paginated list of ERC-4626 vaults indexed from various chains, joined with
|
|
31
|
+
* their current statistics (TVL in USD, 7d/30d/90d APY).
|
|
39
32
|
*/
|
|
40
33
|
async earnVaults(request, options) {
|
|
41
34
|
return unwrapAsync(earnEarnVaults(this, request, options));
|
package/dist/esm/sdk/earn.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"earn.js","sourceRoot":"","sources":["../../../src/sdk/earn.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"earn.js","sourceRoot":"","sources":["../../../src/sdk/earn.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,IAAK,SAAQ,SAAS;IACjC;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CACd,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,YAAY,CAChB,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,UAAU,CACd,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,UAAU,CACd,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# VaultInfo
|
|
2
2
|
|
|
3
|
-
Information about a single
|
|
3
|
+
Information about a single ERC-4626 vault from the database.
|
|
4
4
|
|
|
5
5
|
## Example Usage
|
|
6
6
|
|
|
@@ -8,50 +8,26 @@ Information about a single DeFi vault.
|
|
|
8
8
|
import { VaultInfo } from "@compass-labs/api-sdk/models/components";
|
|
9
9
|
|
|
10
10
|
let value: VaultInfo = {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
shareToken: "<value>",
|
|
16
|
-
stablecoinish: true,
|
|
11
|
+
vaultAddress: "<value>",
|
|
12
|
+
chain: "<value>",
|
|
13
|
+
owner: "<value>",
|
|
14
|
+
asset: "<value>",
|
|
17
15
|
};
|
|
18
16
|
```
|
|
19
17
|
|
|
20
18
|
## Fields
|
|
21
19
|
|
|
22
|
-
| Field
|
|
23
|
-
|
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
35
|
-
| `
|
|
36
|
-
| `cagrNet` | *string* | :heavy_minus_sign: | Compound Annual Growth Rate after fees as a decimal. |
|
|
37
|
-
| `threeMonthsReturns` | *string* | :heavy_minus_sign: | 3-month returns as a decimal. |
|
|
38
|
-
| `threeMonthsReturnsNet` | *string* | :heavy_minus_sign: | 3-month returns after fees as a decimal. |
|
|
39
|
-
| `threeMonthsCagr` | *string* | :heavy_minus_sign: | 3-month CAGR as a decimal. |
|
|
40
|
-
| `threeMonthsCagrNet` | *string* | :heavy_minus_sign: | 3-month CAGR after fees as a decimal. |
|
|
41
|
-
| `threeMonthsSharpe` | *string* | :heavy_minus_sign: | 3-month Sharpe ratio. |
|
|
42
|
-
| `threeMonthsSharpeNet` | *string* | :heavy_minus_sign: | 3-month Sharpe ratio after fees. |
|
|
43
|
-
| `threeMonthsVolatility` | *string* | :heavy_minus_sign: | 3-month volatility. |
|
|
44
|
-
| `oneMonthReturns` | *string* | :heavy_minus_sign: | 1-month returns as a decimal. |
|
|
45
|
-
| `oneMonthReturnsNet` | *string* | :heavy_minus_sign: | 1-month returns after fees as a decimal. |
|
|
46
|
-
| `oneMonthCagr` | *string* | :heavy_minus_sign: | 1-month CAGR as a decimal. |
|
|
47
|
-
| `oneMonthCagrNet` | *string* | :heavy_minus_sign: | 1-month CAGR after fees as a decimal. |
|
|
48
|
-
| `currentNav` | *string* | :heavy_minus_sign: | Current Net Asset Value in denomination token. |
|
|
49
|
-
| `peakNav` | *string* | :heavy_minus_sign: | Peak Net Asset Value in denomination token. |
|
|
50
|
-
| `feeLabel` | *string* | :heavy_minus_sign: | Human-readable fee structure label. |
|
|
51
|
-
| `managementFee` | *string* | :heavy_minus_sign: | Management fee as a decimal. |
|
|
52
|
-
| `performanceFee` | *string* | :heavy_minus_sign: | Performance fee as a decimal. |
|
|
53
|
-
| `depositFee` | *string* | :heavy_minus_sign: | Deposit fee as a decimal. |
|
|
54
|
-
| `withdrawFee` | *string* | :heavy_minus_sign: | Withdrawal fee as a decimal. |
|
|
55
|
-
| `years` | *string* | :heavy_minus_sign: | Age of the vault in years. |
|
|
56
|
-
| `eventCount` | *number* | :heavy_minus_sign: | Number of events/transactions in the vault. |
|
|
57
|
-
| `features` | *string*[] | :heavy_minus_sign: | List of vault features and capabilities. |
|
|
20
|
+
| Field | Type | Required | Description |
|
|
21
|
+
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
|
22
|
+
| `vaultAddress` | *string* | :heavy_check_mark: | The vault contract address. |
|
|
23
|
+
| `chain` | *string* | :heavy_check_mark: | Blockchain name (e.g., 'ethereum', 'base'). |
|
|
24
|
+
| `name` | *string* | :heavy_minus_sign: | The name of the vault. |
|
|
25
|
+
| `symbol` | *string* | :heavy_minus_sign: | The vault share token symbol. |
|
|
26
|
+
| `owner` | *string* | :heavy_check_mark: | The vault owner address. |
|
|
27
|
+
| `asset` | *string* | :heavy_check_mark: | The underlying asset contract address. |
|
|
28
|
+
| `assetName` | *string* | :heavy_minus_sign: | The name of the underlying asset. |
|
|
29
|
+
| `assetSymbol` | *string* | :heavy_minus_sign: | The symbol of the underlying asset (e.g., 'USDC'). |
|
|
30
|
+
| `tvlUsd` | *string* | :heavy_minus_sign: | Total Value Locked in USD. |
|
|
31
|
+
| `apy7d` | *string* | :heavy_minus_sign: | 7-day APY as a percentage (e.g., 5.25 = 5.25%). |
|
|
32
|
+
| `apy30d` | *string* | :heavy_minus_sign: | 30-day APY as a percentage. |
|
|
33
|
+
| `apy90d` | *string* | :heavy_minus_sign: | 90-day APY as a percentage. |
|
|
@@ -1,17 +1,24 @@
|
|
|
1
|
-
#
|
|
1
|
+
# VaultsResponse
|
|
2
2
|
|
|
3
|
-
Response model for a paginated list of
|
|
3
|
+
Response model for a paginated list of ERC-4626 vaults.
|
|
4
4
|
|
|
5
5
|
## Example Usage
|
|
6
6
|
|
|
7
7
|
```typescript
|
|
8
|
-
import {
|
|
8
|
+
import { VaultsResponse } from "@compass-labs/api-sdk/models/components";
|
|
9
9
|
|
|
10
|
-
let value:
|
|
11
|
-
total:
|
|
12
|
-
offset:
|
|
13
|
-
limit:
|
|
14
|
-
vaults: [
|
|
10
|
+
let value: VaultsResponse = {
|
|
11
|
+
total: 928619,
|
|
12
|
+
offset: 122574,
|
|
13
|
+
limit: 498952,
|
|
14
|
+
vaults: [
|
|
15
|
+
{
|
|
16
|
+
vaultAddress: "<value>",
|
|
17
|
+
chain: "<value>",
|
|
18
|
+
owner: "<value>",
|
|
19
|
+
asset: "<value>",
|
|
20
|
+
},
|
|
21
|
+
],
|
|
15
22
|
};
|
|
16
23
|
```
|
|
17
24
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
import { V2EarnVaultsRequest } from "@compass-labs/api-sdk/models/operations";
|
|
7
7
|
|
|
8
8
|
let value: V2EarnVaultsRequest = {
|
|
9
|
-
orderBy: "
|
|
9
|
+
orderBy: "tvl_usd",
|
|
10
10
|
direction: "desc",
|
|
11
11
|
offset: 0,
|
|
12
12
|
limit: 50,
|
|
@@ -18,8 +18,9 @@ let value: V2EarnVaultsRequest = {
|
|
|
18
18
|
|
|
19
19
|
| Field | Type | Required | Description | Example |
|
|
20
20
|
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
21
|
-
| `orderBy` | *string* | :heavy_check_mark: | The field to order the results by. |
|
|
21
|
+
| `orderBy` | *string* | :heavy_check_mark: | The field to order the results by. | tvl_usd |
|
|
22
22
|
| `direction` | [operations.Direction](../../models/operations/direction.md) | :heavy_minus_sign: | The direction to order the results by. | desc |
|
|
23
23
|
| `offset` | *number* | :heavy_minus_sign: | The offset of the first item to return. | 0 |
|
|
24
24
|
| `limit` | *number* | :heavy_minus_sign: | The number of items to return. | 50 |
|
|
25
|
-
| `chain` | [operations.V2EarnVaultsChain](../../models/operations/v2earnvaultschain.md) | :heavy_check_mark: | N/A | ethereum |
|
|
25
|
+
| `chain` | [operations.V2EarnVaultsChain](../../models/operations/v2earnvaultschain.md) | :heavy_check_mark: | N/A | ethereum |
|
|
26
|
+
| `assetSymbol` | *string* | :heavy_minus_sign: | Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH'). | |
|
package/docs/sdks/earn/README.md
CHANGED
|
@@ -5,8 +5,7 @@
|
|
|
5
5
|
### Available Operations
|
|
6
6
|
|
|
7
7
|
* [earnPositions](#earnpositions) - List earn positions
|
|
8
|
-
* [
|
|
9
|
-
* [earnVaults](#earnvaults) - List vaults
|
|
8
|
+
* [earnVaults](#earnvaults) - List Vaults
|
|
10
9
|
* [earnAaveTokenRates](#earnaavetokenrates) - Get token rates on Aave
|
|
11
10
|
* [earnCreateAccount](#earncreateaccount) - Create earn account
|
|
12
11
|
* [earnTransfer](#earntransfer) - Transfer tokens to/from account
|
|
@@ -96,87 +95,12 @@ run();
|
|
|
96
95
|
| errors.HTTPValidationError | 422 | application/json |
|
|
97
96
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
98
97
|
|
|
99
|
-
## earnPositionsPositionId
|
|
100
|
-
|
|
101
|
-
This endpoint fetches a single Compass Earn position by its encoded ID.
|
|
102
|
-
|
|
103
|
-
### Example Usage
|
|
104
|
-
|
|
105
|
-
<!-- UsageSnippet language="typescript" operationID="v2_earn_positions_{position_id}" method="get" path="/v2/earn/positions/{position_id}" -->
|
|
106
|
-
```typescript
|
|
107
|
-
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
108
|
-
|
|
109
|
-
const compassApiSDK = new CompassApiSDK({
|
|
110
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
111
|
-
});
|
|
112
|
-
|
|
113
|
-
async function run() {
|
|
114
|
-
const result = await compassApiSDK.earn.earnPositionsPositionId({
|
|
115
|
-
positionId: "<id>",
|
|
116
|
-
userAddress: "0x7fD8D98Afe730c9aE9b584f1D815f8dA1B4B4d4c",
|
|
117
|
-
days: 100,
|
|
118
|
-
});
|
|
119
|
-
|
|
120
|
-
console.log(result);
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
run();
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
### Standalone function
|
|
127
|
-
|
|
128
|
-
The standalone function version of this method:
|
|
129
|
-
|
|
130
|
-
```typescript
|
|
131
|
-
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
132
|
-
import { earnEarnPositionsPositionId } from "@compass-labs/api-sdk/funcs/earnEarnPositionsPositionId.js";
|
|
133
|
-
|
|
134
|
-
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
135
|
-
// You can create one instance of it to use across an application.
|
|
136
|
-
const compassApiSDK = new CompassApiSDKCore({
|
|
137
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
138
|
-
});
|
|
139
|
-
|
|
140
|
-
async function run() {
|
|
141
|
-
const res = await earnEarnPositionsPositionId(compassApiSDK, {
|
|
142
|
-
positionId: "<id>",
|
|
143
|
-
userAddress: "0x7fD8D98Afe730c9aE9b584f1D815f8dA1B4B4d4c",
|
|
144
|
-
days: 100,
|
|
145
|
-
});
|
|
146
|
-
if (res.ok) {
|
|
147
|
-
const { value: result } = res;
|
|
148
|
-
console.log(result);
|
|
149
|
-
} else {
|
|
150
|
-
console.log("earnEarnPositionsPositionId failed:", res.error);
|
|
151
|
-
}
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
run();
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
### Parameters
|
|
158
|
-
|
|
159
|
-
| Parameter | Type | Required | Description |
|
|
160
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
161
|
-
| `request` | [operations.V2EarnPositionsPositionIdRequest](../../models/operations/v2earnpositionspositionidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
162
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
163
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
164
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
165
|
-
|
|
166
|
-
### Response
|
|
167
|
-
|
|
168
|
-
**Promise\<[components.EarnPositionResponse](../../models/components/earnpositionresponse.md)\>**
|
|
169
|
-
|
|
170
|
-
### Errors
|
|
171
|
-
|
|
172
|
-
| Error Type | Status Code | Content Type |
|
|
173
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
174
|
-
| errors.HTTPValidationError | 422 | application/json |
|
|
175
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
176
|
-
|
|
177
98
|
## earnVaults
|
|
178
99
|
|
|
179
|
-
|
|
100
|
+
Fetch ERC-4626 vaults from the database with TVL and APY stats.
|
|
101
|
+
|
|
102
|
+
Returns a paginated list of ERC-4626 vaults indexed from various chains, joined with
|
|
103
|
+
their current statistics (TVL in USD, 7d/30d/90d APY).
|
|
180
104
|
|
|
181
105
|
### Example Usage
|
|
182
106
|
|
|
@@ -190,7 +114,7 @@ const compassApiSDK = new CompassApiSDK({
|
|
|
190
114
|
|
|
191
115
|
async function run() {
|
|
192
116
|
const result = await compassApiSDK.earn.earnVaults({
|
|
193
|
-
orderBy: "
|
|
117
|
+
orderBy: "tvl_usd",
|
|
194
118
|
direction: "desc",
|
|
195
119
|
offset: 0,
|
|
196
120
|
limit: 50,
|
|
@@ -219,7 +143,7 @@ const compassApiSDK = new CompassApiSDKCore({
|
|
|
219
143
|
|
|
220
144
|
async function run() {
|
|
221
145
|
const res = await earnEarnVaults(compassApiSDK, {
|
|
222
|
-
orderBy: "
|
|
146
|
+
orderBy: "tvl_usd",
|
|
223
147
|
direction: "desc",
|
|
224
148
|
offset: 0,
|
|
225
149
|
limit: 50,
|
|
@@ -247,7 +171,7 @@ run();
|
|
|
247
171
|
|
|
248
172
|
### Response
|
|
249
173
|
|
|
250
|
-
**Promise\<[components.
|
|
174
|
+
**Promise\<[components.VaultsResponse](../../models/components/vaultsresponse.md)\>**
|
|
251
175
|
|
|
252
176
|
### Errors
|
|
253
177
|
|
|
@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v20.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Sun, 14 Dec 2025 00:04:32 GMT
|
|
12
12
|
* Dependencies: [undici-types](https://npmjs.com/package/undici-types)
|
|
13
13
|
|
|
14
14
|
# Credits
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/node",
|
|
3
|
-
"version": "20.19.
|
|
3
|
+
"version": "20.19.27",
|
|
4
4
|
"description": "TypeScript definitions for node",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
|
|
6
6
|
"license": "MIT",
|
|
@@ -135,6 +135,6 @@
|
|
|
135
135
|
"undici-types": "~6.21.0"
|
|
136
136
|
},
|
|
137
137
|
"peerDependencies": {},
|
|
138
|
-
"typesPublisherContentHash": "
|
|
138
|
+
"typesPublisherContentHash": "93de83e3adc7c983f95cd1ea65338fc0705267f2e83738d75488fe33f636fcd1",
|
|
139
139
|
"typeScriptVersion": "5.2"
|
|
140
140
|
}
|
|
@@ -1637,6 +1637,11 @@ declare module "process" {
|
|
|
1637
1637
|
* @param args Additional arguments to pass when invoking the `callback`
|
|
1638
1638
|
*/
|
|
1639
1639
|
nextTick(callback: Function, ...args: any[]): void;
|
|
1640
|
+
/**
|
|
1641
|
+
* The process.noDeprecation property indicates whether the --no-deprecation flag is set on the current Node.js process.
|
|
1642
|
+
* See the documentation for the ['warning' event](https://nodejs.org/docs/latest/api/process.html#event-warning) and the [emitWarning()](https://nodejs.org/docs/latest/api/process.html#processemitwarningwarning-type-code-ctor) method for more information about this flag's behavior.
|
|
1643
|
+
*/
|
|
1644
|
+
noDeprecation?: boolean;
|
|
1640
1645
|
/**
|
|
1641
1646
|
* This API is available through the [--experimental-permission](https://nodejs.org/api/cli.html#--experimental-permission) flag.
|
|
1642
1647
|
*
|
|
@@ -478,9 +478,9 @@
|
|
|
478
478
|
}
|
|
479
479
|
},
|
|
480
480
|
"node_modules/@types/node": {
|
|
481
|
-
"version": "20.19.
|
|
482
|
-
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.
|
|
483
|
-
"integrity": "sha512-
|
|
481
|
+
"version": "20.19.27",
|
|
482
|
+
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.27.tgz",
|
|
483
|
+
"integrity": "sha512-N2clP5pJhB2YnZJ3PIHFk5RkygRX5WO/5f0WC08tp0wd+sv0rsJk3MqWn3CbNmT2J505a5336jaQj4ph1AdMug==",
|
|
484
484
|
"dev": true,
|
|
485
485
|
"license": "MIT",
|
|
486
486
|
"dependencies": {
|