@xoxno/types 1.0.388 → 1.0.391

package/dist/enums/wallet-client-type.enum.d.ts

@@ -15,5 +15,9 @@ export declare enum WalletClientType {
     XBULL = "xbull",
     HANA = "hana",
     LOBSTR = "lobstr",
-    STELLAR_WALLET_CONNECT = "wallet_connect"
+    STELLAR_WALLET_CONNECT = "wallet_connect",
+    ALBEDO = "albedo",
+    HOT_WALLET = "hot_wallet",
+    RABET = "rabet",
+    KLEVER = "klever"
 }

package/dist/enums/wallet-client-type.enum.js

@@ -20,4 +20,8 @@ var WalletClientType;
     WalletClientType["HANA"] = "hana";
     WalletClientType["LOBSTR"] = "lobstr";
     WalletClientType["STELLAR_WALLET_CONNECT"] = "wallet_connect";
+    WalletClientType["ALBEDO"] = "albedo";
+    WalletClientType["HOT_WALLET"] = "hot_wallet";
+    WalletClientType["RABET"] = "rabet";
+    WalletClientType["KLEVER"] = "klever";
 })(WalletClientType || (exports.WalletClientType = WalletClientType = {}));

package/dist/index.d.ts

@@ -184,6 +184,7 @@ export * from './entities/web2user-data/web2user-wallet';
 export * from './entities/web2user-data/web2user.doc';
 export * from './entities/xoxno-liquid-egld-sc/provider.dto';
 export * from './requests/aggregator/arda-swap-result.dto';
+export * from './requests/aggregator/soroswap-quote.dto';
 export * from './requests/aggregator/swap';
 export * from './requests/bober-battle/analytics';
 export * from './requests/chat/chat-token';

package/dist/index.js

@@ -273,6 +273,7 @@ __exportStar(require("./enums/xoxno-egld-liquid-sc.enum"), exports);
 __exportStar(require("./enums/xoxno-egld-ls-activity.enum"), exports);
 __exportStar(require("./enums/xoxno-ls-activity.enum"), exports);
 __exportStar(require("./requests/aggregator/arda-swap-result.dto"), exports);
+__exportStar(require("./requests/aggregator/soroswap-quote.dto"), exports);
 __exportStar(require("./requests/aggregator/swap"), exports);
 __exportStar(require("./requests/bober-battle/analytics"), exports);
 __exportStar(require("./requests/chat/chat-token"), exports);

package/dist/requests/aggregator/soroswap-quote.dto.d.ts

@@ -0,0 +1,56 @@
+/**
+ * One leg of a split route returned by the Soroswap aggregator.
+ *
+ * The shape mirrors the Soroban lending contract's `DexDistribution`
+ * (see rs-lending-xlm common/src/types.rs) so the backend can forward
+ * this vector verbatim into `SwapSteps.distribution`. `protocolId`
+ * is the u32 enum discriminant:
+ *   Soroswap = 0, Phoenix = 1, Aqua = 2, Comet = 3
+ */
+export declare class StellarSwapDistributionDto {
+    protocolId: number;
+    path: string[];
+    parts: number;
+    bytes?: string[] | null;
+}
+/**
+ * Pre-mapped `SwapSteps` ready to be handed to `buildStellarLendingTx`.
+ * Backend shapes this from the Soroswap `/quote` response so the UI
+ * never deals with the protocol-id string -> u32 enum mapping.
+ */
+export declare class StellarSwapStepsDto {
+    amountOutMin: string;
+    distribution: StellarSwapDistributionDto[];
+}
+/**
+ * Query DTO for `GET /stellar/aggregator/quote`. Mirrors the subset of
+ * Soroswap `/quote` parameters that are meaningful for lending actions.
+ * `sdex` is intentionally excluded from `protocols` server-side because
+ * SDEX cannot be routed through the Soroban aggregator CPI.
+ */
+export declare class SoroswapQuoteRequestDto {
+    assetIn: string;
+    assetOut: string;
+    amount: string;
+    tradeType: 'EXACT_IN' | 'EXACT_OUT';
+    network: 'mainnet' | 'testnet';
+    slippageBps?: number;
+    parts?: number;
+    maxHops?: number;
+}
+/**
+ * Response DTO for `GET /stellar/aggregator/quote`. Carries the raw
+ * quote metadata plus the pre-mapped `steps` value the UI can forward
+ * verbatim into `buildStellarLendingTx({ action, args: { steps } })`.
+ */
+export declare class SoroswapQuoteResponseDto {
+    assetIn: string;
+    assetOut: string;
+    amountIn: string;
+    amountOut: string;
+    amountOutMin: string;
+    tradeType: 'EXACT_IN' | 'EXACT_OUT';
+    priceImpactPct: string;
+    platform: 'router' | 'aggregator' | 'sdex';
+    steps: StellarSwapStepsDto;
+}

