@compass-labs/api-sdk 2.2.98 → 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 (14) hide show
  1. package/dist/commonjs/models/components/creditbalancesresponse.d.ts +1 -1
  2. package/dist/commonjs/models/components/earnbalancesresponse.d.ts +1 -1
  3. package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.d.ts +1 -1
  4. package/dist/esm/models/components/creditbalancesresponse.d.ts +1 -1
  5. package/dist/esm/models/components/earnbalancesresponse.d.ts +1 -1
  6. package/dist/esm/models/components/tokenizedassetsbalancesresponse.d.ts +1 -1
  7. package/docs/models/components/creditbalancesresponse.md +5 -5
  8. package/docs/models/components/earnbalancesresponse.md +5 -5
  9. package/docs/models/components/tokenizedassetsbalancesresponse.md +5 -5
  10. package/openapi_prepped_for_speakeasy.json +3 -3
  11. package/package.json +1 -1
  12. package/src/models/components/creditbalancesresponse.ts +1 -1
  13. package/src/models/components/earnbalancesresponse.ts +1 -1
  14. package/src/models/components/tokenizedassetsbalancesresponse.ts +1 -1
package/dist/commonjs/models/components/creditbalancesresponse.d.ts CHANGED
@@ -11,7 +11,7 @@ export type CreditBalancesResponse = {
11
11
  */
12
12
  creditAccountAddress: string;
13
13
  /**
14
- * Token balances keyed by token symbol.
14
+ * 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.
15
15
  */
16
16
  balances?: {
17
17
  [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance;
package/dist/commonjs/models/components/earnbalancesresponse.d.ts CHANGED
@@ -11,7 +11,7 @@ export type EarnBalancesResponse = {
11
11
  */
12
12
  earnAccountAddress: string;
13
13
  /**
14
- * Token balances keyed by token symbol.
14
+ * 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.
15
15
  */
16
16
  balances?: {
17
17
  [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance;
package/dist/commonjs/models/components/tokenizedassetsbalancesresponse.d.ts CHANGED
@@ -17,7 +17,7 @@ export type TokenizedAssetsBalancesResponse = {
17
17
  */
18
18
  tokenizedAssetsAccountAddress: string;
19
19
  /**
20
- * Token balances keyed by symbol. Each entry includes the current balance, its USD value, and transfer history.
20
+ * 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.
21
21
  */
22
22
  balances?: {
23
23
  [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance;
package/dist/esm/models/components/creditbalancesresponse.d.ts CHANGED
@@ -11,7 +11,7 @@ export type CreditBalancesResponse = {
11
11
  */
12
12
  creditAccountAddress: string;
13
13
  /**
14
- * Token balances keyed by token symbol.
14
+ * 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.
15
15
  */
16
16
  balances?: {
17
17
  [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance;
package/dist/esm/models/components/earnbalancesresponse.d.ts CHANGED
@@ -11,7 +11,7 @@ export type EarnBalancesResponse = {
11
11
  */
12
12
  earnAccountAddress: string;
13
13
  /**
14
- * Token balances keyed by token symbol.
14
+ * 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.
15
15
  */
16
16
  balances?: {
17
17
  [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance;
package/dist/esm/models/components/tokenizedassetsbalancesresponse.d.ts CHANGED
@@ -17,7 +17,7 @@ export type TokenizedAssetsBalancesResponse = {
17
17
  */
18
18
  tokenizedAssetsAccountAddress: string;
19
19
  /**
20
- * Token balances keyed by symbol. Each entry includes the current balance, its USD value, and transfer history.
20
+ * 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.
21
21
  */
22
22
  balances?: {
23
23
  [k: string]: CompassApiBackendV2ModelsBalancesTokenBalance;
package/docs/models/components/creditbalancesresponse.md CHANGED
@@ -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). |
package/docs/models/components/earnbalancesresponse.md CHANGED
@@ -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). |
package/docs/models/components/tokenizedassetsbalancesresponse.md CHANGED
@@ -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. |
package/openapi_prepped_for_speakeasy.json CHANGED
@@ -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": [
@@ -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": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-labs/api-sdk",
3
- "version": "2.2.98",
3
+ "version": "2.2.99",
4
4
  "author": "royalnine",
5
5
  "type": "module",
6
6
  "tshy": {
package/src/models/components/creditbalancesresponse.ts CHANGED
@@ -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 }
package/src/models/components/earnbalancesresponse.ts CHANGED
@@ -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 }
package/src/models/components/tokenizedassetsbalancesresponse.ts CHANGED
@@ -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 }