@bloque/sdk-swap 0.0.28

package/README.md

@@ -0,0 +1,5 @@
+# `@bloque/sdk-swap`
+
+⚠️ **Warning**: This package is intended for internal use. Its release cycle does not follow SemVer, which means we might release breaking changes (change APIs, remove functionality) without any prior warning.
+
+For documentation, please refer to the [main SDK documentation](../sdk/README.md).

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";const __rslib_import_meta_url__="u"<typeof document?new(require("url".replace("",""))).URL("file:"+__filename).href:document.currentScript&&document.currentScript.src||new URL("main.js",document.baseURI).href;var __webpack_require__={};__webpack_require__.d=(e,t)=>{for(var a in t)__webpack_require__.o(t,a)&&!__webpack_require__.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:t[a]})},__webpack_require__.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),__webpack_require__.r=e=>{"u">typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var __webpack_exports__={};__webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{SwapClient:()=>SwapClient,PseClient:()=>PseClient});const sdk_core_namespaceObject=require("@bloque/sdk-core");class PseClient extends sdk_core_namespaceObject.BaseClient{async banks(){return{banks:(await this.httpClient.request({method:"GET",path:"/api/utils/pse/banks"})).banks.map(e=>this._mapBankResponse(e))}}_mapBankResponse(e){return{code:e.financial_institution_code,name:e.financial_institution_name}}}class SwapClient extends sdk_core_namespaceObject.BaseClient{pse;constructor(e){super(e),this.pse=new PseClient(this.httpClient)}async findRates(e){let t=new URLSearchParams,a=JSON.stringify([e.fromAsset,e.toAsset]);t.append("edge",a),t.append("from_medium",JSON.stringify(e.fromMediums)),t.append("to_medium",JSON.stringify(e.toMediums)),void 0!==e.amountSrc&&t.append("amount_src",e.amountSrc),void 0!==e.amountDst&&t.append("amount_dst",e.amountDst),e.sort&&t.append("sort",e.sort),e.sortBy&&t.append("sort_by",e.sortBy);let r=t.toString(),_=`/api/rates?${r}`;return{rates:(await this.httpClient.request({method:"GET",path:_})).rates.map(e=>this._mapRateResponse(e))}}_mapRateResponse(e){return{id:e.id,sig:e.sig,swapSig:e.swap_sig,maker:e.maker,edge:e.edge,fee:{at:e.fee.at,value:e.fee.value,formula:e.fee.formula,components:e.fee.components.map(e=>({at:e.at,name:e.name,type:e.type,value:e.value,percentage:e.percentage,pair:e.pair,amount:e.amount}))},at:e.at,until:e.until,fromMediums:e.from_medium,toMediums:e.to_medium,rate:e.rate,ratio:e.ratio,fromLimits:e.from_limits,toLimits:e.to_limits,createdAt:e.created_at,updatedAt:e.updated_at}}}for(var __rspack_i in exports.PseClient=__webpack_exports__.PseClient,exports.SwapClient=__webpack_exports__.SwapClient,__webpack_exports__)-1===["PseClient","SwapClient"].indexOf(__rspack_i)&&(exports[__rspack_i]=__webpack_exports__[__rspack_i]);Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './pse/pse-client';
+export * from './pse/types';
+export * from './swap-client';
+export * from './types';

package/dist/index.js

@@ -0,0 +1 @@
+import{BaseClient as t}from"@bloque/sdk-core";class e extends t{async banks(){return{banks:(await this.httpClient.request({method:"GET",path:"/api/utils/pse/banks"})).banks.map(t=>this._mapBankResponse(t))}}_mapBankResponse(t){return{code:t.financial_institution_code,name:t.financial_institution_name}}}class a extends t{pse;constructor(t){super(t),this.pse=new e(this.httpClient)}async findRates(t){let e=new URLSearchParams,a=JSON.stringify([t.fromAsset,t.toAsset]);e.append("edge",a),e.append("from_medium",JSON.stringify(t.fromMediums)),e.append("to_medium",JSON.stringify(t.toMediums)),void 0!==t.amountSrc&&e.append("amount_src",t.amountSrc),void 0!==t.amountDst&&e.append("amount_dst",t.amountDst),t.sort&&e.append("sort",t.sort),t.sortBy&&e.append("sort_by",t.sortBy);let s=e.toString(),n=`/api/rates?${s}`;return{rates:(await this.httpClient.request({method:"GET",path:n})).rates.map(t=>this._mapRateResponse(t))}}_mapRateResponse(t){return{id:t.id,sig:t.sig,swapSig:t.swap_sig,maker:t.maker,edge:t.edge,fee:{at:t.fee.at,value:t.fee.value,formula:t.fee.formula,components:t.fee.components.map(t=>({at:t.at,name:t.name,type:t.type,value:t.value,percentage:t.percentage,pair:t.pair,amount:t.amount}))},at:t.at,until:t.until,fromMediums:t.from_medium,toMediums:t.to_medium,rate:t.rate,ratio:t.ratio,fromLimits:t.from_limits,toLimits:t.to_limits,createdAt:t.created_at,updatedAt:t.updated_at}}}export{e as PseClient,a as SwapClient};

