@7kprotocol/sdk-ts 3.5.1 → 3.5.2-beta.0

package/lib/esm/types/types/okx.d.ts

@@ -0,0 +1,193 @@
+/**
+ * OKX DEX Swap API Types
+ * Documentation: https://web3.okx.com/vi/build/docs/waas/dex-swap
+ */
+/**
+ * Gas level options for swap transactions
+ */
+export type GasLevel = "average" | "fast" | "slow";
+/**
+ * Swap API Request Parameters
+ */
+export interface OkxSwapRequest {
+    /** Chain ID (e.g., 1 for Ethereum) */
+    chainId: string;
+    /** The input amount of a token to be sold (set in minimal divisible units) */
+    amount: string;
+    /** The contract address of a token you want to send (e.g., 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee for native token) */
+    fromTokenAddress: string;
+    /** The contract address of a token you want to receive */
+    toTokenAddress: string;
+    /** Slippage limit (0-1 for EVM, 0-less than 1 for Solana) */
+    slippage: string;
+    /** User's wallet address */
+    userWalletAddress: string;
+    /** Recipient address of a purchased token (if not set, userWalletAddress will receive the token) */
+    swapReceiverAddress?: string;
+    /** The percentage of fromTokenAmount or toTokenAmount sent to referrer (0-3, max 2 decimal points) */
+    feePercent?: string;
+    /** Wallet address to receive commission fee from fromToken */
+    fromTokenReferrerWalletAddress?: string;
+    /** Wallet address to receive commission fee from toToken */
+    toTokenReferrerWalletAddress?: string;
+    /** When true, positive slippage revenue sent to referrer's address (default: false) */
+    enablePositiveSlippage?: boolean;
+    /** The gas (in wei) for the swap transaction */
+    gaslimit?: string;
+    /** Target gas price level (defaults to "average") */
+    gasLevel?: GasLevel;
+    /** DexId of liquidity pool for limited quotes, multiple separated by comma (e.g., "1,50,180") */
+    dexIds?: string;
+    /** When enabled, restricts routing to single liquidity pool (Solana only, default: false) */
+    directRoute?: boolean;
+    /** Percentage (0-1.0) of price impact allowed (default: 0.9) */
+    priceImpactProtectionPercentage?: string;
+    /** Custom parameters encoded as 128-character 64-bytes hexadecimal string (must start with "0x") */
+    callDataMemo?: string;
+    /** Used for Solana transactions, similar to gasPrice on Ethereum */
+    computeUnitPrice?: string;
+    /** Used for Solana transactions, similar to gasLimit on Ethereum */
+    computeUnitLimit?: string;
+    /** When true, API calculates auto slippage recommendations (default: false) */
+    autoSlippage?: boolean;
+    /** Maximum auto slippage when autoSlippage is true */
+    maxAutoSlippage?: string;
+}
+/**
+ * Token information
+ */
+export interface OkxTokenInfo {
+    /** Token contract address */
+    tokenContractAddress: string;
+    /** Token symbol (e.g., "USDC") */
+    tokenSymbol: string;
+    /** Token unit price in USD (may be null for special cases) */
+    tokenUnitPrice: string | null;
+    /** Decimal number defining smallest unit */
+    decimal: string;
+    /** Whether the token is a honeypot token */
+    isHoneyPot: boolean;
+    /** Token tax rate (0-1, where 0.01 = 1%) */
+    taxRate: string;
+}
+/**
+ * DEX Protocol information
+ */
+export interface OkxDexProtocol {
+    /** Name of the liquidity protocol (e.g., "Uniswap V3") */
+    dexName: string;
+    /** Percentage of assets handled by the protocol */
+    percent: string;
+}
+/**
+ * Sub-router information
+ */
+export interface OkxSubRouter {
+    /** Liquidity protocols used on the path */
+    dexProtocol: OkxDexProtocol[];
+    /** Information of token to be sold */
+    fromToken: OkxTokenInfo;
+    /** Information of token to be bought */
+    toToken: OkxTokenInfo;
+}
+/**
+ * Main router information
+ */
+export interface OkxRouter {
+    /** One of the main paths for the token swap */
+    router: string;
+    /** Percentage of assets handled by the main path */
+    routerPercent: string;
+    /** Quote path sub data set */
+    subRouterList: OkxSubRouter[];
+}
+/**
+ * Quote comparison information
+ */
+export interface OkxQuoteCompare {
+    /** DEX name of the quote route */
+    dexName: string;
+    /** DEX logo of the quote route */
+    dexLogo: string;
+    /** Estimated network fee (USD) of the quote route */
+    tradeFee: string;
+    /** Received amount of the quote route */
+    amountOut: string;
+    /** Price impact percentage */
+    priceImpactPercentage: string;
+}
+/**
+ * Transaction data model
+ */
+export interface OkxTransactionData {
+    /** Additional signing data (if required) */
+    signatureData?: string[];
+    /** User's wallet address */
+    from: string;
+    /** Estimated amount of the gas limit */
+    gas: string;
+    /** Gas price in wei */
+    gasPrice?: string;
+    /** EIP-1559: Recommended priority cost of gas per unit */
+    maxPriorityFeePerGas?: string;
+    /** The contract address of OKX DEX router */
+    to: string;
+    /** The amount of native tokens (in wei) to be sent to the contract */
+    value: string;
+    /** Minimum amount of token to buy when price reaches slippage limit */
+    minReceiveAmount: string;
+    /** Call data */
+    data: string;
+    /** Current transaction slippage value */
+    slippage: string;
+}
+/**
+ * Router result data
+ */
+export interface OkxRouterResult {
+    /** Chain ID */
+    chainId: string;
+    /** The input amount of a token to be sold */
+    fromTokenAmount: string;
+    /** The resulting amount of a token to be bought */
+    toTokenAmount: string;
+    /** Estimated network fee (USD) of the quote route */
+    tradeFee: string;
+    /** Estimated gas consumption in smallest units (e.g., wei) */
+    estimateGasFee: string;
+    /** Quote path data set */
+    dexRouterList: OkxRouter[];
+    /** Information of token to be sold */
+    fromToken: OkxTokenInfo;
+    /** Information of token to be bought */
+    toToken: OkxTokenInfo;
+    /** Price impact percentage */
+    priceImpactPercentage?: string;
+    /** Comparison of quote routes */
+    quoteCompareList?: OkxQuoteCompare[];
+}
+/**
+ * Swap API Response Data
+ */
+export interface OkxSwapResponseData {
+    /** Quote path data */
+    routerResult: OkxRouterResult;
+    /** Contract data model */
+    tx: OkxTransactionData;
+}
+/**
+ * OKX API Standard Response Wrapper
+ */
+export interface OkxApiResponse<T> {
+    /** Response code ("0" indicates success) */
+    code: string;
+    /** Response data array */
+    data: T[];
+    /** Response message */
+    msg: string;
+}
+/**
+ * Complete Swap API Response
+ */
+export type OkxSwapResponse = OkxApiResponse<OkxSwapResponseData>;
+//# sourceMappingURL=okx.d.ts.map