package/dist/requests/aggregator/soroswap-quote.dto.js

@@ -0,0 +1,253 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SoroswapQuoteResponseDto = exports.SoroswapQuoteRequestDto = exports.StellarSwapStepsDto = exports.StellarSwapDistributionDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+/**
+ * One leg of a split route returned by the Soroswap aggregator.
+ *
+ * The shape mirrors the Soroban lending contract's `DexDistribution`
+ * (see rs-lending-xlm common/src/types.rs) so the backend can forward
+ * this vector verbatim into `SwapSteps.distribution`. `protocolId`
+ * is the u32 enum discriminant:
+ *   Soroswap = 0, Phoenix = 1, Aqua = 2, Comet = 3
+ */
+class StellarSwapDistributionDto {
+}
+exports.StellarSwapDistributionDto = StellarSwapDistributionDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Protocol enum discriminant matching the Soroban `Protocol` enum: Soroswap=0, Phoenix=1, Aqua=2, Comet=3',
+        example: 0,
+    }),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.IsIn)([0, 1, 2, 3]),
+    __metadata("design:type", Number)
+], StellarSwapDistributionDto.prototype, "protocolId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Ordered list of Soroban contract addresses describing the swap path (length >= 2)',
+        example: [
+            'CCW67TSZV3SSS2HXMBQ5JFGCKJNXKZM7UQUWUZPUTHXSTZLEO7SJMI75',
+            'CDTKPWPLOURQA2SGTKTUQOWRCBZEORB4BWBOMJ3D3ZTQQSGE5F6JBQLV',
+        ],
+        isArray: true,
+        type: String,
+    }),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    __metadata("design:type", Array)
+], StellarSwapDistributionDto.prototype, "path", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Split weight for this leg (> 0)',
+        example: 10,
+    }),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(1),
+    __metadata("design:type", Number)
+], StellarSwapDistributionDto.prototype, "parts", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Optional 32-byte hints forwarded to the aggregator, base64-encoded. `null` or omitted for Soroswap / Phoenix / Aqua.',
+        required: false,
+        nullable: true,
+        isArray: true,
+        type: String,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    __metadata("design:type", Object)
+], StellarSwapDistributionDto.prototype, "bytes", void 0);
+/**
+ * Pre-mapped `SwapSteps` ready to be handed to `buildStellarLendingTx`.
+ * Backend shapes this from the Soroswap `/quote` response so the UI
+ * never deals with the protocol-id string -> u32 enum mapping.
+ */
+class StellarSwapStepsDto {
+}
+exports.StellarSwapStepsDto = StellarSwapStepsDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Minimum amount of output token the router must return, as an i128 decimal string in base units',
+        example: '9067253',
+    }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], StellarSwapStepsDto.prototype, "amountOutMin", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Split route across one or more AMMs',
+        type: () => StellarSwapDistributionDto,
+        isArray: true,
+    }),
+    (0, class_validator_1.IsArray)(),
+    (0, class_validator_1.ValidateNested)({ each: true }),
+    (0, class_transformer_1.Type)(() => StellarSwapDistributionDto),
+    __metadata("design:type", Array)
+], StellarSwapStepsDto.prototype, "distribution", void 0);
+/**
+ * Query DTO for `GET /stellar/aggregator/quote`. Mirrors the subset of
+ * Soroswap `/quote` parameters that are meaningful for lending actions.
+ * `sdex` is intentionally excluded from `protocols` server-side because
+ * SDEX cannot be routed through the Soroban aggregator CPI.
+ */
+class SoroswapQuoteRequestDto {
+}
+exports.SoroswapQuoteRequestDto = SoroswapQuoteRequestDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Input asset Soroban contract address',
+        example: 'CAS3J7GYLGXMF6TDJBBYYSE3HQ6BBSMLNUQ34T6TZMYMW2EVH34XOWMA',
+    }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteRequestDto.prototype, "assetIn", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Output asset Soroban contract address',
+        example: 'CCW67TSZV3SSS2HXMBQ5JFGCKJNXKZM7UQUWUZPUTHXSTZLEO7SJMI75',
+    }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteRequestDto.prototype, "assetOut", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Amount as an i128 decimal string in base units',
+        example: '10000000',
+    }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteRequestDto.prototype, "amount", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Trade type. Stellar lending actions only support EXACT_IN in v1; EXACT_OUT is reserved for future use.',
+        enum: ['EXACT_IN', 'EXACT_OUT'],
+        example: 'EXACT_IN',
+    }),
+    (0, class_validator_1.IsIn)(['EXACT_IN', 'EXACT_OUT']),
+    __metadata("design:type", String)
+], SoroswapQuoteRequestDto.prototype, "tradeType", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Soroswap network',
+        enum: ['mainnet', 'testnet'],
+        example: 'testnet',
+    }),
+    (0, class_validator_1.IsIn)(['mainnet', 'testnet']),
+    __metadata("design:type", String)
+], SoroswapQuoteRequestDto.prototype, "network", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Slippage tolerance in basis points. Defaults to 50 (= 0.5%) server-side when omitted.',
+        required: false,
+        example: 50,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], SoroswapQuoteRequestDto.prototype, "slippageBps", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Number of split routes for optimisation. Defaults to 10 server-side when omitted.',
+        required: false,
+        example: 10,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(1),
+    __metadata("design:type", Number)
+], SoroswapQuoteRequestDto.prototype, "parts", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Maximum number of hops per route. Defaults to 2 server-side when omitted.',
+        required: false,
+        example: 2,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(1),
+    __metadata("design:type", Number)
+], SoroswapQuoteRequestDto.prototype, "maxHops", void 0);
+/**
+ * Response DTO for `GET /stellar/aggregator/quote`. Carries the raw
+ * quote metadata plus the pre-mapped `steps` value the UI can forward
+ * verbatim into `buildStellarLendingTx({ action, args: { steps } })`.
+ */
+class SoroswapQuoteResponseDto {
+}
+exports.SoroswapQuoteResponseDto = SoroswapQuoteResponseDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Input asset Soroban contract address' }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteResponseDto.prototype, "assetIn", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Output asset Soroban contract address' }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteResponseDto.prototype, "assetOut", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Input amount as an i128 decimal string in base units',
+    }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteResponseDto.prototype, "amountIn", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Expected output amount as an i128 decimal string',
+    }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteResponseDto.prototype, "amountOut", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Minimum output (EXACT_IN) or maximum input (EXACT_OUT) after slippage',
+    }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteResponseDto.prototype, "amountOutMin", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        enum: ['EXACT_IN', 'EXACT_OUT'],
+    }),
+    (0, class_validator_1.IsIn)(['EXACT_IN', 'EXACT_OUT']),
+    __metadata("design:type", String)
+], SoroswapQuoteResponseDto.prototype, "tradeType", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Estimated price impact as a percentage string',
+        example: '0.50',
+    }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SoroswapQuoteResponseDto.prototype, "priceImpactPct", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Which Soroswap execution surface served the quote. Stellar lending actions only accept `router` or `aggregator`.',
+        enum: ['router', 'aggregator', 'sdex'],
+    }),
+    (0, class_validator_1.IsIn)(['router', 'aggregator', 'sdex']),
+    __metadata("design:type", String)
+], SoroswapQuoteResponseDto.prototype, "platform", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Pre-mapped SwapSteps ready to forward into the Soroban lending contract',
+        type: () => StellarSwapStepsDto,
+    }),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => StellarSwapStepsDto),
+    __metadata("design:type", StellarSwapStepsDto)
+], SoroswapQuoteResponseDto.prototype, "steps", void 0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xoxno/types",
-  "version": "1.0.388",
+  "version": "1.0.391",
   "description": "Shared types and utilities for XOXNO API.",
   "exports": {
     ".": {