@compass-labs/api-sdk 2.2.97 → 2.2.99

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.
Files changed (47) hide show
  1. package/dist/commonjs/models/components/creditbalancesresponse.d.ts +1 -1
  2. package/dist/commonjs/models/components/creditunlooppreview.d.ts +1 -1
  3. package/dist/commonjs/models/components/earnbalancesresponse.d.ts +1 -1
  4. package/dist/commonjs/models/components/index.d.ts +1 -0
  5. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  6. package/dist/commonjs/models/components/index.js +1 -0
  7. package/dist/commonjs/models/components/index.js.map +1 -1
  8. package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.d.ts +1 -1
  9. package/dist/commonjs/models/components/tokenizedassetstraderequest.d.ts +6 -0
  10. package/dist/commonjs/models/components/tokenizedassetstraderequest.d.ts.map +1 -1
  11. package/dist/commonjs/models/components/tokenizedassetstraderequest.js +2 -0
  12. package/dist/commonjs/models/components/tokenizedassetstraderequest.js.map +1 -1
  13. package/dist/commonjs/models/components/wisdomtreecredentials.d.ts +41 -0
  14. package/dist/commonjs/models/components/wisdomtreecredentials.d.ts.map +1 -0
  15. package/dist/commonjs/models/components/wisdomtreecredentials.js +58 -0
  16. package/dist/commonjs/models/components/wisdomtreecredentials.js.map +1 -0
  17. package/dist/esm/models/components/creditbalancesresponse.d.ts +1 -1
  18. package/dist/esm/models/components/creditunlooppreview.d.ts +1 -1
  19. package/dist/esm/models/components/earnbalancesresponse.d.ts +1 -1
  20. package/dist/esm/models/components/index.d.ts +1 -0
  21. package/dist/esm/models/components/index.d.ts.map +1 -1
  22. package/dist/esm/models/components/index.js +1 -0
  23. package/dist/esm/models/components/index.js.map +1 -1
  24. package/dist/esm/models/components/tokenizedassetsbalancesresponse.d.ts +1 -1
  25. package/dist/esm/models/components/tokenizedassetstraderequest.d.ts +6 -0
  26. package/dist/esm/models/components/tokenizedassetstraderequest.d.ts.map +1 -1
  27. package/dist/esm/models/components/tokenizedassetstraderequest.js +2 -0
  28. package/dist/esm/models/components/tokenizedassetstraderequest.js.map +1 -1
  29. package/dist/esm/models/components/wisdomtreecredentials.d.ts +41 -0
  30. package/dist/esm/models/components/wisdomtreecredentials.d.ts.map +1 -0
  31. package/dist/esm/models/components/wisdomtreecredentials.js +21 -0
  32. package/dist/esm/models/components/wisdomtreecredentials.js.map +1 -0
  33. package/docs/models/components/creditbalancesresponse.md +5 -5
  34. package/docs/models/components/creditunlooppreview.md +13 -13
  35. package/docs/models/components/earnbalancesresponse.md +5 -5
  36. package/docs/models/components/tokenizedassetsbalancesresponse.md +5 -5
  37. package/docs/models/components/tokenizedassetstraderequest.md +11 -10
  38. package/docs/models/components/wisdomtreecredentials.md +31 -0
  39. package/openapi_prepped_for_speakeasy.json +52 -4
  40. package/package.json +1 -1
  41. package/src/models/components/creditbalancesresponse.ts +1 -1
  42. package/src/models/components/creditunlooppreview.ts +1 -1
  43. package/src/models/components/earnbalancesresponse.ts +1 -1
  44. package/src/models/components/index.ts +1 -0
  45. package/src/models/components/tokenizedassetsbalancesresponse.ts +1 -1
  46. package/src/models/components/tokenizedassetstraderequest.ts +11 -0
  47. package/src/models/components/wisdomtreecredentials.ts +69 -0
