genius-intents 0.28.0 → 0.29.1-develop.0

package/dist/protocols/liquid-mesh/liquid-mesh.service.d.ts

@@ -0,0 +1,232 @@
+import { LiquidMeshConfig, LiquidMeshPriceRequestParams, LiquidMeshPriceResponse } from './liquid-mesh.types';
+import { IIntentProtocol } from '../../interfaces/intent-protocol';
+import { ChainIdEnum, ProtocolEnum } from '../../types/enums';
+import { PriceResponse, RawProtocolPriceResponse } from '../../types/price-response';
+import { QuoteResponse } from '../../types/quote-response';
+import { GeniusIntentsSDKConfig } from '../../types/sdk-config';
+import { IntentPriceParams } from '../../types/price-params';
+import { IntentQuoteParams } from '../../types/quote-params';
+/**
+ * The `LiquidMeshService` class implements the IIntentProtocol interface for token swaps
+ * using the Liquid Mesh aggregator. It provides functionality for fetching price quotes
+ * and generating transaction data for token swaps on various EVM-compatible blockchains.
+ *
+ * @implements {IIntentProtocol}
+ */
+export declare class LiquidMeshService implements IIntentProtocol {
+    /**
+     * The protocol identifier for Liquid Mesh.
+     */
+    readonly protocol = ProtocolEnum.LIQUID_MESH;
+    /**
+     * The list of blockchain networks supported by the Liquid Mesh service.
+     */
+    readonly chains: ChainIdEnum[];
+    readonly networkIds: {
+        56: string;
+        8453: string;
+        1399811149: string;
+    };
+    /**
+     * Indicates that the service operates only on a single blockchain.
+     */
+    readonly singleChain = true;
+    /**
+     * Indicates that the service does not support cross-chain operations.
+     */
+    readonly multiChain = false;
+    /**
+     * The endpoint for quote requests.
+     */
+    readonly quoteEndpoint = "/v1/quote";
+    /**
+     * The Liquid Mesh API key used for authentication.
+     */
+    private readonly _apiKey?;
+    /**
+     * The Ed25519 private key for signing JWTs.
+     */
+    private _privateKey?;
+    /**
+     * Promise that resolves when the private key is initialized.
+     */
+    private _privateKeyPromise?;
+    /**
+     * The Liquid Mesh proxy URL, if configured. Will only send
+     * requests through the proxy if this is set.
+     */
+    private _proxyUrl?;
+    /**
+     * The API key for the proxy service.
+     */
+    private _proxyApiKey?;
+    /**
+     * Cache for approve addresses per network to avoid repeated API calls.
+     */
+    private readonly _approvalContract;
+    constructor(config: GeniusIntentsSDKConfig & LiquidMeshConfig);
+    /**
+     * Converts a standard Base64 string to Base64URL encoding.
+     * Base64URL replaces '+' with '-', '/' with '_', and removes '=' padding.
+     *
+     * @param base64 - The standard Base64 encoded string.
+     * @returns The Base64URL encoded string.
+     */
+    private _toBase64Url;
+    /**
+     * Initializes the Ed25519 private key from base64-encoded seed and public key.
+     * Automatically converts standard Base64 to Base64URL if needed.
+     *
+     * @param privateKeySeed - The Ed25519 private key seed (Base64 or Base64URL).
+     * @param publicKey - The Ed25519 public key (Base64 or Base64URL).
+     */
+    private _initializePrivateKey;
+    /**
+     * Generates a signed JWT for Liquid Mesh API authentication.
+     *
+     * @param method - The HTTP method (GET, POST, etc.).
+     * @param path - The canonical request path (e.g., /v1/bsc/quote?amount=100).
+     * @param body - The request body (empty string for GET requests).
+     * @returns A promise that resolves to the signed JWT token.
+     */
+    private _generateAuthToken;
+    /**
+     * Generates the authentication headers for Liquid Mesh API requests.
+     *
+     * @param method - The HTTP method.
+     * @param path - The canonical request path.
+     * @param body - The request body.
+     * @returns A promise that resolves to the headers object.
+     */
+    private _getAuthHeaders;
+    /**
+     * Checks if the service is configured to use a proxy.
+     *
+     * @returns True if using proxy, false for direct API access.
+     */
+    private _isUsingProxy;
+    /**
+     * Builds the request URL, routing through proxy if configured.
+     * When proxy is enabled, the original target URL is passed as a query parameter.
+     *
+     * @param targetUrl - The original Liquid Mesh API URL.
+     * @returns The URL to use for the request (proxy URL or original URL).
+     */
+    private _buildRequestUrl;
+    /**
+     * Gets the appropriate headers for the request.
+     * When using proxy, no auth headers are needed (proxy handles authentication).
+     * For direct API access, generates JWT auth headers.
+     *
+     * @param method - The HTTP method.
+     * @param path - The canonical request path.
+     * @param body - The request body.
+     * @returns A promise that resolves to the headers object.
+     */
+    private _getRequestHeaders;
+    /**
+     * Checks if the provided configuration object is valid.
+     *
+     * @typeParam T - The expected shape of the configuration object.
+     * @param config - The configuration object to validate.
+     * @returns `true` if the configuration is valid, otherwise `false`.
+     */
+    isCorrectConfig<T extends {
+        [key: string]: string;
+    }>(config: {
+        [key: string]: string;
+    }): config is T;
+    /**
+     * Checks if the given network is Solana.
+     *
+     * @param networkId - The chain ID to check.
+     * @returns True if the network is Solana.
+     */
+    private _isSolanaNetwork;
+    /**
+     * Gets the native token address for the given network.
+     *
+     * @param networkId - The chain ID.
+     * @returns The native token address for the network.
+     */
+    private _getNativeAddress;
+    private _wrapSolanaMessageAsTransaction;
+    private _wrapRawMessage;
+    /**
+     * Fetches a price quote for a token swap from the Liquid Mesh API.
+     *
+     * @param {IntentPriceParams} params - The parameters required for the price quote.
+     *
+     * @returns {Promise<Omit<PriceResponse, 'protocolResponse'> & { protocolResponse: LiquidMeshPriceResponse }>}
+     * A promise that resolves to a `PriceResponse` object containing:
+     * - The amount of output tokens expected from the swap.
+     * - Gas estimation for the transaction.
+     * - The raw response from the Liquid Mesh API.
+     *
+     * @throws {SdkError} If the parameters are invalid or unsupported.
+     * @throws {SdkError} If the API returns an invalid response.
+     * @throws {SdkError} If there's an error fetching the price.
+     */
+    fetchPrice(params: IntentPriceParams): Promise<Omit<PriceResponse, 'protocolResponse'> & {
+        protocolResponse: LiquidMeshPriceResponse;
+    }>;
+    /**
+     * Fetches a swap quote from the Liquid Mesh API and builds the transaction data
+     * needed to execute the swap.
+     *
+     * Note: Liquid Mesh uses a single endpoint for both price and quote. The quote
+     * endpoint returns route information that can be used to construct the swap transaction.
+     *
+     * @param {IntentQuoteParams} params - The parameters required for the swap quote.
+     *
+     * @returns {Promise<QuoteResponse & { protocolResponse: LiquidMeshPriceResponse }>}
+     * A promise that resolves to a `QuoteResponse` object containing:
+     * - The expected amount of output tokens.
+     * - The transaction data needed to execute the swap.
+     * - Gas estimates for the transaction.
+     *
+     * @throws {SdkError} If the parameters are invalid or unsupported.
+     * @throws {SdkError} If the API returns an invalid response.
+     * @throws {SdkError} If there's an error fetching the quote.
+     */
+    fetchQuote(params: IntentQuoteParams): Promise<QuoteResponse & {
+        protocolResponse: LiquidMeshPriceResponse;
+    }>;
+    /**
+     * Fetches a swap quote for EVM chains and builds the transaction data.
+     *
+     * @private
+     */
+    private _fetchEvmQuote;
+    /**
+     * Fetches a swap quote for Solana and builds the transaction data.
+     *
+     * @private
+     */
+    private _fetchSolanaQuote;
+    /**
+     * Transforms the price parameters to the format expected by the Liquid Mesh API.
+     *
+     * @param {IntentPriceParams} params - The original price parameters.
+     *
+     * @returns {LiquidMeshPriceRequestParams} The transformed parameters ready for the Liquid Mesh API.
+     */
+    protected priceParamsToRequestParams(params: IntentPriceParams): LiquidMeshPriceRequestParams;
+    /**
+     * Validates the parameters for a price quote request.
+     *
+     * @param {IntentPriceParams} params - The parameters to validate.
+     *
+     * @throws {SdkError} If any of the parameters are invalid or unsupported.
+     */
+    protected validatePriceParams(params: IntentPriceParams): void;
+    /**
+     * Type guard to check if a response is a valid Liquid Mesh price response.
+     *
+     * @param {RawProtocolPriceResponse} response - The response to check.
+     *
+     * @returns {boolean} True if the response is a valid Liquid Mesh price response.
+     */
+    protected isLiquidMeshPriceResponse(response: RawProtocolPriceResponse): response is LiquidMeshPriceResponse;
+}
+//# sourceMappingURL=liquid-mesh.service.d.ts.map

