@avail-project/ca-common 1.0.1-beta1 → 2.0.0

package/dist/esm/xcs/lifi-agg.js

@@ -2,11 +2,13 @@ import axios, { AxiosError } from "axios";
 import { bytesToHex, getAddress } from "viem";
 import { QuoteType, } from "./iface";
 import { Universe } from "../proto/definition";
+import Decimal from "decimal.js";
 export class LiFiAggregator {
     static BASE_URL_V1 = "https://li.quest/v1";
     static COMMON_OPTIONS = {
         denyExchanges: "openocean",
         slippage: "0.01",
+        skipSimulation: true,
     };
     axios;
     constructor(apiKey) {
@@ -15,6 +17,7 @@ export class LiFiAggregator {
             headers: {
                 "x-lifi-api-key": apiKey,
             },
+            timeout: 10_000,
         });
     }
     async getQuotes(requests) {
@@ -76,12 +79,38 @@ export class LiFiAggregator {
                 }
                 throw e;
             }
+            const { estimate, transactionRequest: { to, value, data }, action: { fromToken, toToken }, } = resp.data;
+            const inputAmountInDecimal = new Decimal(estimate.fromAmount)
+                .div(Decimal.pow(10, fromToken.decimals))
+                .toFixed(fromToken.decimals);
+            const outputAmountInDecimal = new Decimal(estimate.toAmountMin)
+                .div(Decimal.pow(10, toToken.decimals))
+                .toFixed(toToken.decimals);
             return {
-                type: r.type,
-                inputAmount: BigInt(resp.data.estimate.fromAmount),
-                outputAmountMinimum: BigInt(resp.data.estimate.toAmountMin),
-                outputAmountLikely: BigInt(resp.data.estimate.toAmount),
-                originalResponse: resp.data,
+                input: {
+                    amount: inputAmountInDecimal,
+                    amountRaw: BigInt(estimate.fromAmount),
+                    contractAddress: inputTokenAddr,
+                    decimals: fromToken.decimals,
+                    value: Decimal.mul(inputAmountInDecimal, fromToken.priceUSD).toNumber(),
+                    symbol: fromToken.symbol,
+                },
+                output: {
+                    amount: outputAmountInDecimal,
+                    amountRaw: BigInt(estimate.toAmountMin),
+                    contractAddress: outputTokenAddr,
+                    decimals: toToken.decimals,
+                    value: Decimal.mul(outputAmountInDecimal, toToken.priceUSD).toNumber(),
+                    symbol: toToken.symbol,
+                },
+                txData: {
+                    approvalAddress: estimate.approvalAddress,
+                    tx: {
+                        to,
+                        value,
+                        data,
+                    },
+                },
             };
         }));
         return list.map((item) => {

package/dist/types/data/currency.d.ts

@@ -13,7 +13,8 @@ export declare enum CurrencyID {
     KAIA = 17,
     SOPH = 18,
     TRX = 19,
-    MON = 20
+    MON = 20,
+    CBTC = 21
 }
 export declare class Currency {
     readonly currencyID: CurrencyID;

package/dist/types/xcs/autochoice.d.ts

@@ -1,16 +1,8 @@
 import Decimal from "decimal.js";
-import { Aggregator, Quote, QuoteRequestExactInput, QuoteRequestExactOutput } from "./iface";
+import { Aggregator, Quote, QuoteRequestExactInput, QuoteRequestExactOutput, QuoteResponse } from "./iface";
 import { Currency, CurrencyID, OmniversalChainID } from "../data";
 import { Bytes } from "../types";
-import { FixedFeeTuple } from "../proto/definition";
-type Asset = {
-    tokenAddress: Bytes;
-    amount: bigint;
-};
-export type Holding = {
-    chainID: OmniversalChainID;
-    value: number;
-} & Asset;
+import { Holding } from "./iface";
 export declare class AutoSelectionError extends Error {
 }
 declare const enum AggregateAggregatorsMode {
@@ -22,15 +14,7 @@ export declare function aggregateAggregators(requests: (QuoteRequestExactInput |
     aggregator: Aggregator;
 }[]>;
 export declare function autoSelectSourcesV2(userAddress: Bytes, holdings: Holding[], outputRequired: Decimal, aggregators: Aggregator[], commonCurrencyID?: CurrencyID): Promise<{
-    quotes: ({
-        req: QuoteRequestExactInput;
-        originalHolding: Holding;
-        cur: Currency;
-        idx: number;
-    } & {
-        quote: Quote;
-        agg: Aggregator;
-    })[];
+    quoteResponses: QuoteResponse[];
     usedCOTs: {
         originalHolding: Holding;
         amountUsed: Decimal;
@@ -38,37 +22,7 @@ export declare function autoSelectSourcesV2(userAddress: Bytes, holdings: Holdin
         cur: Currency;
     }[];
 }>;
-export declare function autoSelectSources(userAddress: Bytes, holdings: Holding[], outputRequired: Decimal, aggregators: Aggregator[], collectionFees: FixedFeeTuple[], commonCurrencyID?: CurrencyID): Promise<({
-    req: QuoteRequestExactInput;
-    cfee: bigint;
-    originalHolding: Holding;
-    cur: Currency;
-} & {
-    quote: Quote;
-    agg: Aggregator;
-})[]>;
-export declare function determineDestinationSwaps(userAddress: Bytes, chainID: OmniversalChainID, requirement: Asset, aggregators: Aggregator[], commonCurrencyID?: CurrencyID): Promise<{
-    quote: Quote | null;
-    aggregator: Aggregator;
-    inputAmount: Decimal;
-    outputAmount: bigint;
-}>;
-export declare function liquidateInputHoldings(userAddress: Bytes, holdings: Holding[], aggregators: Aggregator[], collectionFees: FixedFeeTuple[], commonCurrencyID?: CurrencyID): Promise<{
-    quotes: {
-        agg: Aggregator;
-        quote: Quote;
-        req: QuoteRequestExactInput;
-        cfee: bigint;
-        originalHolding: Holding;
-        cur: Currency;
-        aggregator: Aggregator;
-    }[];
-    total: Decimal;
-}>;
-export declare function destinationSwapWithExactIn(userAddress: Bytes, chainID: OmniversalChainID, inputAmount: bigint, outputToken: Bytes, aggregators: Aggregator[], commonCurrencyID?: CurrencyID): Promise<{
-    inputAmount: Decimal;
-    outputAmount: bigint;
-    quote: Quote | null;
-    aggregator: Aggregator;
-}>;
+export declare function determineDestinationSwaps(userAddress: Bytes, requirement: Holding, aggregators: Aggregator[], commonCurrencyID?: CurrencyID): Promise<QuoteResponse>;
+export declare function liquidateInputHoldings(userAddress: Bytes, holdings: Holding[], aggregators: Aggregator[], commonCurrencyID?: CurrencyID): Promise<QuoteResponse[]>;
+export declare function destinationSwapWithExactIn(userAddress: Bytes, omniChainID: OmniversalChainID, inputAmount: bigint, outputToken: Bytes, aggregators: Aggregator[], inputCurrency?: CurrencyID): Promise<QuoteResponse>;
 export {};

package/dist/types/xcs/bebop-agg.d.ts

@@ -35,7 +35,7 @@ export type BebopCommonQuote = {
         priceBeforeFee: number;
     }>;
     settlementAddress: string;
-    approvalTarget: string;
+    approvalTarget: Hex;
     requiredSignatures: Array<never>;
     priceImpact: number;
     warnings: Array<never>;
@@ -100,5 +100,5 @@ export declare class BebopAggregator implements Aggregator {
     private static readonly COMMON_OPTIONS;
     private readonly axios;
     constructor(apiKey: string);
-    getQuotes(requests: (QuoteRequestExactInput | QuoteRequestExactOutput)[]): Promise<(BebopQuote | null)[]>;
+    getQuotes(requests: (QuoteRequestExactInput | QuoteRequestExactOutput)[]): Promise<(Quote | null)[]>;
 }

package/dist/types/xcs/iface.d.ts

@@ -1,5 +1,6 @@
 import { Bytes } from "../types";
 import { OmniversalChainID } from "../data";
+import { Hex } from "viem";
 export declare enum QuoteType {
     EXACT_IN = 0,
     EXACT_OUT = 1
@@ -8,12 +9,43 @@ export declare enum QuoteSeriousness {
     PRICE_SURVEY = 0,
     SERIOUS = 1
 }
+export type QuoteResponse = {
+    chainID: number;
+    quote: Quote;
+    holding: Holding;
+    aggregator: Aggregator;
+};
+export type Holding = {
+    chainID: OmniversalChainID;
+    tokenAddress: Bytes;
+    amountRaw: bigint;
+};
 export interface Quote {
-    originalResponse: unknown;
-    type: QuoteType;
-    inputAmount: bigint;
-    outputAmountMinimum: bigint;
-    outputAmountLikely: bigint;
+    expiry?: number;
+    input: {
+        contractAddress: Hex;
+        amount: string;
+        amountRaw: bigint;
+        decimals: number;
+        value: number;
+        symbol: string;
+    };
+    output: {
+        contractAddress: Hex;
+        amount: string;
+        amountRaw: bigint;
+        decimals: number;
+        value: number;
+        symbol: string;
+    };
+    txData: {
+        approvalAddress: Hex;
+        tx: {
+            to: Hex;
+            data: Hex;
+            value: Hex;
+        };
+    };
 }
 type CommonQuoteParameters = {
     userAddress: Bytes;

package/dist/types/xcs/index.d.ts

@@ -1,5 +1,4 @@
 export * from './iface';
 export * from './lifi-agg';
-export * from './yieldyak-agg';
 export * from './bebop-agg';
 export * from './autochoice';

package/dist/types/xcs/lifi-agg.d.ts

@@ -1,35 +1,39 @@
+import { Hex } from "viem";
 import { Aggregator, Quote, QuoteRequestExactInput, QuoteRequestExactOutput } from "./iface";
 export type LiFiResponse = {
     type: string;
     id: string;
     estimate: {
         tool: string;
-        approvalAddress: string;
+        approvalAddress: Hex;
         toAmountMin: string;
         toAmount: string;
         fromAmount: string;
         executionDuration: number;
-        fromAmountUSD: string;
-        toAmountUSD: string;
+    };
+    action: {
+        fromToken: {
+            symbol: string;
+            decimals: number;
+            priceUSD: string;
+        };
+        toToken: {
+            symbol: string;
+            decimals: number;
+            priceUSD: string;
+        };
     };
     integrator: string;
     transactionRequest: {
-        value: string;
-        to: string;
-        data: string;
-        chainId: number;
-        gasPrice: string;
-        gasLimit: string;
-        from: string;
+        value: Hex;
+        to: Hex;
+        data: Hex;
     };
 };
-export type LiFiQuote = Quote & {
-    originalResponse: LiFiResponse;
-};
 export declare class LiFiAggregator implements Aggregator {
     private static readonly BASE_URL_V1;
     private static readonly COMMON_OPTIONS;
     private readonly axios;
     constructor(apiKey: string);
-    getQuotes(requests: (QuoteRequestExactInput | QuoteRequestExactOutput)[]): Promise<(LiFiQuote | null)[]>;
+    getQuotes(requests: (QuoteRequestExactInput | QuoteRequestExactOutput)[]): Promise<(Quote | null)[]>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avail-project/ca-common",
-  "version": "1.0.1-beta1",
+  "version": "2.0.0",
   "description": "common utilities for CA",
   "files": [
     "dist"

package/dist/cjs/xcs/yieldyak-agg.js

@@ -1,113 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.YieldYakAggregator = void 0;
-const viem_1 = require("viem");
-const es_toolkit_1 = require("es-toolkit");
-const iface_1 = require("./iface");
-const data_1 = require("../data");
-const definition_1 = require("../proto/definition");
-const yakaggregator_abi_1 = require("../evmabi/yakaggregator.abi");
-const YakAggregatorAddresses = new Map([
-    [(0, data_1.encodeChainID36)(definition_1.Universe.ETHEREUM, 42161), '0xb32C79a25291265eF240Eb32E9faBbc6DcEE3cE3'],
-    [(0, data_1.encodeChainID36)(definition_1.Universe.ETHEREUM, 10), '0xCd887F78c77b36B0b541E77AfD6F91C0253182A2'],
-    [(0, data_1.encodeChainID36)(definition_1.Universe.ETHEREUM, 43114), '0xC4729E56b831d74bBc18797e0e17A295fA77488c'],
-].map(([chainID, addr]) => {
-    return [(0, viem_1.bytesToHex)(chainID), addr];
-}));
-class YieldYakAggregator {
-    clients = new Map();
-    constructor(clients) {
-        for (const client of clients) {
-            const chainIDHex = (0, viem_1.bytesToHex)(client.chainID.toBytes());
-            const aggAddr = YakAggregatorAddresses.get(chainIDHex);
-            if (aggAddr == null) {
-                continue;
-            }
-            this.clients.set(chainIDHex, {
-                chainID: client.chainID,
-                client: client.client,
-                aggregatorAddress: aggAddr
-            });
-        }
-    }
-    async getQuotes(_requests) {
-        const requestsWithOriginalIndexes = _requests.map((r, rid) => {
-            return {
-                req: r,
-                idx: rid,
-            };
-        });
-        const responses = new Array(_requests.length).fill(null);
-        // it's so sad that JS doesn't have a proper binary data type
-        const groupedByChainID = (0, es_toolkit_1.groupBy)(requestsWithOriginalIndexes, r => (0, viem_1.bytesToHex)(r.req.chain.toBytes()));
-        await Promise.all(Array.from(Object.entries(groupedByChainID)).map(async ([chainIDHex, requests]) => {
-            const config = this.clients.get(chainIDHex);
-            if (config == null) {
-                return;
-            }
-            const reverseIndexes = [];
-            const mc3calls = [];
-            for (const req of requests) {
-                const inputTokenHex = (0, viem_1.bytesToHex)(req.req.inputToken.subarray(12));
-                const outputTokenHex = (0, viem_1.bytesToHex)(req.req.outputToken.subarray(12));
-                let args;
-                switch (req.req.type) {
-                    case iface_1.QuoteType.EXACT_IN: {
-                        args = [req.req.inputAmount, inputTokenHex, outputTokenHex, 0, 1];
-                        break;
-                    }
-                    case iface_1.QuoteType.EXACT_OUT: {
-                        args = [req.req.outputAmount, outputTokenHex, inputTokenHex, 0, 1];
-                        break;
-                    }
-                }
-                const indexes = [];
-                for (let steps = 1; steps !== 5; steps++) {
-                    const clonedArgs = (0, es_toolkit_1.clone)(args);
-                    clonedArgs[3] = steps;
-                    const idx = mc3calls.push({
-                        address: config.aggregatorAddress,
-                        abi: yakaggregator_abi_1.YakAggregatorABI,
-                        functionName: 'findBestPathWithGas',
-                        args: clonedArgs
-                    });
-                    indexes.push(idx - 1);
-                }
-                reverseIndexes.push([req, indexes]);
-            }
-            const _final = await config.client.multicall({
-                allowFailure: false,
-                contracts: mc3calls,
-                multicallAddress: '0xcA11bde05977b3631167028862bE2a173976CA11'
-            });
-            for (const [req, indexes] of reverseIndexes) {
-                const collected = [];
-                for (const index of indexes) {
-                    collected.push(_final[index]);
-                }
-                // @ts-expect-error the typing in maxBy is wrong, it can work with anything that is comparable
-                const optimalChoice = (0, es_toolkit_1.maxBy)(collected, route => (0, es_toolkit_1.last)(route.amounts));
-                if (optimalChoice.path.length === 0) {
-                    responses[req.idx] = null;
-                    return;
-                }
-                // we have to reverse everything
-                if (req.req.type === iface_1.QuoteType.EXACT_OUT) {
-                    optimalChoice.adapters.reverse();
-                    optimalChoice.amounts.reverse();
-                    optimalChoice.path.reverse();
-                }
-                const output = (0, es_toolkit_1.last)(optimalChoice.amounts);
-                responses[req.idx] = {
-                    type: req.req.type,
-                    inputAmount: optimalChoice.amounts[0],
-                    outputAmountLikely: output,
-                    outputAmountMinimum: output,
-                    offer: optimalChoice
-                };
-            }
-        }));
-        return responses;
-    }
-}
-exports.YieldYakAggregator = YieldYakAggregator;

package/dist/esm/xcs/yieldyak-agg.js

@@ -1,109 +0,0 @@
-import { bytesToHex } from "viem";
-import { clone as _clone, groupBy, last as _last, maxBy } from "es-toolkit";
-import { QuoteType } from "./iface";
-import { encodeChainID36 } from "../data";
-import { Universe } from "../proto/definition";
-import { YakAggregatorABI } from "../evmabi/yakaggregator.abi";
-const YakAggregatorAddresses = new Map([
-    [encodeChainID36(Universe.ETHEREUM, 42161), '0xb32C79a25291265eF240Eb32E9faBbc6DcEE3cE3'],
-    [encodeChainID36(Universe.ETHEREUM, 10), '0xCd887F78c77b36B0b541E77AfD6F91C0253182A2'],
-    [encodeChainID36(Universe.ETHEREUM, 43114), '0xC4729E56b831d74bBc18797e0e17A295fA77488c'],
-].map(([chainID, addr]) => {
-    return [bytesToHex(chainID), addr];
-}));
-export class YieldYakAggregator {
-    clients = new Map();
-    constructor(clients) {
-        for (const client of clients) {
-            const chainIDHex = bytesToHex(client.chainID.toBytes());
-            const aggAddr = YakAggregatorAddresses.get(chainIDHex);
-            if (aggAddr == null) {
-                continue;
-            }
-            this.clients.set(chainIDHex, {
-                chainID: client.chainID,
-                client: client.client,
-                aggregatorAddress: aggAddr
-            });
-        }
-    }
-    async getQuotes(_requests) {
-        const requestsWithOriginalIndexes = _requests.map((r, rid) => {
-            return {
-                req: r,
-                idx: rid,
-            };
-        });
-        const responses = new Array(_requests.length).fill(null);
-        // it's so sad that JS doesn't have a proper binary data type
-        const groupedByChainID = groupBy(requestsWithOriginalIndexes, r => bytesToHex(r.req.chain.toBytes()));
-        await Promise.all(Array.from(Object.entries(groupedByChainID)).map(async ([chainIDHex, requests]) => {
-            const config = this.clients.get(chainIDHex);
-            if (config == null) {
-                return;
-            }
-            const reverseIndexes = [];
-            const mc3calls = [];
-            for (const req of requests) {
-                const inputTokenHex = bytesToHex(req.req.inputToken.subarray(12));
-                const outputTokenHex = bytesToHex(req.req.outputToken.subarray(12));
-                let args;
-                switch (req.req.type) {
-                    case QuoteType.EXACT_IN: {
-                        args = [req.req.inputAmount, inputTokenHex, outputTokenHex, 0, 1];
-                        break;
-                    }
-                    case QuoteType.EXACT_OUT: {
-                        args = [req.req.outputAmount, outputTokenHex, inputTokenHex, 0, 1];
-                        break;
-                    }
-                }
-                const indexes = [];
-                for (let steps = 1; steps !== 5; steps++) {
-                    const clonedArgs = _clone(args);
-                    clonedArgs[3] = steps;
-                    const idx = mc3calls.push({
-                        address: config.aggregatorAddress,
-                        abi: YakAggregatorABI,
-                        functionName: 'findBestPathWithGas',
-                        args: clonedArgs
-                    });
-                    indexes.push(idx - 1);
-                }
-                reverseIndexes.push([req, indexes]);
-            }
-            const _final = await config.client.multicall({
-                allowFailure: false,
-                contracts: mc3calls,
-                multicallAddress: '0xcA11bde05977b3631167028862bE2a173976CA11'
-            });
-            for (const [req, indexes] of reverseIndexes) {
-                const collected = [];
-                for (const index of indexes) {
-                    collected.push(_final[index]);
-                }
-                // @ts-expect-error the typing in maxBy is wrong, it can work with anything that is comparable
-                const optimalChoice = maxBy(collected, route => _last(route.amounts));
-                if (optimalChoice.path.length === 0) {
-                    responses[req.idx] = null;
-                    return;
-                }
-                // we have to reverse everything
-                if (req.req.type === QuoteType.EXACT_OUT) {
-                    optimalChoice.adapters.reverse();
-                    optimalChoice.amounts.reverse();
-                    optimalChoice.path.reverse();
-                }
-                const output = _last(optimalChoice.amounts);
-                responses[req.idx] = {
-                    type: req.req.type,
-                    inputAmount: optimalChoice.amounts[0],
-                    outputAmountLikely: output,
-                    outputAmountMinimum: output,
-                    offer: optimalChoice
-                };
-            }
-        }));
-        return responses;
-    }
-}

package/dist/types/xcs/yieldyak-agg.d.ts

@@ -1,21 +0,0 @@
-import { Hex, PublicClient } from "viem";
-import { Aggregator, Quote, QuoteRequestExactInput, QuoteRequestExactOutput } from "./iface";
-import { OmniversalChainID } from "../data";
-type YakOffer = {
-    amounts: bigint[];
-    adapters: Hex[];
-    path: Hex[];
-    gasEstimate: bigint;
-};
-export type YakAggregatorQuote = Quote & {
-    offer: YakOffer;
-};
-export declare class YieldYakAggregator implements Aggregator {
-    private readonly clients;
-    constructor(clients: {
-        chainID: OmniversalChainID;
-        client: PublicClient;
-    }[]);
-    getQuotes(_requests: (QuoteRequestExactInput | QuoteRequestExactOutput)[]): Promise<(YakAggregatorQuote | null)[]>;
-}
-export {};