package/lib/esm/types/types/okx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"okx.d.ts","sourceRoot":"","sources":["../../../../src/types/okx.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,MAAM,EAAE,MAAM,CAAC;IACf,2HAA2H;IAC3H,gBAAgB,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,cAAc,EAAE,MAAM,CAAC;IACvB,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oGAAoG;IACpG,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,sGAAsG;IACtG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8DAA8D;IAC9D,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,4DAA4D;IAC5D,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,uFAAuF;IACvF,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,iGAAiG;IACjG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gEAAgE;IAChE,+BAA+B,CAAC,EAAE,MAAM,CAAC;IACzC,oGAAoG;IACpG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+EAA+E;IAC/E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,sDAAsD;IACtD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,6BAA6B;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,8DAA8D;IAC9D,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,UAAU,EAAE,OAAO,CAAC;IACpB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2CAA2C;IAC3C,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,sCAAsC;IACtC,SAAS,EAAE,YAAY,CAAC;IACxB,wCAAwC;IACxC,OAAO,EAAE,YAAY,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,aAAa,EAAE,MAAM,CAAC;IACtB,8BAA8B;IAC9B,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,sEAAsE;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,eAAe;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,eAAe,EAAE,MAAM,CAAC;IACxB,mDAAmD;IACnD,aAAa,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,cAAc,EAAE,MAAM,CAAC;IACvB,0BAA0B;IAC1B,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,sCAAsC;IACtC,SAAS,EAAE,YAAY,CAAC;IACxB,wCAAwC;IACxC,OAAO,EAAE,YAAY,CAAC;IACtB,8BAA8B;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,iCAAiC;IACjC,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,sBAAsB;IACtB,YAAY,EAAE,eAAe,CAAC;IAC9B,0BAA0B;IAC1B,EAAE,EAAE,kBAAkB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,uBAAuB;IACvB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,cAAc,CAAC,mBAAmB,CAAC,CAAC"}

package/lib/esm/types/utils/condition.d.ts

@@ -1,2 +1,2 @@
-export declare function assert(condition: boolean, message?: string | null): asserts condition;
+export declare function assert(condition: any, message?: string | null): asserts condition;
 //# sourceMappingURL=condition.d.ts.map

package/lib/esm/types/utils/condition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../../../src/utils/condition.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM,CACpB,SAAS,EAAE,OAAO,EAClB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GACtB,OAAO,CAAC,SAAS,CAInB"}
+{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../../../src/utils/condition.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM,CACpB,SAAS,EAAE,GAAG,EACd,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GACtB,OAAO,CAAC,SAAS,CAInB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@7kprotocol/sdk-ts",
-  "version": "3.5.1",
+  "version": "3.5.2-beta.0",
   "description": "",
   "exports": {
     ".": {
@@ -79,6 +79,7 @@
   },
   "optionalDependencies": {
     "@cetusprotocol/aggregator-sdk": "^1.4.1",
-    "@flowx-finance/sdk": "^1.13.8"
+    "@flowx-finance/sdk": "^1.13.8",
+    "@naviprotocol/astros-aggregator-sdk": "^1.9.1"
   }
 }