@hypermid/sdk 1.2.0

package/dist/chains.js

@@ -0,0 +1,97 @@
+/**
+ * Chain ID constants for all supported chains.
+ *
+ * EVM chains use their standard numeric chain IDs.
+ * Non-EVM chains can be referenced by slug string (preferred) or numeric ID.
+ *
+ * @example
+ * ```ts
+ * import { ChainId, ChainSlug } from "@hypermid/sdk";
+ *
+ * // Numeric IDs (backwards compatible)
+ * const quote = await hm.getQuote({
+ *   fromChain: ChainId.ETHEREUM,    // 1
+ *   toChain: ChainId.ARBITRUM,      // 42161
+ *   ...
+ * });
+ *
+ * // String slugs (recommended for non-EVM)
+ * const quote2 = await hm.getQuote({
+ *   fromChain: ChainSlug.SOLANA,    // "solana"
+ *   toChain: ChainSlug.BITCOIN,     // "bitcoin"
+ *   ...
+ * });
+ * ```
+ */
+import { CHAIN_REGISTRY, NI_CHAIN_BASE, resolveChain, } from "./chain-registry.js";
+// ─── Numeric Chain IDs (backwards compatible) ────────────────────────────────
+const NI_BASE = NI_CHAIN_BASE;
+export const ChainId = {
+    // ─── EVM Chains ──────────────────────────────────────────────
+    ETHEREUM: 1,
+    OPTIMISM: 10,
+    BSC: 56,
+    GNOSIS: 100,
+    POLYGON: 137,
+    X_LAYER: 196,
+    ARBITRUM: 42161,
+    AVALANCHE: 43114,
+    BASE: 8453,
+    PLASMA: 1012,
+    BERACHAIN: 80094,
+    MONAD: 10143,
+    // ─── Non-EVM (LI.FI supported) ──────────────────────────────
+    SOLANA: 1151111081099710,
+    BITCOIN: 20000000000001,
+    SUI: 9270000000000000,
+    // ─── Near Intents-only chains ────────────────────────────────
+    NEAR: NI_BASE + 1,
+    TON: NI_BASE + 2,
+    TRON: NI_BASE + 3,
+    XRP: NI_BASE + 4,
+    DOGECOIN: NI_BASE + 5,
+    LITECOIN: NI_BASE + 6,
+    BITCOIN_CASH: NI_BASE + 7,
+    STELLAR: NI_BASE + 8,
+    CARDANO: NI_BASE + 9,
+    APTOS: NI_BASE + 10,
+    STARKNET: NI_BASE + 11,
+    DASH: NI_BASE + 12,
+    ZCASH: NI_BASE + 13,
+    ALEO: NI_BASE + 14,
+    ADI: NI_BASE + 15,
+};
+/**
+ * Human-readable chain slug constants (recommended for non-EVM chains).
+ *
+ * @example
+ * ```ts
+ * import { ChainSlug } from "@hypermid/sdk";
+ * const quote = await hm.getQuote({
+ *   fromChain: ChainSlug.SOLANA,     // "solana"
+ *   toChain: ChainSlug.NEAR,         // "near"
+ *   ...
+ * });
+ * ```
+ */
+export const ChainSlug = Object.fromEntries(CHAIN_REGISTRY.map((c) => [c.slug.toUpperCase().replace(/-/g, "_"), c.slug]));
+/**
+ * Check if a chain ID belongs to a Near Intents-only chain.
+ * Accepts slug strings or numeric IDs.
+ */
+export function isNearIntentsChain(chainId) {
+    if (typeof chainId === "number") {
+        return chainId >= NI_BASE && chainId < NI_BASE + 1000;
+    }
+    const entry = resolveChain(chainId);
+    return entry !== null && entry.numericId >= NI_BASE && entry.numericId < NI_BASE + 1000;
+}
+/**
+ * Check if a chain supports wallet-connected deposit mode.
+ * Accepts slug strings or numeric IDs.
+ */
+export function supportsWalletDeposit(chainId) {
+    const entry = resolveChain(chainId);
+    return entry?.depositMode === "wallet";
+}
+//# sourceMappingURL=chains.js.map