package/dist/protocols/liquid-mesh/liquid-mesh.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquid-mesh.service.d.ts","sourceRoot":"","sources":["../../../src/protocols/liquid-mesh/liquid-mesh.service.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,gBAAgB,EAChB,4BAA4B,EAC5B,uBAAuB,EAMxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAgB,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAO3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAQ7D;;;;;;GAMG;AACH,qBAAa,iBAAkB,YAAW,eAAe;IACvD;;OAEG;IACH,SAAgB,QAAQ,4BAA4B;IAEpD;;OAEG;IACH,SAAgB,MAAM,gBAA2D;IAEjF,SAAgB,UAAU;;;;MAIxB;IAEF;;OAEG;IACH,SAAgB,WAAW,QAAQ;IAEnC;;OAEG;IACH,SAAgB,UAAU,SAAS;IAEnC;;OAEG;IACH,SAAgB,aAAa,eAAe;IAE5C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAS;IAElC;;OAEG;IAEH,OAAO,CAAC,WAAW,CAAC,CAAM;IAE1B;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAC,CAAgB;IAE3C;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAC,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAwD;gBAE9E,MAAM,EAAE,sBAAsB,GAAG,gBAAgB;IAiC7D;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAIpB;;;;;;OAMG;YACW,qBAAqB;IAgCnC;;;;;;;OAOG;YACW,kBAAkB;IA0ChC;;;;;;;OAOG;YACW,eAAe;IAgB7B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAIrB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAoBxB;;;;;;;;;OASG;YACW,kBAAkB;IAkBhC;;;;;;OAMG;IACI,eAAe,CAAC,CAAC,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAAE,MAAM,EAAE;QAClE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,GAAG,MAAM,IAAI,CAAC;IAMf;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAIxB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,+BAA+B;IAkEvC,OAAO,CAAC,eAAe;IA+CvB;;;;;;;;;;;;;;OAcG;IACU,UAAU,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CACzD,IAAI,CAAC,aAAa,EAAE,kBAAkB,CAAC,GAAG;QACxC,gBAAgB,EAAE,uBAAuB,CAAC;KAC3C,CACF;IAqFD;;;;;;;;;;;;;;;;;;OAkBG;IACU,UAAU,CACrB,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,aAAa,GAAG;QAAE,gBAAgB,EAAE,uBAAuB,CAAA;KAAE,CAAC;IAgCzE;;;;OAIG;YACW,cAAc;IA8G5B;;;;OAIG;YACW,iBAAiB;IA6G/B;;;;;;OAMG;IACH,SAAS,CAAC,0BAA0B,CAAC,MAAM,EAAE,iBAAiB,GAAG,4BAA4B;IAuB7F;;;;;;OAMG;IACH,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAsB9D;;;;;;OAMG;IACH,SAAS,CAAC,yBAAyB,CACjC,QAAQ,EAAE,wBAAwB,GACjC,QAAQ,IAAI,uBAAuB;CAGvC"}