@compass-labs/api-sdk 0.0.12 → 0.0.13
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 +13 -0
- package/bin/mcp-server.js +1022 -278
- package/bin/mcp-server.js.map +29 -13
- package/dist/commonjs/funcs/skyBuy.d.ts +19 -0
- package/dist/commonjs/funcs/skyBuy.d.ts.map +1 -0
- package/dist/commonjs/funcs/skyBuy.js +118 -0
- package/dist/commonjs/funcs/skyBuy.js.map +1 -0
- package/dist/commonjs/funcs/skyDeposit.d.ts +19 -0
- package/dist/commonjs/funcs/skyDeposit.d.ts.map +1 -0
- package/dist/commonjs/funcs/skyDeposit.js +118 -0
- package/dist/commonjs/funcs/skyDeposit.js.map +1 -0
- package/dist/commonjs/funcs/skyPosition.d.ts +18 -0
- package/dist/commonjs/funcs/skyPosition.d.ts.map +1 -0
- package/dist/commonjs/funcs/skyPosition.js +121 -0
- package/dist/commonjs/funcs/skyPosition.js.map +1 -0
- package/dist/commonjs/funcs/skySell.d.ts +19 -0
- package/dist/commonjs/funcs/skySell.d.ts.map +1 -0
- package/dist/commonjs/funcs/skySell.js +118 -0
- package/dist/commonjs/funcs/skySell.js.map +1 -0
- package/dist/commonjs/funcs/skyWithdraw.d.ts +19 -0
- package/dist/commonjs/funcs/skyWithdraw.d.ts.map +1 -0
- package/dist/commonjs/funcs/skyWithdraw.js +118 -0
- package/dist/commonjs/funcs/skyWithdraw.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/server.js +11 -1
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/skyBuy.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/skyBuy.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/skyBuy.js +66 -0
- package/dist/commonjs/mcp-server/tools/skyBuy.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/skyDeposit.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/skyDeposit.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/skyDeposit.js +66 -0
- package/dist/commonjs/mcp-server/tools/skyDeposit.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/skyPosition.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/skyPosition.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/skyPosition.js +64 -0
- package/dist/commonjs/mcp-server/tools/skyPosition.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/skySell.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/skySell.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/skySell.js +66 -0
- package/dist/commonjs/mcp-server/tools/skySell.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/skyWithdraw.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/skyWithdraw.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/skyWithdraw.js +66 -0
- package/dist/commonjs/mcp-server/tools/skyWithdraw.js.map +1 -0
- package/dist/commonjs/models/components/contractname.d.ts +9 -0
- package/dist/commonjs/models/components/contractname.d.ts.map +1 -1
- package/dist/commonjs/models/components/contractname.js +3 -0
- package/dist/commonjs/models/components/contractname.js.map +1 -1
- package/dist/commonjs/models/components/increaseallowanceparams.d.ts +9 -0
- package/dist/commonjs/models/components/increaseallowanceparams.d.ts.map +1 -1
- package/dist/commonjs/models/components/increaseallowanceparams.js +3 -0
- package/dist/commonjs/models/components/increaseallowanceparams.js.map +1 -1
- package/dist/commonjs/models/components/increaseallowancerequest.d.ts +9 -0
- package/dist/commonjs/models/components/increaseallowancerequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/increaseallowancerequest.js +3 -0
- package/dist/commonjs/models/components/increaseallowancerequest.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +5 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +5 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/multicallactiontype.d.ts +51 -51
- package/dist/commonjs/models/components/multicallactiontype.js +17 -17
- package/dist/commonjs/models/components/multicallactiontype.js.map +1 -1
- package/dist/commonjs/models/components/skybuyrequest.d.ts +100 -0
- package/dist/commonjs/models/components/skybuyrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/skybuyrequest.js +130 -0
- package/dist/commonjs/models/components/skybuyrequest.js.map +1 -0
- package/dist/commonjs/models/components/skycheckpositionresponse.d.ts +34 -0
- package/dist/commonjs/models/components/skycheckpositionresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/skycheckpositionresponse.js +80 -0
- package/dist/commonjs/models/components/skycheckpositionresponse.js.map +1 -0
- package/dist/commonjs/models/components/skydepositrequest.d.ts +68 -0
- package/dist/commonjs/models/components/skydepositrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/skydepositrequest.js +98 -0
- package/dist/commonjs/models/components/skydepositrequest.js.map +1 -0
- package/dist/commonjs/models/components/skysellrequest.d.ts +100 -0
- package/dist/commonjs/models/components/skysellrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/skysellrequest.js +130 -0
- package/dist/commonjs/models/components/skysellrequest.js.map +1 -0
- package/dist/commonjs/models/components/skywithdrawrequest.d.ts +44 -0
- package/dist/commonjs/models/components/skywithdrawrequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/skywithdrawrequest.js +75 -0
- package/dist/commonjs/models/components/skywithdrawrequest.js.map +1 -0
- package/dist/commonjs/models/operations/genericallowance.d.ts +9 -0
- package/dist/commonjs/models/operations/genericallowance.d.ts.map +1 -1
- package/dist/commonjs/models/operations/genericallowance.js +3 -0
- package/dist/commonjs/models/operations/genericallowance.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +1 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +1 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/skyposition.d.ts +31 -0
- package/dist/commonjs/models/operations/skyposition.d.ts.map +1 -0
- package/dist/commonjs/models/operations/skyposition.js +80 -0
- package/dist/commonjs/models/operations/skyposition.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +3 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +4 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/commonjs/sdk/sky.d.ts +49 -0
- package/dist/commonjs/sdk/sky.d.ts.map +1 -0
- package/dist/commonjs/sdk/sky.js +70 -0
- package/dist/commonjs/sdk/sky.js.map +1 -0
- package/dist/esm/funcs/skyBuy.d.ts +19 -0
- package/dist/esm/funcs/skyBuy.d.ts.map +1 -0
- package/dist/esm/funcs/skyBuy.js +82 -0
- package/dist/esm/funcs/skyBuy.js.map +1 -0
- package/dist/esm/funcs/skyDeposit.d.ts +19 -0
- package/dist/esm/funcs/skyDeposit.d.ts.map +1 -0
- package/dist/esm/funcs/skyDeposit.js +82 -0
- package/dist/esm/funcs/skyDeposit.js.map +1 -0
- package/dist/esm/funcs/skyPosition.d.ts +18 -0
- package/dist/esm/funcs/skyPosition.d.ts.map +1 -0
- package/dist/esm/funcs/skyPosition.js +85 -0
- package/dist/esm/funcs/skyPosition.js.map +1 -0
- package/dist/esm/funcs/skySell.d.ts +19 -0
- package/dist/esm/funcs/skySell.d.ts.map +1 -0
- package/dist/esm/funcs/skySell.js +82 -0
- package/dist/esm/funcs/skySell.js.map +1 -0
- package/dist/esm/funcs/skyWithdraw.d.ts +19 -0
- package/dist/esm/funcs/skyWithdraw.d.ts.map +1 -0
- package/dist/esm/funcs/skyWithdraw.js +82 -0
- package/dist/esm/funcs/skyWithdraw.js.map +1 -0
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.d.ts.map +1 -1
- package/dist/esm/mcp-server/server.js +11 -1
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/mcp-server/tools/skyBuy.d.ts +8 -0
- package/dist/esm/mcp-server/tools/skyBuy.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/skyBuy.js +30 -0
- package/dist/esm/mcp-server/tools/skyBuy.js.map +1 -0
- package/dist/esm/mcp-server/tools/skyDeposit.d.ts +8 -0
- package/dist/esm/mcp-server/tools/skyDeposit.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/skyDeposit.js +30 -0
- package/dist/esm/mcp-server/tools/skyDeposit.js.map +1 -0
- package/dist/esm/mcp-server/tools/skyPosition.d.ts +8 -0
- package/dist/esm/mcp-server/tools/skyPosition.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/skyPosition.js +28 -0
- package/dist/esm/mcp-server/tools/skyPosition.js.map +1 -0
- package/dist/esm/mcp-server/tools/skySell.d.ts +8 -0
- package/dist/esm/mcp-server/tools/skySell.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/skySell.js +30 -0
- package/dist/esm/mcp-server/tools/skySell.js.map +1 -0
- package/dist/esm/mcp-server/tools/skyWithdraw.d.ts +8 -0
- package/dist/esm/mcp-server/tools/skyWithdraw.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/skyWithdraw.js +30 -0
- package/dist/esm/mcp-server/tools/skyWithdraw.js.map +1 -0
- package/dist/esm/models/components/contractname.d.ts +9 -0
- package/dist/esm/models/components/contractname.d.ts.map +1 -1
- package/dist/esm/models/components/contractname.js +3 -0
- package/dist/esm/models/components/contractname.js.map +1 -1
- package/dist/esm/models/components/increaseallowanceparams.d.ts +9 -0
- package/dist/esm/models/components/increaseallowanceparams.d.ts.map +1 -1
- package/dist/esm/models/components/increaseallowanceparams.js +3 -0
- package/dist/esm/models/components/increaseallowanceparams.js.map +1 -1
- package/dist/esm/models/components/increaseallowancerequest.d.ts +9 -0
- package/dist/esm/models/components/increaseallowancerequest.d.ts.map +1 -1
- package/dist/esm/models/components/increaseallowancerequest.js +3 -0
- package/dist/esm/models/components/increaseallowancerequest.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +5 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +5 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/multicallactiontype.d.ts +51 -51
- package/dist/esm/models/components/multicallactiontype.js +17 -17
- package/dist/esm/models/components/multicallactiontype.js.map +1 -1
- package/dist/esm/models/components/skybuyrequest.d.ts +100 -0
- package/dist/esm/models/components/skybuyrequest.d.ts.map +1 -0
- package/dist/esm/models/components/skybuyrequest.js +90 -0
- package/dist/esm/models/components/skybuyrequest.js.map +1 -0
- package/dist/esm/models/components/skycheckpositionresponse.d.ts +34 -0
- package/dist/esm/models/components/skycheckpositionresponse.d.ts.map +1 -0
- package/dist/esm/models/components/skycheckpositionresponse.js +42 -0
- package/dist/esm/models/components/skycheckpositionresponse.js.map +1 -0
- package/dist/esm/models/components/skydepositrequest.d.ts +68 -0
- package/dist/esm/models/components/skydepositrequest.d.ts.map +1 -0
- package/dist/esm/models/components/skydepositrequest.js +58 -0
- package/dist/esm/models/components/skydepositrequest.js.map +1 -0
- package/dist/esm/models/components/skysellrequest.d.ts +100 -0
- package/dist/esm/models/components/skysellrequest.d.ts.map +1 -0
- package/dist/esm/models/components/skysellrequest.js +90 -0
- package/dist/esm/models/components/skysellrequest.js.map +1 -0
- package/dist/esm/models/components/skywithdrawrequest.d.ts +44 -0
- package/dist/esm/models/components/skywithdrawrequest.d.ts.map +1 -0
- package/dist/esm/models/components/skywithdrawrequest.js +37 -0
- package/dist/esm/models/components/skywithdrawrequest.js.map +1 -0
- package/dist/esm/models/operations/genericallowance.d.ts +9 -0
- package/dist/esm/models/operations/genericallowance.d.ts.map +1 -1
- package/dist/esm/models/operations/genericallowance.js +3 -0
- package/dist/esm/models/operations/genericallowance.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +1 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +1 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/skyposition.d.ts +31 -0
- package/dist/esm/models/operations/skyposition.d.ts.map +1 -0
- package/dist/esm/models/operations/skyposition.js +42 -0
- package/dist/esm/models/operations/skyposition.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +3 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +4 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/dist/esm/sdk/sky.d.ts +49 -0
- package/dist/esm/sdk/sky.d.ts.map +1 -0
- package/dist/esm/sdk/sky.js +66 -0
- package/dist/esm/sdk/sky.js.map +1 -0
- package/docs/sdks/sky/README.md +417 -0
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/skyBuy.ts +165 -0
- package/src/funcs/skyDeposit.ts +165 -0
- package/src/funcs/skyPosition.ts +169 -0
- package/src/funcs/skySell.ts +165 -0
- package/src/funcs/skyWithdraw.ts +165 -0
- package/src/lib/config.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +11 -1
- package/src/mcp-server/tools/skyBuy.ts +39 -0
- package/src/mcp-server/tools/skyDeposit.ts +39 -0
- package/src/mcp-server/tools/skyPosition.ts +37 -0
- package/src/mcp-server/tools/skySell.ts +39 -0
- package/src/mcp-server/tools/skyWithdraw.ts +39 -0
- package/src/models/components/contractname.ts +3 -0
- package/src/models/components/increaseallowanceparams.ts +3 -0
- package/src/models/components/increaseallowancerequest.ts +3 -0
- package/src/models/components/index.ts +5 -0
- package/src/models/components/multicallactiontype.ts +19 -19
- package/src/models/components/skybuyrequest.ts +177 -0
- package/src/models/components/skycheckpositionresponse.ts +82 -0
- package/src/models/components/skydepositrequest.ts +140 -0
- package/src/models/components/skysellrequest.ts +177 -0
- package/src/models/components/skywithdrawrequest.ts +87 -0
- package/src/models/operations/genericallowance.ts +3 -0
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/skyposition.ts +81 -0
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/sky.ts +108 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"skyposition.js","sourceRoot":"","sources":["../../../../src/models/operations/skyposition.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AASjD,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;IAChE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAC9B,4CAA4C,CAC7C;CACF,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAQH,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,kBAA2B,CAAC;IACzE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,4CAA4C,CAAC;CAC9E,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,WAAW,EAAE,cAAc;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,KAAW,mBAAmB,CAOnC;AAPD,WAAiB,mBAAmB;IAClC,kEAAkE;IACrD,iCAAa,GAAG,gCAAgC,CAAC;IAC9D,mEAAmE;IACtD,kCAAc,GAAG,iCAAiC,CAAC;AAGlE,CAAC,EAPgB,mBAAmB,KAAnB,mBAAmB,QAOnC;AAED,MAAM,UAAU,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,iCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}
|
package/dist/esm/sdk/sdk.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { ClientSDK } from "../lib/sdks.js";
|
|
|
2
2
|
import { AaveV3 } from "./aavev3.js";
|
|
3
3
|
import { AerodromeSlipstream } from "./aerodromeslipstream.js";
|
|
4
4
|
import { Morpho } from "./morpho.js";
|
|
5
|
+
import { Sky } from "./sky.js";
|
|
5
6
|
import { Token } from "./token.js";
|
|
6
7
|
import { TransactionBatching } from "./transactionbatching.js";
|
|
7
8
|
import { UniswapV3 } from "./uniswapv3.js";
|
|
@@ -13,6 +14,8 @@ export declare class CompassApiSDK extends ClientSDK {
|
|
|
13
14
|
get aerodromeSlipstream(): AerodromeSlipstream;
|
|
14
15
|
private _morpho?;
|
|
15
16
|
get morpho(): Morpho;
|
|
17
|
+
private _sky?;
|
|
18
|
+
get sky(): Sky;
|
|
16
19
|
private _token?;
|
|
17
20
|
get token(): Token;
|
|
18
21
|
private _uniswapV3?;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,oBAAoB,CAAC,CAAsB;IACnD,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,IAAI,KAAK,IAAI,KAAK,CAEjB;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,oBAAoB,CAAC,CAAsB;IACnD,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;CACF"}
|
|
1
|
+
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,aAAc,SAAQ,SAAS;IAC1C,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,oBAAoB,CAAC,CAAsB;IACnD,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;IAED,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,OAAO,CAAC,IAAI,CAAC,CAAM;IACnB,IAAI,GAAG,IAAI,GAAG,CAEb;IAED,OAAO,CAAC,MAAM,CAAC,CAAQ;IACvB,IAAI,KAAK,IAAI,KAAK,CAEjB;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,oBAAoB,CAAC,CAAsB;IACnD,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;CACF"}
|
package/dist/esm/sdk/sdk.js
CHANGED
|
@@ -5,6 +5,7 @@ import { ClientSDK } from "../lib/sdks.js";
|
|
|
5
5
|
import { AaveV3 } from "./aavev3.js";
|
|
6
6
|
import { AerodromeSlipstream } from "./aerodromeslipstream.js";
|
|
7
7
|
import { Morpho } from "./morpho.js";
|
|
8
|
+
import { Sky } from "./sky.js";
|
|
8
9
|
import { Token } from "./token.js";
|
|
9
10
|
import { TransactionBatching } from "./transactionbatching.js";
|
|
10
11
|
import { UniswapV3 } from "./uniswapv3.js";
|
|
@@ -19,6 +20,9 @@ export class CompassApiSDK extends ClientSDK {
|
|
|
19
20
|
get morpho() {
|
|
20
21
|
return (this._morpho ?? (this._morpho = new Morpho(this._options)));
|
|
21
22
|
}
|
|
23
|
+
get sky() {
|
|
24
|
+
return (this._sky ?? (this._sky = new Sky(this._options)));
|
|
25
|
+
}
|
|
22
26
|
get token() {
|
|
23
27
|
return (this._token ?? (this._token = new Token(this._options)));
|
|
24
28
|
}
|
package/dist/esm/sdk/sdk.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,OAAO,aAAc,SAAQ,SAAS;IAE1C,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,mBAAmB;QACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,KAAzB,IAAI,CAAC,oBAAoB,GAAK,IAAI,mBAAmB,CAC3D,IAAI,CAAC,QAAQ,CACd,EAAC,CAAC;IACL,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,KAAK;QACP,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpD,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,mBAAmB;QACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,KAAzB,IAAI,CAAC,oBAAoB,GAAK,IAAI,mBAAmB,CAC3D,IAAI,CAAC,QAAQ,CACd,EAAC,CAAC;IACL,CAAC;CACF"}
|
|
1
|
+
{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,OAAO,aAAc,SAAQ,SAAS;IAE1C,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,mBAAmB;QACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,KAAzB,IAAI,CAAC,oBAAoB,GAAK,IAAI,mBAAmB,CAC3D,IAAI,CAAC,QAAQ,CACd,EAAC,CAAC;IACL,CAAC;IAGD,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACtD,CAAC;IAGD,IAAI,GAAG;QACL,OAAO,CAAC,IAAI,CAAC,IAAI,KAAT,IAAI,CAAC,IAAI,GAAK,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChD,CAAC;IAGD,IAAI,KAAK;QACP,OAAO,CAAC,IAAI,CAAC,MAAM,KAAX,IAAI,CAAC,MAAM,GAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACpD,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,mBAAmB;QACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,KAAzB,IAAI,CAAC,oBAAoB,GAAK,IAAI,mBAAmB,CAC3D,IAAI,CAAC,QAAQ,CACd,EAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
2
|
+
import * as components from "../models/components/index.js";
|
|
3
|
+
import * as operations from "../models/operations/index.js";
|
|
4
|
+
export declare class Sky extends ClientSDK {
|
|
5
|
+
/**
|
|
6
|
+
* Check USDS Position
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* Check the USDS overall position.
|
|
10
|
+
*/
|
|
11
|
+
position(request: operations.SkyPositionRequest, options?: RequestOptions): Promise<components.SkyCheckPositionResponse>;
|
|
12
|
+
/**
|
|
13
|
+
* Buy USDS
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* Buy USDS with DAI or USDC on a 1:1 basis.
|
|
17
|
+
*
|
|
18
|
+
* There are no fees.
|
|
19
|
+
*/
|
|
20
|
+
buy(request: components.SkyBuyRequest, options?: RequestOptions): Promise<components.UnsignedTransaction>;
|
|
21
|
+
/**
|
|
22
|
+
* Sell USDS
|
|
23
|
+
*
|
|
24
|
+
* @remarks
|
|
25
|
+
* Sell USDS for DAI or USDC on a 1:1 basis.
|
|
26
|
+
*
|
|
27
|
+
* There are no fees.
|
|
28
|
+
*/
|
|
29
|
+
sell(request: components.SkySellRequest, options?: RequestOptions): Promise<components.UnsignedTransaction>;
|
|
30
|
+
/**
|
|
31
|
+
* Deposit USDS
|
|
32
|
+
*
|
|
33
|
+
* @remarks
|
|
34
|
+
* Deposit USDS for sUSDS to earn yield.
|
|
35
|
+
*
|
|
36
|
+
* There are no fees.
|
|
37
|
+
*/
|
|
38
|
+
deposit(request: components.SkyDepositRequest, options?: RequestOptions): Promise<components.UnsignedTransaction>;
|
|
39
|
+
/**
|
|
40
|
+
* Withdraw USDS
|
|
41
|
+
*
|
|
42
|
+
* @remarks
|
|
43
|
+
* Withdraw USDS for sUSDS to stop earning yield.
|
|
44
|
+
*
|
|
45
|
+
* There are no fees.
|
|
46
|
+
*/
|
|
47
|
+
withdraw(request: components.SkyWithdrawRequest, options?: RequestOptions): Promise<components.UnsignedTransaction>;
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=sky.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sky.d.ts","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AASA,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,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;OAOG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;OAOG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,cAAc,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;OAOG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;OAOG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAO3C"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
import { skyBuy } from "../funcs/skyBuy.js";
|
|
5
|
+
import { skyDeposit } from "../funcs/skyDeposit.js";
|
|
6
|
+
import { skyPosition } from "../funcs/skyPosition.js";
|
|
7
|
+
import { skySell } from "../funcs/skySell.js";
|
|
8
|
+
import { skyWithdraw } from "../funcs/skyWithdraw.js";
|
|
9
|
+
import { ClientSDK } from "../lib/sdks.js";
|
|
10
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
11
|
+
export class Sky extends ClientSDK {
|
|
12
|
+
/**
|
|
13
|
+
* Check USDS Position
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* Check the USDS overall position.
|
|
17
|
+
*/
|
|
18
|
+
async position(request, options) {
|
|
19
|
+
return unwrapAsync(skyPosition(this, request, options));
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Buy USDS
|
|
23
|
+
*
|
|
24
|
+
* @remarks
|
|
25
|
+
* Buy USDS with DAI or USDC on a 1:1 basis.
|
|
26
|
+
*
|
|
27
|
+
* There are no fees.
|
|
28
|
+
*/
|
|
29
|
+
async buy(request, options) {
|
|
30
|
+
return unwrapAsync(skyBuy(this, request, options));
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Sell USDS
|
|
34
|
+
*
|
|
35
|
+
* @remarks
|
|
36
|
+
* Sell USDS for DAI or USDC on a 1:1 basis.
|
|
37
|
+
*
|
|
38
|
+
* There are no fees.
|
|
39
|
+
*/
|
|
40
|
+
async sell(request, options) {
|
|
41
|
+
return unwrapAsync(skySell(this, request, options));
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Deposit USDS
|
|
45
|
+
*
|
|
46
|
+
* @remarks
|
|
47
|
+
* Deposit USDS for sUSDS to earn yield.
|
|
48
|
+
*
|
|
49
|
+
* There are no fees.
|
|
50
|
+
*/
|
|
51
|
+
async deposit(request, options) {
|
|
52
|
+
return unwrapAsync(skyDeposit(this, request, options));
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Withdraw USDS
|
|
56
|
+
*
|
|
57
|
+
* @remarks
|
|
58
|
+
* Withdraw USDS for sUSDS to stop earning yield.
|
|
59
|
+
*
|
|
60
|
+
* There are no fees.
|
|
61
|
+
*/
|
|
62
|
+
async withdraw(request, options) {
|
|
63
|
+
return unwrapAsync(skyWithdraw(this, request, options));
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
//# sourceMappingURL=sky.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sky.js","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CACP,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,MAAM,CACvB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,OAAO,CACxB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CACX,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -0,0 +1,417 @@
|
|
|
1
|
+
# Sky
|
|
2
|
+
(*sky*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [position](#position) - Check USDS Position
|
|
9
|
+
* [buy](#buy) - Buy USDS
|
|
10
|
+
* [sell](#sell) - Sell USDS
|
|
11
|
+
* [deposit](#deposit) - Deposit USDS
|
|
12
|
+
* [withdraw](#withdraw) - Withdraw USDS
|
|
13
|
+
|
|
14
|
+
## position
|
|
15
|
+
|
|
16
|
+
Check the USDS overall position.
|
|
17
|
+
|
|
18
|
+
### Example Usage
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
22
|
+
|
|
23
|
+
const compassApiSDK = new CompassApiSDK({
|
|
24
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
async function run() {
|
|
28
|
+
const result = await compassApiSDK.sky.position({
|
|
29
|
+
userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
// Handle the result
|
|
33
|
+
console.log(result);
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
run();
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Standalone function
|
|
40
|
+
|
|
41
|
+
The standalone function version of this method:
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
45
|
+
import { skyPosition } from "@compass-labs/api-sdk/funcs/skyPosition.js";
|
|
46
|
+
|
|
47
|
+
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
48
|
+
// You can create one instance of it to use across an application.
|
|
49
|
+
const compassApiSDK = new CompassApiSDKCore({
|
|
50
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
async function run() {
|
|
54
|
+
const res = await skyPosition(compassApiSDK, {
|
|
55
|
+
userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
if (!res.ok) {
|
|
59
|
+
throw res.error;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
const { value: result } = res;
|
|
63
|
+
|
|
64
|
+
// Handle the result
|
|
65
|
+
console.log(result);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
run();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
|
|
73
|
+
| Parameter | Type | Required | Description |
|
|
74
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
75
|
+
| `request` | [operations.SkyPositionRequest](../../models/operations/skypositionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
76
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
77
|
+
| `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. |
|
|
78
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
79
|
+
|
|
80
|
+
### Response
|
|
81
|
+
|
|
82
|
+
**Promise\<[components.SkyCheckPositionResponse](../../models/components/skycheckpositionresponse.md)\>**
|
|
83
|
+
|
|
84
|
+
### Errors
|
|
85
|
+
|
|
86
|
+
| Error Type | Status Code | Content Type |
|
|
87
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
88
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
89
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
90
|
+
|
|
91
|
+
## buy
|
|
92
|
+
|
|
93
|
+
Buy USDS with DAI or USDC on a 1:1 basis.
|
|
94
|
+
|
|
95
|
+
There are no fees.
|
|
96
|
+
|
|
97
|
+
### Example Usage
|
|
98
|
+
|
|
99
|
+
```typescript
|
|
100
|
+
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
101
|
+
|
|
102
|
+
const compassApiSDK = new CompassApiSDK({
|
|
103
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
async function run() {
|
|
107
|
+
const result = await compassApiSDK.sky.buy({
|
|
108
|
+
tokenIn: "USDC",
|
|
109
|
+
amount: 1.5,
|
|
110
|
+
sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
// Handle the result
|
|
114
|
+
console.log(result);
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
run();
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Standalone function
|
|
121
|
+
|
|
122
|
+
The standalone function version of this method:
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
126
|
+
import { skyBuy } from "@compass-labs/api-sdk/funcs/skyBuy.js";
|
|
127
|
+
|
|
128
|
+
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
129
|
+
// You can create one instance of it to use across an application.
|
|
130
|
+
const compassApiSDK = new CompassApiSDKCore({
|
|
131
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
async function run() {
|
|
135
|
+
const res = await skyBuy(compassApiSDK, {
|
|
136
|
+
tokenIn: "USDC",
|
|
137
|
+
amount: 1.5,
|
|
138
|
+
sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
if (!res.ok) {
|
|
142
|
+
throw res.error;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
const { value: result } = res;
|
|
146
|
+
|
|
147
|
+
// Handle the result
|
|
148
|
+
console.log(result);
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
run();
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Parameters
|
|
155
|
+
|
|
156
|
+
| Parameter | Type | Required | Description |
|
|
157
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
158
|
+
| `request` | [components.SkyBuyRequest](../../models/components/skybuyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
159
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
160
|
+
| `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. |
|
|
161
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
162
|
+
|
|
163
|
+
### Response
|
|
164
|
+
|
|
165
|
+
**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
|
|
166
|
+
|
|
167
|
+
### Errors
|
|
168
|
+
|
|
169
|
+
| Error Type | Status Code | Content Type |
|
|
170
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
171
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
172
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
173
|
+
|
|
174
|
+
## sell
|
|
175
|
+
|
|
176
|
+
Sell USDS for DAI or USDC on a 1:1 basis.
|
|
177
|
+
|
|
178
|
+
There are no fees.
|
|
179
|
+
|
|
180
|
+
### Example Usage
|
|
181
|
+
|
|
182
|
+
```typescript
|
|
183
|
+
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
184
|
+
|
|
185
|
+
const compassApiSDK = new CompassApiSDK({
|
|
186
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
async function run() {
|
|
190
|
+
const result = await compassApiSDK.sky.sell({
|
|
191
|
+
tokenOut: "USDC",
|
|
192
|
+
amount: 1.5,
|
|
193
|
+
sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
// Handle the result
|
|
197
|
+
console.log(result);
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
run();
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Standalone function
|
|
204
|
+
|
|
205
|
+
The standalone function version of this method:
|
|
206
|
+
|
|
207
|
+
```typescript
|
|
208
|
+
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
209
|
+
import { skySell } from "@compass-labs/api-sdk/funcs/skySell.js";
|
|
210
|
+
|
|
211
|
+
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
212
|
+
// You can create one instance of it to use across an application.
|
|
213
|
+
const compassApiSDK = new CompassApiSDKCore({
|
|
214
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
215
|
+
});
|
|
216
|
+
|
|
217
|
+
async function run() {
|
|
218
|
+
const res = await skySell(compassApiSDK, {
|
|
219
|
+
tokenOut: "USDC",
|
|
220
|
+
amount: 1.5,
|
|
221
|
+
sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
222
|
+
});
|
|
223
|
+
|
|
224
|
+
if (!res.ok) {
|
|
225
|
+
throw res.error;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
const { value: result } = res;
|
|
229
|
+
|
|
230
|
+
// Handle the result
|
|
231
|
+
console.log(result);
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
run();
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Parameters
|
|
238
|
+
|
|
239
|
+
| Parameter | Type | Required | Description |
|
|
240
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
241
|
+
| `request` | [components.SkySellRequest](../../models/components/skysellrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
242
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
243
|
+
| `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. |
|
|
244
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
245
|
+
|
|
246
|
+
### Response
|
|
247
|
+
|
|
248
|
+
**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
|
|
249
|
+
|
|
250
|
+
### Errors
|
|
251
|
+
|
|
252
|
+
| Error Type | Status Code | Content Type |
|
|
253
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
254
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
255
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
256
|
+
|
|
257
|
+
## deposit
|
|
258
|
+
|
|
259
|
+
Deposit USDS for sUSDS to earn yield.
|
|
260
|
+
|
|
261
|
+
There are no fees.
|
|
262
|
+
|
|
263
|
+
### Example Usage
|
|
264
|
+
|
|
265
|
+
```typescript
|
|
266
|
+
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
267
|
+
|
|
268
|
+
const compassApiSDK = new CompassApiSDK({
|
|
269
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
270
|
+
});
|
|
271
|
+
|
|
272
|
+
async function run() {
|
|
273
|
+
const result = await compassApiSDK.sky.deposit({
|
|
274
|
+
amount: 1.5,
|
|
275
|
+
sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
// Handle the result
|
|
279
|
+
console.log(result);
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
run();
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Standalone function
|
|
286
|
+
|
|
287
|
+
The standalone function version of this method:
|
|
288
|
+
|
|
289
|
+
```typescript
|
|
290
|
+
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
291
|
+
import { skyDeposit } from "@compass-labs/api-sdk/funcs/skyDeposit.js";
|
|
292
|
+
|
|
293
|
+
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
294
|
+
// You can create one instance of it to use across an application.
|
|
295
|
+
const compassApiSDK = new CompassApiSDKCore({
|
|
296
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
297
|
+
});
|
|
298
|
+
|
|
299
|
+
async function run() {
|
|
300
|
+
const res = await skyDeposit(compassApiSDK, {
|
|
301
|
+
amount: 1.5,
|
|
302
|
+
sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
303
|
+
});
|
|
304
|
+
|
|
305
|
+
if (!res.ok) {
|
|
306
|
+
throw res.error;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
const { value: result } = res;
|
|
310
|
+
|
|
311
|
+
// Handle the result
|
|
312
|
+
console.log(result);
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
run();
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### Parameters
|
|
319
|
+
|
|
320
|
+
| Parameter | Type | Required | Description |
|
|
321
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
322
|
+
| `request` | [components.SkyDepositRequest](../../models/components/skydepositrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
323
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
324
|
+
| `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. |
|
|
325
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
326
|
+
|
|
327
|
+
### Response
|
|
328
|
+
|
|
329
|
+
**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
|
|
330
|
+
|
|
331
|
+
### Errors
|
|
332
|
+
|
|
333
|
+
| Error Type | Status Code | Content Type |
|
|
334
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
335
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
336
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
337
|
+
|
|
338
|
+
## withdraw
|
|
339
|
+
|
|
340
|
+
Withdraw USDS for sUSDS to stop earning yield.
|
|
341
|
+
|
|
342
|
+
There are no fees.
|
|
343
|
+
|
|
344
|
+
### Example Usage
|
|
345
|
+
|
|
346
|
+
```typescript
|
|
347
|
+
import { CompassApiSDK } from "@compass-labs/api-sdk";
|
|
348
|
+
|
|
349
|
+
const compassApiSDK = new CompassApiSDK({
|
|
350
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
351
|
+
});
|
|
352
|
+
|
|
353
|
+
async function run() {
|
|
354
|
+
const result = await compassApiSDK.sky.withdraw({
|
|
355
|
+
amount: "259.48",
|
|
356
|
+
sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
357
|
+
});
|
|
358
|
+
|
|
359
|
+
// Handle the result
|
|
360
|
+
console.log(result);
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
run();
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### Standalone function
|
|
367
|
+
|
|
368
|
+
The standalone function version of this method:
|
|
369
|
+
|
|
370
|
+
```typescript
|
|
371
|
+
import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
|
|
372
|
+
import { skyWithdraw } from "@compass-labs/api-sdk/funcs/skyWithdraw.js";
|
|
373
|
+
|
|
374
|
+
// Use `CompassApiSDKCore` for best tree-shaking performance.
|
|
375
|
+
// You can create one instance of it to use across an application.
|
|
376
|
+
const compassApiSDK = new CompassApiSDKCore({
|
|
377
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
378
|
+
});
|
|
379
|
+
|
|
380
|
+
async function run() {
|
|
381
|
+
const res = await skyWithdraw(compassApiSDK, {
|
|
382
|
+
amount: "259.48",
|
|
383
|
+
sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
|
|
384
|
+
});
|
|
385
|
+
|
|
386
|
+
if (!res.ok) {
|
|
387
|
+
throw res.error;
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
const { value: result } = res;
|
|
391
|
+
|
|
392
|
+
// Handle the result
|
|
393
|
+
console.log(result);
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
run();
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### Parameters
|
|
400
|
+
|
|
401
|
+
| Parameter | Type | Required | Description |
|
|
402
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
403
|
+
| `request` | [components.SkyWithdrawRequest](../../models/components/skywithdrawrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
404
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
405
|
+
| `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. |
|
|
406
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
407
|
+
|
|
408
|
+
### Response
|
|
409
|
+
|
|
410
|
+
**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
|
|
411
|
+
|
|
412
|
+
### Errors
|
|
413
|
+
|
|
414
|
+
| Error Type | Status Code | Content Type |
|
|
415
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
416
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
417
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
package/jsr.json
CHANGED