package/dist/chains.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chains.js","sourceRoot":"","sources":["../src/chains.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,EACL,cAAc,EACd,aAAa,EACb,YAAY,GAEb,MAAM,qBAAqB,CAAC;AAE7B,gFAAgF;AAEhF,MAAM,OAAO,GAAG,aAAa,CAAC;AAE9B,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,gEAAgE;IAChE,QAAQ,EAAE,CAAC;IACX,QAAQ,EAAE,EAAE;IACZ,GAAG,EAAE,EAAE;IACP,MAAM,EAAE,GAAG;IACX,OAAO,EAAE,GAAG;IACZ,OAAO,EAAE,GAAG;IACZ,QAAQ,EAAE,KAAK;IACf,SAAS,EAAE,KAAK;IAChB,IAAI,EAAE,IAAI;IACV,MAAM,EAAE,IAAI;IACZ,SAAS,EAAE,KAAK;IAChB,KAAK,EAAE,KAAK;IAEZ,+DAA+D;IAC/D,MAAM,EAAE,gBAAgB;IACxB,OAAO,EAAE,cAAc;IACvB,GAAG,EAAE,gBAAgB;IAErB,gEAAgE;IAChE,IAAI,EAAE,OAAO,GAAG,CAAC;IACjB,GAAG,EAAE,OAAO,GAAG,CAAC;IAChB,IAAI,EAAE,OAAO,GAAG,CAAC;IACjB,GAAG,EAAE,OAAO,GAAG,CAAC;IAChB,QAAQ,EAAE,OAAO,GAAG,CAAC;IACrB,QAAQ,EAAE,OAAO,GAAG,CAAC;IACrB,YAAY,EAAE,OAAO,GAAG,CAAC;IACzB,OAAO,EAAE,OAAO,GAAG,CAAC;IACpB,OAAO,EAAE,OAAO,GAAG,CAAC;IACpB,KAAK,EAAE,OAAO,GAAG,EAAE;IACnB,QAAQ,EAAE,OAAO,GAAG,EAAE;IACtB,IAAI,EAAE,OAAO,GAAG,EAAE;IAClB,KAAK,EAAE,OAAO,GAAG,EAAE;IACnB,IAAI,EAAE,OAAO,GAAG,EAAE;IAClB,GAAG,EAAE,OAAO,GAAG,EAAE;CACT,CAAC;AAIX;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CACzC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAClD,CAAC;AAE7B;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAwB;IACzD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,OAAO,IAAI,OAAO,IAAI,OAAO,GAAG,OAAO,GAAG,IAAI,CAAC;IACxD,CAAC;IACD,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACpC,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,SAAS,IAAI,OAAO,IAAI,KAAK,CAAC,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC;AAC1F,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAwB;IAC5D,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACpC,OAAO,KAAK,EAAE,WAAW,KAAK,QAAQ,CAAC;AACzC,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,257 @@
+import type { HyperMidConfig, ChainsResponse, TokensParams, TokensResponse, ConnectionsParams, GasPricesParams, QuoteParams, QuoteResponse, RoutesParams, StatusParams, StatusResponse, ExecuteParams, ExecuteResponse, DepositSubmitParams, DepositSubmitResponse, DepositStatusParams, DepositStatusResponse, OnrampQuoteParams, OnrampCheckoutParams, OnrampCheckoutResponse, OnrampStatusResponse, OnrampConfigResponse, OnrampAssetsParams, SwapEventParams, SwapEventResponse, PartnerInfo, PartnerStats, PartnerStatsParams, Transaction, PaginatedResponse, PaginationParams, CreateWebhookParams, WebhookCreated, WebhooksListResponse, PingResponse, BalancesParams, BalancesResponse, InboundReceiverParams, InboundReceiverResponse } from "./types.js";
+export declare class HyperMid {
+    private readonly baseUrl;
+    private readonly apiKey?;
+    private readonly timeout;
+    private readonly _fetch;
+    constructor(config?: HyperMidConfig);
+    private request;
+    private get;
+    private post;
+    private delete;
+    /**
+     * Get all supported chains (LI.FI + Near Intents).
+     * Cached server-side for 1 hour.
+     */
+    getChains(): Promise<ChainsResponse>;
+    /**
+     * Get available tokens, optionally filtered by chains and keywords.
+     * Cached server-side for 5 minutes.
+     */
+    getTokens(params?: TokensParams): Promise<TokensResponse>;
+    /**
+     * Get available connections (which token pairs can be swapped).
+     */
+    getConnections(params: ConnectionsParams): Promise<unknown>;
+    /**
+     * Get available bridge/swap tools.
+     * Cached server-side for 1 hour.
+     */
+    getTools(): Promise<unknown>;
+    /**
+     * Get gas prices for specified chains.
+     */
+    getGasPrices(params: GasPricesParams): Promise<unknown>;
+    /**
+     * Get the best swap quote for a token pair.
+     *
+     * @example
+     * ```ts
+     * const quote = await hm.getQuote({
+     *   fromChain: 1,
+     *   fromToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+     *   fromAmount: "100000000",  // 100 USDC
+     *   toChain: 42161,
+     *   toToken: "0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8",
+     *   fromAddress: "0x...",
+     * });
+     * ```
+     */
+    getQuote(params: QuoteParams): Promise<QuoteResponse>;
+    /**
+     * Get available routes for a token pair (multi-route comparison).
+     * Supports both GET and POST — SDK uses POST for flexibility.
+     */
+    getRoutes(params: RoutesParams): Promise<unknown>;
+    /**
+     * Check the status of a cross-chain swap.
+     *
+     * @example LI.FI status
+     * ```ts
+     * const status = await hm.getStatus({
+     *   txHash: "0x...",
+     *   fromChain: 1,
+     *   toChain: 42161,
+     * });
+     * ```
+     *
+     * @example Near Intents status
+     * ```ts
+     * const status = await hm.getStatus({
+     *   provider: "near-intents",
+     *   correlationId: "abc-123",
+     * });
+     * ```
+     */
+    getStatus(params: StatusParams): Promise<StatusResponse>;
+    /**
+     * Get full transaction data for execution.
+     *
+     * **LI.FI routes**: Returns `transactionRequest` — sign and broadcast with your wallet.
+     *
+     * **Near Intents routes**: Returns `depositAddress` — send tokens there.
+     * Use `depositMode` to control wallet vs. manual flow.
+     *
+     * @example LI.FI swap
+     * ```ts
+     * const result = await hm.execute({
+     *   fromChain: 1,
+     *   fromToken: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+     *   fromAmount: "100000000",
+     *   toChain: 42161,
+     *   toToken: "0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8",
+     *   fromAddress: "0x...",
+     *   toAddress: "0x...",
+     * });
+     * if (result.provider === "lifi") {
+     *   // Sign result.transactionRequest with your wallet
+     * }
+     * ```
+     *
+     * @example Near Intents manual deposit (user hasn't connected wallet)
+     * ```ts
+     * const result = await hm.execute({
+     *   fromChain: 900000003,  // Tron
+     *   fromToken: "...",
+     *   fromAmount: "10000000",
+     *   toChain: 900000002,  // TON
+     *   toToken: "...",
+     *   fromAddress: "T...",
+     *   toAddress: "EQ...",
+     *   depositMode: "manual",  // Force manual mode
+     * });
+     * // Show result.depositAddress to user with QR code
+     * ```
+     */
+    execute(params: ExecuteParams): Promise<ExecuteResponse>;
+    /**
+     * Submit a deposit transaction hash after sending tokens to a Near Intents deposit address.
+     * Only needed for `depositMode: "wallet"`. Manual deposits are auto-detected.
+     */
+    submitDeposit(params: DepositSubmitParams): Promise<DepositSubmitResponse>;
+    /**
+     * Check the status of a Near Intents deposit/swap.
+     *
+     * @example
+     * ```ts
+     * const status = await hm.getDepositStatus({
+     *   depositAddress: "0x...",
+     * });
+     * if (status.status === "SUCCESS") {
+     *   console.log("Swap complete!", status.swapDetails);
+     * }
+     * ```
+     */
+    getDepositStatus(params: DepositStatusParams): Promise<DepositStatusResponse>;
+    /**
+     * Get a fiat → crypto price quote.
+     */
+    getOnrampQuote(params: OnrampQuoteParams): Promise<unknown>;
+    /**
+     * Create a fiat → crypto purchase session. Returns a redirect URL
+     * to the payment page.
+     *
+     * @example
+     * ```ts
+     * const { redirectUrl, orderUid } = await hm.createOnrampCheckout({
+     *   walletAddress: "0x...",
+     *   cryptoToken: "ETH",
+     *   cryptoChain: "ethereum",
+     *   fiatCurrency: "USD",
+     *   fiatAmount: 100,
+     * });
+     * // Redirect user to redirectUrl
+     * ```
+     */
+    createOnrampCheckout(params: OnrampCheckoutParams): Promise<OnrampCheckoutResponse>;
+    /**
+     * Check on-ramp order status.
+     */
+    getOnrampStatus(orderUid: string): Promise<OnrampStatusResponse>;
+    /**
+     * Get supported chains and tokens for on-ramp.
+     * Cached server-side for 5 minutes.
+     */
+    getOnrampConfig(): Promise<OnrampConfigResponse>;
+    /**
+     * Get asset config (min/max amounts, precision, payment methods).
+     */
+    getOnrampAssets(params: OnrampAssetsParams): Promise<unknown>;
+    /**
+     * Record a swap event for analytics. partner_id is automatically
+     * attributed from your API key.
+     */
+    recordSwapEvent(params: SwapEventParams): Promise<SwapEventResponse>;
+    /**
+     * Get your partner info (requires API key).
+     */
+    getPartnerInfo(): Promise<PartnerInfo>;
+    /**
+     * Get volume, fee, and performance stats (requires API key).
+     *
+     * @example
+     * ```ts
+     * const stats = await hm.getPartnerStats({
+     *   from: "2025-01-01",
+     *   to: "2025-03-31",
+     * });
+     * console.log(`Volume: $${stats.volume_usd}`);
+     * ```
+     */
+    getPartnerStats(params?: PartnerStatsParams): Promise<PartnerStats>;
+    /**
+     * Get paginated transaction history (requires API key).
+     */
+    getPartnerTransactions(params?: PaginationParams): Promise<PaginatedResponse<Transaction>>;
+    /**
+     * Register a webhook endpoint. Returns the signing secret — store it securely!
+     * The secret is only shown once, on creation.
+     *
+     * @example
+     * ```ts
+     * const webhook = await hm.createWebhook({
+     *   url: "https://myapp.com/webhooks/hypermid",
+     *   events: ["swap.completed", "onramp.completed"],
+     * });
+     * // Store webhook.secret securely!
+     * ```
+     */
+    createWebhook(params: CreateWebhookParams): Promise<WebhookCreated>;
+    /**
+     * List all registered webhooks (requires API key).
+     * Note: webhook secrets are never returned in list responses.
+     */
+    listWebhooks(): Promise<WebhooksListResponse>;
+    /**
+     * Delete a webhook by ID (requires API key).
+     */
+    deleteWebhook(webhookId: string): Promise<{
+        deleted: boolean;
+        id: string;
+    }>;
+    /**
+     * Get token balances for a wallet address across chains.
+     * Uses Alchemy Portfolio API + PulseChain RPC + Blockstream (BTC) on the backend.
+     *
+     * @example
+     * ```ts
+     * const balances = await hm.getBalances({
+     *   address: "0x1234...",
+     *   chainIds: [1, 42161, 8453, 369],
+     * });
+     * console.log(balances.totalBalanceUSD);
+     * ```
+     */
+    getBalances(params: BalancesParams): Promise<BalancesResponse>;
+    /**
+     * Register a USDC deposit at the InboundReceiver contract for SuperSwap.
+     * Call this AFTER the user's bridge transaction confirms on-chain.
+     *
+     * @example
+     * ```ts
+     * const result = await hm.registerInboundReceiver({
+     *   txHash: "0xabc...",
+     *   fromChain: 8453,
+     *   toChain: 369,
+     *   receiverAddress: "0xuser...",
+     *   outputToken: "0x0000...0000", // PLS
+     * });
+     * ```
+     */
+    registerInboundReceiver(params: InboundReceiverParams): Promise<InboundReceiverResponse>;
+    /**
+     * Simple health check. Returns API status, version, uptime, and provider statuses.
+     */
+    ping(): Promise<PingResponse>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EAEd,cAAc,EACd,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,WAAW,EACX,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACd,oBAAoB,EACpB,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,YAAY,CAAC;AAUpB,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0B;gBAErC,MAAM,GAAE,cAAmB;YASzB,OAAO;IA0ErB,OAAO,CAAC,GAAG;IAOX,OAAO,CAAC,IAAI;IAOZ,OAAO,CAAC,MAAM;IAMd;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC;IAI1C;;;OAGG;IACG,SAAS,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAI/D;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQjE;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAIlC;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7D;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;IAc3D;;;OAGG;IACG,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAcvD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IA0B9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC;IAgB9D;;;OAGG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAOhF;;;;;;;;;;;;OAYG;IACG,gBAAgB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IASnF;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAYjE;;;;;;;;;;;;;;;OAeG;IACG,oBAAoB,CACxB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,sBAAsB,CAAC;IAalC;;OAEG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAItE;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAItD;;OAEG;IACG,eAAe,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IAUnE;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAM1E;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAI5C;;;;;;;;;;;OAWG;IACG,eAAe,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAIzE;;OAEG;IACG,sBAAsB,CAC1B,MAAM,CAAC,EAAE,gBAAgB,GACxB,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAS1C;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,cAAc,CAAC;IAOzE;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAInD;;OAEG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IAMjF;;;;;;;;;;;;OAYG;IACG,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQpE;;;;;;;;;;;;;;OAcG;IACG,uBAAuB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAM9F;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,YAAY,CAAC;CAGpC"}