squarefi-bff-api-module 1.36.83 → 1.36.84

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.
@@ -7953,11 +7953,22 @@ export interface components {
7953
7953
  /** @description Blockchain chain reference */
7954
7954
  ChainRef: {
7955
7955
  id?: number;
7956
- /** @example Ethereum */
7956
+ /**
7957
+ * @description Stable key of the network. Match on `id`, `name` or `symbol`; show `display_name`.
7958
+ * @example Ethereum
7959
+ */
7957
7960
  name?: string;
7958
- /** @example ETH */
7961
+ /**
7962
+ * @description Stable key of the network (not a ticker to display).
7963
+ * @example ETH
7964
+ */
7959
7965
  symbol?: string;
7960
7966
  enabled?: boolean;
7967
+ /**
7968
+ * @description Network name to show people. Falls back to `name`.
7969
+ * @example BNB Smart Chain
7970
+ */
7971
+ display_name?: string;
7961
7972
  };
7962
7973
  /** @description Crypto deposit address */
7963
7974
  CryptoAddress: {
@@ -10351,7 +10351,14 @@ export interface paths {
10351
10351
  headers: {
10352
10352
  [name: string]: unknown;
10353
10353
  };
10354
- content?: never;
10354
+ content: {
10355
+ "application/json": {
10356
+ /** @example true */
10357
+ success: boolean;
10358
+ data: components["schemas"]["ReferenceChain"][];
10359
+ pagination?: components["schemas"]["PaginationResponse"];
10360
+ };
10361
+ };
10355
10362
  };
10356
10363
  401: components["responses"]["UnauthorizedError"];
10357
10364
  };
@@ -16518,7 +16525,30 @@ export interface components {
16518
16525
  /** Format: date-time */
16519
16526
  created_at?: string;
16520
16527
  };
16521
- /** @description Blockchain network as stored in the `chain` reference table. Embedded whole into every item of `GET /frontend/wallets/{wallet_id}/addresses`; `GET /frontend/reference/chains` returns the `id` / `name` / `symbol` / `enabled` subset of the same rows. Rely on those four fields — the rest is the raw reference row and is not a stable contract. */
16528
+ /** @description A network on `GET /frontend/reference/chains` (and the `chain` of each currency on `GET /frontend/reference/currencies`). `name` and `symbol` are keys: match on them, show `display_name`. */
16529
+ ReferenceChain: {
16530
+ /** @example 3 */
16531
+ id: number;
16532
+ /**
16533
+ * @description Stable key of the network
16534
+ * @example Binance Smart Chain
16535
+ */
16536
+ name: string | null;
16537
+ /**
16538
+ * @description Stable key of the network, not a ticker to display
16539
+ * @example BSC
16540
+ */
16541
+ symbol: string | null;
16542
+ enabled: boolean;
16543
+ /**
16544
+ * @description Network name to show people; falls back to `name`
16545
+ * @example BNB Smart Chain
16546
+ */
16547
+ display_name: string;
16548
+ /** @description Whether the tenant's AML provider can screen addresses on this network (chains list only) */
16549
+ aml_supported?: boolean;
16550
+ };
16551
+ /** @description Blockchain network as stored in the `chain` reference table. Embedded whole into every item of `GET /frontend/wallets/{wallet_id}/addresses`; `GET /frontend/reference/chains` returns the `ReferenceChain` subset of the same rows. Rely on `id` / `name` / `symbol` / `enabled` / `display_name` — the rest is the raw reference row and is not a stable contract. `name` and `symbol` are keys: match on them, show `display_name`. */
16522
16552
  Chain: {
16523
16553
  /**
16524
16554
  * @description Numeric chain ID — the value `chain` carries on the single-address endpoints and in the `{chain}` path parameter
@@ -16531,6 +16561,11 @@ export interface components {
16531
16561
  symbol: string | null;
16532
16562
  /** @description Whether new addresses can be created on this network */
16533
16563
  enabled: boolean;
16564
+ /**
16565
+ * @description Network name to show people, as stored. Filled for every network; `GET /frontend/reference/chains` (`ReferenceChain`) also falls back to `name`.
16566
+ * @example BNB Smart Chain
16567
+ */
16568
+ display_name?: string | null;
16534
16569
  is_beta?: boolean | null;
16535
16570
  is_testnet?: boolean | null;
16536
16571
  /** @description Public RPC endpoint of the network */
@@ -3881,6 +3881,8 @@ export interface paths {
3881
3881
  name?: string;
3882
3882
  symbol?: string;
3883
3883
  enabled?: boolean;
3884
+ /** @description Network name to show people; falls back to `name` */
3885
+ display_name?: string;
3884
3886
  }[];
3885
3887
  };
3886
3888
  };
@@ -8036,9 +8038,16 @@ export interface components {
8036
8038
  is_tenant_enabled?: boolean;
8037
8039
  chain?: {
8038
8040
  id?: number;
8041
+ /** @description Stable key of the network; show `display_name` */
8039
8042
  name?: string;
8043
+ /** @description Stable key of the network */
8040
8044
  symbol?: string;
8041
8045
  enabled?: boolean;
8046
+ /**
8047
+ * @description Network name to show people; falls back to `name`
8048
+ * @example BNB Smart Chain
8049
+ */
8050
+ display_name?: string;
8042
8051
  } | null;
8043
8052
  };
8044
8053
  CryptoAddress: {
@@ -1435,8 +1435,15 @@ export interface components {
1435
1435
  };
1436
1436
  ChainDto: {
1437
1437
  id: number;
1438
+ /** @description Stable key of the network (e.g. `Binance Smart Chain`). Match on it; show `display_name`. */
1438
1439
  name: string | null;
1440
+ /** @description Stable key of the network (e.g. `MATIC`), also the icon key. Not a ticker to display. */
1439
1441
  symbol: string | null;
1442
+ /**
1443
+ * @description Network name to show people (BNB Smart Chain, TRON, TON). Falls back to `name`.
1444
+ * @example BNB Smart Chain
1445
+ */
1446
+ display_name: string | null;
1440
1447
  is_beta: boolean | null;
1441
1448
  };
1442
1449
  AllChainsResponseDto: {
@@ -429,11 +429,14 @@ export declare namespace API {
429
429
  id: number;
430
430
  name: string;
431
431
  symbol: string;
432
+ /** The network name to show people (BNB Smart Chain, TRON); when null, show name. name and symbol are stable keys, not labels. */
433
+ display_name: string | null;
432
434
  is_beta: boolean | null;
433
435
  }
434
436
  type ChainList = {
435
- count: number;
437
+ total: number;
436
438
  data: Chain[];
439
+ has_more: boolean;
437
440
  };
438
441
  }
439
442
  namespace Common {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squarefi-bff-api-module",
3
- "version": "1.36.83",
3
+ "version": "1.36.84",
4
4
  "description": "Squarefi BFF API client module",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",