package/dist/internal/wire-types.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @internal
+ * Wire types for API communication (snake_case format)
+ * These types represent the raw API request/response format
+ * and should not be used directly by SDK consumers.
+ */
+/**
+ * @internal
+ * Fee component type from API
+ */
+export type FeeComponentType = 'percentage' | 'rate' | 'fixed';
+/**
+ * @internal
+ * Fee component from API
+ */
+export interface FeeComponent {
+    at: number;
+    name: string;
+    type: FeeComponentType;
+    value: number | string;
+    percentage?: number;
+    pair?: string;
+    amount?: number;
+}
+/**
+ * @internal
+ * Fee details from API
+ */
+export interface Fee {
+    at: number;
+    value: number;
+    formula: string;
+    components: FeeComponent[];
+}
+/**
+ * @internal
+ * Rate from API
+ */
+export interface Rate {
+    id: string;
+    sig: string;
+    swap_sig: string;
+    maker: string;
+    edge: [string, string];
+    fee: Fee;
+    at: string;
+    until: string;
+    from_medium: string[];
+    to_medium: string[];
+    rate: [number, number];
+    ratio: number;
+    from_limits: [string, string];
+    to_limits: [string, string];
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * @internal
+ * Find rates response from API
+ */
+export interface FindRatesResponse {
+    rates: Rate[];
+}
+export interface PseBank {
+    financial_institution_code: string;
+    financial_institution_name: string;
+}
+export interface ListPseBanksResponse {
+    banks: PseBank[];
+}

package/dist/pse/pse-client.d.ts

@@ -0,0 +1,31 @@
+import { BaseClient } from '@bloque/sdk-core';
+import type { ListBanksResult } from './types';
+/**
+ * PSE client for PSE-related utilities
+ *
+ * Provides access to PSE (Pagos Seguros en Línea) utilities like bank listing.
+ */
+export declare class PseClient extends BaseClient {
+    /**
+     * List available PSE banks
+     *
+     * Retrieves the list of financial institutions available for PSE payments.
+     *
+     * @returns Promise resolving to list of banks
+     *
+     * @example
+     * ```typescript
+     * const result = await bloque.swap.pse.banks();
+     *
+     * for (const bank of result.banks) {
+     *   console.log(`${bank.code}: ${bank.name}`);
+     * }
+     * ```
+     */
+    banks(): Promise<ListBanksResult>;
+    /**
+     * Maps API bank response to SDK format
+     * @internal
+     */
+    private _mapBankResponse;
+}

package/dist/pse/types.d.ts

@@ -0,0 +1,13 @@
+export interface Bank {
+    /**
+     * Financial institution code
+     */
+    code: string;
+    /**
+     * Financial institution name
+     */
+    name: string;
+}
+export interface ListBanksResult {
+    banks: Bank[];
+}

package/dist/swap-client.d.ts

@@ -0,0 +1,41 @@
+import type { HttpClient } from '@bloque/sdk-core';
+import { BaseClient } from '@bloque/sdk-core';
+import { PseClient } from './pse/pse-client';
+import type { FindRatesParams, FindRatesResult } from './types';
+/**
+ * Swap client for finding exchange rates
+ *
+ * Provides access to exchange rate discovery and swapping functionality.
+ * - pse: PSE utilities (bank listing, etc.)
+ */
+export declare class SwapClient extends BaseClient {
+    readonly pse: PseClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Find available exchange rates
+     *
+     * Retrieves exchange rates for a given asset pair and optional filters.
+     *
+     * @param params - Rate search parameters
+     * @returns Promise resolving to available rates
+     *
+     * @example
+     * ```typescript
+     * const result = await bloque.swap.findRates({
+     *   fromAsset: 'COP/2',
+     *   toAsset: 'DUSD/6',
+     *   fromMediums: ['bancolombia'],
+     *   toMediums: ['kusama'],
+     *   amountSrc: '50000000' // 500000.00 COP (scaled by 2 decimals)
+     * });
+     *
+     * console.log(result.rates[0].ratio);
+     * ```
+     */
+    findRates(params: FindRatesParams): Promise<FindRatesResult>;
+    /**
+     * Maps API rate response to SDK format
+     * @internal
+     */
+    private _mapRateResponse;
+}

package/dist/types.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Public types for @bloque/sdk-swap
+ */
+/**
+ * Fee component type
+ */
+export type FeeComponentType = 'percentage' | 'rate' | 'fixed';
+/**
+ * Fee component details
+ */
+export interface FeeComponent {
+    /** Timestamp when this component was calculated */
+    at: number;
+    /** Component name (e.g., 'take_rate', 'exchange_rate', 'pse_fee') */
+    name: string;
+    /** Type of fee component */
+    type: FeeComponentType;
+    /** Component value */
+    value: number | string;
+    /** Percentage value (only for percentage type) */
+    percentage?: number;
+    /** Currency pair (only for rate type) */
+    pair?: string;
+    /** Fixed amount (only for fixed type) */
+    amount?: number;
+}
+/**
+ * Fee details for a rate
+ */
+export interface Fee {
+    /** Timestamp when the fee was calculated */
+    at: number;
+    /** Fee value */
+    value: number;
+    /** Formula used to calculate the fee */
+    formula: string;
+    /** Components that make up the fee */
+    components: FeeComponent[];
+}
+/**
+ * Rate limits tuple [min, max]
+ */
+export type RateLimits = [string, string];
+/**
+ * Rate tuple [sourceAmount, destinationAmount]
+ */
+export type RateTuple = [number, number];
+/**
+ * Exchange rate information
+ */
+export interface SwapRate {
+    /** Unique rate identifier */
+    id: string;
+    /** Rate signature */
+    sig: string;
+    /** Swap signature */
+    swapSig: string;
+    /** Maker identifier */
+    maker: string;
+    /** Asset edge [fromAsset, toAsset] */
+    edge: [string, string];
+    /** Fee details */
+    fee: Fee;
+    /** Timestamp when the rate was created */
+    at: string;
+    /** Timestamp until the rate is valid */
+    until: string;
+    /** Available source mediums */
+    fromMediums: string[];
+    /** Available destination mediums */
+    toMediums: string[];
+    /** Rate tuple [sourceAmount, destinationAmount] */
+    rate: RateTuple;
+    /** Exchange ratio */
+    ratio: number;
+    /** Source amount limits [min, max] */
+    fromLimits: RateLimits;
+    /** Destination amount limits [min, max] */
+    toLimits: RateLimits;
+    /** Creation timestamp */
+    createdAt: string;
+    /** Last update timestamp */
+    updatedAt: string;
+}
+/**
+ * Parameters for finding exchange rates
+ */
+export interface FindRatesParams {
+    /**
+     * Source asset with precision (e.g., "COP/2" where /2 indicates 2 decimal places)
+     * @example "COP/2"
+     */
+    fromAsset: string;
+    /**
+     * Destination asset with precision (e.g., "DUSD/6" where /6 indicates 6 decimal places)
+     * @example "DUSD/6"
+     */
+    toAsset: string;
+    /**
+     * Source payment mediums (e.g., PSE, Bancolombia, Nequi)
+     * @example ["bancolombia", "pse"]
+     */
+    fromMediums: string[];
+    /**
+     * Destination payment mediums (e.g., Pomelo, Kreivo)
+     * @example ["kusama", "pomelo"]
+     */
+    toMediums: string[];
+    /**
+     * Source amount as bigint string (scaled by asset precision).
+     * Provide this OR amountDst, not both.
+     * @example "1000000" represents 10000.00 for COP/2
+     */
+    amountSrc?: string;
+    /**
+     * Destination amount as bigint string (scaled by asset precision).
+     * Provide this OR amountSrc, not both.
+     * @example "50000" represents 0.5000 for USD/4
+     */
+    amountDst?: string;
+    /**
+     * Sort order: 'asc' (best rate first) or 'desc' (highest rate first)
+     * @default "asc"
+     */
+    sort?: 'asc' | 'desc';
+    /**
+     * Sort by field: 'rate' (by exchange ratio) or 'at' (by calculation time)
+     * @default "rate"
+     */
+    sortBy?: 'rate' | 'at';
+}
+/**
+ * Result of finding exchange rates
+ */
+export interface FindRatesResult {
+    /** Array of available rates */
+    rates: SwapRate[];
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@bloque/sdk-swap",
+  "version": "0.0.28",
+  "type": "module",
+  "keywords": [
+    "bloque",
+    "sdk",
+    "api"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "homepage": "git+https://github.com/bloque-app/sdk.git#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bloque-app/sdk.git",
+    "directory": "packages/swap"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "@bloque/sdk-core": "0.0.28"
+  }
+}