@compass-labs/api-sdk 2.2.19 → 2.2.20

package/docs/models/components/credituseroperationbody.md

@@ -0,0 +1,80 @@
+# CreditUserOperationBody
+
+
+## Supported Types
+
+### `components.CreditBorrowParams`
+
+```typescript
+const value: components.CreditBorrowParams = {
+  actionType: "CREDIT_BORROW",
+  token: "<value>",
+  amount: "528.33",
+};
+```
+
+### `components.CreditRepayParams`
+
+```typescript
+const value: components.CreditRepayParams = {
+  actionType: "CREDIT_REPAY",
+  token: "<value>",
+  amount: 9432.03,
+};
+```
+
+### `components.CreditSupplyParams`
+
+```typescript
+const value: components.CreditSupplyParams = {
+  actionType: "CREDIT_SUPPLY",
+  token: "<value>",
+  amount: "271.94",
+};
+```
+
+### `components.CreditWithdrawParams`
+
+```typescript
+const value: components.CreditWithdrawParams = {
+  actionType: "CREDIT_WITHDRAW",
+  token: "<value>",
+  amount: 6714.86,
+};
+```
+
+### `components.EarnSwapParams`
+
+```typescript
+const value: components.EarnSwapParams = {
+  actionType: "V2_SWAP",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  amountIn: 1543.87,
+  slippage: "0.5",
+};
+```
+
+### `components.EarnTransferFromEOAParams`
+
+```typescript
+const value: components.EarnTransferFromEOAParams = {
+  actionType: "V2_TRANSFER_FROM_EOA",
+  token: "<value>",
+  amount: 4305.68,
+  permit2Signature: "<value>",
+  permit2Nonce: 649287,
+  permit2Deadline: 645376,
+};
+```
+
+### `components.EarnTransferToEOAParams`
+
+```typescript
+const value: components.EarnTransferToEOAParams = {
+  actionType: "V2_TRANSFER_TO_EOA",
+  token: "<value>",
+  amount: 692.89,
+};
+```
+

package/docs/models/components/creditwithdrawparams.md

@@ -0,0 +1,23 @@
+# CreditWithdrawParams
+
+Withdraw collateral from Aave via Credit Account.
+
+## Example Usage
+
+```typescript
+import { CreditWithdrawParams } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditWithdrawParams = {
+  actionType: "CREDIT_WITHDRAW",
+  token: "<value>",
+  amount: 6714.86,
+};
+```
+
+## Fields
+
+| Field                                   | Type                                    | Required                                | Description                             | Example                                 |
+| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
+| `actionType`                            | *"CREDIT_WITHDRAW"*                     | :heavy_check_mark:                      | N/A                                     | CREDIT_WITHDRAW                         |
+| `token`                                 | *string*                                | :heavy_check_mark:                      | Collateral token to withdraw from Aave. |                                         |
+| `amount`                                | *components.CreditWithdrawParamsAmount* | :heavy_check_mark:                      | Amount in token units to withdraw.      |                                         |

package/docs/models/components/creditwithdrawparamsamount.md

@@ -0,0 +1,19 @@
+# CreditWithdrawParamsAmount
+
+Amount in token units to withdraw.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/debtposition.md

@@ -0,0 +1,30 @@
+# DebtPosition
+
+A per-reserve debt position.
+
+## Example Usage
+
+```typescript
+import { DebtPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: DebtPosition = {
+  token: "<value>",
+  symbol: "<value>",
+  amountBorrowed: "<value>",
+  events: [],
+};
+```
+
+## Fields
+
+| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              | Example                                                                  |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
+| `token`                                                                  | *string*                                                                 | :heavy_check_mark:                                                       | Address of the borrow token.                                             |                                                                          |
+| `symbol`                                                                 | *string*                                                                 | :heavy_check_mark:                                                       | Symbol of the borrow token (e.g. WETH).                                  |                                                                          |
+| `amountBorrowed`                                                         | *string*                                                                 | :heavy_check_mark:                                                       | Current on-chain variable debt balance.                                  |                                                                          |
+| `usdValue`                                                               | *string*                                                                 | :heavy_minus_sign:                                                       | Debt value in USD.                                                       |                                                                          |
+| `borrowApy`                                                              | *string*                                                                 | :heavy_minus_sign:                                                       | Current borrow APY in percentage (e.g. 4.5 means 4.5%).                  |                                                                          |
+| `totalBorrowed`                                                          | *string*                                                                 | :heavy_minus_sign:                                                       | Total amount borrowed across all borrow events.                          |                                                                          |
+| `totalRepaid`                                                            | *string*                                                                 | :heavy_minus_sign:                                                       | Total amount repaid across all repay events.                             |                                                                          |
+| `interestPaid`                                                           | *string*                                                                 | :heavy_minus_sign:                                                       | Interest paid on debt: on_chain_balance + total_repaid - total_borrowed. |                                                                          |
+| `events`                                                                 | [components.CreditEvent](../../models/components/creditevent.md)[]       | :heavy_minus_sign:                                                       | All historical events for this debt reserve.                             | []                                                                       |

package/docs/models/components/eventtype.md

@@ -0,0 +1,17 @@
+# EventType
+
+Type of credit event.
+
+## Example Usage
+
+```typescript
+import { EventType } from "@compass-labs/api-sdk/models/components";
+
+let value: EventType = "withdraw";
+```
+
+## Values
+
+```typescript
+"supply" | "withdraw" | "borrow" | "repay" | "liquidation"
+```

package/docs/models/components/repayamount.md

@@ -0,0 +1,19 @@
+# RepayAmount
+
+Amount of repay_token to repay (in token units, not wei).
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 0.01;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/withdrawamount.md

@@ -0,0 +1,19 @@
+# WithdrawAmount
+
+Amount of collateral to withdraw (in token units, not wei).
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 100;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/operations/v2creditpositionschain.md

@@ -0,0 +1,15 @@
+# V2CreditPositionsChain
+
+## Example Usage
+
+```typescript
+import { V2CreditPositionsChain } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2CreditPositionsChain = "base";
+```
+
+## Values
+
+```typescript
+"arbitrum" | "base" | "ethereum"
+```

package/docs/models/operations/v2creditpositionsrequest.md

@@ -0,0 +1,19 @@
+# V2CreditPositionsRequest
+
+## Example Usage
+
+```typescript
+import { V2CreditPositionsRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2CreditPositionsRequest = {
+  chain: "base",
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+};
+```
+
+## Fields
+
+| Field                                                                                  | Type                                                                                   | Required                                                                               | Description                                                                            | Example                                                                                |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `chain`                                                                                | [operations.V2CreditPositionsChain](../../models/operations/v2creditpositionschain.md) | :heavy_check_mark:                                                                     | N/A                                                                                    | base                                                                                   |
+| `owner`                                                                                | *string*                                                                               | :heavy_check_mark:                                                                     | The address of the owner of the credit account to get positions for.                   | 0x01E62835dd7F52173546A325294762143eE4a882                                             |