@@ -14,8 +14,8 @@ let value: CreditBalancesResponse = {
14
14
 
15
15
  ## Fields
16
16
 
17
- | Field | Type | Required | Description |
18
- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | `creditAccountAddress` | *string* | :heavy_check_mark: | The derived credit account address. |
20
- | `balances` | Record<string, [components.CompassApiBackendV2ModelsBalancesTokenBalance](../../models/components/compassapibackendv2modelsbalancestokenbalance.md)> | :heavy_minus_sign: | Token balances keyed by token symbol. |
21
- | `totalUsdValue` | *string* | :heavy_minus_sign: | Total USD value of all balances (sum of available values). |
17
+ | Field | Type | Required | Description |
18
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19
+ | `creditAccountAddress` | *string* | :heavy_check_mark: | The derived credit account address. |
20
+ | `balances` | Record<string, [components.CompassApiBackendV2ModelsBalancesTokenBalance](../../models/components/compassapibackendv2modelsbalancestokenbalance.md)> | :heavy_minus_sign: | Token balances keyed by token symbol. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' — match on token_address for exactness. |
21
+ | `totalUsdValue` | *string* | :heavy_minus_sign: | Total USD value of all balances (sum of available values). |
@@ -24,16 +24,16 @@ let value: CreditUnloopPreview = {
24
24
 
25
25
  ## Fields
26
26
 
27
- | Field | Type | Required | Description | Example |
28
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
29
- | `iterations` | *number* | :heavy_check_mark: | Number of swap-bearing unwind iterations bundled (the final collateral sweep leg does not count). | |
30
- | `totalCollateralWithdrawn` | *string* | :heavy_check_mark: | Guaranteed minimum total collateral withdrawn (token units). | |
31
- | `totalDebtRepaid` | *string* | :heavy_check_mark: | Guaranteed minimum total debt repaid (borrow-token units); actual can only be higher (swap fills above the floor repay more). | |
32
- | `endingCollateral` | *string* | :heavy_check_mark: | Pair collateral left supplied after the unwind (token units). On a full close this is 0, except when non-pair Aave debt still needs this collateral as backing then the final sweep is capped and this reports the residual left supplied. | |
33
- | `endingDebt` | *string* | :heavy_check_mark: | Projected remaining debt (borrow-token units); 0 on a full close. | |
34
- | `endingMultiplier` | *string* | :heavy_check_mark: | Projected leverage after the unwind; 1 when the debt is cleared. Never promises more deleverage than is guaranteed. | |
35
- | `projectedLtv` | *string* | :heavy_check_mark: | Projected end loan-to-value in percent, at the sizing oracle prices; 0 when the debt is cleared. | |
36
- | `projectedHealthFactor` | *string* | :heavy_check_mark: | Projected health factor (Aave account-level / Morpho market-level). Never overstated at the 1.0 boundary. | |
37
- | `estimatedMaxDust` | *string* | :heavy_check_mark: | Upper bound of borrow-token surplus the unwind can leave in the Credit Account — the sum of each swap's quote minus its guaranteed floor plus the full-close overshoot. It accumulates in the Credit Account, is recoverable, and is never lost. | |
38
- | `fullyUnwound` | *boolean* | :heavy_check_mark: | True when the requested target was fully reached in this transaction. False on a partial-progress plan (allow_partial=true) — call unloop again to finish. | |
39
- | `legs` | [components.UnloopLegPreview](../../models/components/unlooplegpreview.md)[] | :heavy_minus_sign: | Per-iteration breakdown. | [] |
27
+ | Field | Type | Required | Description | Example |
28
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
29
+ | `iterations` | *number* | :heavy_check_mark: | Number of swap-bearing unwind iterations bundled (the final collateral sweep leg does not count). | |
30
+ | `totalCollateralWithdrawn` | *string* | :heavy_check_mark: | Guaranteed minimum total collateral withdrawn (token units). | |
31
+ | `totalDebtRepaid` | *string* | :heavy_check_mark: | Guaranteed minimum total debt repaid (borrow-token units); actual can only be higher (swap fills above the floor repay more). | |
32
+ | `endingCollateral` | *string* | :heavy_check_mark: | Pair collateral left supplied after the unwind (token units). On a full close this is 0 when the sweep can take everything; when the final sweep must be an exact amount (non-pair Aave debt needs backing, or a shared reserve caps it) this reports the residual left supplied, including a dust-scale rounding margin. | |
33
+ | `endingDebt` | *string* | :heavy_check_mark: | Projected remaining debt (borrow-token units); 0 on a full close. | |
34
+ | `endingMultiplier` | *string* | :heavy_check_mark: | Projected leverage after the unwind; 1 when the debt is cleared. Never promises more deleverage than is guaranteed. | |
35
+ | `projectedLtv` | *string* | :heavy_check_mark: | Projected end loan-to-value in percent, at the sizing oracle prices; 0 when the debt is cleared. | |
36
+ | `projectedHealthFactor` | *string* | :heavy_check_mark: | Projected health factor (Aave account-level / Morpho market-level). Never overstated at the 1.0 boundary. | |
37
+ | `estimatedMaxDust` | *string* | :heavy_check_mark: | Upper bound of borrow-token surplus the unwind can leave in the Credit Account — the sum of each swap's quote minus its guaranteed floor plus the full-close overshoot. It accumulates in the Credit Account, is recoverable, and is never lost. | |
38
+ | `fullyUnwound` | *boolean* | :heavy_check_mark: | True when the requested target was fully reached in this transaction. False on a partial-progress plan (allow_partial=true) — call unloop again to finish. | |
39
+ | `legs` | [components.UnloopLegPreview](../../models/components/unlooplegpreview.md)[] | :heavy_minus_sign: | Per-iteration breakdown. | [] |
@@ -14,8 +14,8 @@ let value: EarnBalancesResponse = {
14
14
 
15
15
  ## Fields
16
16
 
17
- | Field | Type | Required | Description |
18
- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | `earnAccountAddress` | *string* | :heavy_check_mark: | The derived earn account address. |
20
- | `balances` | Record<string, [components.CompassApiBackendV2ModelsBalancesTokenBalance](../../models/components/compassapibackendv2modelsbalancestokenbalance.md)> | :heavy_minus_sign: | Token balances keyed by token symbol. |
21
- | `totalUsdValue` | *string* | :heavy_minus_sign: | Total USD value of all balances (sum of available values). |
17
+ | Field | Type | Required | Description |
18
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19
+ | `earnAccountAddress` | *string* | :heavy_check_mark: | The derived earn account address. |
20
+ | `balances` | Record<string, [components.CompassApiBackendV2ModelsBalancesTokenBalance](../../models/components/compassapibackendv2modelsbalancestokenbalance.md)> | :heavy_minus_sign: | Token balances keyed by token symbol. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' — match on token_address for exactness. |
21
+ | `totalUsdValue` | *string* | :heavy_minus_sign: | Total USD value of all balances (sum of available values). |
@@ -18,8 +18,8 @@ let value: TokenizedAssetsBalancesResponse = {
18
18
 
19
19
  ## Fields
20
20
 
21
- | Field | Type | Required | Description |
22
- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
23
- | `tokenizedAssetsAccountAddress` | *string* | :heavy_check_mark: | The derived Tokenized Assets Account address. |
24
- | `balances` | Record<string, [components.CompassApiBackendV2ModelsBalancesTokenBalance](../../models/components/compassapibackendv2modelsbalancestokenbalance.md)> | :heavy_minus_sign: | Token balances keyed by symbol. Each entry includes the current balance, its USD value, and transfer history. |
25
- | `totalUsdValue` | *string* | :heavy_minus_sign: | Total USD value of all priced balances. |
21
+ | Field | Type | Required | Description |
22
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23
+ | `tokenizedAssetsAccountAddress` | *string* | :heavy_check_mark: | The derived Tokenized Assets Account address. |
24
+ | `balances` | Record<string, [components.CompassApiBackendV2ModelsBalancesTokenBalance](../../models/components/compassapibackendv2modelsbalancestokenbalance.md)> | :heavy_minus_sign: | Token balances keyed by symbol. Each entry includes the current balance, its USD value, and transfer history. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' — match on token_address for exactness. |
25
+ | `totalUsdValue` | *string* | :heavy_minus_sign: | Total USD value of all priced balances. |
@@ -28,13 +28,14 @@ let value: TokenizedAssetsTradeRequest = {
28
28
 
29
29
  ## Fields
30
30
 
31
- | Field | Type | Required | Description | Example |
32
- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
33
- | `tokenIn` | *string* | :heavy_check_mark: | Token to spend. For a buy this must be a stablecoin the Midas issuance vault accepts (USDC on every supported network; mBASIS also accepts USDT/DAI on Ethereum). For a sell it is the Midas RWA asset to redeem (e.g. 'mTBILL'). | |
34
- | `tokenOut` | *string* | :heavy_check_mark: | Token to receive. For a buy this is the Midas RWA asset to mint (e.g. 'mTBILL'); for a sell it is the payout stablecoin (USDC). | |
35
- | `amountIn` | *components.TokenizedAssetsTradeRequestAmountIn* | :heavy_check_mark: | Human-readable amount of `token_in` to trade (token units, not wei). | |
36
- | `slippage` | *components.TokenizedAssetsTradeRequestSlippage* | :heavy_minus_sign: | Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). | 0.5 |
37
- | `owner` | *string* | :heavy_check_mark: | The owner's wallet address. | |
38
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
39
- | `gasSponsorship` | *boolean* | :heavy_minus_sign: | When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction. | false |
40
- | `fee` | [components.TokenizedAssetsFee](../../models/components/tokenizedassetsfee.md) | :heavy_minus_sign: | Optional partner fee charged when selling (exiting). It is taken from the payout-token (USDC) proceeds and sent to your fee recipient inside the same execution. | |
31
+ | Field | Type | Required | Description | Example |
32
+ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
33
+ | `tokenIn` | *string* | :heavy_check_mark: | Token to spend. For a buy this must be a stablecoin the Midas issuance vault accepts (USDC on every supported network; mBASIS also accepts USDT/DAI on Ethereum). For a sell it is the Midas RWA asset to redeem (e.g. 'mTBILL'). | |
34
+ | `tokenOut` | *string* | :heavy_check_mark: | Token to receive. For a buy this is the Midas RWA asset to mint (e.g. 'mTBILL'); for a sell it is the payout stablecoin (USDC). | |
35
+ | `amountIn` | *components.TokenizedAssetsTradeRequestAmountIn* | :heavy_check_mark: | Human-readable amount of `token_in` to trade (token units, not wei). | |
36
+ | `slippage` | *components.TokenizedAssetsTradeRequestSlippage* | :heavy_minus_sign: | Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). | 0.5 |
37
+ | `owner` | *string* | :heavy_check_mark: | The owner's wallet address. | |
38
+ | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
39
+ | `gasSponsorship` | *boolean* | :heavy_minus_sign: | When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction. | false |
40
+ | `wisdomtree` | [components.WisdomTreeCredentials](../../models/components/wisdomtreecredentials.md) | :heavy_minus_sign: | WisdomTree Connect API credentials, required only when trading a WisdomTree money-market fund. Each organization authenticates with its own credentials, which are exchanged for a short-lived token to look up the settlement wallet for this trade. They are never stored and are masked in logs. | |
41
+ | `fee` | [components.TokenizedAssetsFee](../../models/components/tokenizedassetsfee.md) | :heavy_minus_sign: | Optional partner fee charged when selling (exiting). It is taken from the payout-token (USDC) proceeds and sent to your fee recipient inside the same execution. | |
@@ -0,0 +1,31 @@
1
+ # WisdomTreeCredentials
2
+
3
+ Per-organization WisdomTree Connect API credentials.
4
+
5
+ Supplied per request rather than configured on the service: each
6
+ organization has its own WisdomTree account, whitelisted wallets and KYC,
7
+ so there is no single service-level credential that could serve every
8
+ caller. The secret is a ``SecretStr`` so it cannot be printed by accident,
9
+ and the error logger masks it in request bodies.
10
+
11
+ ## Example Usage
12
+
13
+ ```typescript
14
+ import { WisdomTreeCredentials } from "@compass-labs/api-sdk/models/components";
15
+
16
+ let value: WisdomTreeCredentials = {
17
+ clientId: "<id>",
18
+ clientSecret: "MHxbGtE8LWfkq3Z",
19
+ username: "Wilbert.Kuhic37",
20
+ password: "bY18a8noS8Agg1J",
21
+ };
22
+ ```
23
+
24
+ ## Fields
25
+
26
+ | Field | Type | Required | Description |
27
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
28
+ | `clientId` | *string* | :heavy_check_mark: | WisdomTree Connect client id for your organization. |
29
+ | `clientSecret` | *string* | :heavy_check_mark: | WisdomTree Connect client secret for your organization. |
30
+ | `username` | *string* | :heavy_check_mark: | WisdomTree Connect username for your organization's account. |
31
+ | `password` | *string* | :heavy_check_mark: | WisdomTree Connect password for your organization's account. |
@@ -12425,7 +12425,7 @@
12425
12425
  },
12426
12426
  "type": "object",
12427
12427
  "title": "Balances",
12428
- "description": "Token balances keyed by token symbol."
12428
+ "description": "Token balances keyed by token symbol. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' \u2014 match on token_address for exactness."
12429
12429
  },
12430
12430
  "total_usd_value": {
12431
12431
  "anyOf": [
@@ -14289,7 +14289,7 @@
14289
14289
  "ending_collateral": {
14290
14290
  "type": "string",
14291
14291
  "title": "Ending Collateral",
14292
- "description": "Pair collateral left supplied after the unwind (token units). On a full close this is 0, except when non-pair Aave debt still needs this collateral as backing \u2014 then the final sweep is capped and this reports the residual left supplied."
14292
+ "description": "Pair collateral left supplied after the unwind (token units). On a full close this is 0 when the sweep can take everything; when the final sweep must be an exact amount (non-pair Aave debt needs backing, or a shared reserve caps it) this reports the residual left supplied, including a dust-scale rounding margin."
14293
14293
  },
14294
14294
  "ending_debt": {
14295
14295
  "type": "string",
@@ -15180,7 +15180,7 @@
15180
15180
  },
15181
15181
  "type": "object",
15182
15182
  "title": "Balances",
15183
- "description": "Token balances keyed by token symbol."
15183
+ "description": "Token balances keyed by token symbol. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' \u2014 match on token_address for exactness."
15184
15184
  },
15185
15185
  "total_usd_value": {
15186
15186
  "anyOf": [
@@ -25711,7 +25711,7 @@
25711
25711
  },
25712
25712
  "type": "object",
25713
25713
  "title": "Balances",
25714
- "description": "Token balances keyed by symbol. Each entry includes the current balance, its USD value, and transfer history."
25714
+ "description": "Token balances keyed by symbol. Each entry includes the current balance, its USD value, and transfer history. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' \u2014 match on token_address for exactness."
25715
25715
  },
25716
25716
  "total_usd_value": {
25717
25717
  "anyOf": [
@@ -26274,6 +26274,17 @@
26274
26274
  "description": "When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction.",
26275
26275
  "example": false
26276
26276
  },
26277
+ "wisdomtree": {
26278
+ "anyOf": [
26279
+ {
26280
+ "$ref": "#/components/schemas/WisdomTreeCredentials"
26281
+ },
26282
+ {
26283
+ "type": "null"
26284
+ }
26285
+ ],
26286
+ "description": "WisdomTree Connect API credentials, required only when trading a WisdomTree money-market fund. Each organization authenticates with its own credentials, which are exchanged for a short-lived token to look up the settlement wallet for this trade. They are never stored and are masked in logs."
26287
+ },
26277
26288
  "fee": {
26278
26289
  "anyOf": [
26279
26290
  {
@@ -29357,6 +29368,43 @@
29357
29368
  ],
29358
29369
  "title": "WildcatGetMarketResponse"
29359
29370
  },
29371
+ "WisdomTreeCredentials": {
29372
+ "properties": {
29373
+ "client_id": {
29374
+ "type": "string",
29375
+ "title": "Client Id",
29376
+ "description": "WisdomTree Connect client id for your organization."
29377
+ },
29378
+ "client_secret": {
29379
+ "type": "string",
29380
+ "format": "password",
29381
+ "title": "Client Secret",
29382
+ "description": "WisdomTree Connect client secret for your organization.",
29383
+ "writeOnly": true
29384
+ },
29385
+ "username": {
29386
+ "type": "string",
29387
+ "title": "Username",
29388
+ "description": "WisdomTree Connect username for your organization's account."
29389
+ },
29390
+ "password": {
29391
+ "type": "string",
29392
+ "format": "password",
29393
+ "title": "Password",
29394
+ "description": "WisdomTree Connect password for your organization's account.",
29395
+ "writeOnly": true
29396
+ }
29397
+ },
29398
+ "type": "object",
29399
+ "required": [
29400
+ "client_id",
29401
+ "client_secret",
29402
+ "username",
29403
+ "password"
29404
+ ],
29405
+ "title": "WisdomTreeCredentials",
29406
+ "description": "Per-organization WisdomTree Connect API credentials.\n\nSupplied per request rather than configured on the service: each\norganization has its own WisdomTree account, whitelisted wallets and KYC,\nso there is no single service-level credential that could serve every\ncaller. The secret is a ``SecretStr`` so it cannot be printed by accident,\nand the error logger masks it in request bodies."
29407
+ },
29360
29408
  "WithdrawalEvent": {
29361
29409
  "properties": {
29362
29410
  "block_number": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-labs/api-sdk",
3
- "version": "2.2.97",
3
+ "version": "2.2.99",
4
4
  "author": "royalnine",
5
5
  "type": "module",
6
6
  "tshy": {
@@ -21,7 +21,7 @@ export type CreditBalancesResponse = {
21
21
  */
22
22
  creditAccountAddress: string;
23
23
  /**
24
- * Token balances keyed by token symbol.
24
+ * Token balances keyed by token symbol. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' — match on token_address for exactness.
25
25
  */
26
26
  balances?:
27
27
  | { [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance }
@@ -29,7 +29,7 @@ export type CreditUnloopPreview = {
29
29
  */
30
30
  totalDebtRepaid: string;
31
31
  /**
32
- * Pair collateral left supplied after the unwind (token units). On a full close this is 0, except when non-pair Aave debt still needs this collateral as backing then the final sweep is capped and this reports the residual left supplied.
32
+ * Pair collateral left supplied after the unwind (token units). On a full close this is 0 when the sweep can take everything; when the final sweep must be an exact amount (non-pair Aave debt needs backing, or a shared reserve caps it) this reports the residual left supplied, including a dust-scale rounding margin.
33
33
  */
34
34
  endingCollateral: string;
35
35
  /**
@@ -21,7 +21,7 @@ export type EarnBalancesResponse = {
21
21
  */
22
22
  earnAccountAddress: string;
23
23
  /**
24
- * Token balances keyed by token symbol.
24
+ * Token balances keyed by token symbol. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' — match on token_address for exactness.
25
25
  */
26
26
  balances?:
27
27
  | { [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance }
@@ -396,6 +396,7 @@ export * from "./vaultwithdrawparams.js";
396
396
  export * from "./vaultwithdrawrequest.js";
397
397
  export * from "./weeklyapys.js";
398
398
  export * from "./wildcatgetmarketresponse.js";
399
+ export * from "./wisdomtreecredentials.js";
399
400
  export * from "./withdraw.js";
400
401
  export * from "./withdrawalevent.js";
401
402
  export * from "./wrapethparams.js";
@@ -27,7 +27,7 @@ export type TokenizedAssetsBalancesResponse = {
27
27
  */
28
28
  tokenizedAssetsAccountAddress: string;
29
29
  /**
30
- * Token balances keyed by symbol. Each entry includes the current balance, its USD value, and transfer history.
30
+ * Token balances keyed by symbol. Each entry includes the current balance, its USD value, and transfer history. Symbols are not unique on-chain: when two tokens collide, each key becomes 'SYMBOL (0xAddress)' — match on token_address for exactness.
31
31
  */
32
32
  balances?:
33
33
  | { [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance }
@@ -10,6 +10,11 @@ import {
10
10
  TokenizedAssetsFee$Outbound,
11
11
  TokenizedAssetsFee$outboundSchema,
12
12
  } from "./tokenizedassetsfee.js";
13
+ import {
14
+ WisdomTreeCredentials,
15
+ WisdomTreeCredentials$Outbound,
16
+ WisdomTreeCredentials$outboundSchema,
17
+ } from "./wisdomtreecredentials.js";
13
18
 
14
19
  /**
15
20
  * Human-readable amount of `token_in` to trade (token units, not wei).
@@ -58,6 +63,10 @@ export type TokenizedAssetsTradeRequest = {
58
63
  * When true, returns an EIP-712 payload for gas-sponsored execution instead of an unsigned transaction.
59
64
  */
60
65
  gasSponsorship?: boolean | undefined;
66
+ /**
67
+ * WisdomTree Connect API credentials, required only when trading a WisdomTree money-market fund. Each organization authenticates with its own credentials, which are exchanged for a short-lived token to look up the settlement wallet for this trade. They are never stored and are masked in logs.
68
+ */
69
+ wisdomtree?: WisdomTreeCredentials | null | undefined;
61
70
  /**
62
71
  * Optional partner fee charged when selling (exiting). It is taken from the payout-token (USDC) proceeds and sent to your fee recipient inside the same execution.
63
72
  */
@@ -113,6 +122,7 @@ export type TokenizedAssetsTradeRequest$Outbound = {
113
122
  owner: string;
114
123
  chain: string;
115
124
  gas_sponsorship?: boolean | undefined;
125
+ wisdomtree?: WisdomTreeCredentials$Outbound | null | undefined;
116
126
  fee?: TokenizedAssetsFee$Outbound | null | undefined;
117
127
  };
118
128
 
@@ -129,6 +139,7 @@ export const TokenizedAssetsTradeRequest$outboundSchema: z.ZodType<
129
139
  owner: z.string(),
130
140
  chain: Chain$outboundSchema,
131
141
  gasSponsorship: z.boolean().optional(),
142
+ wisdomtree: z.nullable(WisdomTreeCredentials$outboundSchema).optional(),
132
143
  fee: z.nullable(TokenizedAssetsFee$outboundSchema).optional(),
133
144
  }).transform((v) => {
134
145
  return remap$(v, {
@@ -0,0 +1,69 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+
8
+ /**
9
+ * Per-organization WisdomTree Connect API credentials.
10
+ *
11
+ * @remarks
12
+ *
13
+ * Supplied per request rather than configured on the service: each
14
+ * organization has its own WisdomTree account, whitelisted wallets and KYC,
15
+ * so there is no single service-level credential that could serve every
16
+ * caller. The secret is a ``SecretStr`` so it cannot be printed by accident,
17
+ * and the error logger masks it in request bodies.
18
+ */
19
+ export type WisdomTreeCredentials = {
20
+ /**
21
+ * WisdomTree Connect client id for your organization.
22
+ */
23
+ clientId: string;
24
+ /**
25
+ * WisdomTree Connect client secret for your organization.
26
+ */
27
+ clientSecret: string;
28
+ /**
29
+ * WisdomTree Connect username for your organization's account.
30
+ */
31
+ username: string;
32
+ /**
33
+ * WisdomTree Connect password for your organization's account.
34
+ */
35
+ password: string;
36
+ };
37
+
38
+ /** @internal */
39
+ export type WisdomTreeCredentials$Outbound = {
40
+ client_id: string;
41
+ client_secret: string;
42
+ username: string;
43
+ password: string;
44
+ };
45
+
46
+ /** @internal */
47
+ export const WisdomTreeCredentials$outboundSchema: z.ZodType<
48
+ WisdomTreeCredentials$Outbound,
49
+ z.ZodTypeDef,
50
+ WisdomTreeCredentials
51
+ > = z.object({
52
+ clientId: z.string(),
53
+ clientSecret: z.string(),
54
+ username: z.string(),
55
+ password: z.string(),
56
+ }).transform((v) => {
57
+ return remap$(v, {
58
+ clientId: "client_id",
59
+ clientSecret: "client_secret",
60
+ });
61
+ });
62
+
63
+ export function wisdomTreeCredentialsToJSON(
64
+ wisdomTreeCredentials: WisdomTreeCredentials,
65
+ ): string {
66
+ return JSON.stringify(
67
+ WisdomTreeCredentials$outboundSchema.parse(wisdomTreeCredentials),
68
+ );
69
+ }